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

Improved documentation further.

Browse Source
This commit is contained in:
MattMo 2023-04-20 08:22:43 -07:00
parent 0a6af3ad98
commit fb99e9d240
3 changed files with 1718 additions and 1706 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,4 +2,12 @@
A simple responsive javascript UI component framework.
[Documentation](docs.md)
[See Documentation](docs.md)
### Documentation build command
`
documentation build ignite-template.js ignite-html.js ignite-element.js -f md > docs.md
`
[Built using](https://github.com/documentationjs/documentation)

3379
docs.md
View File

File diff suppressed because it is too large Load Diff

35
ignite-element.js
View File

@ -50,19 +50,34 @@ class IgniteElement extends HTMLElement {
constructor() {
super();
/** @type {Boolean} */
/**
* @ignore
* @type {Boolean}
* */
this.elementConnected = false; //Used to know if the connectedCallback was already called.
/** @type {IgniteTemplate} */
/**
* The ignite html template used to construct this element.
* @type {IgniteTemplate}
* */
this.template = null;
/** @type {HTMLElement[]} */
/**
* The child elements within this element upon creation.
* @type {HTMLElement[]}
* */
this.elements = [];
/** @type {IgniteCallback} */
/**
* @ignore
* @type {IgniteCallback}
* */
this.readyCallback = new IgniteCallback(() => this.ready());
/** @type {IgniteCallback[]} */
/**
* @ignore
* @type {IgniteCallback[]}
* */
this.onDisconnectCallbacks = [];
//Create the variables for this element.
@ -82,7 +97,7 @@ class IgniteElement extends HTMLElement {
* Returns an object with all the variables for this ignite element. Variables
* unlike properties have no callbacks or events, they are just data.
*
* @returns An object with properties that will be assigned to this ignite element as variables.
* @returns {Object} An object with properties that will be assigned to this ignite element as variables.
*
* @example
* get variables() {
@ -100,7 +115,7 @@ class IgniteElement extends HTMLElement {
* Returns an object with all the properties for this ignite element. If null or empty
* then no properties will be created. To change a property and read it's current value see below.
*
* @returns An object with properties that will be assigned to this ignite element.
* @returns {Object} An object with properties that will be assigned to this ignite element.
*
* @example
* get properties() {
@ -127,7 +142,7 @@ class IgniteElement extends HTMLElement {
* value the CSS will auto be injected into the current HTML page once and reused for the life
* of the ignite element.
*
* @returns A string containing CSS code to be used with this ignite element.
* @returns {String} A string containing CSS code to be used with this ignite element.
*
* @example
* get styles() {
@ -166,6 +181,7 @@ class IgniteElement extends HTMLElement {
/**
* Gets all the property values from this element and returns it.
* @returns {Object} An object with all of the property values for this ignite element.
*/
getProperties() {
var ret = {};
@ -357,7 +373,7 @@ class IgniteElement extends HTMLElement {
}
/**
* Called wehn this ignite element is being initialized. When this is called
* Called when this ignite element is being initialized. When this is called
* the element has not been created. This is good for login checking code or special setup code.
*/
init() {
@ -384,6 +400,7 @@ class IgniteElement extends HTMLElement {
/**
* Generates a uuid and returns it.
* @returns {String} A unique string, for example: '1b23ec67-4d90-4992-9c5a-b5c0844deaef'
*/
uuid() {
return ([1e7] + -1e3 + -4e3 + -8e3 + -1e11).replace(/[018]/g, c =>