Namespace
- Source:
Classes
Methods
(static) deepAssign Object deep merger method _uibMsgHandler If UIBUILDER for Node-RED is active, auto-handle incoming messages targetted at instance id fires state-timeline:connected - When an instance of the component is attached to the DOM. `evt.details` contains the details of the element. fires state-timeline:disconnected - When an instance of the component is removed from the DOM. `evt.details` contains the details of the element. fires state-timeline:attribChanged - When a watched attribute changes. `evt.details` contains the details of the change. NOTE that listeners can be attached either to the `document` or to the specific element instance. Standard watched attributes (common across all my components):()
A zero dependency web component that will display JavaScript console output on-page.
Properties:
Name | Type | Description |
---|---|---|
inherit-style |
string | boolean | Optional. Load external styles into component (only useful if using template). If present but empty, will default to './index.css'. Optionally give a URL to load. Other watched attributes: None Standard props (common across all my components): |
version |
string | Static. The component version string (date updated). Also has a getter. |
uib |
boolean | True if UIBUILDER for Node-RED is loaded |
$ |
function | jQuery-like shadow dom selector |
$$ |
function | jQuery-like shadow dom multi-selector |
_iCount |
number | The component version string (date updated) |
opts |
object | This components controllable options - get/set using the `config()` method Other props: By default, all attributes are also created as properties |
- Source:
(static) deepAssign Object deep merger method _uibMsgHandler If UIBUILDER for Node-RED is active, auto-handle incoming messages targetted at instance id fires state-timeline:connected - When an instance of the component is attached to the DOM. `evt.details` contains the details of the element. fires state-timeline:disconnected - When an instance of the component is removed from the DOM. `evt.details` contains the details of the element. fires state-timeline:attribChanged - When a watched attribute changes. `evt.details` contains the details of the change. NOTE that listeners can be attached either to the `document` or to the specific element instance. Standard watched attributes (common across all my components):()
A zero dependency web component that will display JavaScript console output on-page.
Properties:
Name | Type | Description |
---|---|---|
inherit-style |
string | boolean | Optional. Load external styles into component (only useful if using template). If present but empty, will default to './index.css'. Optionally give a URL to load. Other watched attributes: None Standard props (common across all my components): |
version |
string | Static. The component version string (date updated). Also has a getter. |
uib |
boolean | True if UIBUILDER for Node-RED is loaded |
$ |
function | jQuery-like shadow dom selector |
$$ |
function | jQuery-like shadow dom multi-selector |
_iCount |
number | The component version string (date updated) |
opts |
object | This components controllable options - get/set using the `config()` method Other props: By default, all attributes are also created as properties |
- Source:
(static) deepAssign Object deep merger method _uibMsgHandler If UIBUILDER for Node-RED is active, auto-handle incoming messages targetted at instance id fires state-timeline:connected - When an instance of the component is attached to the DOM. `evt.details` contains the details of the element. fires state-timeline:disconnected - When an instance of the component is removed from the DOM. `evt.details` contains the details of the element. fires state-timeline:attribChanged - When a watched attribute changes. `evt.details` contains the details of the change. NOTE that listeners can be attached either to the `document` or to the specific element instance. Standard watched attributes (common across all my components):()
A zero dependency web component that will display JavaScript console output on-page.
Properties:
Name | Type | Description |
---|---|---|
inherit-style |
string | boolean | Optional. Load external styles into component (only useful if using template). If present but empty, will default to './index.css'. Optionally give a URL to load. Other watched attributes: None Standard props (common across all my components): |
version |
string | Static. The component version string (date updated). Also has a getter. |
uib |
boolean | True if UIBUILDER for Node-RED is loaded |
$ |
function | jQuery-like shadow dom selector |
$$ |
function | jQuery-like shadow dom multi-selector |
_iCount |
number | The component version string (date updated) |
opts |
object | This components controllable options - get/set using the `config()` method Other props: By default, all attributes are also created as properties |
- Source:
(static) disconnectedCallback Called when the element is removed from a document OTHER METHODS: None CUSTOM EVENTS: "component-template:connected" - When an instance of the component is attached to the DOM. `evt.details` contains the details of the element. "component-template:ready" - Alias for connected. The instance can handle property & attribute changes "component-template:disconnected" - When an instance of the component is removed from the DOM. `evt.details` contains the details of the element. "component-template:attribChanged" - When a watched attribute changes. `evt.details.data` contains the details of the change. NOTE that listeners can be attached either to the `document` or to the specific element instance. Standard watched attributes (common across all my components):()
Define a new zero dependency custom web component ECMA module that can be used as an HTML tag
Properties:
Name | Type | Description |
---|---|---|
inherit-style |
string | boolean | Optional. Load external styles into component (only useful if using template). If present but empty, will default to './index.css'. Optionally give a URL to load. |
name |
string | Optional. HTML name attribute. Included in output _meta prop. Other watched attributes: None PROPS FROM BASE: (see TiBaseComponent) OTHER STANDARD PROPS: |
componentVersion |
string | Static. The component version string (date updated). Also has a getter that returns component and base version strings. Other props: By default, all attributes are also created as properties NB: properties marked with 💫 are dynamic and have getters/setters. |
- License:
- Apache-2.0 METHODS FROM BASE: (see TiBaseComponent) STANDARD METHODS:
- Source:
Example
<component-template name="myComponent" inherit-style="./myComponent.css"></component-template>
See https://github.com/runem/web-component-analyzer?tab=readme-ov-file#-how-to-document-your-components-using-jsdoc
(static) disconnectedCallback Called when the element is removed from a document OTHER METHODS: None CUSTOM EVENTS: "component-template:connected" - When an instance of the component is attached to the DOM. `evt.details` contains the details of the element. "component-template:ready" - Alias for connected. The instance can handle property & attribute changes "component-template:disconnected" - When an instance of the component is removed from the DOM. `evt.details` contains the details of the element. "component-template:attribChanged" - When a watched attribute changes. `evt.details.data` contains the details of the change. NOTE that listeners can be attached either to the `document` or to the specific element instance. Standard watched attributes (common across all my components):()
Define a new zero dependency custom web component ECMA module that can be used as an HTML tag
Properties:
Name | Type | Description |
---|---|---|
inherit-style |
string | boolean | Optional. Load external styles into component (only useful if using template). If present but empty, will default to './index.css'. Optionally give a URL to load. |
name |
string | Optional. HTML name attribute. Included in output _meta prop. Other watched attributes: None PROPS FROM BASE: (see TiBaseComponent) OTHER STANDARD PROPS: |
componentVersion |
string | Static. The component version string (date updated). Also has a getter that returns component and base version strings. Other props: By default, all attributes are also created as properties NB: properties marked with 💫 are dynamic and have getters/setters. |
- License:
- Apache-2.0 METHODS FROM BASE: (see TiBaseComponent) STANDARD METHODS:
- Source:
Example
<component-template name="myComponent" inherit-style="./myComponent.css"></component-template>
See https://github.com/runem/web-component-analyzer?tab=readme-ov-file#-how-to-document-your-components-using-jsdoc
(static) disconnectedCallback Called when the element is removed from a document OTHER METHODS: None CUSTOM EVENTS: "component-template:connected" - When an instance of the component is attached to the DOM. `evt.details` contains the details of the element. "component-template:ready" - Alias for connected. The instance can handle property & attribute changes "component-template:disconnected" - When an instance of the component is removed from the DOM. `evt.details` contains the details of the element. "component-template:attribChanged" - When a watched attribute changes. `evt.details.data` contains the details of the change. NOTE that listeners can be attached either to the `document` or to the specific element instance. Standard watched attributes (common across all my components):()
Define a new zero dependency custom web component ECMA module that can be used as an HTML tag
Properties:
Name | Type | Description |
---|---|---|
inherit-style |
string | boolean | Optional. Load external styles into component (only useful if using template). If present but empty, will default to './index.css'. Optionally give a URL to load. |
name |
string | Optional. HTML name attribute. Included in output _meta prop. Other watched attributes: None PROPS FROM BASE: (see TiBaseComponent) OTHER STANDARD PROPS: |
componentVersion |
string | Static. The component version string (date updated). Also has a getter that returns component and base version strings. Other props: By default, all attributes are also created as properties NB: properties marked with 💫 are dynamic and have getters/setters. |
- License:
- Apache-2.0 METHODS FROM BASE: (see TiBaseComponent) STANDARD METHODS:
- Source:
Example
<component-template name="myComponent" inherit-style="./myComponent.css"></component-template>
See https://github.com/runem/web-component-analyzer?tab=readme-ov-file#-how-to-document-your-components-using-jsdoc