Updated more documentation.

This commit is contained in:
MattMo 2023-11-01 08:25:14 -07:00
parent ab7209f5bf
commit 7c8ce52537

View File

@ -963,7 +963,7 @@ class IgniteTemplate {
/** /**
* Adds a checked attribute to this template. * Adds a checked attribute to this template.
* @param {Boolean|IgniteProperty} value The value to set for the checked attribute. * @param {Boolean|IgniteProperty} value The value to set for the checked attribute.
* @param {*} converter Optional function that can convert the value if needed. * @param {Any} converter Optional function that can convert the value if needed.
* @returns {IgniteTemplate} This ignite template so function calls can be chained. * @returns {IgniteTemplate} This ignite template so function calls can be chained.
*/ */
checked(value, converter = null) { checked(value, converter = null) {
@ -972,8 +972,8 @@ class IgniteTemplate {
/** /**
* Adds a disabled attribute and class to this template. * Adds a disabled attribute and class to this template.
* @param {Boolean|IgniteProperty} value A value to determine whether or not the element should be marked as disable or not. * @param {Boolean|IgniteProperty|IgniteProperty[]} value A value to determine whether or not the element should be marked as disable or not.
* @param {*} converter Optional function that can convert the value if needed. * @param {Any} converter Optional function that can convert the value if needed.
* @returns {IgniteTemplate} This ignite template so function calls can be chained. * @returns {IgniteTemplate} This ignite template so function calls can be chained.
*/ */
disabled(value, converter = null) { disabled(value, converter = null) {
@ -1037,7 +1037,7 @@ class IgniteTemplate {
/** /**
* Adds a readonly attribute and class to this template. * Adds a readonly attribute and class to this template.
* @param {Boolean|IgniteProperty} value A value to determine whether or not the element should be marked as readonly or not. * @param {Boolean|IgniteProperty} value A value to determine whether or not the element should be marked as readonly or not.
* @param {*} converter Optional function that can convert the value if needed. * @param {Any} converter Optional function that can convert the value if needed.
* @returns {IgniteTemplate} This ignite template so function calls can be chained. * @returns {IgniteTemplate} This ignite template so function calls can be chained.
*/ */
readonly(value, converter = null) { readonly(value, converter = null) {
@ -1111,7 +1111,7 @@ class IgniteTemplate {
* Sets a data attribute on the element to be constructed by this template. * Sets a data attribute on the element to be constructed by this template.
* @param {String} name The name of the data attribute to set on the element this template will construct. * @param {String} name The name of the data attribute to set on the element this template will construct.
* @param {String|IgniteProperty} value The value to set for the data attribute of the element this template will construct. * @param {String|IgniteProperty} value The value to set for the data attribute of the element this template will construct.
* @param {*} converter An optional function that can convert the value if needed. * @param {Any} converter An optional function that can convert the value if needed.
* @returns {IgniteTemplate} This ignite template so function calls can be chained. * @returns {IgniteTemplate} This ignite template so function calls can be chained.
*/ */
data(name, value, converter = null) { data(name, value, converter = null) {