Instance Node
Instances, when used in conjunction with templates, provide a lightweight way to reuse parts of your app (also known as composition).
Instances are attached to a template, and will "instantiate" or "expand" the template at the location specified by the instance. Additional scope can be provided to the template using the scope property, which is available at {{scope.element}} within the template.
Properties
Visible
| Prop | instanceNode.isVisible |
|---|---|
| Type | boolean |
| Default | {{true}} |
Whether or not this node is visible.
Enabled
| Prop | instanceNode.isEnabled |
|---|---|
| Type | boolean |
| Default | {{true}} |
Whether or not this node is enabled.
Tooltip
| Prop | instanceNode.tooltip |
|---|---|
| Type | string |
| Default | undefined |
The tooltip text to display when hovered or focused over this node.
Top
| Prop | instanceNode.top |
|---|---|
| Type | string |
| Default | 1 |
The position of the node from the top side of the grid (grid-row-start).
Left
| Prop | instanceNode.left |
|---|---|
| Type | string |
| Default | 1 |
The position of the node from the left side of the grid (grid-column-start).
Width
| Prop | instanceNode.width |
|---|---|
| Type | string |
| Default | 128px |
The width of the node. When this node is in a grid layout, this should be done using unitless grid column units (specifying 4 will become grid-column-end: span 4). When this node is in a stack layout, the width must be specified using CSS units (e.g. 100px or 100%).
Min Width
| Prop | instanceNode.minWidth |
|---|---|
| Type | string |
| Default | none |
The minimum width of the node. When this node is in a grid layout, this property is ignored.
Max Width
| Prop | instanceNode.maxWidth |
|---|---|
| Type | string |
| Default | none |
The maximum width of the node. When this node is in a grid layout, this property is ignored.
Height
| Prop | instanceNode.height |
|---|---|
| Type | string |
| Default | 32px |
The height of the node. When this node is in a grid layout, this should be done using unitless grid row units (specifying 4 will become grid-row-end: span 4). When this node is in a stack layout, the height must be specified using CSS units (e.g. 100px or 100%).
Min Height
| Prop | instanceNode.minHeight |
|---|---|
| Type | string |
| Default | none |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Max Height
| Prop | instanceNode.maxHeight |
|---|---|
| Type | string |
| Default | none |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Overflow
| Prop | instanceNode.overflow |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.
Overflow X
| Prop | instanceNode.overflowX |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the horizontal axis for content that is larger than its container.
Overflow Y
| Prop | instanceNode.overflowY |
|---|---|
| Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
| Default | auto |
The strategy used to handle overflow in the vertical axis for content that is larger than its container.
Custom Styles
| Prop | instanceNode.styles |
|---|---|
| Type | string |
| Default | element.styles { } |
Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.
Scope
| Prop | instanceNode.scope |
|---|---|
| Type | unknown |
| Default | {} |
Additional data with which to populate the template. This data will be available as {{scope}} within the template.