Skip to main content

Introducing Workflow Engine, try for FREE workflowengine.io.

Module: @react-form-builder/designer

Classes

Interfaces

Type Aliases

CustomizableKey

Ƭ CustomizableKey: "MainContainer" | "Header" | "MainMenu_Button" | "MainMenu_Dropdown" | "Header_Toolbar" | "ToggleModeButton" | "ResolutionSelect" | "LocalizationSelect" | "JsonViewButton" | "ToggleThemeButton" | "LeftPanel" | "LeftPanel_Nav" | "LeftPanel_Content" | "Tree_Tab" | "Tree_Tab_Content" | "Components_Tab" | "Components_Tab_Content" | "Settings_Tab" | "Settings_Tab_Content" | "Forms_Tab" | "Forms_Tab_Content" | "CentralPanel" | "FormContainer" | "RightPanel" | "RightPanel_Nav" | "RightPanel_Content" | "Main_Tab" | "Main_Tab_Content" | "Style_Tab" | "Style_Tab_Content" | "Actions_Tab" | "Actions_Tab_Content" | "Rules_Tab" | "Rules_Tab_Content" | "LabeledProperty" | "PropertyCodeButton" | "PropertyLabel" | "PropertyInput"

The available keys of the customizable components.


CustomizationMap

Ƭ CustomizationMap: Partial<Record<CustomizableKey, Options>>

The map of customizations for the FormBuilder components.


FormBuilderI18n

Ƭ FormBuilderI18n: Object

The i18n data of the form builder.

Type declaration

NameTypeDescription
getData(languageFullCode: string) => Promise<FormBuilderI18nData>The callback function called when loading data for i18n. Accepts the full code (en-US, en-GB, etc.) of a language.
languagesLanguage[]The languages.

FormBuilderI18nData

Ƭ FormBuilderI18nData: Object

Data required to translate the form builder interface.

Type declaration

NameTypeDescription
componentsLocale?anyThe locale for translating rSuite components https://rsuitejs.com/guide/i18n/#supported-locales.
dataanyThe JSON with translation.

Options

Ƭ Options: Object

Customization options for the FormBuilder component.

Type declaration

NameTypeDescription
className?stringThe component className.
customRenderer?(defaultElement: ReactElement, component: ComponentType<any>, props: any) => ReactElementThe component custom renderer.
hidden?booleanTrue if you want to hide the component.
style?CSSProperties | stringThe component style. Supported formats - CSSProperties object, standard CSS as string, nested selectors.

Functions

ActionCell

ActionCell(props): Element

The React component that displays the table cell with the icon button. Internal use only.

Parameters

NameTypeDescription
propsActionCellPropsthe React component properties.

Returns

Element

the React element.


CheckCell

CheckCell(props): Element

The React component that displays the table cell with the checkbox. Internal use only.

Parameters

NameTypeDescription
propsInputCellPropsthe React component properties.

Returns

Element

the React element.


EditableTable

EditableTable(props): Element

The React component that displays the table with editable cells. Internal use only.

Parameters

NameTypeDescription
propsEditableTablePropsthe React component properties.

Returns

Element

the React element.


FormBuilder

FormBuilder(props): Element

The React component that displays the form builder.

Parameters

NameTypeDescription
propsFormBuilderPropsthe React component properties.

Returns

Element

the React element.


InputCell

InputCell(props): Element

The React component that displays the table cell with the input. Internal use only.

Parameters

NameTypeDescription
propsInputCellPropsthe React component properties.

Returns

Element

the React element.


SelectCell

SelectCell(props): Element

The React component that displays the table cell with the select input. Internal use only.

Parameters

NameTypeDescription
propsSelectCellPropsthe React component properties.

Returns

Element

the React element.


makeColumns

makeColumns(columns): Element[]

Creates table columns based on their descriptions. Internal use only.

Parameters

NameTypeDescription
columnsColumnDescription[]the column descriptions.

Returns

Element[]

the array with React elements.