Global

Members

(constant) tagClsMap :Object

Source:

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
Source:

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

Source:

Type Definitions

ATag

Properties:
Name Type Description
children Array.<string>
attrs ATagAttrs
Source:

BrTag

Properties:
Name Type Description
children undefined
attrs undefined
Source:

FooterTag

Properties:
Name Type Description
children Array.<string>
attrs undefined
Source:

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

Source:

FormItemContent :object

Properties:
Name Type Description
type 'string' | 'date' | 'datetime'
name string
description string
header string | undefined
footer string | undefined
Source:

FormItemMenu :Object

Properties:
Name Type Description
type 'form-menu'
body Array.<FormItemMenuItem>
name string
header string | undefined
footer string | undefined
meta FormItemMenuMeta | undefined
Source:

FormItemMenuItem :object

Properties:
Name Type Description
type 'option' | 'content'
description string
value string | undefined
Source:

FormItemMenuMeta :Object

Properties:
Name Type Description
autoSelect boolean
multiSelect boolean
numbered boolean
Source:

FormMeta :object

Properties:
Name Type Description
completionStatusShow boolean | undefined
completionStatusInHeader boolean | undefined
confirmationNeeded boolean | undefined
Source:

FormTag

Properties:
Name Type Description
children Array.<SectionTag>
attrs FormTagAttrs
Source:

HeaderTag

Properties:
Name Type Description
children Array.<string>
attrs undefined
Source:

InputTag

Properties:
Name Type Description
children undefined
attrs InputTagAttrs
Source:

LabelTag

Properties:
Name Type Description
children Array.<string>
attrs undefined
Source:

LiTag

Properties:
Name Type Description
children Array.<(ATag|string)>
attrs LiTagAttrs
Source:
Properties:
Name Type Description
type 'menu'
body Array.<MenuItem>
header string | undefined
footer string | undefined
meta MenuMeta | undefined
Source:
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

Source:
Properties:
Name Type Description
autoSelect boolean
Source:

PTag

Properties:
Name Type Description
children Array.<string>
attrs undefined
Source:

Response :Object

Properties:
Name Type Description
contentType 'form' | 'menu'
content Form | Menu
Source:

SectionTag

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

Tag

Properties:
Name Type Description
children Array.<Tag> | undefined
attrs Object | undefined
tagName string
Source:

UlTag

Properties:
Name Type Description
children Array.<LiTag>
attrs undefined
Source: