Interface: FormBuilderProps
Properties of the React Form builder component.
Extends
Omit<FormViewerProps,"view">
Properties
actions?
optionalactions:CustomActions
Custom actions for the form viewer.
Inherited from
Omit.actions
builderRef?
optionalbuilderRef:ForwardedRef<IFormBuilder>
The reference to IFormBuilder.
componentWrapper?
optionalcomponentWrapper:ComponentType<any>
The React component that wraps every component in a form. Internal use only.
Inherited from
Omit.componentWrapper
computeChildren?
optionalcomputeChildren:ComputeChildren
Function that calculates all child properties of a component. Internal use only.
Inherited from
Omit.computeChildren
customization?
optionalcustomization:Partial<Record<CustomizableKey,Options>>
The map of customizations for the FormBuilder components.
erroneous?
optionalerroneous: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?
optionalerrorWrapper:ComponentType<ErrorWrapperProps>
The default error wrapper used when errorType is not specified in the form.
Inherited from
Omit.errorWrapper
event()?
optionalevent: (stream) =>void
The function for processing form events. Internal use only.
Parameters
• stream: EventStream
the event stream of the form viewer.
Returns
void
Inherited from
Omit.event
formName?
optionalformName:string
The form name.
Inherited from
Omit.formName
formStorage?
optionalformStorage:IFormStorage
The external form storage.
formValidators?
optionalformValidators:FormValidators
The set of functions that validate the form data.
Inherited from
Omit.formValidators
getForm()?
optionalgetForm: (name?) =>string|Promise<string>
Loads the form.
Parameters
• name?: string
the form name.
Returns
string | Promise<string>
the string or Promise with the form.
Inherited from
Omit.getForm
i18n?
optionali18n:FormBuilderI18n
The i18n data of the form builder.
initialData?
optionalinitialData:Record<string,unknown>
The initial data of the form.
Inherited from
Omit.initialData
language?
optionallanguage:Language
The language of form.
Inherited from
Omit.language
licenseKey?
optionallicenseKey:string
The FormEngine license key.
Inherited from
Omit.licenseKey
localize?
optionallocalize:ComponentLocalizer
The function to localize the properties of a component.
Inherited from
Omit.localize
onFormDataChange()?
optionalonFormDataChange: (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
onFormSchemaChange()?
optionalonFormSchemaChange: (formSchema) =>void
The event is called whenever a form schema changes.
Parameters
• formSchema: string
the current form schema serialized to JSON.
Returns
void
propertyEditors?
optionalpropertyEditors:Record<string,ComponentType<AnnotationEditorProps>>
Custom component property editors. Attention! Unstable API.
readOnly?
optionalreadOnly:boolean
If true, the form is read-only.
Inherited from
Omit.readOnly
showAllValidationErrors?
optionalshowAllValidationErrors:boolean
If true, all validation errors will be displayed.
Inherited from
Omit.showAllValidationErrors
theme?
optionaltheme:FormBuilderTheme
Indicates the theme preference.
validators?
optionalvalidators:Partial<Record<keyofSchemaTypeMap,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?
optionalviewMode:ViewMode
Display resolution type.
Inherited from
Omit.viewMode
viewerRef?
optionalviewerRef:ForwardedRef<IFormViewer>
The reference to IFormViewer.
Inherited from
Omit.viewerRef