@formkit/i18n

Introduction

Le plugin officiel d'internationalisation (i18n) de FormKit. Ce paquet contient les locales et le plugin qui intègre FormKit avec ces locales. Lisez la documentation sur l'internationalisation pour les instructions d'utilisation.

Fonctions

createI18nPlugin()

Créez un nouveau plugin d'internationalisation pour FormKit.

Signature

createI18nPlugin(registry: FormKitLocaleRegistry): FormKitPlugin;

Paramètres

Retourne

FormKitPlugin

date()

Étant donné une chaîne ou une date, retourne une version agréable et lisible par l'homme.

Signature

date(date: string | Date): string;

Paramètres

  • date — Une chaîne ou une date.

Retourne

string

list()

Crée une liste séparée par des virgules de type Oxford.

Signature

list(items: string[], conjunction?: string): string;

Paramètres

  • items — les éléments à lister.
  • conjunction optionnel — dans la liste "x, y, et z", "et" est la conjonction. Par défaut, c'est "ou".

Retourne

string

order()

Trie deux variables du plus petit au plus grand.

Signature

order(first: string | number, second: string | number): [smaller: number | string, larger: number | string];

Paramètres

  • first — Le premier nombre ou chaîne.
  • second — Le deuxième nombre ou chaîne.

Retourne

[smaller: number | string, larger: number | string]

sentence()

Étant donné une chaîne, convertissez-la en minuscules.

Signature

sentence(str: string): string;

Paramètres

  • str — La chaîne à convertir en minuscules.

Retourne

string

TypeScript

FormKitLocale

Une locale est simplement une collection de registres de messages de locale, ils sont indexés par le type (comme un espace de noms) ex : "validation" ou "ui". Les auteurs de plugins peuvent également déclarer leurs propres types.

interface FormKitLocale {
    [index: string]: FormKitLocaleMessages;
    ui: FormKitLocaleMessages;
}

FormKitLocaleMessages

Un registre de messages de locale — il s'agit simplement d'un objet clé/valeur avec des clés de chaîne (nom du message) et soit des valeurs de chaîne (pour des retours simples) ou des fonctions qui reçoivent un objet contexte.

interface FormKitLocaleMessages {
    [index: string]: string | ((...args: any[]) => string);
}