DomSmith plugin to enable tooltip support via $tooltip key on node definitions.
Tooltips are shown when the pointer enters an element that includes a $tooltip block.
The plugin modifies the node definition in-place and adds a pointerenter event handler.
- Version
- 1.0.0
- License
- MIT
- Requires
- Tooltip
- Source
- domSmithTooltip.js, line 3
Members
inner tooltip :Tooltip
Tooltip Instance used for this plugin.
- Type
- Tooltip
- Source
- domSmithTooltip.js, line 18
Methods
private, inner addNode(nodeDef) → DomSmith~NodeDefinition|undefined
Hook called by DomSmith during node creation.
| Name | Type | Description |
|---|---|---|
nodeDef |
DomSmith~NodeDefinition |
Node definition passed from DomSmith. |
- Returns
-
The modified nodeDef or undefined if no tooltip was applied.
- Type DomSmith~NodeDefinition | undefined
- Source
- domSmithTooltip.js, line 35
inner setParent(parentEle)
Assign parent element during initialization.
| Name | Type | Description |
|---|---|---|
parentEle |
HTMLElement |
The element the tooltip is attaching to. |
- Source
- domSmithTooltip.js, line 58
inner removeParent()
Remove parent element during destroy.
- Source
- domSmithTooltip.js, line 65
inner destroyPlugin()
Destroys the tooltip plugin.
- Source
- domSmithTooltip.js, line 72