@formkit/i18n

• 介绍
• 函数
  • createI18nPlugin()
  • date()
  • list()
  • order()
  • sentence()
• TypeScript
  • FormKitLocale
  • FormKitLocaleMessages
  • FormKitLocaleRegistry

介绍

官方的FormKit国际化（i18n）插件。该包包含了语言环境和将FormKit与这些语言环境集成的插件。阅读国际化文档以获取使用说明。

函数

createI18nPlugin()

为FormKit创建一个新的国际化插件。

签名

createI18nPlugin(registry: FormKitLocaleRegistry): FormKitPlugin;

参数

• registry — FormKitLocales的注册表。

返回值

FormKitPlugin

date()

给定一个字符串或日期，返回一个友好的人类可读版本。

签名

date(date: string | Date): string;

参数

• date — 一个字符串或日期。

返回值

string

list()

创建一个用牛津逗号分隔的项目列表。

签名

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

参数

• items — 要列出的项目。
• conjunction 可选 — 在列表 "x, y, and z" 中，"and" 是连接词。默认为 "or"。

返回值

string

order()

将两个变量从小到大排序。

签名

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

参数

• first — 第一个数字或字符串。
• second — 第二个数字或字符串。

返回值

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

sentence()

给定一个字符串，将其转换为句首大写。

签名

sentence(str: string): string;

参数

• str — 要转换为句首大写的字符串。

返回值

string

TypeScript

FormKitLocale

语言环境只是一组语言环境消息注册表，它们以类型为键（类似于命名空间），例如："validation"或"ui"。插件作者也可以声明自己的类型。

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

FormKitLocaleMessages

语言环境消息的注册表 - 这只是一个具有字符串键（消息名称）和字符串值（用于简单返回）或接收上下文对象的函数的键/值对象。

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

FormKitLocaleRegistry

语言环境注册表只是将语言环境索引（'ar'，'en'，'it'等）与其相应的语言环境的键值对。

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