Les variables

Les variables sont des champs de données qui peuvent être utilisés dans le modèle pour personnaliser le document. Ces variables sont applicablent à un block de texte via l’onglet dynamic dans le panneau d’outils (panneau de droite).

Les variables ne sont pas liées à un contact, elles sont donc utilisables pour tous les contacts. Elle peuvent être éditées par l’utilisateur lors de la création du document.ou remplis simplement via le panneau de formulaire.

---

Paramètres d’une variable

interface TFormData {
  key: TChampsKeys | 'DEFAULT'
  type: string;
  name: string;
  autoFill: boolean;
  editable: boolean;
  content: string | null;
  index: number | null;
  placeholder?: string;
  options: OptionKey[];
  empty: boolean;
}

Key	Description
key	Clé de la variable, elle doit être unique pour chaque variable. => customization key
type	Type de la variable, il peut être string, number, mail
name	Nom de la variable, il sera affiché dans le panneau d’outils.
autoFill	Si la variable doit être remplie automatiquement à partir des données du contact.
editable	Si la variable doit être éditable par l’utilisateur.
content	Contenu de la variable, contenu affiché dans le modele et lors de la génération du fichier de production
index	Index de la variable, il permet de définir sa position dans le bloc de texte
placeholder	Placeholder de la variable, il sera affiché lors de l’edition du bloc de texte avant d’ètre remplacé
options	Options de la variable, (comming later)
empty	Si la variable est vide,

---

les options d’une variable (WIP)

 type OptionKey = {
  name: string;
  on: boolean;
  val?: any;
  val1?: any;
  val2?: any;
  description: string;
};

Key	Description
name	Nom de l’option, il sera affiché dans le panneau d’outils.
on	Si l’option est activée ou non.
val	Valeur de l’option, elle peut être de type string, number
val1	Valeur de l’option, elle peut être de type string, number
val2	Valeur de l’option, elle peut être de type string, number
description	Description de l’option, elle sera affichée dans le panneau d’outils.

---

Options : text

Key	Description
include	Si activé, la chaîne générée inclura le texte spécifié. Vous pouvez définir le texte dans le champ val.
startWith	Si activé, la chaîne générée commencera par le texte spécifié. Vous pouvez définir le texte dans le champ val.
endWith	Si activé, la chaîne générée se terminera par le texte spécifié. Vous pouvez définir le texte dans le champ val.
length	Si activé, la longueur de la chaîne générée sera contrainte au nombre spécifié. Vous pouvez définir la longueur maximale dans le champ val.
uppercase	Si activé, la chaîne générée sera convertie en majuscules.
lowercase	Si activé, la chaîne générée sera convertie en minuscules.
first_letter_uppercase	Si activé, la première lettre de la chaîne générée sera convertie en majuscule.
replace	Si activé, vous pouvez remplacer les occurrences d’une chaîne par une autre dans la chaîne générée. Vous pouvez spécifier les chaînes à remplacer dans les champs val1 et val2.

---

Options : number

Key	Description
Digit only	Si activé, la chaîne générée ne contiendra que des chiffres.
format	Si activé, vous pouvez formater la chaîne générée selon un format spécifique. Vous pouvez spécifier le format dans le champ val.
replace	Si activé, vous pouvez remplacer les occurrences d’une chaîne par une autre dans la chaîne générée. Vous pouvez spécifier les chaînes à remplacer dans les champs val1 et val2.
prefix	Si activé, vous pouvez ajouter un préfixe à la chaîne générée. Vous pouvez spécifier le préfixe dans le champ val.

---

Options : mail

Key	Description
at	Si activé, vous pouvez forcer le champ a contenir un @ afin de garantir la présence d’un email