Container Node

Containers are visual dividers that contain other canvas nodes, akin to the HTML div element.

Items within a container are arranged side-by-side using CSS Flexbox. Containers can be nested to create, responsive complex layouts.

Properties

Visible

PropcontainerNode.isVisible
Typeboolean
Default{{true}}

Whether or not this node is visible.

Enabled

PropcontainerNode.isEnabled
Typeboolean
Default{{true}}

Whether or not this node is enabled.

Tooltip

PropcontainerNode.tooltip
Typestring
Defaultundefined

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

Top

PropcontainerNode.top
Typestring
Default1

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

Left

PropcontainerNode.left
Typestring
Default1

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

Width

PropcontainerNode.width
Typestring
Default384px

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

PropcontainerNode.minWidth
Typestring
Defaultnone

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

Max Width

PropcontainerNode.maxWidth
Typestring
Defaultnone

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

Height

PropcontainerNode.height
Typestring
Default196px

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

PropcontainerNode.minHeight
Typestring
Defaultnone

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

Max Height

PropcontainerNode.maxHeight
Typestring
Defaultnone

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

Overflow

PropcontainerNode.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

PropcontainerNode.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

PropcontainerNode.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

PropcontainerNode.styles
Typestring
Defaultelement.styles { }

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

Layout Style

PropcontainerNode.layoutStyle
TypeNodeLayoutStyle ('GRID' | 'HORIZONTAL_STACK' | 'VERTICAL_STACK')
DefaultGRID

The layout style used by the container to arrange its children. Can be either a horizontal or vertical stack.

Grid Columns

PropcontainerNode.gridColumns
Typenumber
Default12

The number of columns in the container's grid system.

Grid Rows

PropcontainerNode.gridRows
Typenumber
Default0

The number of rows in the container's grid system, expanding to fill the container.

Grid Row Height

PropcontainerNode.gridRowHeight
Typestring
Default16

The height of each row within the container's grid system, in pixels.

Row Gap

PropcontainerNode.gridRowGap
Typestring
Default4

The space between each row within the container's grid system, in pixels.

Column Gap

PropcontainerNode.gridColumnGap
Typestring
Default4

The space between each column within the container's grid system, in pixels.

Padding

PropcontainerNode.padding
Typestring
Default16

The internal padding of the container to place around its children.

Spacing

PropcontainerNode.spacing
Typestring
Default16

The spacing to use between child nodes of the container.

Background Color

PropcontainerNode.backgroundColor
Typestring
Defaultsurface.100

The background color of the container.

Box Shadow

PropcontainerNode.boxShadow
Typestring
Defaultmd

The box shadow of the container. Supports standard box-shadow values or tokens defined in the theme.

Border Radius

PropcontainerNode.borderRadius
Typestring
Default0

The radius of the rounding of the corners of the container. Set to 0 to have no rounded corners.

Distribute Content

PropcontainerNode.distributeContent
TypeNodeLayoutDistributeStyle ('start' | 'center' | 'end' | 'around' | 'between' | 'even')
Defaultstart

The distribution of the children nodes within the container. Corresponds to the justify-content CSS Flexbox property.

Align Content

PropcontainerNode.alignContent
TypeNodeLayoutAlignStyle ('start' | 'center' | 'end')
Defaultstart

The alignment of the children nodes within the container. Corresponds to the align-items CSS Flexbox property.

Wrap Content

PropcontainerNode.wrapContent
TypeNodeLayoutWrapStyle ('wrap' | 'nowrap' | 'wrap-reverse')
Defaultnowrap

How the children nodes wrap within the container. Corresponds to the flex-wrap CSS Flexbox property.

Type

PropcontainerNode.containerType
TypeContainerTypes ('ON_SUBMIT_FORM' | 'NONE')
DefaultNONE

Select different form behaviors.

Method Options

PropcontainerNode.formMethodOption
TypeHttpMethodTypes ('GET' | 'POST')
DefaultPOST

Select the method you want to submit the form with.

Action

PropcontainerNode.formAction
Typestring
Default#

The URL where the form will be submitted.

Form Data

PropcontainerNode.formData
Typeunknown
Defaultundefined

Stores the values from form inputs within the node.

Event Handlers

On Submit

HandlercontainerNode.onSubmit

Called when the user hits "Enter". Use this event to trigger downstream actions when the form is submitted.