Class: FormViewerPropsStore
Represents the props passed to the FormViewer Store. Internal use only.
Constructors
Constructor
new FormViewerPropsStore(
formViewerProps):FormViewerPropsStore
Constructs a new FormViewerPropsStore from the given FormViewerProps.
Parameters
formViewerProps
the FormViewer props.
Returns
FormViewerPropsStore
the FormViewerPropsStore.
Properties
actions?
optionalactions:ActionValues
Custom actions for the form viewer.
context?
optionalcontext:any
The arbitrary user context.
disabled?
optionaldisabled:boolean
If true, the form is disabled.
errorWrapper?
optionalerrorWrapper:ComponentType<ErrorWrapperProps>
The default error wrapper used when errorType is not specified in the form.
formValidators?
optionalformValidators:FormValidators
The set of functions that validate the form data.
initialData
initialData:
Record<string,unknown> ={}
The initial form data.
localizationEngine?
optionallocalizationEngine:ILocalizationEngine
The localization engine provided via FormViewer props.
localizer?
optionallocalizer:ComponentLocalizer
The function to localize the properties of a component.
propsLanguage?
optionalpropsLanguage:`${string}-${string}`
The full language code passed in the FormViewer properties, e.g. 'en-US'.
readOnly?
optionalreadOnly:boolean
If true, the form is read-only.
showAllValidationErrors?
optionalshowAllValidationErrors:boolean
If true, all validation errors will be displayed.
validators?
optionalvalidators:Partial<Record<keyofSchemaTypeMap,CustomValidationRules>>
The set of metadata of validation rules, grouped by the type of value being validated.
view
view:
IView
The metadata of the form viewer components.
Methods
applyProps()
applyProps(
formViewerProps):void
Applies the given FormViewerProps.
Parameters
formViewerProps
the properties to apply.
Returns
void
clone()
clone():
FormViewerPropsStore
Returns the clone of the FormViewerPropsStore object.
Returns
FormViewerPropsStore
the clone of the FormViewerPropsStore object.