@apexhub/apex-ui-react 0.0.0-stage → 1.2.2
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 +40727 -0
- package/dist/index.d.ts +6873 -0
- package/dist/index.mjs +40711 -0
- package/dist/llm/alert.tokens.txt +44 -0
- package/dist/llm/alert.txt +167 -0
- package/dist/llm/apex-provider.txt +369 -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 +143 -0
- package/dist/llm/breadcrumb.txt +251 -0
- package/dist/llm/button.tokens.txt +470 -0
- package/dist/llm/button.txt +270 -0
- package/dist/llm/card.tokens.txt +29 -0
- package/dist/llm/card.txt +118 -0
- package/dist/llm/cascader.tokens.txt +261 -0
- package/dist/llm/cascader.txt +917 -0
- package/dist/llm/checkbox.tokens.txt +36 -0
- package/dist/llm/checkbox.txt +343 -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 +428 -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 +28 -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 +491 -0
- package/dist/llm/input.tokens.txt +136 -0
- package/dist/llm/input.txt +424 -0
- package/dist/llm/layout.tokens.txt +29 -0
- package/dist/llm/layout.txt +298 -0
- package/dist/llm/menu.tokens.txt +100 -0
- package/dist/llm/menu.txt +687 -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 +35 -0
- package/dist/llm/pagination.txt +217 -0
- package/dist/llm/popover.tokens.txt +18 -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 +26 -0
- package/dist/llm/radio.txt +385 -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 +831 -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 +1049 -0
- package/dist/llm/tabs.tokens.txt +78 -0
- package/dist/llm/tabs.txt +306 -0
- package/dist/llm/tag.tokens.txt +75 -0
- package/dist/llm/tag.txt +304 -0
- package/dist/llm/tooltip.tokens.txt +22 -0
- package/dist/llm/tooltip.txt +304 -0
- package/dist/llm/tree-select.tokens.txt +175 -0
- package/dist/llm/tree-select.txt +772 -0
- package/dist/llm/tree.tokens.txt +34 -0
- package/dist/llm/tree.txt +501 -0
- package/dist/llm/typography.tokens.txt +60 -0
- package/dist/llm/typography.txt +413 -0
- package/dist/llm/upload.tokens.txt +205 -0
- package/dist/llm/upload.txt +708 -0
- package/dist/llms-full.txt +16826 -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 +20095 -0
- package/dist/zh_CN.d.ts +191 -0
- package/llms-full.txt +16826 -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 +369 -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 +143 -0
- package/src/button/llm.txt +270 -0
- package/src/button/tokens.txt +470 -0
- package/src/card/llm.txt +118 -0
- package/src/card/tokens.txt +29 -0
- package/src/cascader/llm.txt +917 -0
- package/src/cascader/tokens.txt +261 -0
- package/src/checkbox/llm.txt +343 -0
- package/src/checkbox/tokens.txt +36 -0
- package/src/collapse/llm.txt +330 -0
- package/src/collapse/tokens.txt +84 -0
- package/src/date-picker/llm.txt +428 -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 +28 -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 +424 -0
- package/src/input/tokens.txt +136 -0
- package/src/input-number/llm.txt +491 -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 +687 -0
- package/src/menu/tokens.txt +100 -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 +217 -0
- package/src/pagination/tokens.txt +35 -0
- package/src/popover/llm.txt +233 -0
- package/src/popover/tokens.txt +18 -0
- package/src/progress/llm.txt +279 -0
- package/src/progress/tokens.txt +83 -0
- package/src/radio/llm.txt +385 -0
- package/src/radio/tokens.txt +26 -0
- package/src/rate/llm.txt +241 -0
- package/src/rate/tokens.txt +20 -0
- package/src/select/llm.txt +831 -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 +1049 -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 +304 -0
- package/src/tag/tokens.txt +75 -0
- package/src/tooltip/llm.txt +304 -0
- package/src/tooltip/tokens.txt +22 -0
- package/src/tree/llm.txt +501 -0
- package/src/tree/tokens.txt +34 -0
- package/src/tree-select/llm.txt +772 -0
- package/src/tree-select/tokens.txt +175 -0
- package/src/typography/llm.txt +413 -0
- package/src/typography/tokens.txt +60 -0
- package/src/upload/llm.txt +708 -0
- package/src/upload/tokens.txt +205 -0
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
# Button
|
|
2
|
+
|
|
3
|
+
> Button:标记一个或多个操作(提交、确认、跳转等)时。
|
|
4
|
+
|
|
5
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.2`(当前源码快照,发布状态以安装包版本为准)。
|
|
6
|
+
|
|
7
|
+
公开导出:`Button`。
|
|
8
|
+
|
|
9
|
+
以下 API 属于 Apex UI;不要据 antd 的同名组件推断额外属性或默认值。默认值列的空缺表示未声明,不代表 `false`。
|
|
10
|
+
|
|
11
|
+
## 快速开始
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Button } from '@apexhub/apex-ui-react'
|
|
15
|
+
|
|
16
|
+
import '@apexhub/apex-ui-react/style.css'
|
|
17
|
+
|
|
18
|
+
export default () => <Button type="primary">主要按钮</Button>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## 何时使用
|
|
22
|
+
|
|
23
|
+
- 标记一个或多个操作(提交、确认、跳转等)时。
|
|
24
|
+
- 需要在不同业务线、不同页面保持一致的按钮外观时。
|
|
25
|
+
- 需要在自定义元素上复用按钮样式时,使用 `asChild`。
|
|
26
|
+
|
|
27
|
+
## API
|
|
28
|
+
|
|
29
|
+
仅使用类型定义支持的属性;原生属性、ref 目标和事件签名因组件而异。关联类型用于解释字段结构;只有「导出类型」中的名称可从包根导入。
|
|
30
|
+
|
|
31
|
+
### Button
|
|
32
|
+
|
|
33
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 | 版本 |
|
|
34
|
+
| --- | --- | --- | --- | --- | --- |
|
|
35
|
+
| type | 按钮类型,控制外观样式<br>- `default`:默认边框按钮(白底)<br>- `primary`:主色实心按钮<br>- `danger`:危险操作(边框红色)<br>- `text`:纯文字,无边框无背景<br>- `link`:链接样式,无边框无背景<br>注:`tabCapsule` 为 Tabs capsule 内部变体,不在对外 API 中暴露。 | `"default" \| "primary" \| "danger" \| "text" \| "link"` | 否 | `'default'` | `0.1.0` |
|
|
36
|
+
| variant | Figma visual style. When provided, it overrides the style implied by `type`.<br>- `main`: solid emphasis<br>- `outline`: bordered emphasis<br>- `secondary`: neutral filled action<br>- `text` / `text-secondary` / `link`: low-emphasis actions<br>- `icon` / `icon-primary`: icon-only actions with hover fill<br>- `icon-transparent`: icon-only action, fully transparent background | `"text" \| "link" \| "main" \| "outline" \| "secondary" \| "text-secondary" \| "icon" \| "icon-primary" \| "icon-transparent" \| null` | 否 | — | `0.1.0` |
|
|
37
|
+
| tone | Visual intent. `main`, `outline`, and `icon` support every tone;<br>`icon-primary`, `icon-transparent`, `secondary`, `text`,<br>`text-secondary`, and `link` use `default`.<br>When omitted, the legacy `danger` type resolves to `error`; other types<br>resolve to `default`. | `"default" \| "error" \| "success" \| "warning" \| null` | 否 | — | `0.1.0` |
|
|
38
|
+
| size | 按钮尺寸(`medium` 32px / `small` 24px;水平内边距共用 `--button-spacing-padding-x`) | `"small" \| "medium" \| null` | 否 | `'medium'` | `0.1.0` |
|
|
39
|
+
| disabled | 是否禁用。禁用时不可点击,视觉降级 | `boolean` | 否 | `false` | — |
|
|
40
|
+
| loading | 是否显示加载状态。<br>loading 为 true 时:不可点击,icon 位置替换为 loading 指示器 | `boolean` | 否 | `false` | `0.1.0` |
|
|
41
|
+
| loadingIcon | 加载态自定义图标。仅在 `loading` 为 true 时生效;<br>未传时使用内置 SVG spinner。 | `React.ReactNode` | 否 | — | — |
|
|
42
|
+
| htmlType | 原生 `<button>` 的 type 属性。仅普通 button 模式生效,与 `href` / `asChild` 互斥。 | `"button" \| "submit" \| "reset"` | 否 | `'button'` | — |
|
|
43
|
+
| href | 跳转地址。指定时渲染为 `<a>` 并保留按钮样式,此时 `htmlType` 失效。<br>与 `asChild` 同时使用时以 `asChild` 为准。 | `string` | 否 | — | — |
|
|
44
|
+
| target | 链接 target。依赖 `href`,仅在 `href` 存在时生效。 | `string` | 否 | — | — |
|
|
45
|
+
| asChild | 将按钮的样式与 props 合并到直接子元素上,而非渲染内置 `<button>` / `<a>`。<br>用于多态组合——让任意元素(如 `<a>`、路由 `Link`)拥有按钮外观。<br>优先级高于 `href` / `htmlType`。 | `boolean` | 否 | `false` | `0.1.0` |
|
|
46
|
+
| icon | 前置图标。loading 为 true 时此 prop 被 loading 指示器替换 | `React.ReactNode` | 否 | — | — |
|
|
47
|
+
| suffixIcon | 尾部图标;loading 时仍保留在文案后方。 | `React.ReactNode` | 否 | — | — |
|
|
48
|
+
| block | 是否撑满父容器宽度(`display: flex; width: 100%`) | `boolean \| null` | 否 | `false` | `0.1.0` |
|
|
49
|
+
| className | 根节点类名 | `string` | 否 | — | — |
|
|
50
|
+
| style | 根节点内联样式(禁止硬编码色值,优先 CSS Token) | `React.CSSProperties` | 否 | — | — |
|
|
51
|
+
| onClick | 点击事件处理器。<br>- asChild / href 模式下,event.currentTarget 可能是任意 HTML 元素<br>- disabled 或 loading 状态下此事件不会触发 | `React.MouseEventHandler<HTMLElement>` | 否 | — | — |
|
|
52
|
+
| children | 按钮内容。仅 icon、无文案时建议同时传入 `aria-label`。 | `React.ReactNode` | 否 | — | — |
|
|
53
|
+
| ref | 转发到根元素的 ref(button 或 a)。<br>React 19 起 ref 作为普通 prop 传递,无需 forwardRef 包装 | `React.Ref<HTMLButtonElement \| HTMLAnchorElement>` | 否 | — | — |
|
|
54
|
+
|
|
55
|
+
### ButtonVariants
|
|
56
|
+
|
|
57
|
+
从 CVA 推断的 variant props 类型
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
type ButtonVariants = VariantProps<typeof buttonVariants>
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### 导出类型
|
|
64
|
+
|
|
65
|
+
另可从 `@apexhub/apex-ui-react` 导入:`ButtonProps`(与上文子类型配合使用)。
|
|
66
|
+
|
|
67
|
+
## 约束
|
|
68
|
+
|
|
69
|
+
- `asChild` / `href` / 普通 `<button>` 三选一:同时传 `asChild` 与 `href` 时**以 `asChild` 为准**;`htmlType` 仅普通 button 模式生效。
|
|
70
|
+
- `target` 仅在 `href` 存在时生效;`loadingIcon` 仅在 `loading` 为 true 时生效。
|
|
71
|
+
- `disabled` 与 `loading` 都会拦截 `onClick`;二者不应同时表达同一状态。
|
|
72
|
+
- 仅图标、无文案时必须传 `aria-label`,否则屏幕阅读器无法朗读。
|
|
73
|
+
|
|
74
|
+
## 代码演示
|
|
75
|
+
|
|
76
|
+
### 外观类型
|
|
77
|
+
|
|
78
|
+
通过 `type` 控制外观:`default`、`primary`、`danger`、`text`、`link`。`main` / `outline` / `icon` 等 Figma 样式可通过 `variant` + `tone` 组合;`text-secondary` 对应设计稿的透明文字样式,`icon-primary` 对应主色图标按钮。显式传入 `variant` 时优先于 `type`。
|
|
79
|
+
|
|
80
|
+
```tsx
|
|
81
|
+
import { Button } from '@apexhub/apex-ui-react'
|
|
82
|
+
|
|
83
|
+
export default () => (
|
|
84
|
+
<div style={{ display: 'flex', gap: 12, flexWrap: 'wrap', alignItems: 'center' }}>
|
|
85
|
+
<Button>默认</Button>
|
|
86
|
+
<Button type="primary">主要</Button>
|
|
87
|
+
<Button type="danger">危险</Button>
|
|
88
|
+
<Button type="text">文字</Button>
|
|
89
|
+
<Button type="link">链接</Button>
|
|
90
|
+
</div>
|
|
91
|
+
)
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### 尺寸
|
|
95
|
+
|
|
96
|
+
提供 `medium`(默认)与 `small` 两种尺寸。对应文字为 14px / 20px 与 12px / 16px;前后图标占位分别为 20px 与 16px。
|
|
97
|
+
|
|
98
|
+
```tsx
|
|
99
|
+
import { Button } from '@apexhub/apex-ui-react'
|
|
100
|
+
|
|
101
|
+
export default () => (
|
|
102
|
+
<div style={{ display: 'flex', gap: 12, alignItems: 'center' }}>
|
|
103
|
+
<Button size="small" type="primary">
|
|
104
|
+
小
|
|
105
|
+
</Button>
|
|
106
|
+
<Button size="medium" type="primary">
|
|
107
|
+
中(默认)
|
|
108
|
+
</Button>
|
|
109
|
+
</div>
|
|
110
|
+
)
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### 加载态
|
|
114
|
+
|
|
115
|
+
`loading` 为 true 时按钮不可点击,前置图标区显示 loading 指示器;可通过 `loadingIcon` 自定义。仅图标无文案时建议传入 `aria-label`。
|
|
116
|
+
|
|
117
|
+
```tsx
|
|
118
|
+
import { Button } from '@apexhub/apex-ui-react'
|
|
119
|
+
|
|
120
|
+
export default () => (
|
|
121
|
+
<div style={{ display: 'flex', gap: 12, alignItems: 'center', flexWrap: 'wrap' }}>
|
|
122
|
+
<Button loading>加载中</Button>
|
|
123
|
+
<Button type="primary" loading>
|
|
124
|
+
提交中
|
|
125
|
+
</Button>
|
|
126
|
+
<Button type="primary" loading loadingIcon={<span aria-hidden>⏳</span>}>
|
|
127
|
+
自定义图标
|
|
128
|
+
</Button>
|
|
129
|
+
<Button type="primary" loading aria-label="提交中" />
|
|
130
|
+
</div>
|
|
131
|
+
)
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### 禁用状态
|
|
135
|
+
|
|
136
|
+
`disabled` 后按钮不可点击,视觉降级;该状态下不会触发 点击事件。
|
|
137
|
+
|
|
138
|
+
```tsx
|
|
139
|
+
import { Button } from '@apexhub/apex-ui-react'
|
|
140
|
+
|
|
141
|
+
export default () => (
|
|
142
|
+
<div style={{ display: 'flex', gap: 12, alignItems: 'center', flexWrap: 'wrap' }}>
|
|
143
|
+
<Button disabled>禁用</Button>
|
|
144
|
+
<Button type="primary" disabled>
|
|
145
|
+
禁用主要
|
|
146
|
+
</Button>
|
|
147
|
+
<Button type="danger" disabled>
|
|
148
|
+
禁用危险
|
|
149
|
+
</Button>
|
|
150
|
+
</div>
|
|
151
|
+
)
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### 图标
|
|
155
|
+
|
|
156
|
+
通过 `icon` 在文案前插入图标,`suffixIcon` 在文案后插入图标;`loading` 时前置 icon 会被 loading 指示器替换。
|
|
157
|
+
|
|
158
|
+
```tsx
|
|
159
|
+
import { Button } from '@apexhub/apex-ui-react'
|
|
160
|
+
|
|
161
|
+
const StarIcon = () => (
|
|
162
|
+
<svg width="14" height="14" viewBox="0 0 24 24" fill="currentColor" aria-hidden>
|
|
163
|
+
<path d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
|
|
164
|
+
</svg>
|
|
165
|
+
)
|
|
166
|
+
|
|
167
|
+
export default () => (
|
|
168
|
+
<div style={{ display: 'flex', gap: 12, alignItems: 'center', flexWrap: 'wrap' }}>
|
|
169
|
+
<Button icon={<StarIcon />}>带图标</Button>
|
|
170
|
+
<Button type="primary" icon={<StarIcon />}>
|
|
171
|
+
主要带图标
|
|
172
|
+
</Button>
|
|
173
|
+
<Button type="primary" icon={<StarIcon />} suffixIcon={<StarIcon />}>
|
|
174
|
+
前后图标
|
|
175
|
+
</Button>
|
|
176
|
+
<Button variant="text-secondary" suffixIcon={<StarIcon />}>
|
|
177
|
+
透明文字
|
|
178
|
+
</Button>
|
|
179
|
+
<Button type="primary" icon={<StarIcon />} aria-label="收藏" />
|
|
180
|
+
<Button variant="icon-primary" icon={<StarIcon />} aria-label="收藏(主色图标)" />
|
|
181
|
+
</div>
|
|
182
|
+
)
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### 全宽
|
|
186
|
+
|
|
187
|
+
`block` 撑满父容器宽度。
|
|
188
|
+
|
|
189
|
+
```tsx
|
|
190
|
+
import { Button } from '@apexhub/apex-ui-react'
|
|
191
|
+
|
|
192
|
+
export default () => (
|
|
193
|
+
<div style={{ width: 300 }}>
|
|
194
|
+
<Button type="primary" block>
|
|
195
|
+
全宽按钮
|
|
196
|
+
</Button>
|
|
197
|
+
</div>
|
|
198
|
+
)
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### 链接按钮
|
|
202
|
+
|
|
203
|
+
指定 `href`(及可选 `target`)时渲染为 `<a>` 并保留按钮样式。
|
|
204
|
+
|
|
205
|
+
```tsx
|
|
206
|
+
import { Button } from '@apexhub/apex-ui-react'
|
|
207
|
+
|
|
208
|
+
export default () => (
|
|
209
|
+
<Button href="https://example.com" target="_blank" type="primary">
|
|
210
|
+
跳转链接
|
|
211
|
+
</Button>
|
|
212
|
+
)
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### 自定义渲染
|
|
216
|
+
|
|
217
|
+
`asChild` 开启后由直接子元素承载按钮属性;与 `href` 同时使用时以 `asChild` 为准。
|
|
218
|
+
|
|
219
|
+
```tsx
|
|
220
|
+
import { Button } from '@apexhub/apex-ui-react'
|
|
221
|
+
|
|
222
|
+
export default () => (
|
|
223
|
+
<Button asChild type="primary">
|
|
224
|
+
<a href="https://example.com" target="_blank" rel="noreferrer">
|
|
225
|
+
渲染为 <a> 标签
|
|
226
|
+
</a>
|
|
227
|
+
</Button>
|
|
228
|
+
)
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
## DOM 结构
|
|
232
|
+
|
|
233
|
+
源码声明的静态 `data-slot`:`button-loading-icon`、`button-icon`、`button-suffix-icon`、`button-content`。具体节点随模式和状态出现,不表示固定嵌套顺序。
|
|
234
|
+
|
|
235
|
+
## 样式定制
|
|
236
|
+
|
|
237
|
+
优先使用本组件公开的尺寸、类型和状态属性。换肤与变量覆盖方式见 [主题指南](../llms-theme.txt)。
|
|
238
|
+
|
|
239
|
+
需要定制具体样式时再读取 [Token 明细](./button.tokens.txt),其中包含用途、定义值及适用作用域。常规组件使用无需加载该文件。
|
|
240
|
+
|
|
241
|
+
## FAQ
|
|
242
|
+
|
|
243
|
+
### `asChild` 和 `href` 同时传了,以哪个为准?
|
|
244
|
+
|
|
245
|
+
以 `asChild` 为准。开启 `asChild` 后按钮属性会交给直接子元素承载,此时 `href` / `target` 不再生效,跳转行为请由子元素自行实现(如 `<a>` 或路由组件)。
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
### 只有图标、没有文案,怎么保证可访问性?
|
|
249
|
+
|
|
250
|
+
给按钮传 `aria-label` 描述操作含义,例如 `<Button icon={<SearchIcon />} aria-label="搜索" />`,否则读屏用户无法得知按钮用途。
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
### `disabled` 和 `loading` 有什么区别?
|
|
255
|
+
|
|
256
|
+
两者都会拦截 `onClick`。`disabled` 是「当前不可用」的静态状态;`loading` 是「正在处理」,额外把 icon 换成 spinner 并标记 `aria-busy="true"`,语义上告诉辅助技术操作进行中。
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
### `loading` 时为什么 `icon` 不见了?
|
|
260
|
+
|
|
261
|
+
这是预期行为。`loading` 为 true 时,前置图标区会被 loading 指示器替换,以避免图标与转圈同时出现造成视觉拥挤。
|
|
262
|
+
|
|
263
|
+
### 没有 antd 的 `ghost` / `dashed` / `shape`?
|
|
264
|
+
|
|
265
|
+
没有。Apex Button 刻意收敛:保留 `type` 五档,并新增 `variant` + `tone` 对齐 Figma;`size` 两档,加载态用布尔 `loading`(自定义图标走 `loadingIcon`)。需要更复杂的形态请用 `className` / `asChild` 自行扩展。
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
### `type="danger"` 和 `type="default"` 宽度不一致?
|
|
269
|
+
|
|
270
|
+
`1.0.0` 起 `outline` / `main` / `secondary` 变体统一最小宽度(80px)。请确认已安装 `@apexhub/apex-ui-react@1.0.0` 并引入 `style.css`。
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Card Token 明细
|
|
2
|
+
|
|
3
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.2`(当前源码快照)。
|
|
4
|
+
|
|
5
|
+
按需读取:[组件用法](./card.txt) · [主题与覆盖规则](../llms-theme.txt)。
|
|
6
|
+
|
|
7
|
+
以下组件变量在设计 Token 源中已定义,并被组件或其共享样式使用;不包含仅在实现中声明的临时变量。用途来自实际 CSS 属性,不是对外新增的 Props。
|
|
8
|
+
|
|
9
|
+
定义值依赖所列尺寸、变体、状态和媒体作用域;Alias 引用还会随 light/dark 主题改变。它们不是统一默认值或最终计算值。作用域用于解释定义位置,不代表内部选择器是稳定的定制 API。
|
|
10
|
+
|
|
11
|
+
| Token | 用途(CSS 属性) | 定义值 | 定义作用域 |
|
|
12
|
+
| --- | --- | --- | --- |
|
|
13
|
+
| `--card-fill-default` | `background-color` | `var(--apex-fill-neutral-secondary)` | `.apex-card.apex-primary-card` |
|
|
14
|
+
| `--card-fill-default` | `background-color` | `var(--apex-fill-neutral-tertiary)` | `.apex-card.apex-secondary-card` |
|
|
15
|
+
| `--card-radius-radius` | `border-radius` | `var(--apex-radius-8)` | `.apex-card.apex-default-card` |
|
|
16
|
+
| `--card-spacing-gap-header` | `gap` | `var(--apex-spacing-8)` | `.apex-card.apex-default-card` |
|
|
17
|
+
| `--card-spacing-padding-x` | `padding` | `var(--apex-spacing-16)` | `.apex-card.apex-default-card` |
|
|
18
|
+
| `--card-spacing-padding-y-bottom` | `padding` | `var(--apex-spacing-16)` | `.apex-card.apex-default-card` |
|
|
19
|
+
| `--card-spacing-padding-y-top` | `padding-top` | `var(--apex-spacing-16)` | `.apex-card.apex-default-card` |
|
|
20
|
+
| `--card-spacing-padding-y-top-header` | `padding` | `var(--apex-spacing-12)` | `.apex-card.apex-default-card` |
|
|
21
|
+
| `--card-stroke-active` | `border-color` | `var(--apex-button-outline-brand-stroke-active)` | `.apex-card.apex-primary-card` |
|
|
22
|
+
| `--card-stroke-active` | `border-color` | `var(--apex-stroke-brand-tertiary)` | `.apex-card.apex-secondary-card` |
|
|
23
|
+
| `--card-stroke-default` | `border` | `var(--apex-stroke-neutral-secondary)` | `.apex-card.apex-primary-card` |
|
|
24
|
+
| `--card-stroke-default` | `border` | `var(--apex-stroke-neutral-tertiary)` | `.apex-card.apex-secondary-card` |
|
|
25
|
+
| `--card-stroke-hover` | `border-color` | `var(--apex-stroke-brand-secondary)` | `.apex-card.apex-primary-card` |
|
|
26
|
+
| `--card-stroke-hover` | `border-color` | `var(--apex-stroke-brand-secondary)` | `.apex-card.apex-secondary-card` |
|
|
27
|
+
| `--card-stroke-selected` | `border-color` | `var(--apex-stroke-brand-primary)` | `.apex-card.apex-primary-card` |
|
|
28
|
+
| `--card-stroke-selected` | `border-color` | `var(--apex-stroke-brand-primary)` | `.apex-card.apex-secondary-card` |
|
|
29
|
+
| `--card-stroke-stroke` | `border` | `var(--apex-border-1)` | `.apex-card.apex-default-card` |
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# Card
|
|
2
|
+
|
|
3
|
+
> Card:需要将一组相关信息收纳在带边框的容器内,与页面背景区分时。
|
|
4
|
+
|
|
5
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.2`(当前源码快照,发布状态以安装包版本为准)。
|
|
6
|
+
|
|
7
|
+
公开导出:`Card`。
|
|
8
|
+
|
|
9
|
+
以下 API 属于 Apex UI;不要据 antd 的同名组件推断额外属性或默认值。默认值列的空缺表示未声明,不代表 `false`。
|
|
10
|
+
|
|
11
|
+
## 快速开始
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Card } from '@apexhub/apex-ui-react'
|
|
15
|
+
|
|
16
|
+
import '@apexhub/apex-ui-react/style.css'
|
|
17
|
+
|
|
18
|
+
export default () => (
|
|
19
|
+
<Card title="卡片标题" style={{ width: 360 }}>
|
|
20
|
+
这是卡片内容区域,可放置任意 React 节点。
|
|
21
|
+
</Card>
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## 何时使用
|
|
26
|
+
|
|
27
|
+
- 需要将一组相关信息收纳在带边框的容器内,与页面背景区分时。
|
|
28
|
+
- 需要在卡片头部展示标题,并在右上角放置操作(链接、按钮、下拉等)时。
|
|
29
|
+
- 表单、列表、详情等模块需要统一的内容区块样式时。
|
|
30
|
+
|
|
31
|
+
## API
|
|
32
|
+
|
|
33
|
+
仅使用类型定义支持的属性;原生属性、ref 目标和事件签名因组件而异。关联类型用于解释字段结构;只有「导出类型」中的名称可从包根导入。
|
|
34
|
+
|
|
35
|
+
### Card
|
|
36
|
+
|
|
37
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
38
|
+
| --- | --- | --- | --- | --- |
|
|
39
|
+
| variant | 卡片表面层级;primary 用于页面主容器,secondary 用于嵌套区域 | `"primary" \| "secondary"` | 否 | — |
|
|
40
|
+
| title | 卡片标题,存在时渲染头部区域 | `React.ReactNode` | 否 | — |
|
|
41
|
+
| extra | 卡片右上角操作区域;与 title 任一存在即渲染 header | `React.ReactNode` | 否 | — |
|
|
42
|
+
| children | 卡片内容区 | `React.ReactNode` | 否 | — |
|
|
43
|
+
| ref | React 19 ref-as-prop | `React.Ref<HTMLDivElement>` | 否 | — |
|
|
44
|
+
| className | 根节点类名 | `string` | 否 | — |
|
|
45
|
+
| style | 根节点内联样式(禁止硬编码色值,优先 CSS Token) | `React.CSSProperties` | 否 | — |
|
|
46
|
+
|
|
47
|
+
### 导出类型
|
|
48
|
+
|
|
49
|
+
另可从 `@apexhub/apex-ui-react` 导入:`CardProps`(与上文子类型配合使用)。
|
|
50
|
+
|
|
51
|
+
## 代码演示
|
|
52
|
+
|
|
53
|
+
### 无标题
|
|
54
|
+
|
|
55
|
+
不传 `title` 与 `extra` 时仅渲染内容区,容器顶部内边距自动加大。
|
|
56
|
+
|
|
57
|
+
```tsx
|
|
58
|
+
import { Card } from '@apexhub/apex-ui-react'
|
|
59
|
+
|
|
60
|
+
export default () => <Card style={{ width: 360 }}>无标题形态:仅内容区,适合嵌入列表或栅格。</Card>
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### 带操作区
|
|
64
|
+
|
|
65
|
+
通过 `extra` 在标题行右侧放置操作内容;`title` 与 `extra` 任一存在即渲染头部区域。
|
|
66
|
+
|
|
67
|
+
```tsx
|
|
68
|
+
import { Button, Card } from '@apexhub/apex-ui-react'
|
|
69
|
+
|
|
70
|
+
export default () => (
|
|
71
|
+
<Card title="任务详情" extra={<Button type="link">编辑</Button>} style={{ width: 360 }}>
|
|
72
|
+
右上角通过 extra 放置操作按钮或链接。
|
|
73
|
+
</Card>
|
|
74
|
+
)
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### 表面层级
|
|
78
|
+
|
|
79
|
+
React Card 可用 `variant` 切换 `primary`(默认)和 `secondary` 表面。悬停、按下以及通过 `data-selected` 标记选中时,边框会显示对应状态。
|
|
80
|
+
|
|
81
|
+
```tsx
|
|
82
|
+
import { Card } from '@apexhub/apex-ui-react'
|
|
83
|
+
|
|
84
|
+
export default () => (
|
|
85
|
+
<div style={{ display: 'flex', flexWrap: 'wrap', gap: 16 }}>
|
|
86
|
+
<Card title="主表面" variant="primary" style={{ width: 240 }}>
|
|
87
|
+
页面中的主要内容区域
|
|
88
|
+
</Card>
|
|
89
|
+
<Card title="次级表面" variant="secondary" style={{ width: 240 }}>
|
|
90
|
+
需要区分层级的内容区域
|
|
91
|
+
</Card>
|
|
92
|
+
<Card title="已选中" variant="secondary" data-selected="" style={{ width: 240 }}>
|
|
93
|
+
通过 data-selected 标记选中状态
|
|
94
|
+
</Card>
|
|
95
|
+
</div>
|
|
96
|
+
)
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## DOM 结构
|
|
100
|
+
|
|
101
|
+
源码声明的静态 `data-slot`:`card`、`card-header`、`card-title`、`card-extra`、`card-body`。具体节点随模式和状态出现,不表示固定嵌套顺序。
|
|
102
|
+
|
|
103
|
+
## 样式定制
|
|
104
|
+
|
|
105
|
+
优先使用本组件公开的尺寸、类型和状态属性。换肤与变量覆盖方式见 [主题指南](../llms-theme.txt)。
|
|
106
|
+
|
|
107
|
+
需要定制具体样式时再读取 [Token 明细](./card.tokens.txt),其中包含用途、定义值及适用作用域。常规组件使用无需加载该文件。
|
|
108
|
+
|
|
109
|
+
## FAQ
|
|
110
|
+
|
|
111
|
+
### 如何切换「有标题 / 无标题」形态?
|
|
112
|
+
|
|
113
|
+
无需额外 prop:传入 `title` 或 `extra` 即为有标题形态;两者皆不传则为无标题形态。
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
### 支持 `hoverable`、`actions` 或 `cover` 吗?
|
|
117
|
+
|
|
118
|
+
当前 v1 未实现这些能力;需要封面或底部操作区时,请在 `children` 内自行布局。
|