Interface: FormBuilderProps

Properties of the React Form builder component.

Extends

• Omit<FormViewerProps, "language" | "view">

Properties

actions?

optional actions?: CustomActions

Custom actions for the form viewer.

Inherited from

Omit.actions

---

builderRef?

optional builderRef?: ForwardedRef<IFormBuilder>

The reference to IFormBuilder.

---

componentWrapper?

optional componentWrapper?: ComponentType<any>

The React component that wraps every component in a form. Internal use only.

Inherited from

Omit.componentWrapper

---

context?

optional context?: any

The arbitrary context used internally by the form viewer.

Inherited from

Omit.context

---

customization?

optional customization?: Partial<Record<string, Options>>

The map of customizations for the FormBuilder components.

---

defaultBuilderLanguage?

optional defaultBuilderLanguage?: `${string}-${string}`

The builder language. When set, it selects the matching entry among FormBuilderI18n.languages.

---

defaultViewerLanguage?

optional defaultViewerLanguage?: `${string}-${string}`

The initial language of the form viewer (form localization preview), e.g. 'en-US'. Unlike the removed FormViewerProps.language prop, this value is only used for the initial selection and does not lock the viewer language.

---

disabled?

optional disabled?: boolean

If true, the form is disabled.

Inherited from

Omit.disabled

---

errors?

optional errors?: Record<string, unknown>

The form validation errors.

Inherited from

Omit.errors

---

errorWrapper?

optional errorWrapper?: ComponentType<ErrorWrapperProps>

The default error wrapper used when errorType is not specified in the form.

Inherited from

Omit.errorWrapper

---

formName?

optional formName?: string

The form name. Updating the value triggers the FormViewerProps.getForm function.

Inherited from

Omit.formName

---

formOptions?

optional formOptions?: any

The form options. Used to transfer any options to the FormViewerProps.getForm function. Updating the value triggers the FormViewerProps.getForm function.

Inherited from

Omit.formOptions

---

formStorage?

optional formStorage?: IFormStorage

The external form storage.

---

formValidators?

optional formValidators?: FormValidators

The set of functions that validate the form data.

Inherited from

Omit.formValidators

---

generateJsonFormSchema?

optional generateJsonFormSchema?: (options) => string

The JSON schema generator for a form.

Parameters

options

GenerateJsonFormSchemaOptions

the generator options.

Returns

string

the JSON schema in string format.

---

getForm?

optional getForm?: (name?, options?) => Promise<string> | string

Loads the form.

Parameters

name?

string

the form name.

options?

any

the form options.

Returns

Promise<string> | string

the string or Promise with the form.

Inherited from

Omit.getForm

---

i18n?

optional i18n?: FormBuilderI18n

The i18n data of the form builder.

---

initialData?

optional initialData?: Record<string, unknown>

The initial data of the form.

Inherited from

Omit.initialData

---

initialState?

optional initialState?: Record<string, unknown>

The initial user-defined state for the form. This object is set into IFormData.state when the form is initialized, this property is reactive.

Inherited from

Omit.initialState

---

jsonSchemaFilename?

optional jsonSchemaFilename?: string

The file name for the generated JSON schema.

---

licenseKey?

optional licenseKey?: string

The FormEngine license key.

---

localizationEngine?

optional localizationEngine?: ILocalizationEngine

The localization engine used by the viewer.

Inherited from

Omit.localizationEngine

---

localize?

optional localize?: ComponentLocalizer

The function to localize the properties of a component.

Inherited from

Omit.localize

---

localStoragePrefix?

optional localStoragePrefix?: string

The prefix for localStorage keys.

---

onBuilderLanguageChange?

optional onBuilderLanguageChange?: (language) => void

A callback invoked when the language is changed in the Builder.

Parameters

language

Language

the language.

Returns

void

---

onFormDataChange?

optional onFormDataChange?: (data) => void

The event is called whenever a form data changes.

Parameters

data

IFormData

the IFormData with all the form data.

Returns

void

Inherited from

Omit.onFormDataChange

---

onFormElementAdd?

optional onFormElementAdd?: (payload) => void

Callback invoked when a component is added to the form.

Parameters

payload

the payload with information about the added component.

insertPosition?

InsertPosition

presetName?

string

slot?

string

slotCondition?

string

source

ComponentData

target

ComponentData

Returns

void

---

onFormElementRemove?

optional onFormElementRemove?: (payload) => void

Callback invoked when a component is removed from the form.

Parameters

payload

the payload with information about the removed component.

source

ComponentData

Returns

void

---

onFormSchemaChange?

optional onFormSchemaChange?: (formSchema) => void

The event is called whenever a form schema changes.

Parameters

formSchema

string

the current form schema serialized to JSON.

Returns

void

---

onViewerLanguageChange?

optional onViewerLanguageChange?: (language) => void

A callback invoked when the form's language is changed.

Parameters

language

Language

the language.

Returns

void

---

persistFormName?

optional persistFormName?: boolean

If true, the form name will be saved to localStorage and restored when the Form builder is reopened. This functionality is enabled by default.

---

presetComponentOptions?

optional presetComponentOptions?: IPresetComponentOptions

The preset component options.

---

propertyEditors?

optional propertyEditors?: Record<string, ComponentType<AnnotationEditorProps>>

Custom component property editors. Attention! Unstable API.

---

readOnly?

optional readOnly?: boolean

If true, the form is read-only.

Inherited from

Omit.readOnly

---

showAllValidationErrors?

optional showAllValidationErrors?: boolean

If true, all validation errors will be displayed.

Inherited from

Omit.showAllValidationErrors

---

stylesProvider?

optional stylesProvider?: ComponentType<StylesProviderProps>

The component that loads the CSS.

---

theme?

optional theme?: FormBuilderTheme

Indicates the theme preference.

---

userContext?

optional userContext?: unknown

The arbitrary context object passed to the form viewer. It is forwarded to custom actions as the third argument of the handler.

Inherited from

Omit.userContext

---

validators?

optional validators?: Partial<Record<keyof SchemaTypeMap, CustomValidationRules>>

The set of metadata of validation rules, grouped by the type of value being validated.

Inherited from

Omit.validators

---

view

view: BuilderView

All the metadata of the components of the form builder.

---

viewerRef?

optional viewerRef?: ForwardedRef<IFormViewer>

The reference to IFormViewer.

Inherited from

Omit.viewerRef

---

viewMode?

optional viewMode?: ViewMode

Display resolution type.

Inherited from

Omit.viewMode