@formkit/themes

Introdução

Este pacote contém os temas oficiais para o FormKit. Leia a documentação de instalação para obter mais informações.

Funções

createIconHandler()

Retorna uma função responsável por carregar um ícone pelo nome.

Assinatura

createIconHandler(iconLoader?: FormKitIconLoader, iconLoaderUrl?: FormKitIconLoaderUrl): FormKitIconLoader;

Parâmetros

  • iconLoader opcional — uma função para carregar um ícone quando ele não for encontrado no registro de ícones.
  • iconLoaderUrl opcional — uma função que retorna uma URL remota para recuperar um ícone SVG pelo nome.

createThemePlugin()

Cria o plugin de tema com base em um nome de tema fornecido.

Assinatura

createThemePlugin(theme?: string, icons?: Record<string, string | undefined>, iconLoaderUrl?: FormKitIconLoaderUrl, iconLoader?: FormKitIconLoader): (node: FormKitNode) => any;

Parâmetros

  • theme opcional — O nome ou ID do tema a ser aplicado.
  • icons opcional — Ícones que você deseja adicionar ao registro global de ícones.
  • iconLoaderUrl opcional — Uma função que retorna uma URL remota para recuperar um ícone SVG pelo nome.
  • iconLoader opcional — Uma função que lida com o carregamento de um ícone quando ele não é encontrado no registro.

generateClasses()

Uma função para gerar funções de classe do FormKit a partir de um objeto JavaScript.

Assinatura

generateClasses(classes: Record<string, Record<string, string>>): Record<string, string | FormKitClasses | Record<string, boolean>>;

Parâmetros

  • classes — Um objeto de tipos de entrada com objetos aninhados de chaves de seção e listas de classes.

Retorna

Um objeto de chaves de seção com funções de classe.

TypeScript

FormKitIconLoader

Uma função que retorna uma string SVG de um ícone.

interface FormKitIconLoader {
    (iconName: string): string | undefined | Promise<string | undefined>;
}

FormKitIconLoaderUrl

Uma função que retorna uma URL remota para recuperar um ícone SVG pelo nome.

interface FormKitIconLoaderUrl {
    (iconName: string): string | undefined;
}