@formkit/themes

Introduction

Ce package contient les thèmes officiels pour FormKit. Lisez la documentation d'installation pour plus d'informations.

Fonctions

createIconHandler()

Renvoie une fonction responsable du chargement d'une icône par son nom.

Signature

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

Paramètres

  • iconLoader optionnel — une fonction pour charger une icône lorsqu'elle n'est pas trouvée dans le iconRegistry.
  • iconLoaderUrl optionnel — une fonction qui renvoie une URL distante pour récupérer une icône SVG par son nom.

createThemePlugin()

Crée le plugin de thème en fonction d'un nom de thème donné.

Signature

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

Paramètres

  • theme optionnel — Le nom ou l'identifiant du thème à appliquer.
  • icons optionnel — Les icônes que vous souhaitez ajouter au registre global des icônes.
  • iconLoaderUrl optionnel — Une fonction qui renvoie une URL distante pour récupérer une icône SVG par son nom.
  • iconLoader optionnel — Une fonction qui gère le chargement d'une icône lorsqu'elle n'est pas trouvée dans le registre.

generateClasses()

Une fonction pour générer des fonctions de classes FormKit à partir d'un objet JavaScript.

Signature

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

Paramètres

  • classes — Un objet de types d'entrée avec des objets imbriqués de sectionKeys et de listes de classes.

Retours

Un objet de sectionKeys avec des fonctions de classes.

TypeScript

FormKitIconLoader

Une fonction qui renvoie une chaîne SVG d'icône.

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

FormKitIconLoaderUrl

Une fonction qui renvoie une URL distante pour récupérer une icône SVG par son nom.

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