Interface: FormBuilderProps
@react-form-builder/designer.FormBuilderProps
Properties of the React Form builder component.
Hierarchy
Omit<FormViewerProps,"view">↳
FormBuilderProps
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
computeChildren
• Optional computeChildren: ComputeChildren
Function that calculates all child properties of a component. Internal use only.
Inherited from
Omit.computeChildren
customization
• Optional customization: Partial<Record<CustomizableKey, Options>>
The map of customizations for the FormBuilder components.
erroneous
• Optional erroneous: boolean
If true, the component will not be wrapped by the error display component. Attention! Don't use it! Unstable API.
Inherited from
Omit.erroneous
errorWrapper
• Optional errorWrapper: ComponentType<ErrorWrapperProps>
The default error wrapper used when errorType is not specified in the form.
Inherited from
Omit.errorWrapper
event
• Optional event: (stream: EventStream) => void
Type declaration
▸ (stream): void
The function for processing form events. Internal use only.
Parameters
| Name | Type | Description |
|---|---|---|
stream | EventStream | the event stream of the form viewer. |
Returns
void
Inherited from
Omit.event
formName
• Optional formName: string
The form name.
Inherited from
Omit.formName
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
getForm
• Optional getForm: (name?: string) => string | Promise<string>
Type declaration
▸ (name?): string | Promise<string>
Loads the form.
Parameters
| Name | Type | Description |
|---|---|---|
name? | string | the form name. |
Returns
string | Promise<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
language
• Optional language: Language
The language of form.
Inherited from
Omit.language
licenseKey
• Optional licenseKey: string
The FormEngine license key.
Inherited from
Omit.licenseKey
localize
• Optional localize: ComponentLocalizer
The function to localize the properties of a component.
Inherited from
Omit.localize
onFormDataChange
• Optional onFormDataChange: (data: IFormData) => void
Type declaration
▸ (data): void
The event is called whenever a form data changes.
Parameters
| Name | Type | Description |
|---|---|---|
data | IFormData | the IFormData with all the form data. |
Returns
void
Inherited from
Omit.onFormDataChange
propertyEditors
• Optional propertyEditors: Record<string, ComponentType<AnnotationEditorProps>>
Custom component property editors. Attention! Unstable API.
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.
viewMode
• Optional viewMode: ViewMode
Display resolution type.
Inherited from
Omit.viewMode
viewerRef
• Optional viewerRef: ForwardedRef<IFormViewer>
The reference to IFormViewer.
Inherited from
Omit.viewerRef