Home Reference Source
import ColumnsComponent from 'formiojs/src/components/columns/Columns.js'
public class | source

ColumnsComponent

Extends:

src/components/_classes/component/Component.js~ComponentFieldNestedComponent → ColumnsComponent

Static Member Summary

Static Public Members
public static get

builderInfo: {"title": string, "icon": string, "group": string, "documentation": string, "weight": number, "schema": *}

Static Method Summary

Static Public Methods
public static

schema(extend: ...*): *

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get
public get
public

columns: *[]

public get
public get
public

rows: *[]

public get

schema: *

Method Summary

Public Methods
public

attach(element: *): *

public

checkComponentConditions(data: *, flags: *, row: *): *

public
public

detach(all: *)

public

groupByRow(): Array<ColumnComponent[]>

Group columns in rows.

public

init()

public
public

justifyColumn(items: *, index: *)

public
public

render(): *

Inherited Summary

From class Field
public

render(element: *): *

From class NestedComponent
public static

schema(extend: ...*): *

public get
public set
public get
public get
public set
public get

data: *

public set
public get
public get
public get
public set
public get

errors: *

public get

isDirty: *

public get
public get
public get
public set
public get
public set
public get

ready: *

public get
public set
public get

schema: *

public get
public get

visible: *

public set
public
public
public
public
private
private

_data: *

private
private
public

addComponent(component: Object, data: Object, before: HTMLElement): Component

Add a new component to the components array.

public

addComponents(element: *, data: *)

public

attach(element: *): *

public

attachComponents(element: *, components: *, container: *): *

public
public

beforePage(next: *): *

Allow components to hook into the next page trigger to perform their own logic.

public

Allow components to hook into the submission to provide their own async data.

public

Return a path of component's value.

public

calculateValue(data: *, flags: *, row: *): *

public

checkAsyncValidity(data: *, dirty: *, row: *, silentCheck: *): *

public

checkConditions(data: *, flags: *, row: *): *

public

checkData(data: *, flags: *, row: *, components: *): *

public

checkModal(isValid: *, dirty: *)

public

checkValidity(data: *, dirty: *, row: *, silentCheck: *): *

public

clear()

public

clearOnHide(show: *)

public
public

createComponent(component: *, data: *): *

Create a new component and add it to the components array.

public
public
public

detach()

public

Perform an iteration over each component within this container component.

public

Perform a deep iteration over every component, including those within other container based components.

public
public

Returns a component provided a key.

public

Return a component provided the Id of the component.

public
public
public

getValue(): *

public

hasComponent(component: *): *

public

init(): *

public

isLastPage(): *

public

isValid(data: *, dirty: *): *

public

removeComponent(component: Component, components: Array<Component>)

Remove a component from the components array.

public

Removes a component provided the Id of the component.

public

Removes a component provided the API key of that component.

public

render(children: *): *

public

renderComponents(components: *): *

public
public
public

setNestedValue(component: *, value: *, flags: {}): *

public

setPristine(pristine: *)

public

setValue(value: *, flags: {}): *

public

shouldSkipValidation(data: *, dirty: *, row: *): *

public

updateValue(value: *, flags: {}): *

Static Public Members

public static get builderInfo: {"title": string, "icon": string, "group": string, "documentation": string, "weight": number, "schema": *} source

Static Public Methods

public static schema(extend: ...*): * source

Override:

NestedComponent#schema

Params:

NameTypeAttributeDescription
extend ...*

Return:

*

Public Constructors

public constructor() source

Override:

NestedComponent#constructor

Public Members

public get className: string source

public get columnKey: string source

public columns: *[] source

public get defaultSchema: * source

Override:

NestedComponent#defaultSchema

public get gridSize: number source

public rows: *[] source

public get schema: * source

Override:

NestedComponent#schema

Public Methods

public attach(element: *): * source

Override:

NestedComponent#attach

Params:

NameTypeAttributeDescription
element *

Return:

*

public checkComponentConditions(data: *, flags: *, row: *): * source

Params:

NameTypeAttributeDescription
data *
flags *
row *

Return:

*

public destroy() source

Override:

NestedComponent#destroy

public detach(all: *) source

Override:

NestedComponent#detach

Params:

NameTypeAttributeDescription
all *

public groupByRow(): Array<ColumnComponent[]> source

Group columns in rows.

Return:

Array<ColumnComponent[]>

public init() source

Override:

NestedComponent#init

public justify() source

public justifyColumn(items: *, index: *) source

Params:

NameTypeAttributeDescription
items *
index *

public labelIsHidden(): boolean source

Return:

boolean

public render(): * source

Override:

NestedComponent#render

Return:

*