Référence de configuration

La configuration du widget Recorder — l’objet passé en overrides en React, ou affecté à la propriété config du Custom Element — suit un JSON Schema livré avec le package. Ce schéma n’est pas qu’une documentation : il permet à un éditeur ou à un agent de compléter et de valider un objet de configuration sans deviner une clé ou une valeur, avant même qu’il n’atteigne le widget. Les tableaux ci-dessous en sont générés, section par section : ils listent exactement les clés acceptées par le widget dans la version que vous installez.

Une configuration minimale

Toutes les clés sont facultatives : n’envoyez que les réglages à modifier, le Recorder conserve sa propre valeur pour le reste. Les chemins ci-dessous sont ceux listés dans les tableaux de cette page.

configuration du widget

{
  "version": 2,
  "layout": {
    "inputStyle": "underlined"
  },
  "fields": {
    "message": {
      "visible": true
    }
  },
  "behavior": {
    "messageEnabled": true
  }
}

`version`

Chemin	Type	Par défaut	Valeurs acceptées	Description
`version`	`enum`	Aucune valeur déclarée	`1` `2`	Non documenté dans le schéma

`styles`

Chemin	Type	Par défaut	Valeurs acceptées	Description
`styles`	`object`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma

`layout`

Chemin	Type	Par défaut	Valeurs acceptées	Description
`layout.steps`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`layout.inputStyle`	`enum`	Aucune valeur déclarée	`boxed` `underlined`	Non documenté dans le schéma

`display`

Chemin	Type	Par défaut	Valeurs acceptées	Description
`display.recorder.stepHeader`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.recorder.title`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.recorder.infoPrimary`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.recorder.infoSecondary`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.stepHeader`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.title`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.mandatoryNote`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.sections.sender.title`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.sections.sender.description`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.sections.recipient.title`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.sections.recipient.description`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.sections.message.title`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.sections.message.description`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.sections.schedule.title`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.form.sections.schedule.description`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.finish.title`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.finish.discoverText`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.finish.discoverButton`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`display.finish.restartButton`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma

`fields`

Chemin	Type	Par défaut	Valeurs acceptées	Description
`fields.firstname.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.firstname.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.firstname.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.firstname.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`fields.lastname.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.lastname.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.lastname.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.lastname.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`fields.senderEmail.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.senderEmail.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.senderEmail.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.senderEmail.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`fields.receiverEmail.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.receiverEmail.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.receiverEmail.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.receiverEmail.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`fields.receiverPhone.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.receiverPhone.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.receiverPhone.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.receiverPhone.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`fields.birthday.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.birthday.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.birthday.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.birthday.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`fields.country.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.country.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.country.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.country.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`fields.message.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.message.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.message.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.message.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`fields.scheduleDate.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.scheduleDate.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.scheduleDate.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.scheduleDate.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`fields.scheduleTime.visible`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.scheduleTime.label`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.scheduleTime.placeholder`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`fields.scheduleTime.requiredLabelSuffix`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`

`behavior`

Chemin	Type	Par défaut	Valeurs acceptées	Description
`behavior.noForm`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`behavior.messageEnabled`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`behavior.scheduleEnabled`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`behavior.countryEnabled`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`behavior.birthdayEnabled`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`behavior.receiverEmailEnabled`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`behavior.receiverPhoneEnabled`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`behavior.emailOptional`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`behavior.consentTitleEnabled`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma
`behavior.additionalConsentsEnabled`	`boolean`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma

`recorder`

Chemin	Type	Par défaut	Valeurs acceptées	Description
`recorder.permissionGate.panelBackgroundColor`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 256`
`recorder.permissionGate.panelBackgroundImageUrl`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`recorder.permissionGate.panelBackgroundSize`	`enum`	Aucune valeur déclarée	`cover` `contain` `auto`	Non documenté dans le schéma
`recorder.permissionGate.panelBackgroundPosition`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 256`
`recorder.permissionGate.panelBackgroundRepeat`	`enum`	Aucune valeur déclarée	`no-repeat` `repeat` `repeat-x` `repeat-y`	Non documenté dans le schéma
`recorder.permissionGate.heroAssetUrl`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`recorder.permissionGate.heroAlt`	`string`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max length 2048`
`recorder.permissionGate.heroWidth`	`number`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max 4096, exclusive min 0`
`recorder.permissionGate.heroHeight`	`number`	Aucune valeur déclarée	Pas de liste fixe	Non documenté dans le schéma Limites `max 4096, exclusive min 0`
`recorder.permissionGate.heroAnimation`	`enum`	Aucune valeur déclarée	`defaultPulse` `none`	Non documenté dans le schéma