Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

checkbox组件文档补充 #675

Closed
wants to merge 5 commits into from
Closed

checkbox组件文档补充 #675

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d7b89f4
feat: 新增官方文档点击可以复制icon功能。
MrXiangXvFan Aug 6, 2024
3f29659
feat: 恢复main分支
MrXiangXvFan Aug 8, 2024
cf7c3f4
Merge branch 'main' of https://github.com/AntmJS/vantui
MrXiangXvFan Aug 13, 2024
91b4496
docs: checkbox组件文档补充
MrXiangXvFan Aug 13, 2024
683f19f
docs: checkbox组件文档补充
MrXiangXvFan Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions packages/vantui/src/checkbox/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,30 +65,30 @@ import { Checkbox, CheckboxGroup } from '@antmjs/vantui'

### CheckboxProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/checkbox.d.ts)

| 参数 | 说明 | 类型 | 默认值 | 必填 |
| ------------- | ---- | ----------------------------------------------------------------------------------------------------------- | ------ | ------- |
| name | - | _&nbsp;&nbsp;ReactNode<br/>_ | - | `false` |
| value | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| disabled | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| checkedColor | - | _&nbsp;&nbsp;string<br/>_ | - | `false` |
| labelPosition | - | _&nbsp;&nbsp;string<br/>_ | - | `false` |
| labelDisabled | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| shape | - | _&nbsp;&nbsp;"round"&nbsp;&brvbar;&nbsp;"square"<br/>_ | - | `false` |
| iconSize | - | _&nbsp;&nbsp;string&nbsp;&brvbar;&nbsp;number<br/>_ | - | `false` |
| children | - | _&nbsp;&nbsp;ReactNode<br/>_ | - | `false` |
| renderIcon | - | _&nbsp;&nbsp;ReactNode<br/>_ | - | `false` |
| onChange | - | _&nbsp;&nbsp;(<br/>&nbsp;&nbsp;&nbsp;&nbsp;event:&nbsp;ITouchEvent<br/>&nbsp;&nbsp;)&nbsp;=>&nbsp;any<br/>_ | - | `false` |
| 参数 | 说明 | 类型 | 默认值 | 必填 |
| ------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------- | ------ | ------- |
| name | 标识符，通常为一个唯一的字符串或数字 | _ReactNode<br/>_ | - | `false` |
| value | 指定当前是否选中 | _boolean<br/>_ | false | `false` |
| disabled | 是否禁用复选框 | _boolean<br/>_ | false | `false` |
| checkedColor | 选中状态颜色 | _string<br/>_ | - | `false` |
| labelPosition | 文本位置，可选值为 left | _string<br/>_ | right | `false` |
| labelDisabled | 是否禁用复选框文本点击 | _boolean<br/>_ | false | `false` |
| shape | 形状，可选值为 square | _"round"&nbsp;&brvbar;&nbsp;"square"<br/>_ | round | `false` |
| iconSize | 图标大小，默认单位为 px | _string&nbsp;&brvbar;&nbsp;number<br/>_ | 20px | `false` |
| children | - | _ReactNode<br/>_ | - | `false` |
| renderIcon | 自定义渲染 icon | _ReactNode<br/>_ | - | `false` |
| onChange | 当绑定值变化时触发的事件 | _(<br/>&nbsp;&nbsp;&nbsp;&nbsp;event:&nbsp;ITouchEvent<br/>&nbsp;&nbsp;)&nbsp;=>&nbsp;any<br/>_ | - | `false` |

### CheckboxGroupProps [[详情]](https://github.com/AntmJS/vantui/tree/main/packages/vantui/types/checkbox.d.ts)

| 参数 | 说明 | 类型 | 默认值 | 必填 |
| --------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------- |
| max | - | _&nbsp;&nbsp;number<br/>_ | - | `false` |
| value | - | _&nbsp;&nbsp;Array<any><br/>_ | - | `false` |
| disabled | - | _&nbsp;&nbsp;boolean<br/>_ | - | `false` |
| direction | - | _&nbsp;&nbsp;attr:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"horizontal"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"vertical"<br/>_ | - | `false` |
| children | - | _&nbsp;&nbsp;ReactNode<br/>_ | - | `false` |
| onChange | - | _&nbsp;&nbsp;(<br/>&nbsp;&nbsp;&nbsp;&nbsp;event:&nbsp;ITouchEvent<br/>&nbsp;&nbsp;)&nbsp;=>&nbsp;any<br/>_ | - | `false` |
| 参数 | 说明 | 类型 | 默认值 | 必填 |
| --------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -------- | ------- |
| max | 最大可选数(0 代表无限制) | _number<br/>_ | 0 | `false` |
| value | 所有选中项的标识符 | _Array<any><br/>_ | [] | `false` |
| disabled | 是否禁用所有复选框 | _boolean<br/>_ | false | `false` |
| direction | 排列方向，可选值为 horizontal | _attr:<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"horizontal"<br/>&nbsp;&nbsp;&nbsp;&nbsp;&brvbar;&nbsp;"vertical"<br/>_ | vertical | `false` |
| children | - | _ReactNode<br/>_ | - | `false` |
| onChange | 当绑定值变化时触发的事件 | _(<br/>&nbsp;&nbsp;&nbsp;&nbsp;event:&nbsp;ITouchEvent<br/>&nbsp;&nbsp;)&nbsp;=>&nbsp;any<br/>_ | - | `false` |

### 样式变量

Expand Down
Loading