Classes

ATagAttrs
ATag
BrTag
FooterTag
FormTagAttrs
FormTag
HeaderTag
ImgTagAttrs
ImgTag
InputTagAttrs
InputTag
LiTagAttrs
LiTag
LoginTagAttrs
LoginTag
LogoutTagAttrs
LogoutTag
PTag
SectionTagAttrs
SectionTag
Tag
TextareaTag
UlTag
VideoTagAttrs
VideoTag

Typedefs

ATag ⇐ Tag
BrTag ⇐ Tag
FooterTag ⇐ Tag
FormTag ⇐ Tag
HeaderTag ⇐ Tag
ImgTag ⇐ Tag
InputTag ⇐ Tag
LabelTag ⇐ Tag
LiTag ⇐ Tag
LoginTag ⇐ Tag
LogoutTag ⇐ Tag
PTag ⇐ Tag
SectionTag ⇐ Tag
Tag
TextareaTag ⇐ Tag
UlTag ⇐ Tag
VideoTag ⇐ 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, skipConfirmation)

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)
skipConfirmation boolean | undefined whether the additional confirmation step at the end of the form will be skipped

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>

ImgTagAttrs

Kind: global class

new ImgTagAttrs([src], [alt])

Param Type
[src] string
[alt] string

ImgTag

Kind: global class

new ImgTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

ImgTag.getAttributes(node) ⇒ ImgTagAttrs

Kind: static method of ImgTag

Param Type
node HTMLImgElement

InputTagAttrs

Kind: global class

new InputTagAttrs(type, [min], [minError], [minlength must be an integer], [minlengthError], [max], [maxError], [maxlength must be an integer], [maxlengthError], [step], [value], [pattern])

Param Type Description
type 'date' | 'datetime' | 'email' | 'hidden' | 'location' | 'number' | 'phone' | 'range' | 'tel' | 'text' | 'textarea' | 'url'
[min] number
[minError] string
[minlength must be an integer] number
[minlengthError] string
[max] number
[maxError] string
[maxlength must be an integer] number
[maxlengthError] string
[step] number
[value] string required if type="hidden"
[pattern] string

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, textSearch)

Param Type
value string | undefined
textSearch string | undefined

LiTag

Kind: global class

new LiTag(children, attrs)

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

LoginTagAttrs

Kind: global class

new LoginTagAttrs([onSuccess], [onFailure])

Param Type
[onSuccess] string
[onFailure] string

LoginTag

Kind: global class

new LoginTag(children, attrs)

Param Type
children undefined
attrs LoginTagAttrs

LoginTag.getAttributes(node) ⇒ LoginTagAttrs

Kind: static method of LoginTag

Param Type
node HTMLElement

LogoutTagAttrs

Kind: global class

new LogoutTagAttrs([onSuccess], [onFailure])

Param Type
[onSuccess] string
[onFailure] string

LogoutTag

Kind: global class

new LogoutTag(children, attrs)

Param Type
children undefined
attrs LogoutTagAttrs

LogoutTag.getAttributes(node) ⇒ LogoutTagAttrs

Kind: static method of LogoutTag

Param Type
node HTMLElement

PTag

Kind: global class

new PTag(children)

Param Type
children Array.<string>

SectionTagAttrs

Kind: global class

new SectionTagAttrs([props])

Instantiates a new SectionTagAttrs

Param Type Default Description
[props] object
[props.name] string this attribute is relevant only if the SectionTag is part of a FormTag
[props.header] string text that will be included in header
[props.footer] string text that will be included in footer
[props.autoSelect] boolean false
[props.multiSelect] boolean false
[props.numbered] boolean false
[props.chunkingFooter] string
[props.confirmationLabel] string
[props.method] string
[props.required] boolean false
[props.default] string
[props.statusExclude] boolean false
[props.statusPrepend] boolean false
[props.url] string
[props.validateTypeError] string
[props.validateTypeErrorFooter] string
[props.validateUrl] string

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|LoginTag|LogoutTag|HeaderTag|FooterTag|TextareaTag|InputTag|ImgTag|VideoTag)>
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 | LoginTag | LogoutTag | ATag | PTag | BrTag | HeaderTag | FooterTag | InputTag | LabelTag | TextareaTag | ImgTag | VideoTag

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

TextareaTag

Kind: global class

new TextareaTag(children)

Param Type
children Array.<string>

UlTag

Kind: global class

new UlTag(children)

Param Type
children Array.<LiTag>

VideoTagAttrs

Kind: global class

new VideoTagAttrs([src], [alt])

Param Type
[src] string
[alt] string

VideoTag

Kind: global class

new VideoTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

VideoTag.getAttributes(node) ⇒ VideoTagAttrs

Kind: static method of VideoTag

Param Type
node HTMLVideoElement

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>

ImgTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs InputTagAttrs

new ImgTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

ImgTag.getAttributes(node) ⇒ ImgTagAttrs

Kind: static method of ImgTag

Param Type
node HTMLImgElement

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

LoginTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs LoginTagAttrs

new LoginTag(children, attrs)

Param Type
children undefined
attrs LoginTagAttrs

LoginTag.getAttributes(node) ⇒ LoginTagAttrs

Kind: static method of LoginTag

Param Type
node HTMLElement

LogoutTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs LogoutTagAttrs

new LogoutTag(children, attrs)

Param Type
children undefined
attrs LogoutTagAttrs

LogoutTag.getAttributes(node) ⇒ LogoutTagAttrs

Kind: static method of LogoutTag

Param Type
node HTMLElement

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|TextareaTag|LabelTag|LoginTag|LogoutTag|ImgTag|VideoTag)>
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|LoginTag|LogoutTag|HeaderTag|FooterTag|TextareaTag|InputTag|ImgTag|VideoTag)>
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 | LoginTag | LogoutTag | ATag | PTag | BrTag | HeaderTag | FooterTag | InputTag | LabelTag | TextareaTag | ImgTag | VideoTag

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

TextareaTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<string>
attrs undefined

new TextareaTag(children)

Param Type
children Array.<string>

UlTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children Array.<LiTag>
attrs undefined

new UlTag(children)

Param Type
children Array.<LiTag>

VideoTag ⇐ Tag

Kind: global typedef
Extends: Tag
Properties

Name Type
children undefined
attrs InputTagAttrs

new VideoTag(children, attrs)

Param Type
children undefined
attrs InputTagAttrs

VideoTag.getAttributes(node) ⇒ VideoTagAttrs

Kind: static method of VideoTag

Param Type
node HTMLVideoElement