lucee.Component coldbox.system.FrameworkSupertype coldbox.system.modules.HTMLHelper.models.HTMLHelper
Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- A cool utility that helps you when working with HTML so it is less verbose, more consistency, ORM data binding, auto escaping and much more.
Property Summary | ||||
---|---|---|---|---|
type | property | default | serializable | required |
any
|
settings
Module Settings.
|
true
|
false
|
Constructor Summary | |
---|---|
init(any controller)
Constructor. |
Method Summary | |
---|---|
private any
|
$htmlHead(any content)
Facade to CFML htmlHead. |
any
|
addAsset(any asset, [boolean sendToHeader='true'], [boolean async='false'], [boolean defer='false'])
Add a js/css asset(s) to the html head section. |
any
|
addJSContent(any content, [boolean sendToHeader='false'])
Generate a script tag with custom JS content. |
any
|
addStyleContent(any content, [boolean sendToHeader='false'])
Generate a style tag with custom CSS content. |
any
|
anchor(any name, [any text=''], [struct data='[runtime expression]'])
Generate anchors. |
any
|
arrayToTable(any data, [string includes=''], [string excludes=''], any buffer)
Convert a table out of an array of structs. |
any
|
audio(any src, [boolean autoplay='false'], [boolean controls='true'], [boolean loop='false'], [boolean preload='false'], [boolean noBaseURL='false'], [any name=''], [any data='[runtime expression]'])
HTML Audio Tag. |
any
|
autoDiscoveryLink([any type='RSS'], [any href], [any rel='alternate'], [any title=''], [struct data='[runtime expression]'])
Creates auto discovery links for RSS and ATOM feeds. |
private any
|
bindValue(any args)
Bind entity values. |
any
|
br([numeric count='1'])
Generate line breaks. |
any
|
button([any name=''], [any value=''], [boolean disabled='false'], [any type='button'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a button. |
any
|
canvas(any id, [any width=''], [any height=''], [any data='[runtime expression]'])
HTML Canvas Tag. |
any
|
checkbox([any name=''], [any value='true'], [boolean disabled='false'], [boolean checked='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a checkbox field. |
any
|
docType([any type='html5'])
Render a doctype by type name: xhtml11,xhtml1-strict,xhtml-trans,xthml-frame,html5,html4-strict,html4-trans,html4-frame. |
any
|
elixir(any fileName, [any buildDirectory='build'], [boolean sendToHeader='true'], [boolean async='false'], [boolean defer='false'])
Adds the versioned path for an asset to the view using ColdBox Elixir. |
any
|
elixirPath(any fileName, [any buildDirectory='build'], [boolean useModuleRoot='false'])
Adds the versioned path for an asset to the view using ColdBox Elixir. |
any
|
emailField([any name=''], [any value=''], [boolean disabled='false'], [boolean readonly='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out an email field. |
any
|
endFieldSet()
End a fieldset. |
any
|
endForm()
End a form. |
any
|
entityFields(any entity, [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any fieldwrapper=''], [struct fieldWrapperAttrs='[runtime expression]'], [struct labelAttrs='[runtime expression]'], [any labelwrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any textareas=''], [boolean booleanSelect='true'], [boolean showRelations='true'], [struct manytoone='[runtime expression]'], [struct manytomany='[runtime expression]'], [boolean inputInsideLabel='false'])
Create fields based on entity properties and relationships. |
any
|
fileField([any name=''], [any value=''], [boolean disabled='false'], [boolean readonly='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a file field. |
private any
|
flattenAttributes(struct target, [any excludes=''], any buffer)
flatten a struct of attributes to strings and returns the incoming buffer. |
private array
|
getColumnArray(any qry, any columnName)
Returns an array of values from the query and column. |
string
|
getSettings()
|
any
|
heading(any content, [numeric size='1'])
Generate headers. |
any
|
hiddenField([any name=''], [any value=''], [boolean disabled='false'], [boolean readonly='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a hidden field. |
any
|
href([any href=''], [any text=''], [any queryString=''], [any title=''], [boolean noBaseURL='false'], [struct data='[runtime expression]'])
Create href tags, using the SES base URL or not. |
any
|
imageButton(any src, [any name=''], [boolean disabled='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a image button. |
any
|
img(any src, [any alt=''], [any class=''], [any width=''], [any height=''], [any title=''], [any rel=''], [any name=''], [boolean noBaseURL='false'], [struct data='[runtime expression]'])
Create image tags using the SES base URL or not. |
any
|
inputField([any type='text'], [any name=''], [any value=''], [boolean disabled='false'], [boolean checked='false'], [boolean readonly='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out an input field. |
any
|
label(any field, [any content=''], [struct labelAttrs='[runtime expression]'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [struct data='[runtime expression]'], [any class=''], [numeric labelMode='0'])
Render a label tag. |
any
|
link([any href=''], [any rel='stylesheet'], [any type='text/css'], [any title=''], [any media=''], [boolean noBaseURL='false'], [any charset='UTF-8'], [boolean sendToHeader='false'], [struct data='[runtime expression]'])
Create link tags, using the SES base URL or not. |
private string
|
makePretty(any text)
Make pretty text. |
any
|
meta(any name, [any content=''], [any type='name'], [boolean sendToHeader='false'], [any property=''])
Generate meta tags. |
any
|
nbs([numeric count='1'])
Generate non-breaking spaces. |
private any
|
normalizeID(any args)
Normalize ID with name arguments. |
any
|
objectsToTable(any data, [string includes=''], [string excludes=''], any buffer)
Convert a table out of an array of objects. |
any
|
ol(any values, [string column=''])
Create ordered lists according to passed in values and arguments, compressed HTML. |
any
|
onMissingMethod([any missingMethodName], [any missingMethodArguments])
Intercepts any XX() call to the helper, meaning rendering ANY type of tag. |
any
|
options([any values], [any column=''], [any nameColumn=''], [any selectedIndex='0'], [any selectedValue=''])
Render out options. |
private boolean
|
passIncludeExclude(any value, [any includes=''], [any excludes=''])
checks if a list include exclude check passes. |
any
|
passwordField([any name=''], [any value=''], [boolean disabled='false'], [boolean readonly='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a password field. |
private string
|
prepareBaseLink([boolean noBaseURL='false'], [any src])
Prepare a base link. |
any
|
queryToTable(any data, [string includes=''], [string excludes=''], any buffer)
Convert a table out of a query, usually the header tag has already printed. |
any
|
radioButton([any name=''], [any value='true'], [boolean disabled='false'], [boolean checked='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a radiobutton field. |
any
|
resetButton([any name=''], [any value='Reset'], [boolean disabled='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a reset button. |
any
|
select([any name=''], [any options=''], [any column=''], [any nameColumn=''], [any selectedIndex='0'], [any selectedValue=''], [any bind=''], [any bindProperty=''], [boolean disabled='false'], [boolean multiple='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelwrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [struct data='[runtime expression]'], [any labelClass=''], [boolean inputInsideLabel='false'])
Render out a select tag. |
any
|
setSettings(any settings)
|
any
|
slugify(any str, [numeric maxLength='0'], [any allow=''])
Slugify a string for URL Safety. |
any
|
startFieldSet([any legend=''], [struct data='[runtime expression]'])
Build a field set with or without a legend. |
any
|
startForm([string action=''], [string name=''], [string method='POST'], [boolean multipart='false'], [boolean ssl], [boolean noBaseURL='false'], [struct data='[runtime expression]'])
Create cool form tags. |
any
|
submitButton([any name=''], [any value='Submit'], [boolean disabled='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a submit button. |
any
|
table(any data, [any includes=''], [any excludes=''], [any name=''])
Convert a table out of data (either a query or array of structures or array of entities). |
any
|
tag(any tag, [any content=''], [struct data='[runtime expression]'], [string excludes=''])
Generate tags. |
any
|
textArea([any name=''], [numeric cols], [numeric rows], [any value=''], [boolean disabled='false'], [boolean readonly='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a textarea. |
any
|
textField([any name=''], [any value=''], [boolean disabled='false'], [boolean readonly='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a text field. |
any
|
toHtmlList(any tag, any values, [any column=''], [struct data='[runtime expression]'])
Convert a sent in tag type to an HTML list. |
any
|
ul(any values, [string column=''])
Create un-ordered lists according to passed in values and arguments, compressed HTML. |
any
|
urlField([any name=''], [any value=''], [boolean disabled='false'], [boolean readonly='false'], [any wrapper=''], [struct wrapperAttrs='[runtime expression]'], [any groupWrapper=''], [struct groupWrapperAttrs='[runtime expression]'], [any label=''], [struct labelAttrs='[runtime expression]'], [any labelWrapper=''], [struct labelWrapperAttrs='[runtime expression]'], [any labelClass=''], [any bind=''], [any bindProperty=''], [struct data='[runtime expression]'], [boolean inputInsideLabel='false'])
Render out a URL field. |
any
|
video(any src, [any width=''], [any height=''], [any poster=''], [boolean autoplay='false'], [boolean controls='true'], [boolean loop='false'], [boolean preload='false'], [boolean noBaseURL='false'], [any name=''], [any data='[runtime expression]'])
HTML Video Tag. |
private any
|
wrapTag(any buffer, any tag, [boolean end='false'], [struct attrs])
Wrap a tag in the buffer. |
Methods inherited from class lucee.Component |
---|
None |
Constructor Detail |
---|
Constructor
controller
- The ColdBox ControllerProperty Detail |
---|
Module Settings
access
- publicrequired
- falsereturntype
- anyserializable
- trueMethod Detail |
---|
Facade to CFML htmlHead
content
Add a js/css asset(s) to the html head section. You can also pass in a list of assets via the asset argument to try to load all of them. You can also make this method return the string that will be sent to the header instead. If the setings: htmlHelper_js_path exists, we will use it as a prefix for JS files (Deprecated by 5.2) If the setings: htmlhelper_css_path exists, we will use it as a prefix for CSS Files (Deprecated by 5.2) In 5.2 the HTML Helper is an internal module, to configure it levareage the `HTMLHelper` module settings. This method tracks assets in the PRC via the key: cbox_assets
addAsset
in class
FrameworkSupertype
asset
- The asset(s) to load, only js or css files. This can also be a comma delimmited list.sendToHeader
- Send to header or returned HTML contentasync
- HTML5 JavaScript argument: Specifies that the script is executed asynchronously (only for external scripts)defer
- HTML5 JavaScript argument: Specifies that the script is executed when the page has finished parsing (only for external scripts)Generate a script tag with custom JS content
content
- The content to render outsendToHeader
- Send to header or returned HTML contentGenerate a style tag with custom CSS content
content
- The content to render outsendToHeader
- Send to header or returned HTML contentGenerate anchors
name
- The name of the anchortext
- The text of the linkdata
- The data-{key} elements to addConvert a table out of an array of structs
data
- The array to convert into a tableincludes
- The columns to includeexcludes
- The columns to excludebuffer
- The output bufferHTML Audio Tag
src
- The source URL or array or list of URL's to create video tags forautoplay
- Whether or not to start playing the video as soon as it cancontrols
- Whether or not to show controls on the video playerloop
- Whether or not to loop the video over and over againpreload
- If true, the video will be loaded at page load, and ready to run. Ignored if 'autoplay' is presentnoBaseURL
- Defaults to false. If you want to NOT append a request's ses or html base url then set this argument to truename
- The name tagdata
- A structure that will add data-{key} elements to the HTML controlCreates auto discovery links for RSS and ATOM feeds.
type
- Type of feed: RSS or ATOM or Custom Typehref
- Te href link to discoverrel
- The rel attributetitle
- The title attributedata
- Struct for data-key elementsBind entity values
args
- The argument structuresGenerate line breaks
count
- The numberRender out a button. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledtype
- The type of button to create: button, reset or submitwrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagHTML Canvas Tag
id
- The id of the canvaswidth
- The width tagheight
- The height tagdata
- A structure that will add data-{key} elements to the HTML controlRender out a checkbox field. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledchecked
- Checkedwrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagRender a doctype by type name: xhtml11,xhtml1-strict,xhtml-trans,xthml-frame,html5,html4-strict,html4-trans,html4-frame
type
Adds the versioned path for an asset to the view using ColdBox Elixir
fileName
- The asset path to find relative to the includes convention directorybuildDirectory
- The build directory inside the includes convention directorysendToHeader
- Send to the header via htmlhead by default, else it returns the contentasync
- HTML5 JavaScript argument: Specifies that the script is executed asynchronously (only for external scripts)defer
- HTML5 JavaScript argument: Specifies that the script is executed when the page has finished parsing (only for external scripts)Adds the versioned path for an asset to the view using ColdBox Elixir
fileName
- The asset path to find relative to the includes convention directorybuildDirectory
- The build directory inside the includes convention directoryuseModuleRoot
- If true, use the module root as the root of the file pathRender out an email field. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledreadonly
- Readonlywrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagEnd a fieldset
End a form
Create fields based on entity properties and relationships
entity
- The entity binded to this controlgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultfieldwrapper
- The wrapper tag to use around the field items. Empty by defaultfieldWrapperAttrs
- Attributes to add to the field wrapper tag. Empty by defaultlabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelwrapper
- The wrapper tag to use around the label items. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labeltextareas
- A list of property names that you want as textareasbooleanSelect
- If a boolean is detected a dropdown is generated, if false, then radio buttonsshowRelations
- If true it will show relation tables for one to one and one to manymanytoone
- A structure of data to help with many to one relationships on how they are presented. Possible key values for each key are [valuecolumn='',namecolumn='',criteria={},sortorder=string]. Example: {criteria={productid=1},sortorder='Department desc'}manytomany
- A structure of data to help with many to one relationships on how they are presented. Possible key values for each key are [valuecolumn='',namecolumn='',criteria={},sortorder=string,selectColumn='']. Example: {criteria={productid=1},sortorder='Department desc'}inputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagRender out a file field. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledreadonly
- Readonlywrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagflatten a struct of attributes to strings and returns the incoming buffer
target
- The targetexcludes
- The excludes listbuffer
- The buffer objectReturns an array of values from the query and column
qry
- The target querycolumnName
- The column name to useGenerate headers
content
- The contentsize
- The sizeRender out a hidden field. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledreadonly
- Readonlywrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagCreate href tags, using the SES base URL or not
href
- Where to link to, this can be an action, absolute, etc If not set, we will create a link to the current executed event.text
- The text of the linkqueryString
- The query string to append, if needed.title
- The title attributenoBaseURL
- Defaults to false. If you want to NOT append a request's ses or html base url, then set this to truedata
- A structure that will add data-{key} elements to the HTML controlRender out a image button. Remember that any extra arguments are passed as tag attributes
src
- The image sourcename
- The name of the textareadisabled
- Disabledwrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagCreate image tags using the SES base URL or not
src
- The source URL to link toalt
- The alt tagclass
- The class tagwidth
- The width tagheight
- The height tagtitle
- The title tagrel
- The rel tagname
- The name tagnoBaseURL
- Defaults to false. If you want to NOT append a request's ses or html base url then set this argument to truedata
- A structure that will add data-{key} elements to the HTML controlRender out an input field. Remember that any extra arguments are passed as tag attributes
type
- The type of input field to create, defaults to textname
- The name of the textareavalue
- The value of the fielddisabled
- Disabledchecked
- Checkedreadonly
- Read onlywrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagRender a label tag. Remember that any extra arguments are passed as tag attributes
field
- The for who attributecontent
- The label content. If not passed the field is usedlabelAttrs
- Attributes to add to the label tag. Empty by defaultwrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultdata
- A structure that will add data-{key} elements to the HTML controlclass
- The class to be applied to the labellabelMode
- 0 - Open and close the label tag with wrappers around it (default); 1 - Open the wrapper and the label but do not close them; 2- Output the content, close the label and the wrapperCreate link tags, using the SES base URL or not
href
- The href link to link torel
- The rel attributetype
- The type attributetitle
- The title attributemedia
- The media attributenoBaseURL
- Defaults to false. If you want to NOT append a request's ses or html base url then set this argument to truecharset
- The charset to add, defaults to utf-8sendToHeader
- Send to the header via htmlhead by default, else it returns the contentdata
- A structure that will add data-{key} elements to the HTML controlMake pretty text
text
- TargetGenerate meta tags
name
- A name for the meta tag or an array of struct data to convert to meta tags.Keys [name,content,type]content
- The content attributetype
- Either ''name'' or ''equiv'' which produces http-equiv instead of the namesendToHeader
- Send to the header via htmlhead by default, else it returns the contentproperty
- The property attributeGenerate non-breaking spaces
count
- The numberNormalize ID with name arguments
args
- The argument structuresConvert a table out of an array of objects
data
- The array to convert into a tableincludes
- The columns to includeexcludes
- The columns to excludebuffer
- The output bufferCreate ordered lists according to passed in values and arguments, compressed HTML
values
- Array or list of valuescolumn
- If the values is a query, this is the name of the column to get the data from to create the listIntercepts any XX() call to the helper, meaning rendering ANY type of tag.
The first positional argument will be treated as the content of the tag or you can use
the content
argument directly:
#html.myWidget( 'is Awesome' )# ->is Awesome #html.contacts( class='bold', content='My Contacts' )# ->My Contacts
missingMethodName
missingMethodArguments
Render out options.
values
- An array, list or query to build options forcolumn
- If using a query or array of objects the column to display as value and namenameColumn
- If using a query or array of objects, the name column to display, if not passed defaults to the value columnselectedIndex
- selected index(s) if any. So either one or a list of indexesselectedValue
- selected value(s) if any. So either one or a list of valueschecks if a list include exclude check passes
value
- The targetincludes
- The includes listexcludes
- The excludes listRender out a password field. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledreadonly
- Readonlywrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagPrepare a base link
noBaseURL
- Indicator for buildingsrc
- The source targetConvert a table out of a query, usually the header tag has already printed
data
- The query to convert into a tableincludes
- The columns to includeexcludes
- The columns to excludebuffer
- The output bufferRender out a radiobutton field. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledchecked
- Checkedwrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagRender out a reset button. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledwrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagRender out a select tag. Remember that any extra arguments are passed as tag attributes
name
- The name of the fieldoptions
- The value for the options, usually by calling our options() methodcolumn
- If using a query or array of objects the column to display as value and namenameColumn
- If using a query or array of objects, the name column to display, if not passed defaults to the value columnselectedIndex
- selected indexselectedValue
- selected value if anybind
- The entity binded to this controlbindProperty
- The property to use for the value, by convention we use the name attributedisabled
- Disabled button or not?multiple
- multiple button or not?wrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelwrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultdata
- A structure that will add data-{key} elements to the HTML controllabelClass
- The class to be applied to the labelinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagsettings
Slugify a string for URL Safety
str
- Target to slugifymaxLength
- The maximum number of characters for the slugallow
- a regex safe list of additional characters to allowBuild a field set with or without a legend
legend
- The legend to usedata
- A structure that will add data-{key} elements to the HTML controlCreate cool form tags. Any extra argument will be passed as attributes to the form tag
action
- The event or route action to submit to. This will be inflated using the request's base URL if not a full http URL. If empty, then it is a self-submitting formname
- The name of the form tagmethod
- The HTTP method of the form, defaults to POSTmultipart
- Set the multipart encoding type on the form, defaults to falsessl
- If true, it will change http to https if found in the ses base url ONLY, false will remove SSLnoBaseURL
- Defaults to false. If you want to NOT append a request's ses or html base url then set this argument to truedata
- A structure that will add data-{key} elements to the HTML controlRender out a submit button. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledwrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagConvert a table out of data (either a query or array of structures or array of entities)
data
- The query, array of dataincludes
- The columns to includeexcludes
- The columns to excludename
- The name tagGenerate tags
tag
- The tag to generatecontent
- The contentdata
- The data-{key} elements to addexcludes
- List of attributes to exclude from the tag generationRender out a textarea. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareacols
- The number of columnsrows
- The number of rowsvalue
- The value of the textareadisabled
- Disabledreadonly
- Readonlywrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagRender out a text field. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledreadonly
- Readonlywrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagConvert a sent in tag type to an HTML list
tag
- The list tag typevalues
- An array or list of valuescolumn
- If the values is a query, this is the name of the column to get the data from to create the listdata
- A structure that will add data-{key} elements to the HTML controlCreate un-ordered lists according to passed in values and arguments, compressed HTML
values
- Array or list of valuescolumn
- If the values is a query, this is the name of the column to get the data from to create the listRender out a URL field. Remember that any extra arguments are passed as tag attributes
name
- The name of the textareavalue
- The value of the textareadisabled
- Disabledreadonly
- Readonlywrapper
- The wrapper tag to use around the tag. Empty by defaultwrapperAttrs
- Attributes to add to the wrapper tag. Empty by defaultgroupWrapper
- The wrapper tag to use around the tag and label. Empty by defaultgroupWrapperAttrs
- Attributes to add to the group wrapper tag. Empty by defaultlabel
- If Passed we will prepend a label taglabelAttrs
- Attributes to add to the label tag. Empty by defaultlabelWrapper
- The wrapper tag to use around the label. Empty by defaultlabelWrapperAttrs
- Attributes to add to the label wrapper tag. Empty by defaultlabelClass
- The class to be applied to the labelbind
- The entity binded to this control, the value comes by convention from the name attributebindProperty
- The property to use for the value, by convention we use the name attributedata
- A structure that will add data-{key} elements to the HTML controlinputInsideLabel
- If true, closes the label tag after the input tag and puts the label text after the input tagHTML Video Tag
src
- The source URL or array or list of URL's to create video tags forwidth
- The width tagheight
- The height tagposter
- The URL of the image when video is unavailableautoplay
- Whether or not to start playing the video as soon as it cancontrols
- Whether or not to show controls on the video playerloop
- Whether or not to loop the video over and over againpreload
- If true, the video will be loaded at page load, and ready to run. Ignored if 'autoplay' is presentnoBaseURL
- Defaults to false. If you want to NOT append a request's ses or html base url then set this argument to truename
- The name tagdata
- A structure that will add data-{key} elements to the HTML controlWrap a tag in the buffer
buffer
- The output buffertag
- The tag to wrap withend
- Start or end of tagattrs
- The attributes of the tag