- ATagAttrs
- ATag
- BrTag
- CardTagAttrs
- CardTag
- CardActionTagAttrs
- CardActionTag
- CardActionsTag
- CardAvatarTagAttrs
- CardAvatarTag
- CardContentTagAttrs
- CardContentTag
- CardHeaderTagAttrs
- CardHeaderTag
- CardMediaTagAttrs
- CardMediaTag
- FooterTag
- FormTagAttrs
- FormTag
- HeaderTag
- ImgTagAttrs
- ImgTag
- InputTagAttrs
- InputTag
- LiTagAttrs
- LiTag
- LoginTagAttrs
- LoginTag
- LogoutTagAttrs
- LogoutTag
- PTag
- SectionTagAttrs
- SectionTag
- SnackbarTagAttrs
- SnackbarTag
- Tag
- TextareaTag
- UlTag
- VideoTagAttrs
- VideoTag
- ATag ⇐
Tag
- BrTag ⇐
Tag
- CardTag ⇐
Tag
- CardActionTag ⇐
Tag
- CardActionsTag ⇐
Tag
- CardAvatarTag ⇐
Tag
- CardContentTag ⇐
Tag
- CardHeaderTag ⇐
Tag
- CardMediaTag ⇐
Tag
- FooterTag ⇐
Tag
- FormTag ⇐
Tag
- HeaderTag ⇐
Tag
- ImgTag ⇐
Tag
- InputTag ⇐
Tag
- LabelTag ⇐
Tag
- LiTag ⇐
Tag
- LoginTag ⇐
Tag
- LogoutTag ⇐
Tag
- PTag ⇐
Tag
- SectionTag ⇐
Tag
- SnackbarTag ⇐
Tag
- Tag
- TextareaTag ⇐
Tag
- UlTag ⇐
Tag
- VideoTag ⇐
Tag
Param | Type | Description |
---|---|---|
href | string |
|
method | 'GET' | 'POST' |
default 'GET' |
Kind: global class
Param | Type |
---|---|
children | Array.<string> |
attrs | ATagAttrs |
Kind: static method of ATag
Param | Type |
---|---|
node | HTMLAnchorElement |
Param | Type | Default | Description |
---|---|---|---|
[action] | string |
Optional path to call when the card is selected | |
[method] | string |
""GET"" |
Optional method associated with the action |
Kind: global class
Properties
Name | Type |
---|---|
children | Array.<(CardHeaderTag|CardMediaTag|CardContentTag|CardActionsTag)> |
Param | Type |
---|---|
attrs | CardTagAttrs |
CardTag.getAttributes(node) ⇒ CardTagAttrs
Kind: static method of CardTag
Param | Type |
---|---|
node | HTMLElement |
Param | Type | Description |
---|---|---|
name | string |
name of the card action button |
path | string |
path for the callback when the card action is selected |
method | string |
to use for the callback |
Kind: global class
Param | Type |
---|---|
children | undefined |
attrs | CardActionTagAttrs |
CardActionTag.getAttributes(node) ⇒ CardActionTagAttrs
Kind: static method of CardActionTag
Param | Type |
---|---|
node | HTMLElement |
Param | Type |
---|---|
children | Array.<CardActionTag> |
Param | Type | Description |
---|---|---|
[src] | string |
public url of the avatar png image |
[name] | string |
name of the avatar |
Kind: global class
Param | Type |
---|---|
children | undefined |
attrs | CardAvatarTagAttrs |
CardAvatarTag.getAttributes(node) ⇒ CardAvatarTagAttrs
Kind: static method of CardAvatarTag
Param | Type |
---|---|
node | HTMLElement |
Param | Type | Description |
---|---|---|
[title] | string |
title of the card |
[subtitle] | string |
subtitle of the card |
[content] | string |
text content to be displayed |
Kind: global class
Param | Type |
---|---|
children | undefined |
attrs | CardContentTagAttrs |
CardContentTag.getAttributes(node) ⇒ CardContentTagAttrs
Kind: static method of CardContentTag
Param | Type |
---|---|
node | HTMLElement |
Param | Type | Description |
---|---|---|
title | string |
Title text |
[subtitle] | string |
Optional subtitle text |
Kind: global class
Properties
Name | Type |
---|---|
[children] | Array.<CardAvatarTag> |
Param | Type |
---|---|
attrs | CardHeaderTagAttrs |
CardHeaderTag.getAttributes(node) ⇒ CardHeaderTagAttrs
Kind: static method of CardHeaderTag
Param | Type |
---|---|
node | HTMLElement |
Param | Type | Description |
---|---|---|
[src] | string |
public url of the avatar png image |
[avatarName] | string |
name of the avatar |
Kind: global class
Param | Type |
---|---|
children | undefined |
attrs | CardMediaTagAttrs |
CardMediaTag.getAttributes(node) ⇒ CardMediaTagAttrs
Kind: static method of CardMediaTag
Param | Type |
---|---|
node | HTMLElement |
Instantiates a new FooterTag
Param | Type |
---|---|
children | Array.<string> |
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 |
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 one SnackbarTag child followed by multiple SectionTag children and each SectionTag deals with one piece of data from the user.Param | Type |
---|---|
children | Array.<SectionTag> |
attrs | FormTagAttrs |
Instantiates a new HeaderTag
Param | Type |
---|---|
children | Array.<string> |
Param | Type |
---|---|
[src] | string |
[alt] | string |
Kind: global class
Param | Type |
---|---|
children | undefined |
attrs | InputTagAttrs |
ImgTag.getAttributes(node) ⇒ ImgTagAttrs
Kind: static method of ImgTag
Param | Type |
---|---|
node | HTMLImgElement |
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 |
Kind: global class
Param | Type |
---|---|
children | undefined |
attrs | InputTagAttrs |
InputTag.getAttributes(node) ⇒ InputTagAttrs
Kind: static method of InputTag
Param | Type |
---|---|
node | HTMLInputElement |
Param | Type |
---|---|
value | string | undefined |
textSearch | string | undefined |
Param | Type |
---|---|
children | Array.<(ATag|string)> |
attrs | LiTagAttrs |
Param | Type |
---|---|
[onSuccess] | string |
[onFailure] | string |
Kind: global class
Param | Type |
---|---|
children | undefined |
attrs | LoginTagAttrs |
LoginTag.getAttributes(node) ⇒ LoginTagAttrs
Kind: static method of LoginTag
Param | Type |
---|---|
node | HTMLElement |
Param | Type |
---|---|
[onSuccess] | string |
[onFailure] | string |
Kind: global class
Param | Type |
---|---|
children | undefined |
attrs | LogoutTagAttrs |
LogoutTag.getAttributes(node) ⇒ LogoutTagAttrs
Kind: static method of LogoutTag
Param | Type |
---|---|
node | HTMLElement |
Param | Type |
---|---|
children | Array.<string> |
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 |
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|CardTag)> |
attrs | SectionTagAttrs |
Param | Type |
---|---|
[message] | string |
[severity] | string |
Kind: global class
Param | Type |
---|---|
children | undefined |
attrs | SnackbarTagAttrs |
SnackbarTag.getAttributes(node) ⇒ SnackbarTagAttrs
Kind: static method of SnackbarTag
Param | Type |
---|---|
node | HTMLElement |
Kind: global class
- Tag
- new Tag(children, attrs)
- .fromNode(node) ⇒
FormTag
|CardTag
|CardHeaderTag
|CardAvatarTag
|CardMediaTag
|CardContentTag
|CardActionsTag
|CardActionTag
|SectionTag
|SnackbarTag
|UlTag
|LiTag
|LoginTag
|LogoutTag
|ATag
|PTag
|BrTag
|HeaderTag
|FooterTag
|InputTag
|LabelTag
|TextareaTag
|ImgTag
|VideoTag
- .getAttributes(node) ⇒
Object
|undefined
Instantiates a Tag
Param | Type |
---|---|
children | Array.<Tag> | undefined |
attrs | Object | undefined |
Tag.fromNode(node) ⇒ FormTag
| CardTag
| CardHeaderTag
| CardAvatarTag
| CardMediaTag
| CardContentTag
| CardActionsTag
| CardActionTag
| SectionTag
| SnackbarTag
| UlTag
| LiTag
| LoginTag
| LogoutTag
| ATag
| PTag
| BrTag
| HeaderTag
| FooterTag
| InputTag
| LabelTag
| TextareaTag
| ImgTag
| VideoTag
Kind: static method of Tag
Param | Type |
---|---|
node | HTMLElement |
Returns the attributes specific to a certain tag
Kind: static method of Tag
Param | Type |
---|---|
node | HTMLElement |
Param | Type |
---|---|
children | Array.<string> |
Param | Type |
---|---|
children | Array.<LiTag> |
Param | Type |
---|---|
[src] | string |
[alt] | string |
Kind: global class
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 |
Param | Type |
---|---|
children | Array.<string> |
attrs | ATagAttrs |
Kind: static method of ATag
Param | Type |
---|---|
node | HTMLAnchorElement |
BrTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | undefined |
attrs | undefined |
CardTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | Array.<(CardHeaderTag|CardMediaTag|CardContentTag|CardActionsTag)> |
attrs | CardTagAttrs |
Param | Type |
---|---|
attrs | CardTagAttrs |
CardTag.getAttributes(node) ⇒ CardTagAttrs
Kind: static method of CardTag
Param | Type |
---|---|
node | HTMLElement |
CardActionTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | undefined |
attrs | CardActionTagAttrs |
Param | Type |
---|---|
children | undefined |
attrs | CardActionTagAttrs |
CardActionTag.getAttributes(node) ⇒ CardActionTagAttrs
Kind: static method of CardActionTag
Param | Type |
---|---|
node | HTMLElement |
CardActionsTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | Array.<CardActionTag> |
attrs | undefined |
Param | Type |
---|---|
children | Array.<CardActionTag> |
CardAvatarTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | undefined |
attrs | CardAvatarTagAttrs |
Param | Type |
---|---|
children | undefined |
attrs | CardAvatarTagAttrs |
CardAvatarTag.getAttributes(node) ⇒ CardAvatarTagAttrs
Kind: static method of CardAvatarTag
Param | Type |
---|---|
node | HTMLElement |
CardContentTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | undefined |
attrs | CardContentTagAttrs |
Param | Type |
---|---|
children | undefined |
attrs | CardContentTagAttrs |
CardContentTag.getAttributes(node) ⇒ CardContentTagAttrs
Kind: static method of CardContentTag
Param | Type |
---|---|
node | HTMLElement |
CardHeaderTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
[children] | Array.<CardAvatarTag> |
attrs | CardHeaderTagAttrs |
Param | Type |
---|---|
attrs | CardHeaderTagAttrs |
CardHeaderTag.getAttributes(node) ⇒ CardHeaderTagAttrs
Kind: static method of CardHeaderTag
Param | Type |
---|---|
node | HTMLElement |
CardMediaTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | undefined |
attrs | CardMediaTagAttrs |
Param | Type |
---|---|
children | undefined |
attrs | CardMediaTagAttrs |
CardMediaTag.getAttributes(node) ⇒ CardMediaTagAttrs
Kind: static method of CardMediaTag
Param | Type |
---|---|
node | HTMLElement |
FooterTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | Array.<string> |
attrs | undefined |
Instantiates a new FooterTag
Param | Type |
---|---|
children | Array.<string> |
FormTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | Array.<SectionTag> |
attrs | FormTagAttrs |
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 one SnackbarTag child followed by multiple 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 |
Instantiates a new HeaderTag
Param | Type |
---|---|
children | Array.<string> |
ImgTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | undefined |
attrs | InputTagAttrs |
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 |
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 |
Param | Type |
---|---|
children | Array.<(ATag|string)> |
attrs | LiTagAttrs |
LoginTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | undefined |
attrs | LoginTagAttrs |
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 |
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 |
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 |
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|CardTag)> |
attrs | SectionTagAttrs |
SnackbarTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | undefined |
attrs | SnackbarTagAttrs |
Param | Type |
---|---|
children | undefined |
attrs | SnackbarTagAttrs |
SnackbarTag.getAttributes(node) ⇒ SnackbarTagAttrs
Kind: static method of SnackbarTag
Param | Type |
---|---|
node | HTMLElement |
Kind: global typedef
Properties
Name | Type |
---|---|
children | Array.<Tag> | undefined |
attrs | Object | undefined |
tagName | string |
- Tag
- new Tag(children, attrs)
- .fromNode(node) ⇒
FormTag
|CardTag
|CardHeaderTag
|CardAvatarTag
|CardMediaTag
|CardContentTag
|CardActionsTag
|CardActionTag
|SectionTag
|SnackbarTag
|UlTag
|LiTag
|LoginTag
|LogoutTag
|ATag
|PTag
|BrTag
|HeaderTag
|FooterTag
|InputTag
|LabelTag
|TextareaTag
|ImgTag
|VideoTag
- .getAttributes(node) ⇒
Object
|undefined
Instantiates a Tag
Param | Type |
---|---|
children | Array.<Tag> | undefined |
attrs | Object | undefined |
Tag.fromNode(node) ⇒ FormTag
| CardTag
| CardHeaderTag
| CardAvatarTag
| CardMediaTag
| CardContentTag
| CardActionsTag
| CardActionTag
| SectionTag
| SnackbarTag
| UlTag
| LiTag
| LoginTag
| LogoutTag
| ATag
| PTag
| BrTag
| HeaderTag
| FooterTag
| InputTag
| LabelTag
| TextareaTag
| ImgTag
| VideoTag
Kind: static method of Tag
Param | Type |
---|---|
node | HTMLElement |
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 |
Param | Type |
---|---|
children | Array.<string> |
UlTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | Array.<LiTag> |
attrs | undefined |
Param | Type |
---|---|
children | Array.<LiTag> |
VideoTag ⇐ Tag
Kind: global typedef
Extends: Tag
Properties
Name | Type |
---|---|
children | undefined |
attrs | InputTagAttrs |
Param | Type |
---|---|
children | undefined |
attrs | InputTagAttrs |
VideoTag.getAttributes(node) ⇒ VideoTagAttrs
Kind: static method of VideoTag
Param | Type |
---|---|
node | HTMLVideoElement |