Class HtmlTagBase<AttrsType, ElementType>`Abstract`

Base class for all HTML tags, parameterized on their attribute types.

Type Parameters

AttrsType extends Attrs
ElementType extends HTMLElement

Hierarchy

Tag<AttrsType, ElementType>
- HtmlTagBase
  - AnchorTag
  - AreaTag
  - BRTag
  - BaseTag
  - BodyTag
  - ButtonTag
  - CanvasTag
  - DListTag
  - DataTag
  - DataListTag
  - DetailsTag
  - DivTag
  - html.DefaultTag
  - EmbedTag
  - FieldSetTag
  - FormTag
  - FrameSetTag
  - HRTag
  - HeadTag
  - HeadingTag
  - HtmlTag
  - IFrameTag
  - html.ImageTag
  - InputTag
  - LITag
  - LabelTag
  - LegendTag
  - LinkTag
  - MapTag
  - MediaTag
  - MenuTag
  - MetaTag
  - MeterTag
  - ModTag
  - OListTag
  - ObjectTag
  - OptGroupTag
  - OptionTag
  - OutputTag
  - ParagraphTag
  - ParamTag
  - PictureTag
  - PreTag
  - ProgressTag
  - QuoteTag
  - html.ScriptTag
  - SelectTag
  - SlotTag
  - SourceTag
  - SpanTag
  - html.StyleTag
  - TableCaptionTag
  - TableCellTag
  - TableColTag
  - TableTag
  - TableRowTag
  - TableSectionTag
  - TemplateTag
  - TextAreaTag
  - TimeTag
  - html.TitleTag
  - TrackTag
  - UListTag
  - UnknownTag

Index

Methods

build buildDataAttrs buildInner class createElement css data id sanitizeDataKey sel text

Methods

build

build(output: string[]): void
Builds the resulting HTML by appending lines to the output array.
Parameters
- output: string[]
  
  A string array on which to append the output
Returns void
Inherited from Tag.build
- Defined in src/tags.ts:243

`Protected` buildDataAttrs

buildDataAttrs(builder: string[], data: DataAttrs, prefix?: string): void
Recursively constructs data attributes into key/value strings. Nested keys are joined with dashes.
Parameters
- builder: string[]
  
  An array of strings on which to append the attributes
- data: DataAttrs
  
  The data attributes object
- prefix: string = 'data-'
  
  A prefix for each attribute name
Returns void
Inherited from Tag.buildDataAttrs
- Defined in src/tags.ts:227

buildInner

buildInner(output: string[]): void
Appends the children
Parameters
- output: string[]
  
  a string array on which to append the output
Returns void
Inherited from Tag.buildInner
- Defined in src/tags.ts:277

class

class(...s: string[]): HtmlTagBase<AttrsType, ElementType>
Assigns a single class to the element.

Returns
this
Parameters
- Rest ...s: string[]
  
  A single class name
Returns HtmlTagBase<AttrsType, ElementType>
Inherited from Tag.class
- Defined in src/tags.ts:105

createElement

createElement(): ElementType
Returns
an actual ElementType generated for this tag, in the current document.

Returns ElementType
- Defined in src/html.ts:52

css

css(s: Partial<CSSStyleDeclaration>): HtmlTagBase<AttrsType, ElementType>
Apply an inline style using the +style+ attribute.

Returns
this
Parameters
- s: Partial<CSSStyleDeclaration>
  
  An inline style to apply to the element
Returns HtmlTagBase<AttrsType, ElementType>
Inherited from Tag.css
- Defined in src/tags.ts:125

data

data(d: DataAttrs): HtmlTagBase<AttrsType, ElementType>
Assign raw data- attributes to the element.

Returns
this
Parameters
- d: DataAttrs
  
  Some raw data attributes
Returns HtmlTagBase<AttrsType, ElementType>
Inherited from Tag.data
- Defined in src/tags.ts:140

id

id(s: string): HtmlTagBase<AttrsType, ElementType>
Assigns the element's id attribute.

Returns
this
Parameters
- s: string
  
  an id
Returns HtmlTagBase<AttrsType, ElementType>
Inherited from Tag.id
- Defined in src/tags.ts:115

`Protected` sanitizeDataKey

sanitizeDataKey(k: string): string
Sanitizes the given data-attribute key based on the rules described here: https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset#:~:text=Using%20data%20attributes.-,Name%20conversion,-dash%2Dstyle%20to
Parameters
- k: string
  
  a data-attribute key
Returns string
Inherited from Tag.sanitizeDataKey
- Defined in src/tags.ts:216

sel

sel(selector: string): HtmlTagBase<AttrsType, ElementType>
Assigns one or more classes and/or an id to the element.

Returns
this
Parameters
- selector: string
Returns HtmlTagBase<AttrsType, ElementType>
Inherited from Tag.sel
- Defined in src/tags.ts:80

text

text(s: string): HtmlTagBase<AttrsType, ElementType>
Set the inner text content of the element.

Returns
this
Parameters
- s: string
  
  The inner text of the element
Returns HtmlTagBase<AttrsType, ElementType>
- Defined in src/html.ts:84

Class HtmlTagBase<AttrsType, ElementType>Abstract

Type Parameters

AttrsType extends Attrs

ElementType extends HTMLElement

Hierarchy

Index

Methods

Methods

build

Parameters

output: string[]

Returns void

Protected buildDataAttrs

Parameters

builder: string[]

data: DataAttrs

prefix: string = 'data-'

Returns void

buildInner

Parameters

output: string[]

Returns void

class

Returns

Parameters

Rest ...s: string[]

Returns HtmlTagBase<AttrsType, ElementType>

createElement

Returns

Returns ElementType

css

Returns

Parameters

s: Partial<CSSStyleDeclaration>

Returns HtmlTagBase<AttrsType, ElementType>

data

Returns

Parameters

d: DataAttrs

Returns HtmlTagBase<AttrsType, ElementType>

id

Returns

Parameters

s: string

Returns HtmlTagBase<AttrsType, ElementType>

Protected sanitizeDataKey

Parameters

k: string

Returns string

sel

Returns

Parameters

selector: string

Returns HtmlTagBase<AttrsType, ElementType>

text

Returns

Parameters

s: string

Returns HtmlTagBase<AttrsType, ElementType>

Settings

Member Visibility

Theme

Class HtmlTagBase<AttrsType, ElementType>`Abstract`

`Protected` buildDataAttrs

`Rest` ...s: string[]

`Protected` sanitizeDataKey