MontoyaTech/ignite-html
MontoyaTech/ignite-html
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improved documentation, added placeholder function to shorten template code.

Browse Source
This commit is contained in:
Matt Mo 2020-09-01 08:50:11 -07:00
parent 52077d1797
commit 3072bb2f7c
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/ignite-template.js
View File

@ -108,6 +108,7 @@ class IgniteTemplate {
* @param {String|IgniteProperty} value The value to set on the element. * @param {String|IgniteProperty} value The value to set on the element.
* @param {Boolean} reflect Whether or not to reflect changes to the value of the element back to the property if one was used. * @param {Boolean} reflect Whether or not to reflect changes to the value of the element back to the property if one was used.
* @param {Function} converter Optional function that can convert the value if needed. * @param {Function} converter Optional function that can convert the value if needed.
* @returns This ignite template so function calls can be chained.
*/ */
value(value, reflect = false, converter = null) { value(value, reflect = false, converter = null) {
if (reflect && converter != null) { if (reflect && converter != null) {
@ -322,6 +323,7 @@ class IgniteTemplate {
* Sets the id attribute of the element to be constructed by this template. * Sets the id attribute of the element to be constructed by this template.
* @param {String|IgniteProperty} value The value to set for the id attribute of the element this template will construct. * @param {String|IgniteProperty} value The value to set for the id attribute of the element this template will construct.
* @param {Function} converter An optional function that can convert the value if needed. * @param {Function} converter An optional function that can convert the value if needed.
* @returns This ignite template so function calls can be chained.
*/ */
id(value, converter = null) { id(value, converter = null) {
return this.attribute("id", value, converter); return this.attribute("id", value, converter);
@ -331,6 +333,7 @@ class IgniteTemplate {
* Sets the type attribute of the element to be constructed by this template. * Sets the type attribute of the element to be constructed by this template.
* @param {String|IgniteProperty} value The value to set for the type attribute of the element this template will construct. * @param {String|IgniteProperty} value The value to set for the type attribute of the element this template will construct.
* @param {Function} converter An optional function that can convert the value if needed. * @param {Function} converter An optional function that can convert the value if needed.
* @returns This ignite template so function calls can be chained.
*/ */
type(value, converter = null) { type(value, converter = null) {
return this.attribute("type", value, converter); return this.attribute("type", value, converter);
@ -340,6 +343,7 @@ class IgniteTemplate {
* Sets the value attribute of the element to be constructed by this template. * Sets the value attribute of the element to be constructed by this template.
* @param {String|IgniteProperty} value The value to set for the src attribute of the element to be constructed by this template. * @param {String|IgniteProperty} value The value to set for the src attribute of the element to be constructed by this template.
* @param {Function} converter An optional function that can convert the value if needed. * @param {Function} converter An optional function that can convert the value if needed.
* @returns This ignite template so function calls can be chained.
*/ */
src(value, converter = null) { src(value, converter = null) {
return this.attribute("src", value, converter); return this.attribute("src", value, converter);
@ -349,11 +353,22 @@ class IgniteTemplate {
* Sets the name attribute of the element to be constructed by this template. * Sets the name attribute of the element to be constructed by this template.
* @param {String|IgniteProperty} value The value to set for the name attribute of the element to be constructed by this template. * @param {String|IgniteProperty} value The value to set for the name attribute of the element to be constructed by this template.
* @param {Function} converter An optional function that can convert the value if needed. * @param {Function} converter An optional function that can convert the value if needed.
* @returns This ignite template so function calls can be chained.
*/ */
name(value, converter = null) { name(value, converter = null) {
return this.attribute("name", value, converter); return this.attribute("name", value, converter);
} }
/**
* Sets the placeholder attribute of the element to be constructed by this template.
* @param {String|IgniteProperty} value The value to set for the placeholder attribute of the element.
* @param {Function} converter An optional function that can convert the value if needed.
* @returns This ignite template so function calls can be chained.
*/
placeholder(value, converter = null) {
return this.attribute("placeholder", value, converter);
}
/** /**
* Constructs this template and adds it to the DOM if this template * Constructs this template and adds it to the DOM if this template
* has not already been constructed. * has not already been constructed.