Optimajet Form Builder

formengine.io

OptimaJet FormBuilder is a powerful React solution that empowers developers and end-users to make front-end drag and drop forms with ease, resulting in cost savings and reduced development time.

llms.txt

This is the documentation for the FormEngine packages.

It contains detailed manuals, components, and utilities for creating user interfaces.

documentation

Complete guide to FormEngine: React form library, drag & drop designer, AI form builder. Learn how to build, validate, and deploy forms in minutes. Free & open source.

FormEngine Documentation - React Form Builder Guide: Complete guide to FormEngine: React form library, drag & drop designer, AI form builder. Learn how to build, validate, and deploy forms in minutes. Free & open source.

search

Search the documentation

adding-wasm-component

Guide to connecting the WASM component

Adding WASM component: Guide to connecting the WASM component

angular-integration

Learn how to integrate FormEngine with Angular to build dynamic forms using reactive and template-driven approaches with live preview and validation.

Integrating FormEngine with Angular: Learn how to integrate FormEngine with Angular to build dynamic forms using reactive and template-driven approaches with live preview and validation.

api-reference

Packages

API reference: Packages
@react-form-builder/components-fast-qr: Interfaces
Interface: FastQrProps: The Fast QR component properties.
Variable: fastQrComponent: const fastQrComponent: Definer\ = fastQr
Variable: fastQrComponentsDescriptions: const fastQrComponentsDescriptions: Record\
Variable: fastQrEnUsComponentsDescriptions: fastQrEnUsComponentsDescriptions: object
Variable: fastQrModel: const fastQrModel: Model\
@react-form-builder/components-google-map: Interfaces
Function: toAddress(): toAddress(components): Address
Interface: GoogleMapProps: Props for the GoogleMap component.
Type Alias: Address: Address = object
Type Alias: MapMarker: MapMarker = object
Variable: googleMapComponent: const googleMapComponent: Definer\ = googleMap
Variable: googleMapComponentsDescriptions: const googleMapComponentsDescriptions: Record\
Variable: googleMapEnUsComponentsDescriptions: googleMapEnUsComponentsDescriptions: object
Variable: googleMapModel: const googleMapModel: Model\
@react-form-builder/components-material-ui: Interfaces
Function: MuiErrorWrapper(): MuiErrorWrapper(props): Element
Interface: BreadcrumbsItem: Settings for a single breadcrumb item.
Interface: MuiBoxProps: The MuiBox component properties.
Interface: MuiBreadcrumbsItemProps: Props for a single breadcrumb item component.
Interface: MuiBreadcrumbsProps: Props for the MuiBreadcrumbs component.
Interface: MuiCardProps: Props for the MuiCard component.
Interface: MuiCheckboxProps: Props for the MuiCheckbox component.
Interface: MuiContainerProps: The MuiContainer component properties.
Interface: MuiControlProps: The props for the MuiControl component.
Interface: MuiDatePickerProps: Props for the MuiDatePicker component.
Interface: MuiDialogProps: Props for the MuiDialog component.
Interface: MuiFormControlLabelProps: Props for the MuiFormControlLabel component.
Interface: MuiFormControlProps: Props for the Material-UI FormControl component.
Interface: MuiListItemProps: The MuiListItem component properties.
Interface: MuiListProps: The MuiList component properties.
Interface: MuiRadioItemProps: Props for the MuiRadioItem component.
Interface: MuiSelectProps: The MuiSelect component properties.
Interface: MuiStackProps: The MuiStack component properties.
Interface: MuiSwitchProps: Props for the MuiSwitch component.
Type Alias: MuiTextFieldProps: MuiTextFieldProps = TextFieldProps & MuiControlProps & object
Variable: builderView: const builderView: BuilderView
Variable: components: const components: BuilderComponent[]
Variable: materialUiComponentsDescriptions: const materialUiComponentsDescriptions: Record\
Variable: models: const models: Model[]
Variable: muiArEgComponentsDescriptions: muiArEgComponentsDescriptions: object
Variable: muiBox: const muiBox: Definer\ & RefAttributes\>
Variable: muiBreadcrumbs: const muiBreadcrumbs: Definer\
Variable: muiButton: const muiButton: Definer\
Variable: muiButtonGroup: const muiButtonGroup: Definer\>>
Variable: muiCard: const muiCard: Definer\
Variable: muiCheckbox: const muiCheckbox: Definer\
Variable: muiCircularProgress: const muiCircularProgress: Definer\
Variable: muiComponents: const muiComponents: Definer[]
Variable: muiContainer: const muiContainer: Definer\ & RefAttributes\>
Variable: muiDatePicker: const muiDatePicker: Definer\
Variable: muiDeDeComponentsDescriptions: muiDeDeComponentsDescriptions: object
Variable: muiDialog: const muiDialog: Definer\
Variable: muiDialogActions: const muiDialogActions: Definer\
Variable: muiDialogContent: const muiDialogContent: Definer\
Variable: muiDialogContentText: const muiDialogContentText: Definer\>>
Variable: muiDialogLayout: const muiDialogLayout: Definer\
Variable: muiDialogTitle: const muiDialogTitle: Definer\>>
Variable: muiEnUsComponentsDescriptions: muiEnUsComponentsDescriptions: object
Variable: muiErrorWrapper: const muiErrorWrapper: Definer\
Variable: muiEsEsComponentsDescriptions: muiEsEsComponentsDescriptions: object
Variable: muiFaIrComponentsDescriptions: muiFaIrComponentsDescriptions: object
Variable: muiFormControlLabel: const muiFormControlLabel: Definer\
Variable: muiFormLabel: const muiFormLabel: Definer\>>
Variable: muiFrFrComponentsDescriptions: muiFrFrComponentsDescriptions: object
Variable: muiHiInComponentsDescriptions: muiHiInComponentsDescriptions: object
Variable: muiItItComponentsDescriptions: muiItItComponentsDescriptions: object
Variable: muiJaJpComponentsDescriptions: muiJaJpComponentsDescriptions: object
Variable: muiKoKrComponentsDescriptions: muiKoKrComponentsDescriptions: object
Variable: muiLinearProgress: const muiLinearProgress: Definer\
Variable: muiLink: const muiLink: Definer\
Variable: muiList: const muiList: Definer\ & RefAttributes\>
Variable: muiListItem: const muiListItem: Definer\ & RefAttributes\>
Variable: MuiLocalizationProvider: const MuiLocalizationProvider: FormViewerWrapper
Variable: muiRadioGroup: const muiRadioGroup: Definer\
Variable: muiRadioItem: const muiRadioItem: Definer\
Variable: muiSelect: const muiSelect: Definer\
Variable: muiSrRsComponentsDescriptions: muiSrRsComponentsDescriptions: object
Variable: muiStack: const muiStack: Definer\ & RefAttributes\>
Variable: muiSwitch: const muiSwitch: Definer\
Variable: muiTextField: const muiTextField: Definer\
Variable: muiTooltip: const muiTooltip: Definer\
Variable: muiTypography: const muiTypography: Definer\>>
Variable: muiUploader: const muiUploader: Definer\
Variable: MuiViewerWrapper: const MuiViewerWrapper: FormViewerWrapper
Variable: muiZhCnComponentsDescriptions: muiZhCnComponentsDescriptions: object
Variable: view: const view: View
@react-form-builder/components-rich-text: Interfaces
Interface: RichTextEditorProps: The Rich text editor component properties.
Variable: richTextComponent: const richTextComponent: Definer\ = richTextEditor
Variable: richTextEditorComponentsDescriptions: const richTextEditorComponentsDescriptions: Record\
Variable: richTextEditorEnUsComponentsDescriptions: richTextEditorEnUsComponentsDescriptions: object
Variable: richTextModel: const richTextModel: Model\
@react-form-builder/components-rsuite-table: Variables
Variable: rSuiteTableComponents: const rSuiteTableComponents: Definer[]
Variable: rSuiteTableComponentsDescriptions: const rSuiteTableComponentsDescriptions: Record\
Variable: rSuiteTableEnUsComponentsDescriptions: rSuiteTableEnUsComponentsDescriptions: object
Variable: tableModels: const tableModels: Model[]
@react-form-builder/components-rsuite: Interfaces
Function: ltrCssLoader(): ltrCssLoader(): Promise\ Promise\>
Function: RsLocalizationWrapper(): RsLocalizationWrapper(props): Element
Function: rtlCssLoader(): rtlCssLoader(): Promise\ Promise\>
Interface: RsAutoCompleteProps: The properties of the RsAutoComplete component.
Interface: RsBreadcrumbItemProps: Props for a single breadcrumb item.
Interface: RsBreadcrumbProps: Props for the RsBreadcrumb component.
Interface: RsCalendarProps: Props for the RsCalendar component.
Interface: RsCardProps: Props for the RsCard component.
Interface: RsContainerProps: Props for the RsContainer component.
Interface: RsDatePickerProps: Props for the RsDatePicker component.
Interface: RsDropdownProps: Props for the RsDropdown component.
Interface: RsErrorMessageProps: The properties of RsErrorMessage component.
Interface: RsHeaderProps: Props for the RsHeader component.
Interface: RsImageProps: Props for the RsImage component.
Interface: RsInputProps: Props for the RsInput component.
Interface: RsLabelProps: Props for the RsLabel component.
Interface: RsLinkProps: Props for the RsLink component.
Interface: RsMenuProps: Props for the RsMenu component.
Interface: RsModalLayoutProps: Props for the RsModalLayout component.
Interface: RsModalProps: Props for the RsModal component.
Interface: RsNumberFormatProps: Props for the RsNumberFormat component.
Interface: RsPatternFormatProps: Props for the RsPatternFormat component.
Interface: RsRadioGroupProps: Props for the RsRadioGroup component.
Interface: RsSearchProps: Props for the RsSearch component.
Interface: RsStaticContentProps: Props for the RsStaticContent component.
Interface: RsTabProps: Props for the RsTab component.
Interface: RsTagPickerProps: Props for the RsTagPicker component.
Interface: RsTextAreaProps: Props for the RsTextArea component.
Interface: RsTimePickerProps: Props for the RsTimePicker component.
Interface: RsTooltipProps: The properties of RsTooltip component.
Interface: RsUploaderProps: Props for the RsUploader component.
Interface: RsWizardProps: Props for the RsWizard component.
Interface: RsWizardStepProps: Props for the RsWizardStep component.
Type Alias: LoadCallback(): LoadCallback = (newData) => void
Type Alias: LoadDataHandler(): LoadDataHandler = (searchKeyword, loadCallback, currentDataLength) => void
Type Alias: MenuItem: MenuItem = object
Type Alias: RsTabItem: RsTabItem = object
Variable: builderViewWithCss: const builderViewWithCss: BuilderView
Variable: components: const components: BuilderComponent[]
Variable: models: const models: Model[]
Variable: rsAutoComplete: const rsAutoComplete: Definer\
Variable: rsBreadcrumb: const rsBreadcrumb: Definer\
Variable: rsButton: const rsButton: Definer\
Variable: rsCalendar: const rsCalendar: Definer\
Variable: rsCard: const rsCard: Definer\
Variable: rsCheckbox: const rsCheckbox: Definer\>
Variable: rsContainer: const rsContainer: Definer\>
Variable: rsDatePicker: const rsDatePicker: Definer\
Variable: rsDivider: const rsDivider: Definer, WithAsProps\> & DividerProps>>>
Variable: rsDropdown: const rsDropdown: Definer\
Variable: rsErrorMessage: const rsErrorMessage: Definer\
Variable: rsHeader: const rsHeader: Definer\
Variable: rsImage: const rsImage: Definer\
Variable: rsInput: const rsInput: Definer\
Variable: rsLabel: const rsLabel: Definer\
Variable: rsLink: const rsLink: Definer\
Variable: rsMenu: const rsMenu: Definer\
Variable: rsMessage: const rsMessage: Definer\
Variable: rsModal: const rsModal: Definer\
Variable: rsModalLayout: const rsModalLayout: Definer\
Variable: rsNumberFormat: const rsNumberFormat: Definer\
Variable: rsPatternFormat: const rsPatternFormat: Definer\
Variable: rsPlaceholderGraph: const rsPlaceholderGraph: Definer, WithAsProps\> & PlaceholderGraphProps>>>
Variable: rsPlaceholderGrid: const rsPlaceholderGrid: Definer, WithAsProps\> & PlaceholderGridProps>>>
Variable: rsPlaceholderParagraph: const rsPlaceholderParagraph: Definer, WithAsProps\> & PlaceholderParagraphProps>>>
Variable: rsProgressCircle: const rsProgressCircle: Definer, WithAsProps\> & ProgressCircleProps>>>
Variable: rsProgressLine: const rsProgressLine: Definer, WithAsProps\> & ProgressLineProps>>>
Variable: rsRadioGroup: const rsRadioGroup: Definer\
Variable: rsSearch: const rsSearch: Definer\
Variable: rsStaticContent: const rsStaticContent: Definer\
Variable: rsTab: const rsTab: Definer\
Variable: rsTagPicker: const rsTagPicker: Definer\
Variable: rsTextArea: const rsTextArea: Definer\
Variable: rsTimePicker: const rsTimePicker: Definer\
Variable: rsToggle: const rsToggle: Definer\
Variable: rsTooltip: const rsTooltip: Definer\
Variable: rSuiteComponents: const rSuiteComponents: Definer[] = []
Variable: rSuiteComponentsDescriptions: const rSuiteComponentsDescriptions: Record\
Variable: rSuiteEnUsComponentsDescriptions: rSuiteEnUsComponentsDescriptions: object
Variable: rsUploader: const rsUploader: Definer\
Variable: rsWizard: const rsWizard: Definer\ & RefAttributes\>
Variable: rsWizardStep: const rsWizardStep: Definer\
Variable: view: const view: View
Variable: viewWithCss: const viewWithCss: View
@react-form-builder/components-signature: Interfaces
Interface: SignatureProps: The Signature pad properties.
Variable: signatureComponent: const signatureComponent: Definer\ = signature
Variable: signatureComponentsDescriptions: const signatureComponentsDescriptions: Record\
Variable: signatureEnUsComponentsDescriptions: signatureEnUsComponentsDescriptions: object
Variable: signatureModel: const signatureModel: Model\
@react-form-builder/components-uploader: Interfaces
Interface: FileType: Represents a file with upload metadata.
Interface: UploaderProps: The properties of the Uploader component.
Type Alias: OnError(): OnError = (error, files?) => void
Type Alias: OnSuccess(): OnSuccess = (files) => void
Variable: uploaderComponent: const uploaderComponent: Definer\ = uploader
Variable: uploaderComponentsDescriptions: const uploaderComponentsDescriptions: Record\
Variable: uploaderEnUsComponentsDescriptions: uploaderEnUsComponentsDescriptions: object
Variable: uploaderModel: const uploaderModel: Model\
@react-form-builder/core: Enumerations
Class: ActionDefinition: Represents the definition of an action.
Class: ActionEventArgs: Arguments passed to the event handler.
Class: Annotation: Basic metadata class for a React component property for the form builder.
Class: AnnotationBuilder: The builder class to define the metadata property of the form builder component.
Class: ArrayBuilder: The builder class to define the metadata property of the form builder component.
Class: BaseBuilder: The base builder class to define the metadata property of the form builder component.
Class: BuilderOptions: Options for building an annotation.
Class: BuilderView: Represents all the metadata of the form builder components.
Class: CalculableResult: Calculable result.
Class: ComponentData: This tree of elements contains the data required to display the component. It is synchronized with the ComponentStore tree.
Class: ComponentDataEvents: Represents a class that holds events related to component data.
Class: ComponentKeyChangedEventArgs: Represents the event argument for the event when the component key changes.
Class: ComponentState: Calculates all the properties of the form view component.
Class: ComponentStore: Component settings for serialization in JSON.
Class: ContainerAnnotation: Metadata for the component container property for the form builder.
Class: DataValidator: Binds all parts of the validation and performs the validation.
Class: EventAnnotation: Metadata for the component event property for the form builder.
Class: FluentLocalizationEngine: Fluent.js implementation of ILocalizationEngine.
Class: Form: Represents a form that is rendered in Viewer or edited in Builder.
Class: FormViewerPropsStore: Represents the props passed to the FormViewer Store. Internal use only.
Class: Language: The language to localize the form builder.
Class: LocalizationStore: Observable storage of localization. Internal use only.
Class: Meta: Component metadata for the form builder.
Class: Model: Represents component metadata for the form viewer.
Class: ModuleAnnotation: Metadata for a component property that is not a property of the component itself,
Class: NodeAnnotationBuilder: The builder class to define the node metadata property.
Class: NoopLocalizationEngine: A no-operation localization engine that provides empty implementations.
Class: OneOfBuilder: The builder class to define the metadata property of the form builder component.
Class: PropertyAnnotation: Metadata for the component property for the form builder.
Class: abstract QuantifierBuilder: The abstract builder class to define the metadata property of the form builder component.
Class: SomeOfBuilder: The builder class to define the metadata property of the form builder component.
Class: Store: The form viewer settings. Internal use only.
Class: StyleAnnotation: Metadata for the component style property for the form builder.
Class: SyncEvent<TSender, TEventArgs>: Represents a synchronous event that can be subscribed to and invoked. Internal use only.
Class: TemplateField: The field with the form data, contains the value of the nested form. Internal use only.
Class: TypedBuilder: The builder class to define the metadata property of the form builder component.
Class: View: Represents all the metadata of the form viewer components.
Enumeration: BiDi: The enumeration of bidirectional text layout types.
Enumeration: PersistedFormVersion: The version of the saved form.
Function: buildForm(): buildForm(options?): IFormJsonBuilder
Function: calculatePropertyValue(): calculatePropertyValue(componentProperty, formViewerData): CalculableResult
Function: camelCase(): camelCase(input): string
Function: checkSlotCondition(): checkSlotCondition(childStore, parentProps): boolean
Function: cloneDeep(): cloneDeep(value, weakMap): T
Function: ComponentTree(): ComponentTree(props): Element
Function: createActionValuesFromObject(): createActionValuesFromObject(obj): ActionValues
Function: createNonNullableContext(): createNonNullableContext(name, defaultValue): [() => T, Provider, Context\]
Function: createProperty(): createProperty(editor): AnnotationBuilder\
Function: debounce(): debounce(fn, wait): (...args) => ReturnType\ | void
Function: findLanguage(): findLanguage(languages, language): Language | undefined
Function: findTreeElementDepth(): findTreeElementDepth(value, element?, depth?): number | undefined
Function: fn(): fn(fnDescriptionBegin, fnDescriptionEnd): TypedBuilder\
Function: forwardRef(): forwardRef(render): ForwardRefExoticComponent\ | ForwardRefExoticComponent\ & RefAttributes\>
Function: generateTemplateTypeName(): generateTemplateTypeName(name): string
Function: generateUniqueName(): generateUniqueName(prefix, existingNames): string
Function: getChildren(): getChildren(data, componentTreeItem, componentProps): Record\
Function: getDefault(): getDefault(annotations): Readonly\>
Function: getDefaultCss(): getDefaultCss(annotations): Readonly\>
Function: getEditableFormData(): getEditableFormData(form): Record\
Function: getKey(): getKey(): string
Function: getTemplateName(): getTemplateName(typeName): string
Function: getValidatorPropertyBlockType(): getValidatorPropertyBlockType(ruleKey): string
Function: groupBy(): groupBy(array, predicate): Record\
Function: isContainer(): isContainer(value): value is ContainerAnnotation
Function: isEmpty(): isEmpty(value): boolean
Function: isEqual(): isEqual(a, b): boolean
Function: isEqualWith(): isEqualWith(a, b, customizer?): boolean
Function: isFunctionalProperty(): isFunctionalProperty(componentProperty?): boolean
Function: isLocalizedProperty(): isLocalizedProperty(componentProperty?): boolean
Function: isNull(): isNull(value): value is null
Function: isNumber(): isNumber(value): value is number
Function: isObject(): isObject(value): value is Record
Function: isPromise(): isPromise(value): value is Promise
Function: isProperty(): isProperty(value): value is PropertyAnnotation
Function: isString(): isString(value): value is string
Function: isTemplateType(): isTemplateType(typeName?): boolean
Function: isUndefined(): isUndefined(value): value is undefined
Function: isValidatorPropertyBlockType(): isValidatorPropertyBlockType(type): boolean
Function: loadResource(): loadResource(id, href, rel): Promise\
Function: merge(): merge(target, ...sources): T
Function: nameAutorun(): nameAutorun(owner, name, params): string
Function: namedObserver(): namedObserver(displayName, component): T
Function: nameObservable(): nameObservable(owner, params): string
Function: needRender(): needRender(componentStore, formData): boolean
Function: reactStylesToCss(): reactStylesToCss(styles, selector?): string
Function: startCase(): startCase(input): string
Function: SuppressResizeObserverErrors(): SuppressResizeObserverErrors(props): Element
Function: toArray(): toArray(annotations?, setup?): Annotation[]
Function: toLabeledValues(): toLabeledValues(items, upper): LabeledValue[]
Function: toUpper(): toUpper(input): string
Function: treeForEach(): treeForEach(tree, fn): void
Function: uniqueId(): uniqueId(prefix): string
Function: unloadResource(): unloadResource(id): void
Function: upperFirst(): upperFirst(input): string
Function: useAriaAttributes(): useAriaAttributes(options): object
Function: useAriaAttributesIds(): useAriaAttributesIds(options): AriaAttributesIds
Function: useAriaErrorMessage(): useAriaErrorMessage(): object
Function: useAriaInvalid(): useAriaInvalid(): object
Function: useBuilderComponent(): useBuilderComponent(builderComponent, viewerComponent, props): ReactElement
Function: useBuilderValue(): useBuilderValue(value, builderValue): T
Function: useDisposable(): useDisposable(factory): T | undefined
Function: useErrorMessage(): useErrorMessage(): string | undefined
Function: useErrorModel(): useErrorModel(): Model\
Function: useMobxConfig(): useMobxConfig(): void
Function: useModalComponentData(): useModalComponentData(parentComponentData, modalType): ComponentData
Function: useModalType(): useModalType(): string | undefined
Function: useTooltipType(): useTooltipType(): string | undefined
Interface: BaseCompilationResult: The result of compiling of anything. Internal use only.
Interface: BuilderComponent: Description of the React component that connects to the form builder.
Interface: ComponentField: Describes the field of the component.
Interface: ComponentMetadataEventListeners: Component metadata event listeners.
Interface: ComponentProperty: The value of the component property.
Interface: ComponentTreeProps: Properties of a form component tree element.
Interface: Definer: The builder class to define the metadata of the form builder component.
Interface: EmbeddedFormProps: The embedded form component properties.
Interface: ErrorWrapperProps: Properties of the React component that wraps the form view component and displays validation errors.
Interface: Field: Field with the form data.
Interface: FormViewerProps: Form viewer React component properties.
Interface: FormViewerWrapperComponentProps: Represents the props for the WrapperComponent. WrapperComponent is a component that wraps the form viewer. Can be added externally.
Interface: IComponentBuilder: Interface for configuring a specific component within the form.
Interface: IComponentDataFactory: The factory for creating ComponentData instances. Internal use only.
Interface: IComponentState: Calculates all the properties of the form view component.
Interface: IDataRootProvider: Provides the root component for the data in the component tree.
Interface: IEventHandlerBuilder: Interface for defining event handlers for a component.
Interface: IForm: A form.
Interface: IFormData: The interface for accessing the form data.
Interface: IFormJsonBuilder: Interface for building a form JSON.
Interface: IFormViewer: The form viewer settings interface.
Interface: ILocalizationEngine: The form localization engine.
Interface: ILocalizationStore: Localization of the form.
Interface: InternalErrorProps: React component properties that display an internal form view error. Internal use only.
Interface: IStore: The form viewer settings interface.
Interface: IValidationBuilder: Interface for defining validation rules for a component.
Interface: IView: Represents all the metadata of the form viewer components.
Interface: LabeledValue: The element with the value and the label.
Interface: LocalizationError: Localization error class.
Interface: PersistedForm: The format for saving a form designed in Form Builder.
Interface: ScreenProps: Properties of the root component of the form. Internal use only.
Interface: SuppressResizeObserverErrorsProps: Represents the props for the SuppressResizeObserverErrors component. Internal use only.
Interface: WrapperProps: React wrapper component properties.
Type Alias: ActionData: ActionData = object
Type Alias: ActionEventHandler(): ActionEventHandler = (e, args?) => Promise\ | void
Type Alias: ActionHandler(): ActionHandler\ = (e, params) => Promise\ | void
Type Alias: ActionParameters: ActionParameters = Record\
Type Alias: ActionsInitializer(): ActionsInitializer = (props, def) => Record\
Type Alias: ActionType: ActionType = "code" | "common" | "custom"
Type Alias: ActionValues: ActionValues = Record\
Type Alias: Annotations: Annotations\ = { [key in keyof T]: BaseBuilder\ | undefined }
Type Alias: AnnotationType: AnnotationType = "Container" | "Event" | "Module" | "Property" | "Style"
Type Alias: Arguments: Arguments = Record\
Type Alias: ArgumentValue: ArgumentValue = FunctionArgumentValue | PrimitiveArgumentValue
Type Alias: AriaAttributesIds: AriaAttributesIds = Record, string>
Type Alias: AriaAttributesOptions: AriaAttributesOptions = object
Type Alias: BoundValueSchema: BoundValueSchema = object
Type Alias: BuilderMode: BuilderMode = "builder" | "viewer"
Type Alias: BuilderSetup: BuilderSetup = Partial\
Type Alias: BuilderTheme: BuilderTheme = "dark" | "light"
Type Alias: CellInfo: CellInfo = object
Type Alias: ComponentDescription: ComponentDescription = I18nItem & object
Type Alias: ComponentDeviceStyle: ComponentDeviceStyle = object
Type Alias: ComponentFeature: ComponentFeature = object
Type Alias: ComponentFeatures: ComponentFeatures = Record\
Type Alias: ComponentKey: ComponentKey = string
Type Alias: ComponentKind: ComponentKind = "component" | "container" | "repeater" | "template"
Type Alias: ComponentLibraryDescription: ComponentLibraryDescription = object
Type Alias: ComponentLocalizer(): ComponentLocalizer = (componentStore, language) => Record\
Type Alias: ComponentPropertiesContext: ComponentPropertiesContext = object
Type Alias: ComponentPropertyBindType: ComponentPropertyBindType = "array" | "single"
Type Alias: ComponentPropertyComputeType: ComponentPropertyComputeType = "function" | "localization"
Type Alias: ComponentPropertyName: ComponentPropertyName = string
Type Alias: ComponentPropsLocalization: ComponentPropsLocalization = Record\
Type Alias: ComponentRole: ComponentRole = "error-message" | "label" | "modal" | string | "tooltip"
Type Alias: ComponentsLocalization: ComponentsLocalization = Record\
Type Alias: ComponentStateFactory(): ComponentStateFactory = (data, store, context?) => IComponentState
Type Alias: ComponentStoreLocalizer(): ComponentStoreLocalizer = (componentStore) => Record\
Type Alias: ComponentStyle: ComponentStyle = object
Type Alias: ComputeChildren(): ComputeChildren = (componentData, componentProps) => Record\
Type Alias: Css: Css = object
Type Alias: CssCleanupFunction(): CssCleanupFunction = () => Promise\
Type Alias: CssLoaderFunction(): CssLoaderFunction = () => Promise\
Type Alias: CssLoaderType: CssLoaderType = BiDi | "common"
Type Alias: CSSObject: CSSObject = Record\
Type Alias: CssPart: CssPart = "css" | "wrapperCss"
Type Alias: CustomActions: CustomActions = Record\
Type Alias: CustomValidationRules: CustomValidationRules = Record\
Type Alias: CustomValidationRuleSettings: CustomValidationRuleSettings = object
Type Alias: DataBindingType: DataBindingType = "none" | "oneWay" | "twoWay"
Type Alias: DataKeyType: DataKeyType = number | string | symbol
Type Alias: DefineActionHelper(): DefineActionHelper = (name, func, params?, description?) => ActionDefinition
Type Alias: DefinerData: DefinerData\ = object
Type Alias: Device: Device = "any" | "desktop" | "mobile" | "tablet"
Type Alias: DeviceStyle: DeviceStyle = object
Type Alias: EditorType: EditorType = string
Type Alias: ErrorMap: ErrorMap = object
Type Alias: ErrorMessageLocalizer(): ErrorMessageLocalizer = (value) => string[] | undefined
Type Alias: EventHandler(): EventHandler = (...args) => unknown
Type Alias: EventName: EventName = string
Type Alias: FieldType: FieldType = "repeater" | "simple" | "template"
Type Alias: FirstParameter: FirstParameter\ = Parameters\[0]
Type Alias: FormBuilderComponentIconName: FormBuilderComponentIconName = typeof iconsList[number]
Type Alias: FormOptions: FormOptions = object
Type Alias: FormValidator(): FormValidator = (data) => Promise\ | undefined>
Type Alias: FormValidators: FormValidators = FormValidator[]
Type Alias: FormViewerValidationRules: FormViewerValidationRules = object
Type Alias: FormViewerWrapper: FormViewerWrapper = ComponentType\
Type Alias: Func(): Func = (...arg) => Promise\ | void
Type Alias: FunctionArgumentValue: FunctionArgumentValue = object
Type Alias: GetInitialDataFn(): GetInitialDataFn = () => unknown
Type Alias: HtmlAttribute: HtmlAttribute = Record\
Type Alias: I18nItem: I18nItem = object
Type Alias: iconsList: iconsList = readonly ["Breadcrumb", "Button", "Card", "Checkbox", "CollectionEditor", "Container", "Content", "CustomBlock", "CustomControl", "DatePicker", "Default", "Dropdown", "Dropzone", "ErrorMessage", "Grid", "GridLayout", "GridView", "Image", "Input", "Label", "Link", "Footer", "Header", "Sidebar", "Menu", "Message", "NumberFormat", "PatternFormat", "ProgressCircle", "ProgressLine", "RadioGroup", "Repeater", "RichTextEditor", "Search", "Signature", "Sparks", "StaticContent", "Tab", "TextArea", "TimePicker", "Toggle", "Tooltip", "TreePicker", "Uploader"]
Type Alias: IDisposable: IDisposable = object
Type Alias: InsertRestrictionFn(): InsertRestrictionFn = (self, target, slot?) => boolean
Type Alias: LanguageFullCode: LanguageFullCode = $-${string}
Type Alias: LocalizationType: LocalizationType = "component" | "modal" | string | "tooltip"
Type Alias: LocalizationValue: LocalizationValue = Record\
Type Alias: MessagesMap: MessagesMap = Record\>
Type Alias: ModalComponentStore: ModalComponentStore = object
Type Alias: NamedActionDefinition: NamedActionDefinition = object
Type Alias: NodeEditorType: NodeEditorType = "node" | "string"
Type Alias: ParameterDefinition: ParameterDefinition\ = [PropertyKey, ParameterType]
Type Alias: ParameterName: ParameterName = string
Type Alias: ParameterType: ParameterType = "boolean" | "function" | "number" | "string"
Type Alias: PreAnnotation: PreAnnotation = Partial\> & Pick\
Type Alias: PrimitiveArgumentValue: PrimitiveArgumentValue = boolean | number | string
Type Alias: PropertyBlockType: PropertyBlockType = "component" | "modal" | string | "tooltip"
Type Alias: PropertyKey: PropertyKey\ = keyof T & string
Type Alias: ReactProperty: ReactProperty = object
Type Alias: Rel: Rel = string | "stylesheet"
Type Alias: ResolvedValidator(): ResolvedValidator = (value, store, getFormData?) => Promise\
Type Alias: RuleValidator(): RuleValidator\ = (value, store, args?, formData?) => Promise\ | RuleValidatorResult
Type Alias: RuleValidatorResult: RuleValidatorResult = boolean | string
Type Alias: SchemaResolver(): SchemaResolver\ = (value) => ResolvedValidator
Type Alias: SchemaType: SchemaType = keyof SchemaTypeMap
Type Alias: SchemaTypeMap: SchemaTypeMap = object
Type Alias: SetInitialDataFn(): SetInitialDataFn = (key, value) => void
Type Alias: Setter(): Setter\ = (value) => void
Type Alias: SyncEventHandler()<TSender, TEventArgs>: SyncEventHandler\ = (source, eventArgs) => void
Type Alias: TemplateProps: TemplateProps = Omit\
Type Alias: TypedLocalization: TypedLocalization = Partial\>
Type Alias: ValidationMessages: ValidationMessages = string] | [MessagesMap | undefined
Type Alias: ValidationResult: ValidationResult = object
Type Alias: ValidationRule: ValidationRule = object
Type Alias: ValidationRuleParameter: ValidationRuleParameter = object
Type Alias: ValidationRuleSet: ValidationRuleSet = Record\
Type Alias: ValidationRuleSettings: ValidationRuleSettings = object
Type Alias: ValidatorFactory(): ValidatorFactory\ = (args) => RuleValidator
Type Alias: Validators: Validators = Partial\>
Type Alias: ValidatorType: ValidatorType = "custom" | "internal"
Type Alias: ViewMode: ViewMode = "desktop" | "mobile" | "tablet"
Variable: ActionEventArgsDeclaration: const ActionEventArgsDeclaration string\n\n /\\n \ The component that triggered the event.\n /\n readonly sender Record\n\n /\\n \ The index of the component in the array, if the component is in the array.\n /\n readonly index? Record\n\n /\\n \ Sets current props of component.\n /\n readonly setUserDefinedProps Record) => void\n\n /\\n \ The form viewer settings.\n /\n readonly store any[]\n\n /\\n \ @returns the event handled by the event handler.\n /\n get event() any\n \n /\\n \ @returns the object for reading and changing form data.\n /\n get data() Record\ | undefined\n\n /\\n \ @returns the object to read and modify root form data.\n /\n get rootData() CellInfo\n\n /\\n \ The user-defined context passed from the form viewer props.\n /\n readonly userContext? any\n}\n"
Variable: array: const array: ArrayBuilder\
Variable: AsyncFunction: const AsyncFunction: Function
Variable: boolean: const boolean: TypedBuilder\
Variable: BuilderModeProvider: BuilderModeProvider: Provider\
Variable: BuilderThemeProvider: BuilderThemeProvider: Provider\
Variable: CellInfoContextProvider: CellInfoContextProvider: Provider\
Variable: cfComponentIsPreset: const cfComponentIsPreset: "component-is-preset" = 'component-is-preset'
Variable: cfDisableActionEditors: const cfDisableActionEditors: "disable-action-editors" = 'disable-action-editors'
Variable: cfDisableAdditionalProperties: const cfDisableAdditionalProperties: "disable-additional-properties" = 'disable-additional-properties'
Variable: cfDisableComponentRemove: const cfDisableComponentRemove: "disable-component-remove" = 'disable-component-remove'
Variable: cfDisableMainComponentProperties: const cfDisableMainComponentProperties: "disable-main-component-properties" = 'disable-main-component-properties'
Variable: cfDisableStyleProperties: const cfDisableStyleProperties: "disable-style-properties" = 'disable-style-properties'
Variable: cfDisableStyles: const cfDisableStyles: "disable-component-styling" = 'disable-component-styling'
Variable: cfDisableStylesForClassNameEditor: const cfDisableStylesForClassNameEditor: "disable-styles-for-classname-editor" = 'disable-styles-for-classname-editor'
Variable: cfDisableTooltipProperties: const cfDisableTooltipProperties: "disable-tooltip-properties" = 'disable-tooltip-properties'
Variable: cfDisableWrapperStyles: const cfDisableWrapperStyles: "disable-component-wrapper-styling" = 'disable-component-wrapper-styling'
Variable: cfEnableInlineStylesEditor: const cfEnableInlineStylesEditor: "enable-inline-styles-editor" = 'enable-inline-styles-editor'
Variable: cfHideFromComponentPalette: const cfHideFromComponentPalette: "hide-from-component-palette" = 'hide-from-component-palette'
Variable: className: const className: Annotation
Variable: color: const color: TypedBuilder\
Variable: commonStyles: const commonStyles: object
Variable: ComponentDataProvider: ComponentDataProvider: Provider\
Variable: containerStyles: const containerStyles: object
Variable: coreComponentsDescriptions: const coreComponentsDescriptions: Record\
Variable: createAnnotation(): const createAnnotation: (editor) => AnnotationBuilder\ = AnnotationBuilder.create
Variable: createView(): const createView: (models) => View = View.create
Variable: cssSize: const cssSize: AnnotationBuilder\
Variable: date: const date: TypedBuilder\
Variable: DefaultWrapper: const DefaultWrapper: ForwardRefExoticComponent\ | ForwardRefExoticComponent\ & RefAttributes\>
Variable: define(): const define: (component, typeName?) => Definer\ = Definer.define
Variable: definePreset(): const definePreset: (name, components) => Definer\ = Definer.definePreset
Variable: DidMountEvent: const DidMountEvent: "onDidMount" = 'onDidMount'
Variable: disabled: const disabled: TypedBuilder\
Variable: embeddedFormMeta: const embeddedFormMeta: Meta
Variable: embeddedFormModel: const embeddedFormModel: Model\
Variable: emptyComponentStore: const emptyComponentStore: ComponentStore
Variable: errorMessageModel: const errorMessageModel: Model\
Variable: event: const event: AnnotationBuilder\
Variable: FormViewer(): const FormViewer: (props) => Element
Variable: FormViewerLite(): const FormViewerLite: (props) => Element
Variable: globalDefaultLanguage: const globalDefaultLanguage: Language
Variable: htmlAttributes: const htmlAttributes: AnnotationBuilder\
Variable: IFormDataDeclaration: const IFormDataDeclaration Record\n\n /\\n \ @returns the object to read and modify parent data (available for array elements).\n /\n get parentData() Record\n\n /\\n \ @returns the {@link Record} with all validation error messages.\n /\n get errors() boolean\n\n /\\n \ @returns A user-defined key-value observable storage. Utilize it to store and share any custom data.\n /\n get state() string) Promise\n\n /\\n \ Returns the validation results without triggering an events and changing the state of the form.\n \ @returns the validation results.\n /\n getValidationResult boolean\n\n /\\n \ Sets the form to its default value.\n \ @param clearInitialData if true, then also clear the initial data. Defaults to true.\n /\n reset(clearInitialData? void\n\n /\\n \ Clears the form data.\n \ @param clearInitialData if true, then also clear the initial data. Defaults to true.\n /\n clear(clearInitialData? void\n\n /\\n \ @returns the index in the array if the component is in the component array.\n /\n index?: number\n}"
Variable: internalErrorModel: const internalErrorModel: Model\
Variable: isUniqueKey: const isUniqueKey: RuleValidator\
Variable: key: const key: Annotation
Variable: KeySymbol: const KeySymbol: typeof KeySymbol
Variable: node: const node: NodeAnnotationBuilder\
Variable: nodeArray: const nodeArray: NodeAnnotationBuilder\
Variable: nonNegNumber: const nonNegNumber: TypedBuilder\
Variable: number: const number: TypedBuilder\
Variable: object: const object: TypedBuilder\
Variable: oneOf(): const oneOf: (...values) => OneOfBuilder\
Variable: oneOfStrict(): const oneOfStrict: (...values) => OneOfBuilder\
Variable: readOnly: const readOnly: TypedBuilder\
Variable: renderWhen: const renderWhen: TypedBuilder\
Variable: required: const required: TypedBuilder\
Variable: screenModel: const screenModel: Model\ & RefAttributes\>
Variable: size: const size: TypedBuilder\
Variable: slotModel: const slotModel: Model\
Variable: someOf(): const someOf: (...values) => SomeOfBuilder\
Variable: StoreContext: StoreContext: Context\
Variable: StoreProvider: StoreProvider: Provider\
Variable: string: const string: TypedBuilder\
Variable: stringNode: const stringNode: NodeAnnotationBuilder\
Variable: time: const time: TypedBuilder\
Variable: timeFormat: const timeFormatmmmm:ss'
Variable: tooltipProps: const tooltipProps: AnnotationBuilder\
Variable: tooltipType: const tooltipType: TypedBuilder\
Variable: useBuilderMode(): useBuilderMode: () => BuilderMode
Variable: useBuilderTheme(): useBuilderTheme: () => BuilderTheme
Variable: useComponentData(): useComponentData: () => ComponentData
Variable: useStore(): useStore: () => Store
[Variable: useViewerProps()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/useViewe