Interface: FormBuilderProps
@react-form-builder/builder.FormBuilderProps
Properties of the React Form builder component.
Hierarchy
↳
FormBuilderProps
Properties
actions
• Optional actions: ActionDefinition[]
External actions for the form viewer.
Inherited from
componentWrapper
• Optional componentWrapper: ComponentType<any>
The React component that wraps every component in a form.
Inherited from
FormViewerProps.componentWrapper
data
• Optional data: Record<string, unknown>
The initial data of the form.
Inherited from
erroneous
• Optional erroneous: boolean
No use a error wrap component.
Inherited from
event
• Optional event: (stream: EventStream) => void
Type declaration
▸ (stream): void
The function for processing form events.
Parameters
| Name | Type | Description |
|---|---|---|
stream | EventStream | the event stream of the form viewer. |
Returns
void
Inherited from
externalPropertyEditors
• Optional externalPropertyEditors: Record<string, ComponentType>
Custom component property editors.
formName
• Optional formName: string
the form name.
Inherited from
formStorage
• Optional formStorage: FormStorage
The external form storage.
getForm
• Optional getForm: (name?: string) => PersistedForm | Promise<PersistedForm>
Type declaration
▸ (name?): PersistedForm | Promise<PersistedForm>
Loads the form.
Parameters
| Name | Type | Description |
|---|---|---|
name? | string | the form name. |
Returns
PersistedForm | Promise<PersistedForm>
the object or Promise with the form.
Inherited from
language
• Optional language: string
The language of form.
Inherited from
slotWrapper
• Optional slotWrapper: ComponentType<any>
The React component that wraps a template slot.
Inherited from
view
• view: BuilderView
All the metadata of the components of the form builder.
Overrides
viewMode
• Optional viewMode: ViewMode
Display resolution type.