Interface: IStore
@react-form-builder/core.IStore
The form viewer settings interface.
Implemented by
Properties
dispose
• dispose: () => void
Type declaration
▸ (): void
Correctly clears allocated resources, the function must be called when destroying an instance of the class.
Returns
void
form
• form: Form
The displayed form.
localizeErrorMessages
• localizeErrorMessages: (componentStore: ComponentStore, validationResults?: ValidationResult[]) => undefined | string
Type declaration
▸ (componentStore, validationResults?): undefined | string
The function to localize the validation error message.
Parameters
| Name | Type | Description |
|---|---|---|
componentStore | ComponentStore | the component settings. |
validationResults? | ValidationResult[] | the results of the validation. |
Returns
undefined | string
the result of localization or undefined.
reduceScreen
• reduceScreen: <T>(callback: (accumulator: T, current: ComponentData) => T, initialValue: T) => T
Type declaration
▸ <T>(callback, initialValue): T
Performs the callback function on each element of the component tree, accumulates the return values.
Type parameters
| Name | Description |
|---|---|
T | the return value type. |
Parameters
| Name | Type | Description |
|---|---|---|
callback | (accumulator: T, current: ComponentData) => T | the function that calculates the value for the accumulator. |
initialValue | T | the initial value for the accumulator. |
Returns
T
the accumulated value.
Accessors
initialDataSlice
• get initialDataSlice(): undefined | Record<string, unknown>
Returns
undefined | Record<string, unknown>
the slice of the initial data in accordance with the Store hierarchy. Internal use only.