@apexhub/apex-ui-react 0.0.0-stage → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +37 -2
- package/dist/en_US.d.ts +191 -0
- package/dist/index.cjs +40692 -0
- package/dist/index.d.ts +6869 -0
- package/dist/index.mjs +40676 -0
- package/dist/llm/alert.tokens.txt +44 -0
- package/dist/llm/alert.txt +167 -0
- package/dist/llm/apex-provider.txt +368 -0
- package/dist/llm/auto-complete.tokens.txt +77 -0
- package/dist/llm/auto-complete.txt +373 -0
- package/dist/llm/avatar.tokens.txt +38 -0
- package/dist/llm/avatar.txt +199 -0
- package/dist/llm/breadcrumb.tokens.txt +193 -0
- package/dist/llm/breadcrumb.txt +251 -0
- package/dist/llm/button.tokens.txt +470 -0
- package/dist/llm/button.txt +262 -0
- package/dist/llm/card.tokens.txt +27 -0
- package/dist/llm/card.txt +95 -0
- package/dist/llm/cascader.tokens.txt +253 -0
- package/dist/llm/cascader.txt +898 -0
- package/dist/llm/checkbox.tokens.txt +28 -0
- package/dist/llm/checkbox.txt +332 -0
- package/dist/llm/collapse.tokens.txt +84 -0
- package/dist/llm/collapse.txt +330 -0
- package/dist/llm/date-picker.tokens.txt +171 -0
- package/dist/llm/date-picker.txt +424 -0
- package/dist/llm/divider.tokens.txt +22 -0
- package/dist/llm/divider.txt +161 -0
- package/dist/llm/drawer.tokens.txt +71 -0
- package/dist/llm/drawer.txt +369 -0
- package/dist/llm/dropdown.tokens.txt +59 -0
- package/dist/llm/dropdown.txt +420 -0
- package/dist/llm/form.tokens.txt +26 -0
- package/dist/llm/form.txt +341 -0
- package/dist/llm/grid.txt +419 -0
- package/dist/llm/image.tokens.txt +28 -0
- package/dist/llm/image.txt +428 -0
- package/dist/llm/input-number.tokens.txt +159 -0
- package/dist/llm/input-number.txt +486 -0
- package/dist/llm/input.tokens.txt +136 -0
- package/dist/llm/input.txt +422 -0
- package/dist/llm/layout.tokens.txt +29 -0
- package/dist/llm/layout.txt +298 -0
- package/dist/llm/menu.tokens.txt +87 -0
- package/dist/llm/menu.txt +680 -0
- package/dist/llm/message.tokens.txt +25 -0
- package/dist/llm/message.txt +301 -0
- package/dist/llm/modal.tokens.txt +96 -0
- package/dist/llm/modal.txt +584 -0
- package/dist/llm/notification.tokens.txt +79 -0
- package/dist/llm/notification.txt +383 -0
- package/dist/llm/pagination.tokens.txt +33 -0
- package/dist/llm/pagination.txt +208 -0
- package/dist/llm/popover.tokens.txt +28 -0
- package/dist/llm/popover.txt +233 -0
- package/dist/llm/progress.tokens.txt +83 -0
- package/dist/llm/progress.txt +279 -0
- package/dist/llm/radio.tokens.txt +21 -0
- package/dist/llm/radio.txt +348 -0
- package/dist/llm/rate.tokens.txt +20 -0
- package/dist/llm/rate.txt +241 -0
- package/dist/llm/select.tokens.txt +160 -0
- package/dist/llm/select.txt +830 -0
- package/dist/llm/skeleton.tokens.txt +15 -0
- package/dist/llm/skeleton.txt +275 -0
- package/dist/llm/spin.tokens.txt +21 -0
- package/dist/llm/spin.txt +294 -0
- package/dist/llm/steps.tokens.txt +30 -0
- package/dist/llm/steps.txt +300 -0
- package/dist/llm/switch.tokens.txt +38 -0
- package/dist/llm/switch.txt +216 -0
- package/dist/llm/table.tokens.txt +94 -0
- package/dist/llm/table.txt +1046 -0
- package/dist/llm/tabs.tokens.txt +78 -0
- package/dist/llm/tabs.txt +306 -0
- package/dist/llm/tag.tokens.txt +76 -0
- package/dist/llm/tag.txt +305 -0
- package/dist/llm/tooltip.tokens.txt +22 -0
- package/dist/llm/tooltip.txt +304 -0
- package/dist/llm/tree-select.tokens.txt +174 -0
- package/dist/llm/tree-select.txt +762 -0
- package/dist/llm/tree.tokens.txt +36 -0
- package/dist/llm/tree.txt +505 -0
- package/dist/llm/typography.tokens.txt +60 -0
- package/dist/llm/typography.txt +413 -0
- package/dist/llm/upload.tokens.txt +201 -0
- package/dist/llm/upload.txt +706 -0
- package/dist/llms-full.txt +16689 -0
- package/dist/llms-theme.txt +32 -0
- package/dist/llms.txt +59 -0
- package/dist/locale/en_US.cjs +160 -0
- package/dist/locale/en_US.d.ts +4 -0
- package/dist/locale/en_US.mjs +161 -0
- package/dist/locale/zh_CN.cjs +160 -0
- package/dist/locale/zh_CN.d.ts +4 -0
- package/dist/locale/zh_CN.mjs +161 -0
- package/dist/style.css +19619 -0
- package/dist/zh_CN.d.ts +191 -0
- package/llms-full.txt +16689 -0
- package/llms-theme.txt +32 -0
- package/llms.txt +59 -0
- package/package.json +118 -3
- package/src/alert/llm.txt +167 -0
- package/src/alert/tokens.txt +44 -0
- package/src/apex-provider/llm.txt +368 -0
- package/src/auto-complete/llm.txt +373 -0
- package/src/auto-complete/tokens.txt +77 -0
- package/src/avatar/llm.txt +199 -0
- package/src/avatar/tokens.txt +38 -0
- package/src/breadcrumb/llm.txt +251 -0
- package/src/breadcrumb/tokens.txt +193 -0
- package/src/button/llm.txt +262 -0
- package/src/button/tokens.txt +470 -0
- package/src/card/llm.txt +95 -0
- package/src/card/tokens.txt +27 -0
- package/src/cascader/llm.txt +898 -0
- package/src/cascader/tokens.txt +253 -0
- package/src/checkbox/llm.txt +332 -0
- package/src/checkbox/tokens.txt +28 -0
- package/src/collapse/llm.txt +330 -0
- package/src/collapse/tokens.txt +84 -0
- package/src/date-picker/llm.txt +424 -0
- package/src/date-picker/tokens.txt +171 -0
- package/src/divider/llm.txt +161 -0
- package/src/divider/tokens.txt +22 -0
- package/src/drawer/llm.txt +369 -0
- package/src/drawer/tokens.txt +71 -0
- package/src/dropdown/llm.txt +420 -0
- package/src/dropdown/tokens.txt +59 -0
- package/src/form/llm.txt +341 -0
- package/src/form/tokens.txt +26 -0
- package/src/grid/llm.txt +419 -0
- package/src/image/llm.txt +428 -0
- package/src/image/tokens.txt +28 -0
- package/src/input/llm.txt +422 -0
- package/src/input/tokens.txt +136 -0
- package/src/input-number/llm.txt +486 -0
- package/src/input-number/tokens.txt +159 -0
- package/src/layout/llm.txt +298 -0
- package/src/layout/tokens.txt +29 -0
- package/src/menu/llm.txt +680 -0
- package/src/menu/tokens.txt +87 -0
- package/src/message/llm.txt +301 -0
- package/src/message/tokens.txt +25 -0
- package/src/modal/llm.txt +584 -0
- package/src/modal/tokens.txt +96 -0
- package/src/notification/llm.txt +383 -0
- package/src/notification/tokens.txt +79 -0
- package/src/pagination/llm.txt +208 -0
- package/src/pagination/tokens.txt +33 -0
- package/src/popover/llm.txt +233 -0
- package/src/popover/tokens.txt +28 -0
- package/src/progress/llm.txt +279 -0
- package/src/progress/tokens.txt +83 -0
- package/src/radio/llm.txt +348 -0
- package/src/radio/tokens.txt +21 -0
- package/src/rate/llm.txt +241 -0
- package/src/rate/tokens.txt +20 -0
- package/src/select/llm.txt +830 -0
- package/src/select/tokens.txt +160 -0
- package/src/skeleton/llm.txt +275 -0
- package/src/skeleton/tokens.txt +15 -0
- package/src/spin/llm.txt +294 -0
- package/src/spin/tokens.txt +21 -0
- package/src/steps/llm.txt +300 -0
- package/src/steps/tokens.txt +30 -0
- package/src/switch/llm.txt +216 -0
- package/src/switch/tokens.txt +38 -0
- package/src/table/llm.txt +1046 -0
- package/src/table/tokens.txt +94 -0
- package/src/tabs/llm.txt +306 -0
- package/src/tabs/tokens.txt +78 -0
- package/src/tag/llm.txt +305 -0
- package/src/tag/tokens.txt +76 -0
- package/src/tooltip/llm.txt +304 -0
- package/src/tooltip/tokens.txt +22 -0
- package/src/tree/llm.txt +505 -0
- package/src/tree/tokens.txt +36 -0
- package/src/tree-select/llm.txt +762 -0
- package/src/tree-select/tokens.txt +174 -0
- package/src/typography/llm.txt +413 -0
- package/src/typography/tokens.txt +60 -0
- package/src/upload/llm.txt +706 -0
- package/src/upload/tokens.txt +201 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Checkbox Token 明细
|
|
2
|
+
|
|
3
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照)。
|
|
4
|
+
|
|
5
|
+
按需读取:[组件用法](./checkbox.txt) · [主题与覆盖规则](../llms-theme.txt)。
|
|
6
|
+
|
|
7
|
+
以下组件变量在设计 Token 源中已定义,并被组件或其共享样式使用;不包含仅在实现中声明的临时变量。用途来自实际 CSS 属性,不是对外新增的 Props。
|
|
8
|
+
|
|
9
|
+
定义值依赖所列尺寸、变体、状态和媒体作用域;Alias 引用还会随 light/dark 主题改变。它们不是统一默认值或最终计算值。作用域用于解释定义位置,不代表内部选择器是稳定的定制 API。
|
|
10
|
+
|
|
11
|
+
| Token | 用途(CSS 属性) | 定义值 | 定义作用域 |
|
|
12
|
+
| --- | --- | --- | --- |
|
|
13
|
+
| `--checkbox-fill-checked` | `fill`、`outline` | `var(--apex-fill-brand-primary)` | `.apex-checkbox.apex-default-checkbox` |
|
|
14
|
+
| `--checkbox-fill-indeterminate` | `fill` | `var(--apex-fill-brand-primary)` | `.apex-checkbox.apex-default-checkbox` |
|
|
15
|
+
| `--checkbox-group-spacing-gap-x` | `column-gap` | `var(--apex-spacing-12)` | `.apex-checkbox-group.apex-default-checkbox-group` |
|
|
16
|
+
| `--checkbox-group-spacing-gap-y` | `row-gap` | `var(--apex-spacing-8)` | `.apex-checkbox-group.apex-default-checkbox-group` |
|
|
17
|
+
| `--checkbox-icon-checked` | `color` | `var(--apex-icon-neutral-quaternary-stable)` | `.apex-checkbox.apex-default-checkbox` |
|
|
18
|
+
| `--checkbox-icon-icon-md` | `height`、`width` | `var(--apex-size-20)` | `.apex-checkbox.apex-default-checkbox` |
|
|
19
|
+
| `--checkbox-icon-indeterminate` | `color` | `var(--apex-icon-neutral-quaternary-stable)` | `.apex-checkbox.apex-default-checkbox` |
|
|
20
|
+
| `--checkbox-radius-radius` | `border-radius` | `var(--apex-radius-4)` | `.apex-checkbox.apex-default-checkbox` |
|
|
21
|
+
| `--checkbox-spacing-gap` | `gap` | `var(--apex-spacing-4)` | `.apex-checkbox.apex-default-checkbox` |
|
|
22
|
+
| `--checkbox-stroke-checked` | `color` | `var(--apex-stroke-brand-primary)` | `.apex-checkbox.apex-default-checkbox` |
|
|
23
|
+
| `--checkbox-stroke-default` | `color` | `var(--apex-stroke-neutral-denary)` | `.apex-checkbox.apex-default-checkbox` |
|
|
24
|
+
| `--checkbox-stroke-disabled` | `color`、`fill` | `var(--apex-stroke-neutral-quinary)` | `.apex-checkbox.apex-default-checkbox` |
|
|
25
|
+
| `--checkbox-stroke-hover` | `color` | `var(--apex-stroke-neutral-octonary)` | `.apex-checkbox.apex-default-checkbox` |
|
|
26
|
+
| `--checkbox-stroke-indeterminate` | `color` | `var(--apex-stroke-brand-primary)` | `.apex-checkbox.apex-default-checkbox` |
|
|
27
|
+
| `--checkbox-text-default` | `color` | `var(--apex-text-neutral-primary)` | `.apex-checkbox.apex-default-checkbox` |
|
|
28
|
+
| `--checkbox-text-disabled` | `color` | `var(--apex-text-neutral-disabled)` | `.apex-checkbox.apex-default-checkbox` |
|
|
@@ -0,0 +1,332 @@
|
|
|
1
|
+
# Checkbox
|
|
2
|
+
|
|
3
|
+
> Checkbox:用户可从多个选项中任选零个、一个或多个时(与 Radio 互斥单选相对)。
|
|
4
|
+
|
|
5
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照,发布状态以安装包版本为准)。
|
|
6
|
+
|
|
7
|
+
公开导出:`Checkbox`、`CheckboxGroup`。
|
|
8
|
+
|
|
9
|
+
以下 API 属于 Apex UI;不要据 antd 的同名组件推断额外属性或默认值。默认值列的空缺表示未声明,不代表 `false`。
|
|
10
|
+
|
|
11
|
+
## 快速开始
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Checkbox } from '@apexhub/apex-ui-react'
|
|
15
|
+
|
|
16
|
+
import '@apexhub/apex-ui-react/style.css'
|
|
17
|
+
|
|
18
|
+
export default () => <Checkbox>Apex UI</Checkbox>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## 何时使用
|
|
22
|
+
|
|
23
|
+
- 用户可从多个选项中任选零个、一个或多个时(与 Radio 互斥单选相对)。
|
|
24
|
+
- 需要「全选 / 半选 / 全不选」父子联动时,父级使用 `indeterminate`。
|
|
25
|
+
- 若只能选一个,请使用 Radio 或 Radio.Group。
|
|
26
|
+
|
|
27
|
+
## API
|
|
28
|
+
|
|
29
|
+
仅使用类型定义支持的属性;原生属性、ref 目标和事件签名因组件而异。关联类型用于解释字段结构;只有「导出类型」中的名称可从包根导入。
|
|
30
|
+
|
|
31
|
+
### Checkbox
|
|
32
|
+
|
|
33
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
34
|
+
| --- | --- | --- | --- | --- |
|
|
35
|
+
| value | 在 `Checkbox.Group` 内作为子项时,标识该项对应取值(与组 `value` 数组比较) | `string \| number \| boolean` | 否 | — |
|
|
36
|
+
| checked | 是否选中(受控) | `boolean` | 否 | `false` |
|
|
37
|
+
| defaultChecked | 初始是否选中(非受控) | `boolean` | 否 | `false` |
|
|
38
|
+
| indeterminate | 半选(不确定)态,常用于全选父级;与 `checked` 并列,由实现合成 indeterminate 视觉态 | `boolean` | 否 | `false` |
|
|
39
|
+
| onChange | 状态变化时的回调 | `(event: CheckboxChangeEvent) => void` | 否 | — |
|
|
40
|
+
| classNames | 为各语义子结构自定义 `className`,支持对象或函数 | `Partial<Record<CheckboxSemanticDOM, string>> \| ((info: { props: Readonly<CheckboxProps> }) => Partial<Record<CheckboxSemanticDOM, string>>)` | 否 | — |
|
|
41
|
+
| styles | 为各语义子结构自定义内联样式(仅允许 CSS Token 等变量赋值,禁止业务硬编码色值) | `Partial<Record<CheckboxSemanticDOM, React.CSSProperties>> \| ((info: { props: Readonly<CheckboxProps> }) => Partial<Record<CheckboxSemanticDOM, React.CSSProperties>>)` | 否 | — |
|
|
42
|
+
| children | 主文案或与勾选框并排展示的内容 | `React.ReactNode` | 否 | — |
|
|
43
|
+
|
|
44
|
+
### RadixCheckboxRootProps
|
|
45
|
+
|
|
46
|
+
```typescript
|
|
47
|
+
type RadixCheckboxRootProps = React.ComponentProps<typeof Checkbox.Root>
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### CheckboxSemanticDOM
|
|
51
|
+
|
|
52
|
+
Checkbox 子结构语义,用于 `classNames` / `styles` 分段定制
|
|
53
|
+
|
|
54
|
+
```typescript
|
|
55
|
+
type CheckboxSemanticDOM = 'root' | 'indicator'
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### CheckboxOption
|
|
59
|
+
|
|
60
|
+
`Checkbox.Group` 的 `options` 项描述(`title` / `className` / `style` 作用于单个选项)
|
|
61
|
+
|
|
62
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
63
|
+
| --- | --- | --- | --- | --- |
|
|
64
|
+
| value | 选项值,出现在组的 `value` 与 `onChange` 回调数组中 | `string \| number \| boolean` | 是 | — |
|
|
65
|
+
| label | 展示文案;省略时可对 `value` 做字符串化 | `React.ReactNode` | 否 | — |
|
|
66
|
+
| title | 选项原生 `title`(悬停提示) | `string` | 否 | — |
|
|
67
|
+
| className | 选项根节点 `className` | `string` | 否 | — |
|
|
68
|
+
| style | 选项根节点样式(仅允许 CSS Token 等变量赋值,禁止业务硬编码色值) | `React.CSSProperties` | 否 | — |
|
|
69
|
+
| disabled | 是否禁用该选项 | `boolean` | 否 | — |
|
|
70
|
+
|
|
71
|
+
### CheckboxChangeTarget
|
|
72
|
+
|
|
73
|
+
继承:`EventTarget`;本节列出新增或重声明字段。
|
|
74
|
+
|
|
75
|
+
变更事件目标:通过 `target.checked` 读取是否选中;
|
|
76
|
+
|
|
77
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
78
|
+
| --- | --- | --- | --- | --- |
|
|
79
|
+
| checked | 是否选中(确定态) | `boolean` | 是 | — |
|
|
80
|
+
| indeterminate | 是否为半选(不确定)态 | `boolean` | 否 | — |
|
|
81
|
+
|
|
82
|
+
### CheckboxChangeEvent
|
|
83
|
+
|
|
84
|
+
继承:`React.SyntheticEvent<HTMLButtonElement, Event>`;本节列出新增或重声明字段。
|
|
85
|
+
|
|
86
|
+
选中状态变更时的回调事件对象
|
|
87
|
+
|
|
88
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
89
|
+
| --- | --- | --- | --- | --- |
|
|
90
|
+
| target | — | `CheckboxChangeTarget` | 是 | — |
|
|
91
|
+
|
|
92
|
+
### CheckboxGroupProps
|
|
93
|
+
|
|
94
|
+
继承:`Pick<
|
|
95
|
+
React.HTMLAttributes<HTMLDivElement>,
|
|
96
|
+
'className' | 'style' | 'id' | 'aria-label' | 'aria-labelledby' | 'aria-describedby' | 'role'
|
|
97
|
+
>`;本节列出新增或重声明字段。
|
|
98
|
+
|
|
99
|
+
Checkbox.Group Props
|
|
100
|
+
|
|
101
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
102
|
+
| --- | --- | --- | --- | --- |
|
|
103
|
+
| ref | 组容器 ref | `React.Ref<HTMLDivElement>` | 否 | — |
|
|
104
|
+
| defaultValue | 默认已选值(非受控) | `(string \| number \| boolean)[]` | 否 | `[]` |
|
|
105
|
+
| disabled | 整组是否禁用 | `boolean` | 否 | `false` |
|
|
106
|
+
| name | 子项共享的 `name`,对应原生复选框组;缺省可由实现生成 | `string` | 否 | — |
|
|
107
|
+
| options | 快捷生成选项;与 `children` 同时存在时优先 `options`,`children` 被忽略(dev 模式 warn) | `string[] \| number[] \| CheckboxOption[]` | 否 | `[]` |
|
|
108
|
+
| value | 当前已选值(受控) | `(string \| number \| boolean)[]` | 否 | `[]` |
|
|
109
|
+
| onChange | 已选值变化回调 | `(checkedValue: Array<string \| number \| boolean>) => void` | 否 | — |
|
|
110
|
+
| children | 自定义子节点(与 `options` 互斥;同时存在时 `options` 胜出) | `React.ReactNode` | 否 | — |
|
|
111
|
+
|
|
112
|
+
### 导出类型
|
|
113
|
+
|
|
114
|
+
另可从 `@apexhub/apex-ui-react` 导入:`CheckboxChangeEvent`、`CheckboxChangeTarget`、`CheckboxGroupProps`、`CheckboxOption`、`CheckboxProps`、`CheckboxSemanticDOM`(与上文子类型配合使用)。
|
|
115
|
+
|
|
116
|
+
## 代码演示
|
|
117
|
+
|
|
118
|
+
### 禁用状态
|
|
119
|
+
|
|
120
|
+
`disabled` 可用于单个复选框或整组复选框,禁用后不可切换。
|
|
121
|
+
|
|
122
|
+
```tsx
|
|
123
|
+
import { Checkbox } from '@apexhub/apex-ui-react'
|
|
124
|
+
|
|
125
|
+
export default () => (
|
|
126
|
+
<div style={{ display: 'flex', flexDirection: 'column', gap: 12 }}>
|
|
127
|
+
<Checkbox disabled>禁用</Checkbox>
|
|
128
|
+
<Checkbox disabled defaultChecked>
|
|
129
|
+
禁用且已选
|
|
130
|
+
</Checkbox>
|
|
131
|
+
<Checkbox.Group disabled defaultValue={['apple']}>
|
|
132
|
+
<Checkbox value="apple">苹果</Checkbox>
|
|
133
|
+
<Checkbox value="banana">香蕉</Checkbox>
|
|
134
|
+
</Checkbox.Group>
|
|
135
|
+
</div>
|
|
136
|
+
)
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### 多种状态
|
|
140
|
+
|
|
141
|
+
并排展示未选、选中、半选及禁用等常见状态,便于对照视觉与交互差异。
|
|
142
|
+
|
|
143
|
+
```tsx
|
|
144
|
+
import { Checkbox } from '@apexhub/apex-ui-react'
|
|
145
|
+
|
|
146
|
+
export default () => (
|
|
147
|
+
<div style={{ display: 'flex', flexDirection: 'column', gap: 12 }}>
|
|
148
|
+
<Checkbox>未选中</Checkbox>
|
|
149
|
+
<Checkbox defaultChecked>已选中</Checkbox>
|
|
150
|
+
<Checkbox indeterminate>半选</Checkbox>
|
|
151
|
+
<Checkbox disabled>禁用 - 未选</Checkbox>
|
|
152
|
+
<Checkbox disabled defaultChecked>
|
|
153
|
+
禁用 - 选中
|
|
154
|
+
</Checkbox>
|
|
155
|
+
<Checkbox disabled indeterminate>
|
|
156
|
+
禁用 - 半选
|
|
157
|
+
</Checkbox>
|
|
158
|
+
</div>
|
|
159
|
+
)
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### 受控用法
|
|
163
|
+
|
|
164
|
+
通过 `checked` 与 变更事件 控制选中;变更事件 通过 `e.target.checked` 读取是否选中。
|
|
165
|
+
|
|
166
|
+
```tsx
|
|
167
|
+
import { Checkbox } from '@apexhub/apex-ui-react'
|
|
168
|
+
|
|
169
|
+
import { useState } from 'react'
|
|
170
|
+
|
|
171
|
+
export default () => {
|
|
172
|
+
const [checked, setChecked] = useState(false)
|
|
173
|
+
return (
|
|
174
|
+
<div style={{ display: 'flex', flexDirection: 'column', gap: 8 }}>
|
|
175
|
+
<Checkbox checked={checked} onChange={(e) => setChecked(e.target.checked)}>
|
|
176
|
+
受控复选框
|
|
177
|
+
</Checkbox>
|
|
178
|
+
<span style={{ fontSize: 12 }}>状态:{checked ? '已选中' : '未选中'}</span>
|
|
179
|
+
</div>
|
|
180
|
+
)
|
|
181
|
+
}
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### 复选框组
|
|
185
|
+
|
|
186
|
+
用 `Checkbox.Group` 包裹多个 `Checkbox`,由组的 `value` / 变更事件 统一管理已选值。
|
|
187
|
+
|
|
188
|
+
```tsx
|
|
189
|
+
import { Checkbox } from '@apexhub/apex-ui-react'
|
|
190
|
+
|
|
191
|
+
export default () => (
|
|
192
|
+
<Checkbox.Group defaultValue={['apple']}>
|
|
193
|
+
<Checkbox value="apple">苹果</Checkbox>
|
|
194
|
+
<Checkbox value="banana">香蕉</Checkbox>
|
|
195
|
+
<Checkbox value="cherry">樱桃</Checkbox>
|
|
196
|
+
</Checkbox.Group>
|
|
197
|
+
)
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### 快捷选项
|
|
201
|
+
|
|
202
|
+
`options` 与 子内容 同时存在时,以 `options` 为准。
|
|
203
|
+
|
|
204
|
+
```tsx
|
|
205
|
+
import type { CheckboxOption } from '@apexhub/apex-ui-react'
|
|
206
|
+
|
|
207
|
+
import { Checkbox } from '@apexhub/apex-ui-react'
|
|
208
|
+
|
|
209
|
+
import { useState } from 'react'
|
|
210
|
+
|
|
211
|
+
const options: CheckboxOption[] = [
|
|
212
|
+
{ label: '苹果', value: 'apple' },
|
|
213
|
+
{ label: '香蕉', value: 'banana' },
|
|
214
|
+
{ label: '樱桃', value: 'cherry' },
|
|
215
|
+
]
|
|
216
|
+
|
|
217
|
+
export default () => {
|
|
218
|
+
const [value, setValue] = useState<Array<string | number | boolean>>(['banana'])
|
|
219
|
+
return (
|
|
220
|
+
<div style={{ display: 'flex', flexDirection: 'column', gap: 8 }}>
|
|
221
|
+
<Checkbox.Group options={options} value={value} onChange={setValue} />
|
|
222
|
+
<span style={{ fontSize: 12 }}>
|
|
223
|
+
已选:{value.length === 0 ? '(空)' : value.map(String).join(', ')}
|
|
224
|
+
</span>
|
|
225
|
+
</div>
|
|
226
|
+
)
|
|
227
|
+
}
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### 全选
|
|
231
|
+
|
|
232
|
+
`indeterminate` 常用于「全选」父级:子项只选中一部分时父级为半选,点击父级可在全选与全不选间切换。
|
|
233
|
+
|
|
234
|
+
```tsx
|
|
235
|
+
import type { CheckboxOption } from '@apexhub/apex-ui-react'
|
|
236
|
+
|
|
237
|
+
import { Checkbox } from '@apexhub/apex-ui-react'
|
|
238
|
+
|
|
239
|
+
import { useState } from 'react'
|
|
240
|
+
|
|
241
|
+
const options: CheckboxOption[] = [
|
|
242
|
+
{ label: '苹果', value: 'apple' },
|
|
243
|
+
{ label: '香蕉', value: 'banana' },
|
|
244
|
+
{ label: '樱桃', value: 'cherry' },
|
|
245
|
+
]
|
|
246
|
+
|
|
247
|
+
export default () => {
|
|
248
|
+
const [list, setList] = useState<string[]>(['apple'])
|
|
249
|
+
const all = options.map((o) => String(o.value))
|
|
250
|
+
const checkedAll = all.every((v) => list.includes(v))
|
|
251
|
+
const indeterminate = list.length > 0 && !checkedAll
|
|
252
|
+
|
|
253
|
+
return (
|
|
254
|
+
<div style={{ display: 'flex', flexDirection: 'column', gap: 12 }}>
|
|
255
|
+
<Checkbox
|
|
256
|
+
checked={checkedAll}
|
|
257
|
+
indeterminate={indeterminate}
|
|
258
|
+
onChange={(e) => setList(e.target.checked ? all : [])}
|
|
259
|
+
>
|
|
260
|
+
全选 / 取消
|
|
261
|
+
</Checkbox>
|
|
262
|
+
<Checkbox.Group
|
|
263
|
+
options={options}
|
|
264
|
+
value={list}
|
|
265
|
+
onChange={(next) => setList(next as string[])}
|
|
266
|
+
/>
|
|
267
|
+
</div>
|
|
268
|
+
)
|
|
269
|
+
}
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
### 自定义语义结构
|
|
273
|
+
|
|
274
|
+
通过 `classNames` 和 `styles` 为复选框的语义子结构(`root` / `indicator`)添加类名或样式。
|
|
275
|
+
|
|
276
|
+
```tsx
|
|
277
|
+
import type { CheckboxProps } from '@apexhub/apex-ui-react'
|
|
278
|
+
|
|
279
|
+
import { Checkbox } from '@apexhub/apex-ui-react'
|
|
280
|
+
|
|
281
|
+
import type * as React from 'react'
|
|
282
|
+
|
|
283
|
+
const styles: CheckboxProps['styles'] = {
|
|
284
|
+
root: {
|
|
285
|
+
'--checkbox-gap': 'var(--apex-spacing-3)',
|
|
286
|
+
} as React.CSSProperties,
|
|
287
|
+
indicator: {
|
|
288
|
+
opacity: 0.9,
|
|
289
|
+
},
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
export default () => (
|
|
293
|
+
<Checkbox
|
|
294
|
+
defaultChecked
|
|
295
|
+
classNames={{
|
|
296
|
+
root: 'custom-checkbox-root',
|
|
297
|
+
indicator: 'custom-checkbox-indicator',
|
|
298
|
+
}}
|
|
299
|
+
styles={styles}
|
|
300
|
+
>
|
|
301
|
+
自定义语义结构
|
|
302
|
+
</Checkbox>
|
|
303
|
+
)
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
## DOM 结构
|
|
307
|
+
|
|
308
|
+
源码声明的静态 `data-slot`:`checkbox-root`、`checkbox`、`checkbox-indicator`、`checkbox-label`、`checkbox-standalone-scope`、`checkbox-group`。具体节点随模式和状态出现,不表示固定嵌套顺序。
|
|
309
|
+
|
|
310
|
+
## 样式定制
|
|
311
|
+
|
|
312
|
+
优先使用本组件公开的尺寸、类型和状态属性。换肤与变量覆盖方式见 [主题指南](../llms-theme.txt)。
|
|
313
|
+
|
|
314
|
+
需要定制具体样式时再读取 [Token 明细](./checkbox.tokens.txt),其中包含用途、定义值及适用作用域。常规组件使用无需加载该文件。
|
|
315
|
+
|
|
316
|
+
## FAQ
|
|
317
|
+
|
|
318
|
+
### `options` 和 `children` 同时传了会怎样?
|
|
319
|
+
|
|
320
|
+
以 `options` 为准,`children` 会被忽略;开发模式下会输出警告。请只选一种渲染方式。
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
### `indeterminate` 和 `checked` 有什么区别?
|
|
325
|
+
|
|
326
|
+
`checked` 表示确定选中;`indeterminate` 表示半选(子项部分选中)。全选父级通常在子项未全选时设 `indeterminate={true}` 且 `checked={false}`。
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
### Group 的 `onChange` 和单个 Checkbox 的 `onChange` 一样吗?
|
|
331
|
+
|
|
332
|
+
不同。Group 的 `onChange` 直接收到当前已选值数组;单个 Checkbox 的 `onChange` 是事件对象,通过 `e.target.checked` 读取。
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Collapse Token 明细
|
|
2
|
+
|
|
3
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照)。
|
|
4
|
+
|
|
5
|
+
按需读取:[组件用法](./collapse.txt) · [主题与覆盖规则](../llms-theme.txt)。
|
|
6
|
+
|
|
7
|
+
以下组件变量在设计 Token 源中已定义,并被组件或其共享样式使用;不包含仅在实现中声明的临时变量。用途来自实际 CSS 属性,不是对外新增的 Props。
|
|
8
|
+
|
|
9
|
+
定义值依赖所列尺寸、变体、状态和媒体作用域;Alias 引用还会随 light/dark 主题改变。它们不是统一默认值或最终计算值。作用域用于解释定义位置,不代表内部选择器是稳定的定制 API。
|
|
10
|
+
|
|
11
|
+
| Token | 用途(CSS 属性) | 定义值 | 定义作用域 |
|
|
12
|
+
| --- | --- | --- | --- |
|
|
13
|
+
| `--collapse-fill-content-default` | `background-color` | `var(--apex-fill-neutral-primary)` | `.apex-collapse.apex-clean-collapse` |
|
|
14
|
+
| `--collapse-fill-content-default` | `background-color` | `var(--apex-fill-neutral-primary)` | `.apex-collapse.apex-default-collapse` |
|
|
15
|
+
| `--collapse-fill-header-default` | `background-color` | `var(--apex-fill-neutral-primary)` | `.apex-collapse.apex-clean-collapse` |
|
|
16
|
+
| `--collapse-fill-header-default` | `background-color` | `var(--apex-fill-neutral-secondary)` | `.apex-collapse.apex-default-collapse` |
|
|
17
|
+
| `--collapse-radius-radius-container` | `border-radius` | `var(--apex-radius-8)` | `.apex-collapse.apex-default-collapse` |
|
|
18
|
+
| `--collapse-spacing-gap-header` | `gap` | `var(--apex-spacing-4)` | `.apex-collapse.apex-default-collapse` |
|
|
19
|
+
| `--collapse-spacing-height-header` | `min-height` | `var(--apex-size-32)` | `.apex-collapse.apex-default-collapse` |
|
|
20
|
+
| `--collapse-spacing-padding-x-header` | `padding` | `var(--apex-spacing-4)` | `.apex-collapse.apex-default-collapse` |
|
|
21
|
+
| `--collapse-spacing-padding-x-left-content` | `padding` | `var(--apex-spacing-32)` | `.apex-collapse.apex-default-collapse` |
|
|
22
|
+
| `--collapse-spacing-padding-x-right-content` | `padding` | `var(--apex-spacing-8)` | `.apex-collapse.apex-default-collapse` |
|
|
23
|
+
| `--collapse-spacing-padding-y-content` | `padding` | `var(--apex-spacing-8)` | `.apex-collapse.apex-default-collapse` |
|
|
24
|
+
| `--collapse-stroke-container-default` | `border-color` | `var(--apex-stroke-neutral-quinary)` | `.apex-collapse.apex-clean-collapse` |
|
|
25
|
+
| `--collapse-stroke-container-default` | `border-color` | `var(--apex-stroke-neutral-quinary)` | `.apex-collapse.apex-default-collapse` |
|
|
26
|
+
| `--collapse-stroke-content-default` | `border-top-color` | `var(--apex-stroke-neutral-quinary)` | `.apex-collapse.apex-clean-collapse` |
|
|
27
|
+
| `--collapse-stroke-content-default` | `border-top-color` | `var(--apex-stroke-neutral-quinary)` | `.apex-collapse.apex-default-collapse` |
|
|
28
|
+
| `--collapse-stroke-header-default` | `border-top-color` | `var(--apex-stroke-neutral-transparent)` | `.apex-collapse.apex-clean-collapse` |
|
|
29
|
+
| `--collapse-stroke-header-default` | `border-top-color` | `var(--apex-stroke-neutral-quinary)` | `.apex-collapse.apex-default-collapse` |
|
|
30
|
+
| `--collapse-stroke-stroke-container` | `border-width` | `var(--apex-border-08)` | `.apex-collapse.apex-default-collapse` |
|
|
31
|
+
| `--collapse-stroke-stroke-content` | `border-top-width` | `var(--apex-border-08)` | `.apex-collapse.apex-default-collapse` |
|
|
32
|
+
| `--collapse-stroke-stroke-header` | `border-top-width` | `var(--apex-border-08)` | `.apex-collapse.apex-default-collapse` |
|
|
33
|
+
| `--collapse-text-content-default` | `color` | `var(--apex-text-neutral-primary)` | `.apex-collapse.apex-clean-collapse` |
|
|
34
|
+
| `--collapse-text-content-default` | `color` | `var(--apex-text-neutral-primary)` | `.apex-collapse.apex-default-collapse` |
|
|
35
|
+
| `--collapse-text-header-default` | `color` | `var(--apex-text-neutral-primary)` | `.apex-collapse.apex-clean-collapse` |
|
|
36
|
+
| `--collapse-text-header-default` | `color` | `var(--apex-text-neutral-primary)` | `.apex-collapse.apex-default-collapse` |
|
|
37
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-20)` | `.apex-font.apex-text-cn-body-font` |
|
|
38
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-18)` | `.apex-font.apex-text-cn-caption-font` |
|
|
39
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-36)` | `.apex-font.apex-text-cn-heading-1-font` |
|
|
40
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-28)` | `.apex-font.apex-text-cn-heading-2-font` |
|
|
41
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-24)` | `.apex-font.apex-text-cn-heading-3-font` |
|
|
42
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-24)` | `.apex-font.apex-text-cn-heading-4-font` |
|
|
43
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-20)` | `.apex-font.apex-text-en-body-font` |
|
|
44
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-18)` | `.apex-font.apex-text-en-caption-font` |
|
|
45
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-36)` | `.apex-font.apex-text-en-heading-1-font` |
|
|
46
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-28)` | `.apex-font.apex-text-en-heading-2-font` |
|
|
47
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-24)` | `.apex-font.apex-text-en-heading-3-font` |
|
|
48
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-24)` | `.apex-font.apex-text-en-heading-4-font` |
|
|
49
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-14)` | `.apex-font.apex-text-cn-body-font` |
|
|
50
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-12)` | `.apex-font.apex-text-cn-caption-font` |
|
|
51
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-24)` | `.apex-font.apex-text-cn-heading-1-font` |
|
|
52
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-18)` | `.apex-font.apex-text-cn-heading-2-font` |
|
|
53
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-16)` | `.apex-font.apex-text-cn-heading-3-font` |
|
|
54
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-16)` | `.apex-font.apex-text-cn-heading-4-font` |
|
|
55
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-14)` | `.apex-font.apex-text-en-body-font` |
|
|
56
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-12)` | `.apex-font.apex-text-en-caption-font` |
|
|
57
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-24)` | `.apex-font.apex-text-en-heading-1-font` |
|
|
58
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-18)` | `.apex-font.apex-text-en-heading-2-font` |
|
|
59
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-16)` | `.apex-font.apex-text-en-heading-3-font` |
|
|
60
|
+
| `--font-fontsize` | `font-size` | `var(--apex-fontsize-16)` | `.apex-font.apex-text-en-heading-4-font` |
|
|
61
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-0)` | `.apex-font.apex-text-cn-body-font` |
|
|
62
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-0)` | `.apex-font.apex-text-cn-caption-font` |
|
|
63
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-0)` | `.apex-font.apex-text-cn-heading-1-font` |
|
|
64
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-0)` | `.apex-font.apex-text-cn-heading-2-font` |
|
|
65
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-8)` | `.apex-font.apex-text-cn-heading-3-font` |
|
|
66
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-0)` | `.apex-font.apex-text-cn-heading-4-font` |
|
|
67
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-1)` | `.apex-font.apex-text-en-body-font` |
|
|
68
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-1)` | `.apex-font.apex-text-en-caption-font` |
|
|
69
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-1)` | `.apex-font.apex-text-en-heading-1-font` |
|
|
70
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-1)` | `.apex-font.apex-text-en-heading-2-font` |
|
|
71
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-1)` | `.apex-font.apex-text-en-heading-3-font` |
|
|
72
|
+
| `--font-fontspacing` | `letter-spacing` | `var(--apex-fontspacing-1)` | `.apex-font.apex-text-en-heading-4-font` |
|
|
73
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-400)` | `.apex-font.apex-text-cn-body-font` |
|
|
74
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-400)` | `.apex-font.apex-text-cn-caption-font` |
|
|
75
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-600)` | `.apex-font.apex-text-cn-heading-1-font` |
|
|
76
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-600)` | `.apex-font.apex-text-cn-heading-2-font` |
|
|
77
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-600)` | `.apex-font.apex-text-cn-heading-3-font` |
|
|
78
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-400)` | `.apex-font.apex-text-cn-heading-4-font` |
|
|
79
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-400)` | `.apex-font.apex-text-en-body-font` |
|
|
80
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-400)` | `.apex-font.apex-text-en-caption-font` |
|
|
81
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-600)` | `.apex-font.apex-text-en-heading-1-font` |
|
|
82
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-600)` | `.apex-font.apex-text-en-heading-2-font` |
|
|
83
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-600)` | `.apex-font.apex-text-en-heading-3-font` |
|
|
84
|
+
| `--font-fontweight` | `font-weight` | `var(--apex-fontweight-400)` | `.apex-font.apex-text-en-heading-4-font` |
|