Konfiguration

Zuletzt geändert am:

Die fachliche Semantik der gemeinsamen Formcentric-Keys ist zentral in Client (Allgemein) dokumentiert.

Diese Seite beschreibt daher vor allem die SDK-Schreibweise, das Verhalten von mount() und die SDK-spezifischen Optionen.

Zielelement

Der erste Parameter von mount() ist das Zielelement.

Unterstützt werden:

  1. ein CSS-Selector-String, zum Beispiel '#my-form'
  2. ein echtes HTMLElement

Das Zielelement muss im Browser-DOM vorhanden sein, wenn mount() aufgerufen wird.

Identifikation und Formquelle

Die gemeinsame Semantik dieser Felder ist in Client (Allgemein) beschrieben.

Im SDK heißen die entsprechenden Keys:

SDK-Key
embedId
formDefinition
srcUrl
dataUrl
designUrl

Das npm-SDK verwendet die in @formcentric/client enthaltene Runtime und akzeptiert formappUrl nicht; untypisiert übergebene Werte werden mit einer Warnung ignoriert. Runtime-URLs für formcentric.js beschreibt Runtime & Auslieferung.

Theme- und Asset-Konfiguration

Die gemeinsame Semantik dieser Felder ist in Client (Allgemein) beschrieben.

Im SDK heißen die entsprechenden Keys:

SDK-Key
themeUrl
themeVariableUrl
themeVariables
templateUrl
themeDir
theme
skipThemeLoad
skipTemplatesLoad
skipFormLoad

Vorbelegung, Request-Kontext und Metadaten

Die gemeinsame Semantik dieser Felder ist in Client (Allgemein) beschrieben.

Im SDK heißen die entsprechenden Keys:

SDK-Key
vars
params
refs
token
requestHeaders
formName
instanceId
env
configuration

Sprache, Locale und Übersetzungen

Die gemeinsame Semantik von Sprache, Locale und Übersetzungen ist in Client (Allgemein) beschrieben. Im SDK heißen die entsprechenden Keys language, locale, localesPath und locales.

Beispiel:


Gebündelte SDK-Integrationen können alternativ ein locales-Objekt direkt übergeben. Das ist der empfohlene Weg, wenn Sie date-fns- und Upload-Locale-Objekte einschließlich ihrer Funktionen bereitstellen möchten.

Der folgende Ausschnitt zeigt die Struktur; ergänzen Sie unter resources die benötigten Formcentric-Übersetzungen. Die Regeln für vorhandene und neue Sprachen stehen in Client (Allgemein) unter Konfiguration → Eigene Übersetzungen einbinden.


Layout und Debugging

Die gemeinsame Semantik von maxWidth, height und debug ist in Client (Allgemein) beschrieben.

Beispiel:


Parent URL / Double-Opt-in

Die fachliche Semantik von parentUrl ist in Client (Allgemein) beschrieben. Im SDK wird derselbe gemeinsame Key direkt als parentUrl verwendet.

Beispiel:


Wenn parentUrl nicht explizit gesetzt ist, wird die aktuelle Seiten-URL als Rücksprungkontext verwendet.

Vollständige MountConfig-Referenz

Das SDK unterstützt die folgenden Mount-Konfigurationsfelder:


Wichtige Verhaltensregeln und Defaults

  1. Mindestens eines von embedId oder formDefinition muss gesetzt sein.
  2. SDK-Integrationen sind config-authoritative. data-fc-* Attribute am Ziel-Element werden nicht als Live-Konfigurationsquelle verwendet.
  3. Die meisten Felder sind reine Initialisierungs-Props. Änderungen daran werden nicht automatisch in eine laufende Instanz übernommen.
  4. conflictBehavior steht bei direkten SDK-Mounts standardmäßig auf 'throw'.
  5. Wenn bewusst eine Übergabe für dieselbe embedId gewünscht ist, sollte conflictBehavior: 'stop-existing' gesetzt werden.
  6. skipThemeLoad und skipTemplatesLoad werden nur berücksichtigt, wenn sie explizit gesetzt sind.
  7. Objektbasierte Konfigurationen wie vars, params, themeVariables und configuration sollten als serialisierbare Objekte übergeben werden. locales ist die Ausnahme: Es enthält date-fns- und Upload-Locale-Objekte einschließlich ihrer Funktionen und wird per Referenz übergeben.
  8. data-fc-watch ist Static-only und wird bei SDK-Mounts ignoriert.

Feedback