From 99e82aeb3b93efcc5ea3816e9394dfc4ba6417fb Mon Sep 17 00:00:00 2001 From: Howie Xie <94725606+HowieHz@users.noreply.github.com> Date: Thu, 27 Nov 2025 13:42:55 +0800 Subject: [PATCH] docs: Update annotations-form.md with checkbox details (#526) * docs: Update annotations-form.md with checkbox details Clarified that 'checkbox' input components should use 'on-value' and 'off-value' for string values. * docs: Update annotations form documentation for checkbox input (#1) --- docs/developer-guide/annotations-form.md | 2 +- versioned_docs/version-2.21/developer-guide/annotations-form.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developer-guide/annotations-form.md b/docs/developer-guide/annotations-form.md index e3b422b..d23b2e5 100644 --- a/docs/developer-guide/annotations-form.md +++ b/docs/developer-guide/annotations-form.md @@ -7,7 +7,7 @@ title: 元数据表单定义 定义元数据编辑表单同样使用 `FormKit Schema`，但和主题或插件的定义方式稍有不同，其中输入组件类型可参考 [表单定义](./form-schema.md)。 :::info 提示 -因为 `metadata.annotations` 是一个键值都为字符串类型的对象，所以表单项的值必须为字符串类型。这就意味着，FormKit 的 `number`、`group`、`repeater` 等类型的输入组件都不能使用。 +因为 `metadata.annotations` 是一个键值都为字符串类型的对象，所以表单项的值必须为字符串类型。这就意味着，FormKit 的 `number`、`group`、`repeater` 等类型的输入组件都不能使用。`checkbox` 类型的输入组件应通过 `on-value` 和 `off-value` 指定字符串值，以替代默认的布尔值。 ::: ## AnnotationSetting 资源定义方式 diff --git a/versioned_docs/version-2.21/developer-guide/annotations-form.md b/versioned_docs/version-2.21/developer-guide/annotations-form.md index e3b422b..d23b2e5 100644 --- a/versioned_docs/version-2.21/developer-guide/annotations-form.md +++ b/versioned_docs/version-2.21/developer-guide/annotations-form.md @@ -7,7 +7,7 @@ title: 元数据表单定义 定义元数据编辑表单同样使用 `FormKit Schema`，但和主题或插件的定义方式稍有不同，其中输入组件类型可参考 [表单定义](./form-schema.md)。 :::info 提示 -因为 `metadata.annotations` 是一个键值都为字符串类型的对象，所以表单项的值必须为字符串类型。这就意味着，FormKit 的 `number`、`group`、`repeater` 等类型的输入组件都不能使用。 +因为 `metadata.annotations` 是一个键值都为字符串类型的对象，所以表单项的值必须为字符串类型。这就意味着，FormKit 的 `number`、`group`、`repeater` 等类型的输入组件都不能使用。`checkbox` 类型的输入组件应通过 `on-value` 和 `off-value` 指定字符串值，以替代默认的布尔值。 ::: ## AnnotationSetting 资源定义方式