• Reference
  • Nodes
  • Components
  • Form Container

Form Container Component

Form Containers expose a submit event which will populate the node's formData Prop with the contained input nodes' values; the submit event will also run the selected action therein.

Properties

Visible

PropisVisible
Typeboolean
Default{{true}}

Whether or not this node is visible.

Enabled

PropisEnabled
Typeboolean
Default{{true}}

Whether or not this node is enabled.

Tooltip

Proptooltip
Typestring
Defaultundefined

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

Top

Proptop
Typenumber
Default1

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

Left

Propleft
Typenumber
Default1

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

Width

Propwidth
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

PropminWidth
Typestring
Defaultnone

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

Max Width

PropmaxWidth
Typestring
Defaultnone

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

Height

Propheight
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

PropminHeight
Typestring
Defaultnone

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

Max Height

PropmaxHeight
Typestring
Defaultnone

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

Overflow

Propoverflow
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

PropoverflowX
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

PropoverflowY
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

Propstyles
Typestring
Defaultelement.styles { }

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

Object Fit

PropobjectFit
TypeObjectFit ('none' | 'contain' | 'cover' | 'fill' | 'scale-down')
Defaultcover

The strategy used to set how the content of a replaced element should be resized to fit its container.

Layout Style

ProplayoutStyle
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

PropgridColumns
Typenumber
Default12

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

Grid Rows

PropgridRows
Typenumber
Default0

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

Grid Row Height

PropgridRowHeight
Typestring
Default16

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

Row Gap

PropgridRowGap
Typestring
Default4

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

Column Gap

PropgridColumnGap
Typestring
Default4

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

Padding

Proppadding
Typestring
Default16

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

Spacing

Propspacing
Typestring
Default16

The spacing to use between child nodes of the container.

Background Color

PropbackgroundColor
Typestring
Defaultsurface.100

The background color of the container.

Box Shadow

PropboxShadow
Typestring
Defaultmd

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

Border Radius

PropborderRadius
Typestring
Default0

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

Distribute Content

PropdistributeContent
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

PropalignContent
TypeNodeLayoutAlignStyle ('start' | 'center' | 'end')
Defaultstart

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

Wrap Content

PropwrapContent
TypeNodeLayoutWrapStyle ('wrap' | 'nowrap' | 'wrap-reverse')
Defaultnowrap

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

Form Data

PropformData
Typeunknown

Stores the values from form inputs contained within the node when the user submits the form.

Event Handlers

On Mount

HandlerformNode.onMount

Called when this node is mounted. Use this event to trigger downstream actions when this node first appears.

On Unmount

HandlerformNode.onUnmount

Called when this node is unmounted. Use this event to trigger downstream actions when this node is removed.

On Hover

HandlerformNode.onHover

Called when the user hovers on the node. Use this event to trigger downstream actions when this node is hovered.

On Leave

HandlerformNode.onLeave

Called when the user is not hovering over the node. Use this event to trigger downstream actions when this node is no longer hovered.

On Focus

HandlerformNode.onFocus

Called when the user focuses the node. Use this event to trigger downstream actions when this node is focused.

On Blur

HandlerformNode.onBlur

Called when the user blurs the node. Use this event to trigger downstream actions when this node is blurred.

On Submit

HandlerformNode.onSubmit

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

Last updated on October 17, 2022