@formkit/i18n

Introdução

O plugin oficial de internacionalização (i18n) do FormKit. Este pacote contém os idiomas e o plugin que integra o FormKit com esses idiomas. Leia a documentação de internacionalização para obter instruções de uso.

Funções

createI18nPlugin()

Cria um novo plugin de internacionalização para o FormKit.

Assinatura

createI18nPlugin(registry: FormKitLocaleRegistry): FormKitPlugin;

Parâmetros

Retorna

FormKitPlugin

date()

Dado uma string ou uma data, retorna uma versão legível para humanos.

Assinatura

date(date: string | Date): string;

Parâmetros

  • date — Uma string ou uma data.

Retorna

string

list()

Cria uma lista separada por vírgulas e com a conjunção de Oxford.

Assinatura

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

Parâmetros

  • items — Os itens a serem listados.
  • conjunction opcional — na lista "x, y e z", "e" é a conjunção. O padrão é "ou".

Retorna

string

order()

Ordena duas variáveis do menor para o maior.

Assinatura

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

Parâmetros

  • first — O primeiro número ou string.
  • second — O segundo número ou string.

Retorna

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

sentence()

Dada uma string, converte-a para caixa de frase.

Assinatura

sentence(str: string): string;

Parâmetros

  • str — A string para converter para caixa de frase.

Retorna

string

TypeScript

FormKitLocale

Um idioma é apenas uma coleção de registros de mensagens de idioma, eles são indexados pelo tipo (como um namespace) ex: "validation" ou "ui". Os autores de plugins também podem declarar seus próprios tipos.

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

FormKitLocaleMessages

Um registro de mensagens de idioma - isso é simplesmente um objeto com chave/valor indexado por string (nome da mensagem) e valores de string (para retornos simples) ou funções que recebem um objeto de contexto.

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

FormKitLocaleRegistry

O registro de idiomas é apenas um par chave-valor dos índices de idioma ('ar', 'en', 'it', etc.) para seus respectivos idiomas.

interface FormKitLocaleRegistry {
    [index: string]: FormKitLocale;
}