Classes

ATagAttrs
ATag
BrTag
FooterTag
FormTagAttrs
FormTag
HeaderTag
InputTagAttrs
InputTag
LiTagAttrs
LiTag
PTag
SectionTagAttrs
SectionTag
Tag
UlTag

Typedefs

ATag ⇐ Tag
BrTag ⇐ Tag
FooterTag ⇐ Tag
FormTag ⇐ Tag
HeaderTag ⇐ Tag
InputTag ⇐ Tag
LabelTag ⇐ Tag
LiTag ⇐ Tag
PTag ⇐ Tag
SectionTag ⇐ Tag
Tag
UlTag ⇐ Tag

ATagAttrs

Kind: global class

new ATagAttrs(href, method)

Param Type Description
href string
method 'GET' | 'POST' default 'GET'

ATag

Kind: global class

new ATag(children, attrs)

Param Type
children Array.<string>
attrs ATagAttrs

ATag.getAttributes(node)

Kind: static method of ATag

Param Type
node HTMLAnchorElement

BrTag

Kind: global class

FooterTag

Kind: global class

new FooterTag(children)

Instantiates a new FooterTag

Param Type
children Array.<string>

FormTagAttrs

Kind: global class

new FormTagAttrs(action, method, header, footer, completionStatusShow, completionStatusInHeader, confirmationNeeded)

Instantiates a new FormTagAttrs

Param Type Description
action string the path where the form data is sent to after the user finishes the form
method string the method use to send the form data
header string | undefined the global form header which can be overwritten at the SectionTag level
footer string | undefined the global form footer which can be overwritten at the SectionTag level
completionStatusShow boolean | undefined whether to display the progress the user made in a form
completionStatusInHeader boolean | undefined whether to display that progress in header (if false it will be displayed in body)
confirmationNeeded boolean | undefined whether the user will receive a form confirmation at the end of the form

FormTag

Kind: global class

new FormTag(children, attrs)

Instantiates a new FormTag. It is the equivalent of the HTML

tag and it is always the root (it cannot be placed inside of another tag). The FormTag is be used in all the situations where some data is expected from the user. The FormTag can have only SectionTag children and each SectionTag deals with one piece of data from the user.

Param Type
children Array.<SectionTag>
attrs FormTagAttrs

HeaderTag

Kind: global class

new HeaderTag(children)

Instantiates a new HeaderTag

Param Type
children Array.<string>

InputTagAttrs

Kind: global class

new InputTagAttrs(type)

Param Type
type 'text' | 'date' | 'datetime'

InputTag

Kind: global class

new InputTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

InputTag.getAttributes(node) ⇒ InputTagAttrs

Kind: static method of InputTag

Param Type
node HTMLInputElement

LiTagAttrs

Kind: global class

new LiTagAttrs(value)

Param Type
value string | undefined

LiTag

Kind: global class

new LiTag(children, attrs)

Param Type
children Array.<(ATag|string)>
attrs LiTagAttrs

PTag

Kind: global class

new PTag(children)

Param Type
children Array.<string>

SectionTagAttrs

Kind: global class

new SectionTagAttrs(name, header, footer, autoSelect, multiSelect, numbered)

Instantiates a new SectionTagAttrs

Param Type Description
name string | undefined this attribute is relevant only if the SectionTag is part of a FormTag
header string | undefined text that will be included in header
footer string | undefined text that will be included in footer
autoSelect boolean | undefined
multiSelect boolean | undefined
numbered boolean | undefined

SectionTag

Kind: global class

new SectionTag(children, attrs)

Instantiates a new SectionTag. A SectionTag may represent a step in a form, a menu or a block of text. A user will always receive the content of a SectionTag at a time.

Param Type
children Array.<(PTag|BrTag|UlTag|LabelTag|HeaderTag|FooterTag|InputTag)>
attrs SectionTagAttrs

Tag

Kind: global class

new Tag(children, attrs)

Instantiates a Tag

Param Type
children Array.<Tag> | undefined
attrs Object | undefined

Tag.fromNode(node) ⇒ FormTag | SectionTag | UlTag | LiTag | ATag | PTag | BrTag | HeaderTag | FooterTag | InputTag | LabelTag

Kind: static method of Tag

Param Type
node HTMLElement

Tag.getAttributes(node) ⇒ Object | undefined

Returns the attributes specific to a certain tag

Kind: static method of Tag

Param Type
node HTMLElement

UlTag

Kind: global class

new UlTag(children)

Param Type
children Array.<LiTag>

ATag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs ATagAttrs

new ATag(children, attrs)

Param Type
children Array.<string>
attrs ATagAttrs

ATag.getAttributes(node)

Kind: static method of ATag

Param Type
node HTMLAnchorElement

BrTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs undefined

FooterTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

new FooterTag(children)

Instantiates a new FooterTag

Param Type
children Array.<string>

FormTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<SectionTag>
attrs FormTagAttrs

new FormTag(children, attrs)

Instantiates a new FormTag. It is the equivalent of the HTML tag and it is always the root (it cannot be placed inside of another tag). The FormTag is be used in all the situations where some data is expected from the user. The FormTag can have only SectionTag children and each SectionTag deals with one piece of data from the user.

Param Type
children Array.<SectionTag>
attrs FormTagAttrs

HeaderTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

new HeaderTag(children)

Instantiates a new HeaderTag

Param Type
children Array.<string>

InputTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs InputTagAttrs

new InputTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

InputTag.getAttributes(node) ⇒ InputTagAttrs

Kind: static method of InputTag

Param Type
node HTMLInputElement

LabelTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

LiTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<(ATag|string)>
attrs LiTagAttrs

new LiTag(children, attrs)

Param Type
children Array.<(ATag|string)>
attrs LiTagAttrs

PTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

new PTag(children)

Param Type
children Array.<string>

SectionTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<(HeaderTag|FooterTag|UlTag|PTag|BrTag|InputTag|LabelTag)>
attrs SectionTagAttrs

new SectionTag(children, attrs)

Instantiates a new SectionTag. A SectionTag may represent a step in a form, a menu or a block of text. A user will always receive the content of a SectionTag at a time.

Param Type
children Array.<(PTag|BrTag|UlTag|LabelTag|HeaderTag|FooterTag|InputTag)>
attrs SectionTagAttrs

Tag

Kind: global typedef
Properties

Name Type
children Array.<Tag> | undefined
attrs Object | undefined
tagName string

new Tag(children, attrs)

Instantiates a Tag

Param Type
children Array.<Tag> | undefined
attrs Object | undefined

Tag.fromNode(node) ⇒ FormTag | SectionTag | UlTag | LiTag | ATag | PTag | BrTag | HeaderTag | FooterTag | InputTag | LabelTag

Kind: static method of Tag

Param Type
node HTMLElement

Tag.getAttributes(node) ⇒ Object | undefined

Returns the attributes specific to a certain tag

Kind: static method of Tag

Param Type
node HTMLElement

UlTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<LiTag>
attrs undefined

new UlTag(children)

Param Type
children Array.<LiTag>