Class HTMLElementBuilder<T>

This will escape all input strings so it is safe by default. Pass a function that returns a string to explicitly indicate that you want the string treated as innerHTML.

Type Parameters

T extends string & keyof HTMLElementTagNameMap

Hierarchy (view full)

Builder<T, IConstructor<HTMLElementTagNameMap[T]>>
- HTMLElementBuilder

Index

Constructors

constructor

new HTMLElementBuilder<T>(tag, ...children): HTMLElementBuilder<T>
Type Parameters
- T extends "object" | "search" | "link" | "small" | "sub" | "sup" | "map" | "input" | "base" | "time" | "code" | "data" | "progress" | "track" | "source" | "button" | "address" | "a" | "abbr" | "area" | "article" | "aside" | "audio" | "b" | "bdi" | "bdo" | "blockquote" | "body" | "br" | "canvas" | "caption" | "cite" | "col" | "colgroup" | "datalist" | "dd" | "del" | "details" | "dfn" | "dialog" | "div" | "dl" | "dt" | "em" | "embed" | "fieldset" | "figcaption" | "figure" | "footer" | "form" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "head" | "header" | "hgroup" | "hr" | "html" | "i" | "iframe" | "img" | "ins" | "kbd" | "label" | "legend" | "li" | "main" | "mark" | "menu" | "meta" | "meter" | "nav" | "noscript" | "ol" | "optgroup" | "option" | "output" | "p" | "picture" | "pre" | "q" | "rp" | "rt" | "ruby" | "s" | "samp" | "script" | "section" | "select" | "slot" | "span" | "strong" | "style" | "summary" | "table" | "tbody" | "td" | "template" | "textarea" | "tfoot" | "th" | "thead" | "title" | "tr" | "u" | "ul" | "var" | "video" | "wbr"
Parameters
- tag: T
- Rest ...children: IElementChild[]
Returns HTMLElementBuilder<T>
Inherited from Builder.constructor
- Defined in src/dom/builder/builder.ts:56

Properties

attrs

attrs: object = {}

children

children: IElementChild[] = []

components

components: IComponent[] = []

nsAttrs

nsAttrs: object = {}

`Optional` parents

parents?: Set<IBuilder> = ...

props

props: object = {}

tag

tag: T

Methods

append

append(...children): HTMLElementBuilder<T>
Parameters
- Rest ...children: IElementChild[]
Returns HTMLElementBuilder<T>
Inherited from Builder.append
- Defined in src/dom/builder/builder.ts:80

appendTo

appendTo(...targets): HTMLElementBuilder<T>
Parameters
- Rest ...targets: (Element | IBuilder)[]
Returns HTMLElementBuilder<T>
Inherited from Builder.appendTo
- Defined in src/dom/builder/builder.ts:141

apply

apply(...components): HTMLElementBuilder<T>
Parameters
- Rest ...components: IComponent[]
Returns HTMLElementBuilder<T>
Inherited from Builder.apply
- Defined in src/dom/builder/builder.ts:92

assign

assign(props): HTMLElementBuilder<T>
Parameters
- props: object
Returns HTMLElementBuilder<T>
Inherited from Builder.assign
- Defined in src/dom/builder/builder.ts:69

build

build(): HTMLElementTagNameMap[T]
Returns HTMLElementTagNameMap[T]
Inherited from Builder.build
- Defined in src/dom/builder/builder.ts:110

create

create(): HTMLElementTagNameMap[T]
Returns HTMLElementTagNameMap[T]
Overrides Builder.create
- Defined in src/dom/builder/builder.ts:226

insertAfter

insertAfter(...targets): HTMLElementBuilder<T>
Parameters
- Rest ...targets: (Element | IBuilder)[]
Returns HTMLElementBuilder<T>
Inherited from Builder.insertAfter
- Defined in src/dom/builder/builder.ts:170

insertBefore

insertBefore(...targets): HTMLElementBuilder<T>
Parameters
- Rest ...targets: (Element | IBuilder)[]
Returns HTMLElementBuilder<T>
Inherited from Builder.insertBefore
- Defined in src/dom/builder/builder.ts:159

prepend

prepend(...children): HTMLElementBuilder<T>
Parameters
- Rest ...children: IElementChild[]
Returns HTMLElementBuilder<T>
Inherited from Builder.prepend
- Defined in src/dom/builder/builder.ts:73

prependTo

prependTo(...targets): HTMLElementBuilder<T>
Parameters
- Rest ...targets: (Element | IBuilder)[]
Returns HTMLElementBuilder<T>
Inherited from Builder.prependTo
- Defined in src/dom/builder/builder.ts:150

render

render(indent?): string
Parameters
- indent: number = 0
Returns string
Inherited from Builder.render
- Defined in src/dom/builder/builder.ts:101

replace

replace(...targets): HTMLElementBuilder<T>
Parameters
- Rest ...targets: (Element | IBuilder)[]
Returns HTMLElementBuilder<T>
Inherited from Builder.replace
- Defined in src/dom/builder/builder.ts:181

replaceChildren

replaceChildren(...children): HTMLElementBuilder<T>
Parameters
- Rest ...children: IElementChild[]
Returns HTMLElementBuilder<T>
Inherited from Builder.replaceChildren
- Defined in src/dom/builder/builder.ts:87

replaceComponents

replaceComponents(...components): HTMLElementBuilder<T>
Parameters
- Rest ...components: IComponent[]
Returns HTMLElementBuilder<T>
Inherited from Builder.replaceComponents
- Defined in src/dom/builder/builder.ts:96

set

set(attrs): HTMLElementBuilder<T>
Parameters
- attrs: {
  [key: string]: any;
  }
  - [key: string]: any
Returns HTMLElementBuilder<T>
Inherited from Builder.set
- Defined in src/dom/builder/builder.ts:60

setNs

setNs(namespace, attrs): HTMLElementBuilder<T>
Parameters
- namespace: string
- attrs: {
  [key: string]: any;
  }
  - [key: string]: any
Returns HTMLElementBuilder<T>
Inherited from Builder.setNs
- Defined in src/dom/builder/builder.ts:64

setup

setup(element): HTMLElementTagNameMap[T]
Parameters
- element: HTMLElementTagNameMap[T]
Returns HTMLElementTagNameMap[T]
Inherited from Builder.setup
- Defined in src/dom/builder/builder.ts:116

Class HTMLElementBuilder<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns HTMLElementBuilder<T>

Properties

attrs

children

components

nsAttrs

Optional parents

props

tag

Methods

append

Parameters

Returns HTMLElementBuilder<T>

appendTo

Parameters

Returns HTMLElementBuilder<T>

apply

Parameters

Returns HTMLElementBuilder<T>

assign

Parameters

Returns HTMLElementBuilder<T>

build

Returns HTMLElementTagNameMap[T]

create

Returns HTMLElementTagNameMap[T]

insertAfter

Parameters

Returns HTMLElementBuilder<T>

insertBefore

Parameters

Returns HTMLElementBuilder<T>

prepend

Parameters

Returns HTMLElementBuilder<T>

prependTo

Parameters

Returns HTMLElementBuilder<T>

render

Parameters

Returns string

replace

Parameters

Returns HTMLElementBuilder<T>

replaceChildren

Parameters

Returns HTMLElementBuilder<T>

replaceComponents

Parameters

Returns HTMLElementBuilder<T>

set

Parameters

[key: string]: any

Returns HTMLElementBuilder<T>

setNs

Parameters

[key: string]: any

Returns HTMLElementBuilder<T>

setup

Parameters

Returns HTMLElementTagNameMap[T]

Settings

Member Visibility

Theme

On This Page

`Optional` parents