Last updated:
Configuration in React makes use of props on FormcentricForm. The technical semantics of the common Formcentric keys are described in the main Formcentric Client (General) documentation. This page therefore focuses on the React syntax and React-specific special cases.
The common semantics of height and maxWidth are described in Formcentric Client (General). In React, these values can be set directly as props or via containerProps on the wrapper.
Example with props:
Example with containerProps:
The technical semantics of parentUrl are described in Formcentric Client (General).
In React, the same common key is set directly as the prop parentUrl – such as when the form finds itself in a modal, for example.
Example:
The technical semantics of vars and the common behaviour with URL parameters are described in Formcentric Client (General).
In React, the common key is set directly as the prop vars.
Example:
The common semantics of language and locale are described in Formcentric Client (General). In React, the same keys are set directly as props.
Example:
The common semantics of localesPath and the structure of the translation file are described in Formcentric Client (General). In React, the same common key is set directly as the prop localesPath.
Example:
Example for a localisation file:
The common semantics of configuration are described in Formcentric Client (General). In React, the same common key is set directly as the prop configuration.
Example:
The common semantics of formName, refs, requestHeaders, persist and other metadata are described in Formcentric Client (General). In React, these common keys are set directly as props.
Example:
The FormcentricForm component supports all mount configuration values as top-level props, as well as some React-specific additional props.
remountKey?: string | numbercontainerProps?: React.HTMLAttributes<HTMLDivElement>className, style, id, role, aria-* or event handlers.onReady?: () => voidonError?: (error: Error) => voidconflictBehavior?: 'throw' | 'stop-existing'embedId is already active on another/the same DOM instance.stop-existing is active by default.The technical semantics of the common props are described in Formcentric Client (General).
In React, these are as follows:
| Prop |
| embedId |
| formDefinition |
| srcUrl |
| dataUrl |
| formappUrl |
| designUrl |
The technical semantics of the common props are described in Formcentric Client (General).
In React, these are as follows:
| Prop |
| designUrl |
| themeUrl |
| themeVariableUrl |
| themeVariables |
| templateUrl |
| themeDir |
| theme |
| skipThemeLoad |
| skipTemplatesLoad |
| skipFormLoad |
The technical semantics of the common props are described in Formcentric Client General.
In React, these are as follows:
| Prop |
| vars |
| params |
| refs |
| token |
| requestHeaders |
| formName |
| instanceId |
| contentHandler |
| env |
| parentUrl |
| configuration |
The technical semantics of the common props are described in Formcentric Client (General).
In React, these are as follows:
| Prop |
| language |
| locale |
| localesPath |
| debug |
| maxWidth |
| height |
embedId or formDefinition must be set.embedId, formDefinition or remountKey trigger a repeat embedding.FormcentricConfigProvider values or browser-global defaults also take effect only after a repeat embedding.containerProps, onReady and onError behave like normal React props and can be refreshed without re-initialisation.conflictBehavior is set to stop-existing by default.ThemeLoad and skipTemplatesLoad take effect only if they are set explicitly.embedId should remain stable.remountKey instead of using a changing React key.vars, params, themeVariables and configuration should be passed as serialisable objects.parentUrl is not set explicitly, the current page URL can be used as a user return context.