From 8603fbee4c2d0f87fb433594c63f92c3998573eb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=83=A1=E6=96=B0=E6=B5=B7?= <1047739781@qq.com>
Date: Wed, 9 Oct 2024 19:44:01 +0800
Subject: [PATCH] feat(CheckboxGroup): add keys props
---
src/checkbox/README.en-US.md | 23 ++++++++++
src/checkbox/README.md | 89 +++++++++++++++++++++++++++++++++++-
2 files changed, 111 insertions(+), 1 deletion(-)
diff --git a/src/checkbox/README.en-US.md b/src/checkbox/README.en-US.md
index e5d620372..33355f7dc 100644
--- a/src/checkbox/README.en-US.md
+++ b/src/checkbox/README.en-US.md
@@ -63,3 +63,26 @@ default-value | Array | undefined | uncontrolled property。Typescript：`T` `ty
name | params | description
-- | -- | --
change | `(value: CheckboxGroupValue, context: { value: boolean\|number\|string, label: boolean\|number\|string })` | \-
+
+### CSS Variables
+
+The component provides the following CSS variables, which can be used to customize styles.
+Name | Default Value | Description
+-- | -- | --
+--td-checkbox-bg-color | @bg-color-container | -
+--td-checkbox-border-color | @component-stroke | -
+--td-checkbox-description-color | @text-color-secondary | -
+--td-checkbox-description-disabled-color | @text-color-disabled | -
+--td-checkbox-description-line-height | 44rpx | -
+--td-checkbox-font-size | 32rpx | -
+--td-checkbox-icon-checked-color | @brand-color | -
+--td-checkbox-icon-color | @component-border | -
+--td-checkbox-icon-disabled-bg-color | @bg-color-component-disabled | -
+--td-checkbox-icon-disabled-color | @brand-color-disabled | -
+--td-checkbox-icon-size | 48rpx | -
+--td-checkbox-tag-active-bg-color | @brand-color-light | -
+--td-checkbox-tag-active-color | @brand-color | -
+--td-checkbox-title-color | @text-color-primary | -
+--td-checkbox-title-disabled-color | @text-color-disabled | -
+--td-checkbox-title-line-height | 48rpx | -
+--td-checkbox-vertical-padding | 32rpx | -
\ No newline at end of file
diff --git a/src/checkbox/README.md b/src/checkbox/README.md
index b0871446e..f6030c162 100644
--- a/src/checkbox/README.md
+++ b/src/checkbox/README.md
@@ -1,4 +1,69 @@
-:: BASE_DOC ::
+---
+title: Checkbox 多选框
+description: 用于预设的一组选项中执行多项选择，并呈现选择结果。
+spline: form
+isComponent: true
+---
+
+
+## 引入
+
+全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。
+
+```json
+"usingComponents": {
+ "t-checkbox": "tdesign-miniprogram/checkbox/checkbox",
+ "t-checkbox-group": "tdesign-miniprogram/checkbox-group/checkbox-group"
+}
+```
+
+## 代码演示
+
+ 在开发者工具中预览效果
+
+
+Tips: 请确保开发者工具为打开状态。导入开发者工具后，依次执行：npm i > 构建npm包 > 勾选 "将JS编译成ES5"
+
+
+### 组件类型
+
+纵向多选框
+
+{{ base }}
+
+横向多选框
+
+{{ horizontal }}
+
+带全选多选框
+
+{{ all }}
+
+### 组件状态
+
+多选框状态
+
+{{ status }}
+
+### 组件样式
+
+勾选样式
+
+{{ type }}
+
+勾选显示位置
+
+{{ right }}
+
+非通栏多选样式
+
+{{ card }}
+
+### 组件规格
+
+多选框尺寸规格
+
+{{ special }}
## API
@@ -63,3 +128,25 @@ default-value | Array | undefined | 选中值。非受控属性。TS 类型：`T
名称 | 参数 | 描述
-- | -- | --
change | `(value: CheckboxGroupValue, context: { value: boolean\|number\|string, label: boolean\|number\|string })` | 值变化时触发。`context` 表示当前点击项内容。
+### CSS Variables
+
+组件提供了下列 CSS 变量，可用于自定义样式。
+名称 | 默认值 | 描述
+-- | -- | --
+--td-checkbox-bg-color | @bg-color-container | -
+--td-checkbox-border-color | @component-stroke | -
+--td-checkbox-description-color | @text-color-secondary | -
+--td-checkbox-description-disabled-color | @text-color-disabled | -
+--td-checkbox-description-line-height | 44rpx | -
+--td-checkbox-font-size | 32rpx | -
+--td-checkbox-icon-checked-color | @brand-color | -
+--td-checkbox-icon-color | @component-border | -
+--td-checkbox-icon-disabled-bg-color | @bg-color-component-disabled | -
+--td-checkbox-icon-disabled-color | @brand-color-disabled | -
+--td-checkbox-icon-size | 48rpx | -
+--td-checkbox-tag-active-bg-color | @brand-color-light | -
+--td-checkbox-tag-active-color | @brand-color | -
+--td-checkbox-title-color | @text-color-primary | -
+--td-checkbox-title-disabled-color | @text-color-disabled | -
+--td-checkbox-title-line-height | 48rpx | -
+--td-checkbox-vertical-padding | 32rpx | -
\ No newline at end of file