# Documentation | FormBuilder ## Docs - [@react-form-builder/components-fast-qr](api-reference/@react-form-builder/components-fast-qr/index): Interfaces - [Interface: FastQrProps](api-reference/@react-form-builder/components-fast-qr/interfaces/FastQrProps): The Fast QR component properties. - [Variable: fastQrComponent](api-reference/@react-form-builder/components-fast-qr/variables/fastQrComponent): const fastQrComponent: Definer\ = fastQr - [Variable: fastQrModel](api-reference/@react-form-builder/components-fast-qr/variables/fastQrModel): const fastQrModel: Model\ - [Function: toAddress()](api-reference/@react-form-builder/components-google-map/functions/toAddress): toAddress(components): Address - [@react-form-builder/components-google-map](api-reference/@react-form-builder/components-google-map/index): Interfaces - [Interface: GoogleMapProps](api-reference/@react-form-builder/components-google-map/interfaces/GoogleMapProps): Props for the GoogleMap component. - [Type Alias: Address](api-reference/@react-form-builder/components-google-map/type-aliases/Address): Address: object - [Type Alias: MapMarker](api-reference/@react-form-builder/components-google-map/type-aliases/MapMarker): MapMarker: object - [Variable: googleMapComponent](api-reference/@react-form-builder/components-google-map/variables/googleMapComponent): const googleMapComponent: Definer\ = googleMap - [Variable: googleMapModel](api-reference/@react-form-builder/components-google-map/variables/googleMapModel): const googleMapModel: Model\ - [@react-form-builder/components-rich-text](api-reference/@react-form-builder/components-rich-text/index): Interfaces - [Interface: RichTextEditorProps](api-reference/@react-form-builder/components-rich-text/interfaces/RichTextEditorProps): The Rich text editor component properties. - [Variable: richTextComponent](api-reference/@react-form-builder/components-rich-text/variables/richTextComponent): const richTextComponent: Definer\ = richTextEditor - [Variable: richTextModel](api-reference/@react-form-builder/components-rich-text/variables/richTextModel): const richTextModel: Model\ - [Function: formEngineRsuiteCssLoader()](api-reference/@react-form-builder/components-rsuite/functions/formEngineRsuiteCssLoader): formEngineRsuiteCssLoader(): Promise\ - [Function: ltrCssLoader()](api-reference/@react-form-builder/components-rsuite/functions/ltrCssLoader): ltrCssLoader(): Promise\ - [Function: RsLocalizationWrapper()](api-reference/@react-form-builder/components-rsuite/functions/RsLocalizationWrapper): RsLocalizationWrapper(props): Element - [Function: rtlCssLoader()](api-reference/@react-form-builder/components-rsuite/functions/rtlCssLoader): rtlCssLoader(): Promise\ - [@react-form-builder/components-rsuite](api-reference/@react-form-builder/components-rsuite/index): Interfaces - [Interface: RsErrorMessageProps](api-reference/@react-form-builder/components-rsuite/interfaces/RsErrorMessageProps): The properties of RsErrorMessage component. - [Interface: RsTooltipProps](api-reference/@react-form-builder/components-rsuite/interfaces/RsTooltipProps): The properties of RsTooltip component. - [Variable: builderViewWithCss](api-reference/@react-form-builder/components-rsuite/variables/builderViewWithCss): const builderViewWithCss: BuilderView - [Variable: models](api-reference/@react-form-builder/components-rsuite/variables/models): const models: Model\[] - [Variable: rsErrorMessage](api-reference/@react-form-builder/components-rsuite/variables/rsErrorMessage): const rsErrorMessage: Definer\ - [Variable: rsTooltip](api-reference/@react-form-builder/components-rsuite/variables/rsTooltip): const rsTooltip: Definer\ - [Variable: rSuiteComponents](api-reference/@react-form-builder/components-rsuite/variables/rSuiteComponents): const rSuiteComponents: Definer\[] = [] - [Variable: view](api-reference/@react-form-builder/components-rsuite/variables/view): const view: View - [Variable: viewWithCss](api-reference/@react-form-builder/components-rsuite/variables/viewWithCss): const viewWithCss: View - [@react-form-builder/components-signature](api-reference/@react-form-builder/components-signature/index): Interfaces - [Interface: SignatureProps](api-reference/@react-form-builder/components-signature/interfaces/SignatureProps): The Signature pad properties. - [Variable: signatureComponent](api-reference/@react-form-builder/components-signature/variables/signatureComponent): const signatureComponent: Definer\ = signature - [Variable: signatureModel](api-reference/@react-form-builder/components-signature/variables/signatureModel): const signatureModel: Model\ - [Class: ActionDefinition](api-reference/@react-form-builder/core/classes/ActionDefinition): Represents the definition of an action. - [Class: ActionEventArgs](api-reference/@react-form-builder/core/classes/ActionEventArgs): Arguments passed to the event handler. - [Class: Annotation](api-reference/@react-form-builder/core/classes/Annotation): Basic metadata class for a React component property for the form builder. - [Class: AnnotationBuilder\](api-reference/@react-form-builder/core/classes/AnnotationBuilder): The builder class to define the metadata property of the form builder component. - [Class: ArrayBuilder\](api-reference/@react-form-builder/core/classes/ArrayBuilder): The builder class to define the metadata property of the form builder component. - [Class: BaseBuilder\](api-reference/@react-form-builder/core/classes/BaseBuilder): The base builder class to define the metadata property of the form builder component. - [Class: BuilderOptions](api-reference/@react-form-builder/core/classes/BuilderOptions): Options for building an annotation. - [Class: BuilderView](api-reference/@react-form-builder/core/classes/BuilderView): Represents all the metadata of the form builder components. - [Class: CalculableResult](api-reference/@react-form-builder/core/classes/CalculableResult): Calculable result. - [Class: ComponentData](api-reference/@react-form-builder/core/classes/ComponentData): This tree of elements contains the data required to display the component. It is synchronized with the ComponentStore tree. - [Class: ComponentDataEvents](api-reference/@react-form-builder/core/classes/ComponentDataEvents): Represents a class that holds events related to component data. - [Class: ComponentKeyChangedEventArgs](api-reference/@react-form-builder/core/classes/ComponentKeyChangedEventArgs): Represents the event argument for the event when the component key changes. - [Class: ComponentState](api-reference/@react-form-builder/core/classes/ComponentState): Calculates all the properties of the form view component. - [Class: ComponentStore](api-reference/@react-form-builder/core/classes/ComponentStore): Component settings for serialization in JSON. - [Class: ContainerAnnotation](api-reference/@react-form-builder/core/classes/ContainerAnnotation): Metadata for the component container property for the form builder. - [Class: DataValidator](api-reference/@react-form-builder/core/classes/DataValidator): Binds all parts of the validation and performs the validation. - [Class: Definer\](api-reference/@react-form-builder/core/classes/Definer): The builder class to define the metadata of the form builder component. - [Class: EventAnnotation](api-reference/@react-form-builder/core/classes/EventAnnotation): Metadata for the component event property for the form builder. - [Class: Form](api-reference/@react-form-builder/core/classes/Form): Represents a form that is rendered in Viewer or edited in Builder. - [Class: FormViewerPropsStore](api-reference/@react-form-builder/core/classes/FormViewerPropsStore): Represents the props passed to the FormViewer Store. Internal use only. - [Class: Language](api-reference/@react-form-builder/core/classes/Language): The language to localize the form builder. - [Class: LocalizationStore](api-reference/@react-form-builder/core/classes/LocalizationStore): Observable storage of localization. Internal use only. - [Class: Meta](api-reference/@react-form-builder/core/classes/Meta): Component metadata for the form builder. - [Class: Model\](api-reference/@react-form-builder/core/classes/Model): Represents component metadata for the form viewer. - [Class: ModuleAnnotation](api-reference/@react-form-builder/core/classes/ModuleAnnotation): Metadata for a component property that is not a property of the component itself, - [Class: NodeAnnotationBuilder\](api-reference/@react-form-builder/core/classes/NodeAnnotationBuilder): The builder class to define the node metadata property. - [Class: OneOfBuilder\](api-reference/@react-form-builder/core/classes/OneOfBuilder): The builder class to define the metadata property of the form builder component. - [Class: PropertyAnnotation](api-reference/@react-form-builder/core/classes/PropertyAnnotation): Metadata for the component property for the form builder. - [Class: abstract QuantifierBuilder\](api-reference/@react-form-builder/core/classes/QuantifierBuilder): The abstract builder class to define the metadata property of the form builder component. - [Class: SomeOfBuilder\](api-reference/@react-form-builder/core/classes/SomeOfBuilder): The builder class to define the metadata property of the form builder component. - [Class: Store](api-reference/@react-form-builder/core/classes/Store): The form viewer settings. Internal use only. - [Class: StyleAnnotation](api-reference/@react-form-builder/core/classes/StyleAnnotation): Metadata for the component style property for the form builder. - [Class: SyncEvent\](api-reference/@react-form-builder/core/classes/SyncEvent): Represents a synchronous event that can be subscribed to and invoked. Internal use only. - [Class: TemplateField](api-reference/@react-form-builder/core/classes/TemplateField): The field with the form data, contains the value of the nested form. Internal use only. - [Class: TypedBuilder\](api-reference/@react-form-builder/core/classes/TypedBuilder): The builder class to define the metadata property of the form builder component. - [Class: View](api-reference/@react-form-builder/core/classes/View): Represents all the metadata of the form viewer components. - [Enumeration: BiDi](api-reference/@react-form-builder/core/enumerations/BiDi): The enumeration of bidirectional text layout types. - [Enumeration: PersistedFormVersion](api-reference/@react-form-builder/core/enumerations/PersistedFormVersion): The version of the saved form. - [Function: BuilderModeProvider()](api-reference/@react-form-builder/core/functions/BuilderModeProvider): BuilderModeProvider(props): null \| ReactElement\\> - [Function: buildForm()](api-reference/@react-form-builder/core/functions/buildForm): buildForm(options?): IFormJsonBuilder - [Function: calculatePropertyValue()](api-reference/@react-form-builder/core/functions/calculatePropertyValue): calculatePropertyValue(componentProperty, formViewerData): CalculableResult - [Function: checkSlotCondition()](api-reference/@react-form-builder/core/functions/checkSlotCondition): checkSlotCondition(childStore, parentProps): any - [Function: ComponentDataProvider()](api-reference/@react-form-builder/core/functions/ComponentDataProvider): ComponentDataProvider(props): null \| ReactElement\\> - [Function: ComponentTree()](api-reference/@react-form-builder/core/functions/ComponentTree): ComponentTree(props): Element - [Function: createActionValuesFromObject()](api-reference/@react-form-builder/core/functions/createActionValuesFromObject): createActionValuesFromObject(obj): ActionValues - [Function: createAnnotation()](api-reference/@react-form-builder/core/functions/createAnnotation): createAnnotation\(editor): AnnotationBuilder\ - [Function: createNonNullableContext()](api-reference/@react-form-builder/core/functions/createNonNullableContext): createNonNullableContext\(name, defaultValue): [() => T, Provider\, Context\] - [Function: createProperty()](api-reference/@react-form-builder/core/functions/createProperty): createProperty(editor): AnnotationBuilder\ - [Function: createView()](api-reference/@react-form-builder/core/functions/createView): createView(models): View - [Function: DefaultWrapper()](api-reference/@react-form-builder/core/functions/DefaultWrapper): DefaultWrapper(props): Element - [Function: define()](api-reference/@react-form-builder/core/functions/define): define\(component, displayName?): Definer\ - [Function: definePreset()](api-reference/@react-form-builder/core/functions/definePreset): definePreset(name, components): Definer\ - [Function: findLanguage()](api-reference/@react-form-builder/core/functions/findLanguage): findLanguage(languages, language): Language \| undefined - [Function: findTreeElementDepth()](api-reference/@react-form-builder/core/functions/findTreeElementDepth): findTreeElementDepth\(value, element?, depth?): number \| undefined - [Function: FormViewer()](api-reference/@react-form-builder/core/functions/FormViewer): FormViewer(props): Element - [Function: forwardRef()](api-reference/@react-form-builder/core/functions/forwardRef): forwardRef\(render): ForwardRefExoticComponent\ \| ForwardRefExoticComponent\ & RefAttributes\\> - [Function: generateTemplateTypeName()](api-reference/@react-form-builder/core/functions/generateTemplateTypeName): generateTemplateTypeName(name): string - [Function: generateUniqueName()](api-reference/@react-form-builder/core/functions/generateUniqueName): generateUniqueName(prefix, existingNames): string - [Function: getChildren()](api-reference/@react-form-builder/core/functions/getChildren): getChildren(data, componentTreeItem, componentProps): Record\ - [Function: getDefault()](api-reference/@react-form-builder/core/functions/getDefault): getDefault(annotations): Readonly\\> - [Function: getDefaultCss()](api-reference/@react-form-builder/core/functions/getDefaultCss): getDefaultCss(annotations): Readonly\\> - [Function: getFluentCompatibleId()](api-reference/@react-form-builder/core/functions/getFluentCompatibleId): getFluentCompatibleId(rawId): string - [Function: getFluentData()](api-reference/@react-form-builder/core/functions/getFluentData): getFluentData(data, parentKey): Record\ - [Function: getKey()](api-reference/@react-form-builder/core/functions/getKey): getKey(): string - [Function: getValidatorPropertyBlockType()](api-reference/@react-form-builder/core/functions/getValidatorPropertyBlockType): getValidatorPropertyBlockType(ruleKey): string - [Function: groupBy()](api-reference/@react-form-builder/core/functions/groupBy): groupBy\(array, predicate): Record\ - [Function: initFormFields()](api-reference/@react-form-builder/core/functions/initFormFields): initFormFields(form): Record\ - [Function: isContainer()](api-reference/@react-form-builder/core/functions/isContainer): isContainer(value): value is ContainerAnnotation - [Function: isFunctionalProperty()](api-reference/@react-form-builder/core/functions/isFunctionalProperty): isFunctionalProperty(componentProperty?): boolean - [Function: isLocalizedProperty()](api-reference/@react-form-builder/core/functions/isLocalizedProperty): isLocalizedProperty(componentProperty?): boolean - [Function: isPromise()](api-reference/@react-form-builder/core/functions/isPromise): isPromise\(value): value is Promise - [Function: isProperty()](api-reference/@react-form-builder/core/functions/isProperty): isProperty(value): value is PropertyAnnotation - [Function: isString()](api-reference/@react-form-builder/core/functions/isString): isString(value): value is string - [Function: isUniqueKey()](api-reference/@react-form-builder/core/functions/isUniqueKey): isUniqueKey(value, store, args?, formData?): RuleValidatorResult \| Promise\ - [Function: isValidatorPropertyBlockType()](api-reference/@react-form-builder/core/functions/isValidatorPropertyBlockType): isValidatorPropertyBlockType(type): boolean - [Function: loadResource()](api-reference/@react-form-builder/core/functions/loadResource): loadResource(id, href, rel): Promise\ - [Function: nameAutorun()](api-reference/@react-form-builder/core/functions/nameAutorun): nameAutorun(owner, name, params): string - [Function: namedObserver()](api-reference/@react-form-builder/core/functions/namedObserver): namedObserver\(displayName, component): T - [Function: nameObservable()](api-reference/@react-form-builder/core/functions/nameObservable): nameObservable(owner, params): string - [Function: oneOf()](api-reference/@react-form-builder/core/functions/oneOf): oneOf\(...values): OneOfBuilder\ - [Function: SDiv()](api-reference/@react-form-builder/core/functions/SDiv): SDiv(props): Element - [Function: someOf()](api-reference/@react-form-builder/core/functions/someOf): someOf\(...values): SomeOfBuilder\ - [Function: StoreContext()](api-reference/@react-form-builder/core/functions/StoreContext): StoreContext(props): null \| ReactElement\\> - [Function: StoreProvider()](api-reference/@react-form-builder/core/functions/StoreProvider): StoreProvider(props): null \| ReactElement\\> - [Function: SuppressResizeObserverErrors()](api-reference/@react-form-builder/core/functions/SuppressResizeObserverErrors): SuppressResizeObserverErrors(props): Element - [Function: testFluentLocalization()](api-reference/@react-form-builder/core/functions/testFluentLocalization): testFluentLocalization(request): CalculableResult - [Function: toArray()](api-reference/@react-form-builder/core/functions/toArray): toArray\(annotations?, setup?): Annotation[] - [Function: toLabeledValues()](api-reference/@react-form-builder/core/functions/toLabeledValues): toLabeledValues(items, upper): object[] - [Function: treeForEach()](api-reference/@react-form-builder/core/functions/treeForEach): treeForEach\(tree, fn): void - [Function: unloadResource()](api-reference/@react-form-builder/core/functions/unloadResource): unloadResource(id): void - [Function: useAriaAttributes()](api-reference/@react-form-builder/core/functions/useAriaAttributes): useAriaAttributes(): object - [Function: useAriaAttributesIds()](api-reference/@react-form-builder/core/functions/useAriaAttributesIds): useAriaAttributesIds(): AriaAttributesIds - [Function: useAriaInvalid()](api-reference/@react-form-builder/core/functions/useAriaInvalid): useAriaInvalid(): object - [Function: useBuilderMode()](api-reference/@react-form-builder/core/functions/useBuilderMode): useBuilderMode(): BuilderMode - [Function: useComponentData()](api-reference/@react-form-builder/core/functions/useComponentData): useComponentData(): ComponentData - [Function: useDisposable()](api-reference/@react-form-builder/core/functions/useDisposable): useDisposable\(factory): T \| undefined - [Function: useErrorModel()](api-reference/@react-form-builder/core/functions/useErrorModel): useErrorModel(): Model\ - [Function: useStore()](api-reference/@react-form-builder/core/functions/useStore): useStore(): Store - [Function: useTooltipType()](api-reference/@react-form-builder/core/functions/useTooltipType): useTooltipType(): undefined \| string - [Function: useViewerProps()](api-reference/@react-form-builder/core/functions/useViewerProps): useViewerProps(): Readonly\ - [Function: ViewerPropsProvider()](api-reference/@react-form-builder/core/functions/ViewerPropsProvider): ViewerPropsProvider(props): null \| ReactElement\\> - [@react-form-builder/core](api-reference/@react-form-builder/core/index): Enumerations - [Interface: BaseCompilationResult](api-reference/@react-form-builder/core/interfaces/BaseCompilationResult): The result of compiling of anything. Internal use only. - [Interface: BuilderComponent](api-reference/@react-form-builder/core/interfaces/BuilderComponent): Description of the React component that connects to the form builder. - [Interface: ComponentField](api-reference/@react-form-builder/core/interfaces/ComponentField): Describes the field of the component. - [Interface: ComponentMetadataEventListeners](api-reference/@react-form-builder/core/interfaces/ComponentMetadataEventListeners): Component metadata event listeners. - [Interface: ComponentProperty](api-reference/@react-form-builder/core/interfaces/ComponentProperty): The value of the component property. - [Interface: ComponentTreeProps](api-reference/@react-form-builder/core/interfaces/ComponentTreeProps): Properties of a form component tree element. - [Interface: ErrorWrapperProps](api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps): Properties of the React component that wraps the form view component and displays validation errors. - [Interface: Field](api-reference/@react-form-builder/core/interfaces/Field): Field with the form data. - [Interface: FormViewerProps](api-reference/@react-form-builder/core/interfaces/FormViewerProps): Form viewer React component properties. - [Interface: FormViewerWrapperComponentProps](api-reference/@react-form-builder/core/interfaces/FormViewerWrapperComponentProps): Represents the props for the WrapperComponent. WrapperComponent is a component that wraps the form viewer. Can be added externally. - [Interface: IComponentBuilder](api-reference/@react-form-builder/core/interfaces/IComponentBuilder): Interface for configuring a specific component within the form. - [Interface: IComponentDataFactory](api-reference/@react-form-builder/core/interfaces/IComponentDataFactory): The factory for creating ComponentData instances. Internal use only. - [Interface: IComponentState](api-reference/@react-form-builder/core/interfaces/IComponentState): Calculates all the properties of the form view component. - [Interface: IDataRootProvider](api-reference/@react-form-builder/core/interfaces/IDataRootProvider): Provides the root component for the data in the component tree. - [Interface: IEventHandlerBuilder](api-reference/@react-form-builder/core/interfaces/IEventHandlerBuilder): Interface for defining event handlers for a component. - [Interface: IFormData](api-reference/@react-form-builder/core/interfaces/IFormData): The interface for accessing the form data. - [Interface: IFormJsonBuilder](api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder): Interface for building a form JSON. - [Interface: IFormViewer](api-reference/@react-form-builder/core/interfaces/IFormViewer): The form viewer settings interface. - [Interface: InternalErrorProps](api-reference/@react-form-builder/core/interfaces/InternalErrorProps): React component properties that display an internal form view error. Internal use only. - [Interface: IStore](api-reference/@react-form-builder/core/interfaces/IStore): The form viewer settings interface. - [Interface: IValidationBuilder](api-reference/@react-form-builder/core/interfaces/IValidationBuilder): Interface for defining validation rules for a component. - [Interface: LabeledValue](api-reference/@react-form-builder/core/interfaces/LabeledValue): The element with the value and the label. - [Interface: PersistedForm](api-reference/@react-form-builder/core/interfaces/PersistedForm): The format for saving a form designed in Form Builder. - [Interface: ScreenProps](api-reference/@react-form-builder/core/interfaces/ScreenProps): Properties of the root component of the form. Internal use only. - [Interface: SuppressResizeObserverErrorsProps](api-reference/@react-form-builder/core/interfaces/SuppressResizeObserverErrorsProps): Represents the props for the SuppressResizeObserverErrors component. Internal use only. - [Interface: WrapperProps](api-reference/@react-form-builder/core/interfaces/WrapperProps): React wrapper component properties. - [Type Alias: ActionData](api-reference/@react-form-builder/core/type-aliases/ActionData): ActionData: object - [Type Alias: ActionEventHandler()](api-reference/@react-form-builder/core/type-aliases/ActionEventHandler): ActionEventHandler: (e) => void \| Promise\ - [Type Alias: ActionHandler()\](api-reference/@react-form-builder/core/type-aliases/ActionHandler): ActionHandler\: (e, params) => void \| Promise\ - [Type Alias: ActionParameters](api-reference/@react-form-builder/core/type-aliases/ActionParameters): ActionParameters: Record\ - [Type Alias: ActionsInitializer()](api-reference/@react-form-builder/core/type-aliases/ActionsInitializer): ActionsInitializer: (props, def) => Record\ - [Type Alias: ActionType](api-reference/@react-form-builder/core/type-aliases/ActionType): ActionType: "common" \| "code" \| "custom" - [Type Alias: ActionValues](api-reference/@react-form-builder/core/type-aliases/ActionValues): ActionValues: Record\ - [Type Alias: Annotations\](api-reference/@react-form-builder/core/type-aliases/Annotations): Annotations\ BaseBuilder\ \| undefined \} - [Type Alias: AnnotationType](api-reference/@react-form-builder/core/type-aliases/AnnotationType): AnnotationType: "Property" \| "Container" \| "Event" \| "Module" \| "Style" - [Type Alias: Arguments](api-reference/@react-form-builder/core/type-aliases/Arguments): Arguments: Record\ - [Type Alias: ArgumentValue](api-reference/@react-form-builder/core/type-aliases/ArgumentValue): ArgumentValue: string \| number \| boolean - [Type Alias: BoundValueSchema](api-reference/@react-form-builder/core/type-aliases/BoundValueSchema): BoundValueSchema: object - [Type Alias: BuilderMode](api-reference/@react-form-builder/core/type-aliases/BuilderMode): BuilderMode: "builder" \| "viewer" - [Type Alias: BuilderSetup](api-reference/@react-form-builder/core/type-aliases/BuilderSetup): BuilderSetup: Partial\ - [Type Alias: ComponentKey](api-reference/@react-form-builder/core/type-aliases/ComponentKey): ComponentKey: string - [Type Alias: ComponentKind](api-reference/@react-form-builder/core/type-aliases/ComponentKind): ComponentKind: "container" \| "component" \| "slot" \| "template" \| "repeater" \| "preset" - [Type Alias: ComponentLocalizer()](api-reference/@react-form-builder/core/type-aliases/ComponentLocalizer): ComponentLocalizer: (componentStore, language) => Record\ - [Type Alias: ComponentPropertyBindType](api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType): ComponentPropertyBindType: "single" \| "array" - [Type Alias: ComponentPropertyComputeType](api-reference/@react-form-builder/core/type-aliases/ComponentPropertyComputeType): ComponentPropertyComputeType: "function" \| "localization" - [Type Alias: ComponentPropertyName](api-reference/@react-form-builder/core/type-aliases/ComponentPropertyName): ComponentPropertyName: string - [Type Alias: ComponentPropsLocalization](api-reference/@react-form-builder/core/type-aliases/ComponentPropsLocalization): ComponentPropsLocalization: Record\ - [Type Alias: ComponentsLocalization](api-reference/@react-form-builder/core/type-aliases/ComponentsLocalization): ComponentsLocalization: Record\ - [Type Alias: ComponentStateFactory()](api-reference/@react-form-builder/core/type-aliases/ComponentStateFactory): ComponentStateFactory: (data, store) => IComponentState - [Type Alias: ComponentStoreLocalizer()](api-reference/@react-form-builder/core/type-aliases/ComponentStoreLocalizer): ComponentStoreLocalizer: (componentStore) => Record\ - [Type Alias: ComputeChildren()](api-reference/@react-form-builder/core/type-aliases/ComputeChildren): ComputeChildren: (componentData, componentProps) => Record\ - [Type Alias: Css](api-reference/@react-form-builder/core/type-aliases/Css): Css: object - [Type Alias: CssLoaderType](api-reference/@react-form-builder/core/type-aliases/CssLoaderType): CssLoaderType: BiDi \| "common" - [Type Alias: CssPart](api-reference/@react-form-builder/core/type-aliases/CssPart): CssPart: "css" \| "wrapperCss" - [Type Alias: CustomActions](api-reference/@react-form-builder/core/type-aliases/CustomActions): CustomActions: Record\ - [Type Alias: CustomValidationRules](api-reference/@react-form-builder/core/type-aliases/CustomValidationRules): CustomValidationRules: Record\ - [Type Alias: CustomValidationRuleSettings](api-reference/@react-form-builder/core/type-aliases/CustomValidationRuleSettings): CustomValidationRuleSettings: object - [Type Alias: DefineActionHelper()](api-reference/@react-form-builder/core/type-aliases/DefineActionHelper): DefineActionHelper: \(name, func, params?, description?) => ActionDefinition - [Type Alias: DefinerData\](api-reference/@react-form-builder/core/type-aliases/DefinerData): DefinerData\: object - [Type Alias: Device](api-reference/@react-form-builder/core/type-aliases/Device): Device: "any" \| "desktop" \| "mobile" \| "tablet" - [Type Alias: DeviceStyle](api-reference/@react-form-builder/core/type-aliases/DeviceStyle): DeviceStyle: object - [Type Alias: EditorType](api-reference/@react-form-builder/core/type-aliases/EditorType): EditorType: string - [Type Alias: ErrorMap](api-reference/@react-form-builder/core/type-aliases/ErrorMap): ErrorMap: object - [Type Alias: ErrorMessageLocalizer()](api-reference/@react-form-builder/core/type-aliases/ErrorMessageLocalizer): ErrorMessageLocalizer: (value) => string \| undefined - [Type Alias: EventName](api-reference/@react-form-builder/core/type-aliases/EventName): EventName: string - [Type Alias: FieldType](api-reference/@react-form-builder/core/type-aliases/FieldType): FieldType: "simple" \| "template" \| "repeater" - [Type Alias: FirstParameter\](api-reference/@react-form-builder/core/type-aliases/FirstParameter): FirstParameter\: Parameters\\[0\] - [Type Alias: FormOptions](api-reference/@react-form-builder/core/type-aliases/FormOptions): FormOptions: object - [Type Alias: FormValidator()](api-reference/@react-form-builder/core/type-aliases/FormValidator): FormValidator: (data) => Promise\ \| undefined\> - [Type Alias: FormValidators](api-reference/@react-form-builder/core/type-aliases/FormValidators): FormValidators: FormValidator[] - [Type Alias: FormViewerValidationRules](api-reference/@react-form-builder/core/type-aliases/FormViewerValidationRules): FormViewerValidationRules: object - [Type Alias: FormViewerWrapper](api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper): FormViewerWrapper: ComponentType\ - [Type Alias: Func()](api-reference/@react-form-builder/core/type-aliases/Func): Func: (...arg) => void \| Promise\ - [Type Alias: GetInitialDataFn()](api-reference/@react-form-builder/core/type-aliases/GetInitialDataFn): GetInitialDataFn: () => unknown - [Type Alias: HtmlAttribute](api-reference/@react-form-builder/core/type-aliases/HtmlAttribute): HtmlAttribute: Record\ - [Type Alias: IDisposable](api-reference/@react-form-builder/core/type-aliases/IDisposable): IDisposable: object - [Type Alias: InsertRestrictionFn()](api-reference/@react-form-builder/core/type-aliases/InsertRestrictionFn): InsertRestrictionFn: (self, target, slot?) => boolean - [Type Alias: LanguageFullCode](api-reference/@react-form-builder/core/type-aliases/LanguageFullCode): LanguageFullCode: \$\{string\}-$\{string\}\ - [Type Alias: LocalizationTestRequest](api-reference/@react-form-builder/core/type-aliases/LocalizationTestRequest): LocalizationTestRequest: object - [Type Alias: LocalizationType](api-reference/@react-form-builder/core/type-aliases/LocalizationType): LocalizationType: "component" \| "tooltip" \| string - [Type Alias: LocalizationValue](api-reference/@react-form-builder/core/type-aliases/LocalizationValue): LocalizationValue: Record\ - [Type Alias: MessagesMap](api-reference/@react-form-builder/core/type-aliases/MessagesMap): MessagesMap: Record\\> - [Type Alias: NamedActionDefinition](api-reference/@react-form-builder/core/type-aliases/NamedActionDefinition): NamedActionDefinition: object - [Type Alias: ParameterDefinition\](api-reference/@react-form-builder/core/type-aliases/ParameterDefinition): ParameterDefinition\: [PropertyKey\, ParameterType] - [Type Alias: ParameterName](api-reference/@react-form-builder/core/type-aliases/ParameterName): ParameterName: string - [Type Alias: ParameterType](api-reference/@react-form-builder/core/type-aliases/ParameterType): ParameterType: "string" \| "number" \| "boolean" - [Type Alias: PreAnnotation](api-reference/@react-form-builder/core/type-aliases/PreAnnotation): PreAnnotation: Partial\\> & Pick\ - [Type Alias: PropertyBlockType](api-reference/@react-form-builder/core/type-aliases/PropertyBlockType): PropertyBlockType: "component" \| "tooltip" \| string - [Type Alias: PropertyKey\](api-reference/@react-form-builder/core/type-aliases/PropertyKey): PropertyKey\: keyof T & string - [Type Alias: Rel](api-reference/@react-form-builder/core/type-aliases/Rel): Rel: "stylesheet" \| string - [Type Alias: ResolvedValidator()](api-reference/@react-form-builder/core/type-aliases/ResolvedValidator): ResolvedValidator: (value, store, getFormData?) => Promise\ - [Type Alias: RuleValidator()\](api-reference/@react-form-builder/core/type-aliases/RuleValidator): RuleValidator\: (value, store, args?, formData?) => RuleValidatorResult \| Promise\ - [Type Alias: RuleValidatorResult](api-reference/@react-form-builder/core/type-aliases/RuleValidatorResult): RuleValidatorResult: string \| boolean - [Type Alias: SchemaResolver()\](api-reference/@react-form-builder/core/type-aliases/SchemaResolver): SchemaResolver\: (value) => ResolvedValidator - [Type Alias: SchemaType](api-reference/@react-form-builder/core/type-aliases/SchemaType): SchemaType: keyof SchemaTypeMap - [Type Alias: SchemaTypeMap](api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap): SchemaTypeMap: object - [Type Alias: Setter()\](api-reference/@react-form-builder/core/type-aliases/Setter): Setter\: (value) => void - [Type Alias: SyncEventHandler()\](api-reference/@react-form-builder/core/type-aliases/SyncEventHandler): SyncEventHandler\: (source, eventArgs) => void - [Type Alias: TypedLocalization](api-reference/@react-form-builder/core/type-aliases/TypedLocalization): TypedLocalization: Partial\\> - [Type Alias: ValidationMessages](api-reference/@react-form-builder/core/type-aliases/ValidationMessages): ValidationMessages: string] \| [MessagesMap \| undefined - [Type Alias: ValidationResult](api-reference/@react-form-builder/core/type-aliases/ValidationResult): ValidationResult: object - [Type Alias: ValidationRule](api-reference/@react-form-builder/core/type-aliases/ValidationRule): ValidationRule: object - [Type Alias: ValidationRuleParameter](api-reference/@react-form-builder/core/type-aliases/ValidationRuleParameter): ValidationRuleParameter: object - [Type Alias: ValidationRuleSet](api-reference/@react-form-builder/core/type-aliases/ValidationRuleSet): ValidationRuleSet: Record\ - [Type Alias: ValidationRuleSettings](api-reference/@react-form-builder/core/type-aliases/ValidationRuleSettings): ValidationRuleSettings: object - [Type Alias: ValidatorFactory()\](api-reference/@react-form-builder/core/type-aliases/ValidatorFactory): ValidatorFactory\: (args) => RuleValidator - [Type Alias: Validators](api-reference/@react-form-builder/core/type-aliases/Validators): Validators: Partial\\> - [Type Alias: ValidatorType](api-reference/@react-form-builder/core/type-aliases/ValidatorType): ValidatorType: "internal" \| "custom" - [Type Alias: ViewMode](api-reference/@react-form-builder/core/type-aliases/ViewMode): ViewMode: "desktop" \| "mobile" \| "tablet" - [Variable: ActionEventArgsDeclaration](api-reference/@react-form-builder/core/variables/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? (props Store\n\n /\\\n \ The event arguments.\n \/\n readonly args SyntheticEvent \| null\n\n /\\\n \ @returns the first element of the event argument array, which is treated as a value.\n \/\n get value() Record\\n \n /\\\n \ @returns the object to read and modify parent data (available for array elements).\n \/\n get parentData() Record\\n\}\n" - [Variable: array](api-reference/@react-form-builder/core/variables/array): const array: ArrayBuilder\ - [Variable: AsyncFunction](api-reference/@react-form-builder/core/variables/AsyncFunction): const AsyncFunction: Function - [Variable: boolean](api-reference/@react-form-builder/core/variables/boolean): const boolean: TypedBuilder\ - [Variable: className](api-reference/@react-form-builder/core/variables/className): const className: Annotation - [Variable: color](api-reference/@react-form-builder/core/variables/color): const color: TypedBuilder\ - [Variable: commonStyles](api-reference/@react-form-builder/core/variables/commonStyles): const commonStyles: object - [Variable: containerStyles](api-reference/@react-form-builder/core/variables/containerStyles): const containerStyles: object - [Variable: cssSize](api-reference/@react-form-builder/core/variables/cssSize): const cssSize: AnnotationBuilder\ - [Variable: date](api-reference/@react-form-builder/core/variables/date): const date: TypedBuilder\ - [Variable: DidMountEvent](api-reference/@react-form-builder/core/variables/DidMountEvent): const DidMountEvent: "onDidMount" = 'onDidMount' - [Variable: disabled](api-reference/@react-form-builder/core/variables/disabled): const disabled: TypedBuilder\ - [Variable: emotionCache](api-reference/@react-form-builder/core/variables/emotionCache): const emotionCache: object - [Variable: emptyComponentStore](api-reference/@react-form-builder/core/variables/emptyComponentStore): const emptyComponentStore: ComponentStore - [Variable: errorMessageModel](api-reference/@react-form-builder/core/variables/errorMessageModel): const errorMessageModel: Model\ - [Variable: event](api-reference/@react-form-builder/core/variables/event): const event: AnnotationBuilder\ - [Variable: globalDefaultLanguage](api-reference/@react-form-builder/core/variables/globalDefaultLanguage): const globalDefaultLanguage: Language - [Variable: htmlAttributes](api-reference/@react-form-builder/core/variables/htmlAttributes): const htmlAttributes: AnnotationBuilder\ - [Variable: IFormDataDeclaration](api-reference/@react-form-builder/core/variables/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 \/\n reset() 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](api-reference/@react-form-builder/core/variables/internalErrorModel): const internalErrorModel: Model\ - [Variable: key](api-reference/@react-form-builder/core/variables/key): const key: Annotation - [Variable: KeySymbol](api-reference/@react-form-builder/core/variables/KeySymbol): const KeySymbol: typeof KeySymbol - [Variable: node](api-reference/@react-form-builder/core/variables/node): const node: NodeAnnotationBuilder\ - [Variable: nodeArray](api-reference/@react-form-builder/core/variables/nodeArray): const nodeArray: NodeAnnotationBuilder\ - [Variable: number](api-reference/@react-form-builder/core/variables/number): const number: TypedBuilder\ - [Variable: object](api-reference/@react-form-builder/core/variables/object): const object: TypedBuilder\ - [Variable: readOnly](api-reference/@react-form-builder/core/variables/readOnly): const readOnly: TypedBuilder\ - [Variable: renderWhen](api-reference/@react-form-builder/core/variables/renderWhen): const renderWhen: TypedBuilder\ - [Variable: screenModel](api-reference/@react-form-builder/core/variables/screenModel): const screenModel: Model\, HTMLDivElement\>\> - [Variable: size](api-reference/@react-form-builder/core/variables/size): const size: TypedBuilder\ - [Variable: slotModel](api-reference/@react-form-builder/core/variables/slotModel): const slotModel: Model\ - [Variable: string](api-reference/@react-form-builder/core/variables/string): const string: TypedBuilder\ - [Variable: time](api-reference/@react-form-builder/core/variables/time): const time: TypedBuilder\ - [Variable: timeFormat](api-reference/@react-form-builder/core/variables/timeFormat): const timeFormatmmmm:ss' - [Variable: tooltipProps](api-reference/@react-form-builder/core/variables/tooltipProps): const tooltipProps: AnnotationBuilder\ - [Variable: tooltipType](api-reference/@react-form-builder/core/variables/tooltipType): const tooltipType: TypedBuilder\ - [Variable: validation](api-reference/@react-form-builder/core/variables/validation): const validation: AnnotationBuilder\ - [Variable: WillUnmountEvent](api-reference/@react-form-builder/core/variables/WillUnmountEvent): const WillUnmountEvent: "onWillUnmount" = 'onWillUnmount' - [Class: ActionDefinition](api-reference/@react-form-builder/designer-bundle/classes/ActionDefinition): Represents the definition of an action. - [Class: Language](api-reference/@react-form-builder/designer-bundle/classes/Language): The language to localize the form builder. - [Function: buildForm()](api-reference/@react-form-builder/designer-bundle/functions/buildForm): buildForm(options?): IFormJsonBuilder - [Function: renderFormBuilder()](api-reference/@react-form-builder/designer-bundle/functions/renderFormBuilder): renderFormBuilder(elementId, props): Root - [Function: renderFormBuilderTo()](api-reference/@react-form-builder/designer-bundle/functions/renderFormBuilderTo): renderFormBuilderTo(container, props): Root - [@react-form-builder/designer-bundle](api-reference/@react-form-builder/designer-bundle/index): Classes - [Class: BuilderView](api-reference/@react-form-builder/designer/classes/BuilderView): Represents all the metadata of the form builder components. - [Class: PresetComponentLocalStorage](api-reference/@react-form-builder/designer/classes/PresetComponentLocalStorage): Class for working with the preset components in the local storage. - [Function: ActionCell()](api-reference/@react-form-builder/designer/functions/ActionCell): ActionCell(props): Element - [Function: CheckCell()](api-reference/@react-form-builder/designer/functions/CheckCell): CheckCell(props): Element - [Function: EditableTable()](api-reference/@react-form-builder/designer/functions/EditableTable): EditableTable(props): Element - [Function: FormBuilder()](api-reference/@react-form-builder/designer/functions/FormBuilder): FormBuilder(props): Element - [Function: InputCell()](api-reference/@react-form-builder/designer/functions/InputCell): InputCell(props): Element - [Function: makeColumns()](api-reference/@react-form-builder/designer/functions/makeColumns): makeColumns(columns): Element[] - [Function: SCell()](api-reference/@react-form-builder/designer/functions/SCell): SCell(props): null \| ReactElement\ - [Function: SelectCell()](api-reference/@react-form-builder/designer/functions/SelectCell): SelectCell(props): Element - [Function: useFormBuilder()](api-reference/@react-form-builder/designer/functions/useFormBuilder): useFormBuilder(): IFormBuilder - [@react-form-builder/designer](api-reference/@react-form-builder/designer/index): Classes - [Interface: ActionCellProps](api-reference/@react-form-builder/designer/interfaces/ActionCellProps): The properties of ActionCell component. - [Interface: AnnotationEditorProps](api-reference/@react-form-builder/designer/interfaces/AnnotationEditorProps): Props for the AnnotationEditor component. - [Interface: CalculableEditorProps](api-reference/@react-form-builder/designer/interfaces/CalculableEditorProps): Represents the props used to edit a calculable property. - [Interface: ColumnDescription](api-reference/@react-form-builder/designer/interfaces/ColumnDescription): The description of the table column. - [Interface: EditableTableProps](api-reference/@react-form-builder/designer/interfaces/EditableTableProps): The React component properties for the EditableTable component. - [Interface: EditableTableState](api-reference/@react-form-builder/designer/interfaces/EditableTableState): The state of the EditableTable component. - [Interface: FormBuilderProps](api-reference/@react-form-builder/designer/interfaces/FormBuilderProps): Properties of the React Form builder component. - [Interface: IFormBuilder](api-reference/@react-form-builder/designer/interfaces/IFormBuilder): The form builder settings interface. - [Interface: IFormStorage](api-reference/@react-form-builder/designer/interfaces/IFormStorage): Interface for storing forms in an external storage. - [Interface: InputCellProps](api-reference/@react-form-builder/designer/interfaces/InputCellProps): The properties of InputCell component. - [Interface: IPresetComponentOptions](api-reference/@react-form-builder/designer/interfaces/IPresetComponentOptions): Interface for configuring preset component options. - [Interface: PresetComponent](api-reference/@react-form-builder/designer/interfaces/PresetComponent): The preset component settings. - [Interface: SelectCellProps](api-reference/@react-form-builder/designer/interfaces/SelectCellProps): The properties of SelectCell component. - [Type Alias: ComputePropertiesParameters](api-reference/@react-form-builder/designer/type-aliases/ComputePropertiesParameters): ComputePropertiesParameters: object - [Type Alias: ComputeTypeParams\](api-reference/@react-form-builder/designer/type-aliases/ComputeTypeParams): ComputeTypeParams\: ComputePropertiesParameters\[T\] - [Type Alias: CustomizableKey](api-reference/@react-form-builder/designer/type-aliases/CustomizableKey): CustomizableKey never - [Type Alias: CustomizationMap](api-reference/@react-form-builder/designer/type-aliases/CustomizationMap): CustomizationMap: Partial\\> - [Type Alias: FormBuilderI18n](api-reference/@react-form-builder/designer/type-aliases/FormBuilderI18n): FormBuilderI18n: object - [Type Alias: FormBuilderI18nData](api-reference/@react-form-builder/designer/type-aliases/FormBuilderI18nData): FormBuilderI18nData: object - [Type Alias: FormBuilderTheme](api-reference/@react-form-builder/designer/type-aliases/FormBuilderTheme): FormBuilderTheme: "light" \| "dark" \| "system" - [Type Alias: LocalizationComputeCodeParams](api-reference/@react-form-builder/designer/type-aliases/LocalizationComputeCodeParams): LocalizationComputeCodeParams: object - [Type Alias: Options](api-reference/@react-form-builder/designer/type-aliases/Options): Options: object - [Variable: CustomizableZone](api-reference/@react-form-builder/designer/variables/CustomizableZone): const CustomizableZone: Set\ - [Class: ActionDefinition](api-reference/@react-form-builder/viewer-bundle/classes/ActionDefinition): Represents the definition of an action. - [Class: Language](api-reference/@react-form-builder/viewer-bundle/classes/Language): The language to localize the form builder. - [Function: buildForm()](api-reference/@react-form-builder/viewer-bundle/functions/buildForm): buildForm(options?): IFormJsonBuilder - [Function: renderFormViewer()](api-reference/@react-form-builder/viewer-bundle/functions/renderFormViewer): renderFormViewer(elementId, props): Root - [Function: renderFormViewerTo()](api-reference/@react-form-builder/viewer-bundle/functions/renderFormViewerTo): renderFormViewerTo(container, props): Root - [@react-form-builder/viewer-bundle](api-reference/@react-form-builder/viewer-bundle/index): Namespaces - [Function: formEngineRsuiteCssLoader()](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/formEngineRsuiteCssLoader): formEngineRsuiteCssLoader(): Promise\ - [Function: ltrCssLoader()](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/ltrCssLoader): ltrCssLoader(): Promise\ - [Function: RsLocalizationWrapper()](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/RsLocalizationWrapper): RsLocalizationWrapper(props): Element - [Function: rtlCssLoader()](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/rtlCssLoader): rtlCssLoader(): Promise\ - [rSuiteComponents](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/index): Index - [Interface: RsErrorMessageProps](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps): The properties of RsErrorMessage component. - [Interface: RsTooltipProps](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTooltipProps): The properties of RsTooltip component. - [Variable: builderViewWithCss](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/builderViewWithCss): const builderViewWithCss: BuilderView - [Variable: models](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/models): const models: Model\[] - [Variable: rsErrorMessage](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsErrorMessage): const rsErrorMessage: Definer\ - [Variable: rsTooltip](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTooltip): const rsTooltip: Definer\ - [Variable: rSuiteComponents](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponents): const rSuiteComponents: Definer\[] = [] - [Variable: view](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/view): const view: View - [Variable: viewWithCss](api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/viewWithCss): const viewWithCss: View - [API reference](api-reference/index): Packages - [Calendar](components-library/fields/calendar): The Calendar component enables you to add a calendar to your form. - [Checkbox](components-library/fields/checkbox): Allows your users to confirm or agree with your provided statement - [DatePicker](components-library/fields/date-picker): Highly customizable component that enables users to enter and pick dates and times in different formats - [Dropdown](components-library/fields/dropdown): Dropdown is a component that is used to create a list of predefined choices and options. - [Google Map](components-library/fields/google-map): The Google Map component enables you to add an interactive map with customizable markers and controls. - [Input](components-library/fields/input): The Input component is a text input field that allows users to enter and edit text - [Number format](components-library/fields/number-format): Powerful input formatter that allows you to restrict and format user input to specific numeric or string patterns - [Pattern format](components-library/fields/pattern-format): Pattern format is used for formatting and displaying numbers and numeric values according to your specified pattern - [Radio group](components-library/fields/radio-group): Allows users to select one option from a list of choices. - [Rich text editor](components-library/fields/rich-text-editor): Powerful text editor. - [Search](components-library/fields/search): Allows users to search for specific information within your specified dataset - [Signature](components-library/fields/signature): A field that allows users to create and capture their handwritten signatures digitally. - [Tag picker](components-library/fields/tag-picker): Allows users to select one or multiple tags from a predefined list. - [Text area](components-library/fields/text-area): Multi-line input field that allows users to enter and edit text - [TimePicker](components-library/fields/time-picker): A component that allows users to enter and select time in various formats. - [Toggle](components-library/fields/toggle): Switch that allows users to select one of two mutually exclusive options - [Uploader](components-library/fields/uploader): Used to upload data or attach files to the form - [Components library](components-library/index): Components based on the React Suite package are available in the - [React Suite components](components-library/rsuite-components): The list of React Suite components used in the FormEngine library. - [Button](components-library/static/button): Clickable element that allows users to perform an action or trigger an event - [Error message](components-library/static/error-message): Used to display an error message to the user, typically in response to form validation error - [Header](components-library/static/header): Text element that displays a title or heading - [Image](components-library/static/image): Enables to upload and customize images - [Label](components-library/static/label): Used to provide descriptive text or captions - [Link](components-library/static/link): Creates a hyperlink to another webpage, email address, or file - [Menu](components-library/static/menu): Navigation menu that provides a list of links to different sections - [Message](components-library/static/message): Displays a message or notification to the user - [Progress Circle](components-library/static/progress-circle): Represents a circular progress indicator for users - [Progress Line](components-library/static/progress-line): Provides a linear progress indicator for users - [QR code](components-library/static/qr-code): Displays QR-code with or without a picture inside it - [Static Content](components-library/static/static-content): Displays static text content within an HTML span tag - [Tooltip](components-library/static/tooltip): Text box that appears when users interact with your component - [Breadcrumb](components-library/structure/breadcrumb): Displays a hierarchical trail of links - [Card](components-library/structure/card): Creates organized layout for your components - [Container](components-library/structure/container): Wraps other components, providing a way to group and organize content - [Repeater](components-library/structure/repeater): Displays a repeating set of components - [Tab](components-library/structure/tab): Allows users to switch between different views or panels - [Wizard](components-library/structure/wizard): Allows users to create multistep forms or wizards. - [Wizard step](components-library/structure/wizard-step): Allows users to add steps to the Wizard component. - [Slot](components-library/templates/slot): Used to display the components of the parent form in the child form - [Form Builder](documentation): Form Builder is a client-side library for creating web forms. The library allows you to map a form from JSON to a dynamic HTML form and send - [External API access](faq/external-api-access): You can access the desired API via custom actions, which are called on a specific event, such as onClick. - [Getting form data](faq/getting-form-data): If you need to retrieve data from a form when the user fills it out, you can - [Getting form JSON](faq/getting-form-json): Getting form JSON. - [Storing user-defined data](faq/storing-user-defined-data): Each component that implements IFormData can maintain a user-defined data - [Theme manipulation](faq/theme-manipulation): How to set a designer theme (light, dark, or system theme). - [Actions](features/actions): Overview - [Adaptive layout](features/adaptive-layout): Form Builder allows you to set different styles for different layouts. In the "For device" drop-down menu on the "Style" tab, you - [Component styling](features/component-styling): Overview - [Computed properties](features/computed-properties): When designing a form in the designer, you can set the values of the component properties in the right pane. Opposite the component - [Conditional rendering](features/conditional-rendering): Overview - [Custom components](features/custom-components): Overview - [Designer customization](features/designer-customization): Customizing the FormBuilder interface - [Designer localization](features/designer-localization): Using custom languages in Designer can greatly enhance your project by allowing you to target a specific audience or customize the user - [Disabled and read-only](features/disabled-and-read-only): How to make a form or part of it disabled or read-only - [Form storage](features/form-storage): By default, the designer does not use external form stores. In this mode you can create forms, export and import forms to JSON files. - [Form's JSON](features/forms-json): Each form created in the form designer is JSON. With the designer, you can export a form to JSON, and you can import a form from JSON. - [Localization](features/localization): Overview - [Nested components](features/nested-components): Form Builder supports nested components out of the box. There are two types of nested components: - [Preset components](features/preset-component): Create a preset component in Designer - [User defined properties](features/user-defined-props): How to override the properties of a component in runtime. - [Using tabs](features/using-tabs): Imagine you have a component that displays tabs. As an example, let's use the Nav component from - [Validation](features/validation): Overview - [Getting started](getting-started/index): Read articles about using FormEngine. - [Installation](getting-started/installation): Installing the Designer and Viewer packages of FormEngine. - [Overview](getting-started/overview): Overview of FormEngine's NPM packages. - [Usage](getting-started/usage): Examples of Designer and Viewer usage. - [Building forms via code](guides/building-forms-via-code): How to create a form using code. - [Camunda integration](guides/camunda): Camunda is a comprehensive workflow automation and decision-making platform that provides process management solutions for organizations of - [Components with multiple children](guides/components-with-multiple-children): How to define components with multiple children components. - [Dynamic dropdown population](guides/dynamic-dropdown-population): How to fill dropdown dynamically. - [Formik integration](guides/formik): Introduction to FormEngine - [Integration with Electron](guides/integration-with-electron): How to run FormEngine in Electron and connect the Monaco editor locally, without CDN. - [Linking dropdown components](guides/linking-dropdowns): Describes how to link dropdown components. - [Google Maps address autocomplete](guides/maps-with-address-autocomplete): Guide to setting up Google Maps with autocomplete functionality. - [Styling multiple components](guides/styling-multiple-components): Showcases how to style multiple components using CSS. - [Tracking form changes](guides/tracking-form-changes): Detecting and tracking changes to data that is submitted to your form can be a crucial aspect of your form management. To detect changes to - [Updating RSuite library](guides/updating-rsuite): To update the RSuite library in Optimajet’s Designer or Components RSuite, you need to gain access to the source code. - [Using Repeater](guides/using-repeater): Learn how to use the Repeater component in your project. - [Adding WASM component](guides/wasm-component): Guide to connecting the WASM component - [Writing values via actions and computed properties](guides/writing-values-via-actions): How to manipulate values using actions and computed properties. - [License key](license-key): Contact our sales department to obtain a licence key. - [Release notes](release-notes): 5.0.1 - [Roadmap](roadmap): On this page you can see what tasks are planned to improve FormEngine. As well as tasks that may be done, but are not yet planned. - [Support](support): Do you need help, found a bug or have an idea? - [Usage with Next.js](usage-with-nextjs): The FormEngine is fully compatible with the latest versions of the Next.js. - [Usage with Remix](usage-with-remix): The FormEngine is fully compatible with the latest versions of the Remix.