Introducing KickStart —  AI generated FormKit forms in seconds. Generate from a screenshot, edit with drag-and-drop or conversational AI, copy & paste as components or schema!
Try for free

@formkit/themes

介绍

该包包含了FormKit的官方主题。阅读安装文档获取更多信息。

函数

createIconHandler()

返回一个负责按名称加载图标的函数。

签名

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

参数

  • iconLoader 可选 — 一个用于在iconRegistry中找不到图标时加载图标的函数。
  • iconLoaderUrl 可选 — 一个返回通过名称检索SVG图标的远程URL的函数。

createThemePlugin()

根据给定的主题名称创建主题插件。

签名

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

参数

  • theme 可选 — 要应用的主题的名称或ID。
  • icons 可选 — 要添加到全局图标注册表的图标。
  • iconLoaderUrl 可选 — 一个返回通过名称检索SVG图标的远程URL的函数。
  • iconLoader 可选 — 一个处理在注册表中找不到图标时加载图标的函数。

generateClasses()

从JavaScript对象生成FormKit类函数的函数。

签名

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

参数

  • classes — 一个包含嵌套对象的输入类型对象。

返回值

一个包含类函数的sectionKeys对象。

TypeScript

FormKitIconLoader

返回一个图标SVG字符串的函数。

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

FormKitIconLoaderUrl

返回通过名称检索SVG图标的远程URL的函数。

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