Class: FormViewerPropsStore
@react-form-builder/core.FormViewerPropsStore
Represents the props passed to the FormViewer Store. Internal use only.
Constructors
constructor
• new FormViewerPropsStore(formViewerProps?)
Constructs a new FormViewerPropsStore from the given FormViewerProps.
Parameters
| Name | Type | Description |
|---|---|---|
formViewerProps? | FormViewerProps | the FormViewer props. |
Properties
actions
• Optional actions: ActionValues
Custom actions for the form viewer.
errorWrapper
• Optional errorWrapper: ComponentType<ErrorWrapperProps>
The default error wrapper used when errorType is not specified in the form.
formValidators
• Optional formValidators: FormValidators
The set of functions that validate the form data.
initialData
• initialData: Record<string, unknown> = {}
The initial form data.
localizer
• Optional localizer: ComponentLocalizer
The function to localize the properties of a component.
propsLanguage
• Optional propsLanguage: Language
The full language code passed in the FormViewer properties.
validators
• Optional validators: Partial<Record<keyof SchemaTypeMap, CustomValidationRules>>
The set of metadata of validation rules, grouped by the type of value being validated.
view
• view: View
The metadata of the form viewer components.
Methods
applyProps
▸ applyProps(formViewerProps): void
Applies the given FormViewerProps.
Parameters
| Name | Type | Description |
|---|---|---|
formViewerProps | FormViewerProps | the properties to apply. |
Returns
void
clone
▸ clone(): FormViewerPropsStore
Returns the clone of the FormViewerPropsStore object.
Returns
the clone of the FormViewerPropsStore object.