Members
(constant) tagClsMap :Object
Methods
loadHtml(htmlFile, htmlText) → {FormTag|SectionTag|UlTag|LiTag|ATag|PTag|*}
Turns a HTML content (from file or from variable) to a Tag object
Parameters:
Name | Type | Description |
---|---|---|
htmlFile |
string | undefined | |
htmlText |
string | undefined |
loadTemplate(templateFile, data) → {FormTag|SectionTag|UlTag|LiTag|ATag|PTag|*}
Turns a template file to a Tag object
Parameters:
Name | Type | Description |
---|---|---|
templateFile |
string |
The name of the template file |
data |
object |
The data to fill the template with |
Type Definitions
ATag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<string> | |
attrs |
ATagAttrs |
BrTag
Properties:
Name | Type | Description |
---|---|---|
children |
undefined | |
attrs |
undefined |
FooterTag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<string> | |
attrs |
undefined |
Form :object
Properties:
Name | Type | Description |
---|---|---|
type |
'form' | |
header |
string | undefined |
header value |
footer |
string | undefined |
footer value |
meta |
FormMeta | |
method |
'get' | 'post' | 'put' | 'delete' | |
path |
string | |
body |
FormItemContent | FormItemMenu |
form body object |
FormItemContent :object
Properties:
Name | Type | Description |
---|---|---|
type |
'string' | 'date' | 'datetime' | |
name |
string | |
description |
string | |
header |
string | undefined | |
footer |
string | undefined |
FormItemMenu :Object
Properties:
Name | Type | Description |
---|---|---|
type |
'form-menu' | |
body |
Array.<FormItemMenuItem> | |
name |
string | |
header |
string | undefined | |
footer |
string | undefined | |
meta |
FormItemMenuMeta | undefined |
FormItemMenuItem :object
Properties:
Name | Type | Description |
---|---|---|
type |
'option' | 'content' | |
description |
string | |
value |
string | undefined |
FormItemMenuMeta :Object
Properties:
Name | Type | Description |
---|---|---|
autoSelect |
boolean | |
multiSelect |
boolean | |
numbered |
boolean |
FormMeta :object
Properties:
Name | Type | Description |
---|---|---|
completionStatusShow |
boolean | undefined | |
completionStatusInHeader |
boolean | undefined | |
confirmationNeeded |
boolean | undefined |
FormTag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<SectionTag> | |
attrs |
FormTagAttrs |
HeaderTag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<string> | |
attrs |
undefined |
InputTag
Properties:
Name | Type | Description |
---|---|---|
children |
undefined | |
attrs |
InputTagAttrs |
LabelTag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<string> | |
attrs |
undefined |
LiTag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<(ATag|string)> | |
attrs |
LiTagAttrs |
Menu :Object
Properties:
Name | Type | Description |
---|---|---|
type |
'menu' | |
body |
Array.<MenuItem> | |
header |
string | undefined | |
footer |
string | undefined | |
meta |
MenuMeta | undefined |
MenuItem :object
Properties:
Name | Type | Default | Description |
---|---|---|---|
type |
'option' | 'content' |
indicating menu option or plain content |
|
description |
string | ||
path |
string | undefined |
For menu options only. Path to be used for HTTP callback (added to base path configured in app's settings in developer portal) |
|
method |
'get' | 'post' | 'put' | 'delete' | undefined | get |
For menu options only. HTTP method that should be used when redirecting after successful menu option submission |
MenuMeta :Object
Properties:
Name | Type | Description |
---|---|---|
autoSelect |
boolean |
PTag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<string> | |
attrs |
undefined |
Response :Object
Properties:
Name | Type | Description |
---|---|---|
contentType |
'form' | 'menu' | |
content |
Form | Menu |
SectionTag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<(HeaderTag|FooterTag|UlTag|PTag|BrTag|InputTag|LabelTag)> | |
attrs |
SectionTagAttrs |
Tag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<Tag> | undefined | |
attrs |
Object | undefined | |
tagName |
string |
UlTag
Properties:
Name | Type | Description |
---|---|---|
children |
Array.<LiTag> | |
attrs |
undefined |