Version: 1.x

ControlGroup

Type: Component

Manages rendering and laying out a group of controls. The layout is managed via CSS Flexbox properties.

Props#

controls#

Type: Control[] | Defaut: []

Collection of controls to be rendered and registered.

isEnabled#

Type: boolean | Defaut: true

Whether the group should be rendered into the DOM or not.

isActive#

Type: boolean | Defaut: false

Whether the group is visible or not.

shouldFill#

Type: boolean | Defaut: false

Whether the group should take up all available space in its container by setting flex: 1 on the root component element.

flow#

Type: string|null | Defaut: null

Sets the flex-flow CSS property of the group (see W3 Schools - flex-flow property. By default the flex-flow is row wrap.

position#

Type: string|null | Defaut: null

Sets the align-items and justify-content CSS properties of the group. This property is written as (align-items):(justify-content). For example, flex-center:flex-start.

Methods#

getEl#

Return Type: HTMLElement

The root HTML element of the component.

hasControls#

Return Type: boolean

Whether the group has any controls or not.

reset#

Reset all props to their default values.

getInstances#

Return Type: { [id]: Component }

The rendered control instances.