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

PropinstanceNode.isVisible
Typeboolean
Default{{true}}

Whether or not this node is visible.

Enabled

PropinstanceNode.isEnabled
Typeboolean
Default{{true}}

Whether or not this node is enabled.

Tooltip

PropinstanceNode.tooltip
Typestring
Defaultundefined

The tooltip text to display when hovered or focused over this node.

Top

PropinstanceNode.top
Typestring
Default1

The position of the node from the top side of the grid (grid-row-start).

Left

PropinstanceNode.left
Typestring
Default1

The position of the node from the left side of the grid (grid-column-start).

Width

PropinstanceNode.width
Typestring
Default128px

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

PropinstanceNode.minWidth
Typestring
Defaultnone

The minimum width of the node. When this node is in a grid layout, this property is ignored.

Max Width

PropinstanceNode.maxWidth
Typestring
Defaultnone

The maximum width of the node. When this node is in a grid layout, this property is ignored.

Height

PropinstanceNode.height
Typestring
Default32px

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

PropinstanceNode.minHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Max Height

PropinstanceNode.maxHeight
Typestring
Defaultnone

The minimum height of the node. When this node is in a grid layout, this property is ignored.

Overflow

PropinstanceNode.overflow
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.

Overflow X

PropinstanceNode.overflowX
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the horizontal axis for content that is larger than its container.

Overflow Y

PropinstanceNode.overflowY
TypeOverflow ('auto' | 'visible' | 'hidden' | 'scroll')
Defaultauto

The strategy used to handle overflow in the vertical axis for content that is larger than its container.

Custom Styles

PropinstanceNode.styles
Typestring
Defaultelement.styles { }

Custom CSS styles to be applied to the node. Use element.styles to refer to the current node.

Scope

PropinstanceNode.scope
Typeunknown
Default{}

Additional data with which to populate the template. This data will be available as {{scope}} within the template.