@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
package/src/tag/llm.txt
ADDED
|
@@ -0,0 +1,305 @@
|
|
|
1
|
+
# Tag
|
|
2
|
+
|
|
3
|
+
> Tag:需要标记状态、分类、属性等短文本信息时(如「进行中」「VIP」)。
|
|
4
|
+
|
|
5
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照,发布状态以安装包版本为准)。
|
|
6
|
+
|
|
7
|
+
公开导出:`Tag`。
|
|
8
|
+
|
|
9
|
+
以下 API 属于 Apex UI;不要据 antd 的同名组件推断额外属性或默认值。默认值列的空缺表示未声明,不代表 `false`。
|
|
10
|
+
|
|
11
|
+
## 快速开始
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Tag } from '@apexhub/apex-ui-react'
|
|
15
|
+
|
|
16
|
+
import '@apexhub/apex-ui-react/style.css'
|
|
17
|
+
|
|
18
|
+
export default () => <Tag>默认标签</Tag>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## 何时使用
|
|
22
|
+
|
|
23
|
+
- 需要标记状态、分类、属性等短文本信息时(如「进行中」「VIP」)。
|
|
24
|
+
- 多选结果、筛选条件等可移除标签场景,配合 关闭事件 使用。
|
|
25
|
+
- 需要带链接的标签时,通过 `href` 渲染为 `<a>` 并保留标签外观。
|
|
26
|
+
|
|
27
|
+
## API
|
|
28
|
+
|
|
29
|
+
仅使用类型定义支持的属性;原生属性、ref 目标和事件签名因组件而异。关联类型用于解释字段结构;只有「导出类型」中的名称可从包根导入。
|
|
30
|
+
|
|
31
|
+
### Tag
|
|
32
|
+
|
|
33
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
34
|
+
| --- | --- | --- | --- | --- |
|
|
35
|
+
| closeIcon | 自定义关闭按钮。`false`/`null` 隐藏,`true` 使用默认图标,传入 ReactNode 自定义。 | `React.ReactNode` | 否 | `false` |
|
|
36
|
+
| color | 标签色(支持预设值与自定义色字符串)。<br>自定义字符串会作为 `backgroundColor` / `borderColor` 注入 inline style;<br>`data-color` 同步输出原始值,便于消费方覆盖。 | `TagColor` | 否 | `'default'` |
|
|
37
|
+
| disabled | 是否禁用标签交互。 | `boolean` | 否 | `false` |
|
|
38
|
+
| href | 点击跳转地址,存在时渲染为 a 标签。 | `string` | 否 | — |
|
|
39
|
+
| target | a 标签 target,href 存在时生效。 | `string` | 否 | — |
|
|
40
|
+
| icon | 前置图标(固定在文案前)。<br>后置或与文案混排时,请把图标写进 `children`;此时不套用 `.apex-tag__icon` 尺寸样式。 | `React.ReactNode` | 否 | — |
|
|
41
|
+
| onClose | 关闭时回调,可通过 `event.preventDefault()` 阻止自卸载。 | `(e: React.MouseEvent<HTMLElement, MouseEvent>) => void` | 否 | — |
|
|
42
|
+
| variant | 标签样式变体。 | `"filled" \| "solid" \| "outlined"` | 否 | `'filled'` |
|
|
43
|
+
| size | 标签尺寸(Apex 扩展;迁移者请注意默认 `md`)。 | `"lg" \| "md" \| "sm"` | 否 | `'md'` |
|
|
44
|
+
| ref | React 19 ref prop。 | `React.Ref<HTMLElement>` | 否 | — |
|
|
45
|
+
|
|
46
|
+
### TagVariant
|
|
47
|
+
|
|
48
|
+
```typescript
|
|
49
|
+
type TagVariant = 'filled' | 'solid' | 'outlined'
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### TagPresetColor
|
|
53
|
+
|
|
54
|
+
```typescript
|
|
55
|
+
type TagPresetColor = 'default' | 'brand' | 'success' | 'warning' | 'error'
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### TagColor
|
|
59
|
+
|
|
60
|
+
```typescript
|
|
61
|
+
type TagColor = TagPresetColor | string
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### TagSize
|
|
65
|
+
|
|
66
|
+
```typescript
|
|
67
|
+
type TagSize = 'lg' | 'md' | 'sm'
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### 导出类型
|
|
71
|
+
|
|
72
|
+
另可从 `@apexhub/apex-ui-react` 导入:`TagColor`、`TagPresetColor`、`TagProps`、`TagSize`、`TagVariant`(与上文子类型配合使用)。
|
|
73
|
+
|
|
74
|
+
## 代码演示
|
|
75
|
+
|
|
76
|
+
### 样式变体
|
|
77
|
+
|
|
78
|
+
通过 `variant` 切换浅底、实心和描边三种视觉样式。
|
|
79
|
+
|
|
80
|
+
```tsx
|
|
81
|
+
import { Tag } from '@apexhub/apex-ui-react'
|
|
82
|
+
|
|
83
|
+
export default () => (
|
|
84
|
+
<div style={{ display: 'flex', gap: 8, flexWrap: 'wrap' }}>
|
|
85
|
+
<Tag variant="filled">Filled</Tag>
|
|
86
|
+
<Tag variant="solid">Solid</Tag>
|
|
87
|
+
<Tag variant="outlined">Outlined</Tag>
|
|
88
|
+
</div>
|
|
89
|
+
)
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### 多彩标签
|
|
93
|
+
|
|
94
|
+
使用 `color` 表示语义色,也可以传入具体色值满足临时标记场景。
|
|
95
|
+
|
|
96
|
+
```tsx
|
|
97
|
+
import type { TagPresetColor, TagVariant } from '@apexhub/apex-ui-react'
|
|
98
|
+
|
|
99
|
+
import { Divider, Tag } from '@apexhub/apex-ui-react'
|
|
100
|
+
|
|
101
|
+
const variants: TagVariant[] = ['filled', 'solid', 'outlined']
|
|
102
|
+
|
|
103
|
+
const presets: TagPresetColor[] = ['default', 'brand', 'success', 'warning', 'error']
|
|
104
|
+
|
|
105
|
+
const customs = ['#f50', '#2db7f5', '#87d068', '#108ee9']
|
|
106
|
+
|
|
107
|
+
const stack = { display: 'flex', flexDirection: 'column' as const, gap: 16 }
|
|
108
|
+
|
|
109
|
+
const row = { display: 'flex', flexWrap: 'wrap' as const, gap: 8, alignItems: 'center' as const }
|
|
110
|
+
|
|
111
|
+
export default () => (
|
|
112
|
+
<div style={stack}>
|
|
113
|
+
{variants.map((variant) => (
|
|
114
|
+
<div key={`preset-${variant}`}>
|
|
115
|
+
<Divider titlePlacement="start">Presets ({variant})</Divider>
|
|
116
|
+
<div style={row}>
|
|
117
|
+
{presets.map((color) => (
|
|
118
|
+
<Tag key={color} color={color} variant={variant}>
|
|
119
|
+
{color}
|
|
120
|
+
</Tag>
|
|
121
|
+
))}
|
|
122
|
+
</div>
|
|
123
|
+
</div>
|
|
124
|
+
))}
|
|
125
|
+
{variants.map((variant) => (
|
|
126
|
+
<div key={`custom-${variant}`}>
|
|
127
|
+
<Divider titlePlacement="start">Custom ({variant})</Divider>
|
|
128
|
+
<div style={row}>
|
|
129
|
+
{customs.map((color) => (
|
|
130
|
+
<Tag key={color} color={color} variant={variant}>
|
|
131
|
+
{color}
|
|
132
|
+
</Tag>
|
|
133
|
+
))}
|
|
134
|
+
</div>
|
|
135
|
+
</div>
|
|
136
|
+
))}
|
|
137
|
+
</div>
|
|
138
|
+
)
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### 动态添加和删除
|
|
142
|
+
|
|
143
|
+
用数组维护一组标签:可关闭项在 关闭事件 中从列表移除,「+ 新标签」向列表追加。
|
|
144
|
+
|
|
145
|
+
```tsx
|
|
146
|
+
import { Button, Tag } from '@apexhub/apex-ui-react'
|
|
147
|
+
|
|
148
|
+
import { useState } from 'react'
|
|
149
|
+
|
|
150
|
+
export default () => {
|
|
151
|
+
const [tags, setTags] = useState(['标签 1', '标签 2', '标签 3'])
|
|
152
|
+
const [nextIndex, setNextIndex] = useState(4)
|
|
153
|
+
|
|
154
|
+
const addTag = () => {
|
|
155
|
+
const label = `标签 ${nextIndex}`
|
|
156
|
+
setNextIndex((n) => n + 1)
|
|
157
|
+
setTags((prev) => [...prev, label])
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
return (
|
|
161
|
+
<div
|
|
162
|
+
style={{
|
|
163
|
+
display: 'flex',
|
|
164
|
+
flexWrap: 'wrap',
|
|
165
|
+
gap: 8,
|
|
166
|
+
alignItems: 'center',
|
|
167
|
+
}}
|
|
168
|
+
>
|
|
169
|
+
<Tag>不可删除</Tag>
|
|
170
|
+
{tags.map((label) => (
|
|
171
|
+
<Tag key={label} onClose={() => setTags((prev) => prev.filter((t) => t !== label))}>
|
|
172
|
+
{label}
|
|
173
|
+
</Tag>
|
|
174
|
+
))}
|
|
175
|
+
<Button
|
|
176
|
+
type="text"
|
|
177
|
+
size="small"
|
|
178
|
+
onClick={addTag}
|
|
179
|
+
style={{
|
|
180
|
+
border: 'none',
|
|
181
|
+
background: 'transparent',
|
|
182
|
+
color: 'var(--apex-text-brand-primary)',
|
|
183
|
+
cursor: 'pointer',
|
|
184
|
+
padding: '0 4px',
|
|
185
|
+
fontSize: 14,
|
|
186
|
+
lineHeight: 1.5715,
|
|
187
|
+
}}
|
|
188
|
+
>
|
|
189
|
+
+ 新标签
|
|
190
|
+
</Button>
|
|
191
|
+
</div>
|
|
192
|
+
)
|
|
193
|
+
}
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### 图标
|
|
197
|
+
|
|
198
|
+
`icon` 固定渲染在文案前,并套用 `.apex-tag__icon` 尺寸样式,适合标准前置图标。
|
|
199
|
+
|
|
200
|
+
若需把图标放在文案后(或与文案混排),可直接在 子内容 中写入图标节点;此时不会走 `icon` 插槽样式,需自行控制图标尺寸。
|
|
201
|
+
|
|
202
|
+
```tsx
|
|
203
|
+
import { Tag } from '@apexhub/apex-ui-react'
|
|
204
|
+
|
|
205
|
+
export default () => (
|
|
206
|
+
<div style={{ display: 'flex', gap: 8, flexWrap: 'wrap', alignItems: 'center' }}>
|
|
207
|
+
<Tag icon={<span aria-hidden="true">★</span>}>前置(icon)</Tag>
|
|
208
|
+
<Tag color="success" icon={<span aria-hidden="true">✓</span>}>
|
|
209
|
+
成功
|
|
210
|
+
</Tag>
|
|
211
|
+
<Tag>
|
|
212
|
+
后置(children)
|
|
213
|
+
<span aria-hidden="true">★</span>
|
|
214
|
+
</Tag>
|
|
215
|
+
<Tag size="sm" variant="outlined" color="brand">
|
|
216
|
+
混排
|
|
217
|
+
<span aria-hidden="true">◆</span>
|
|
218
|
+
</Tag>
|
|
219
|
+
</div>
|
|
220
|
+
)
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### 禁用状态
|
|
224
|
+
|
|
225
|
+
`disabled` 时禁止点击和关闭交互。
|
|
226
|
+
|
|
227
|
+
```tsx
|
|
228
|
+
import { Tag } from '@apexhub/apex-ui-react'
|
|
229
|
+
|
|
230
|
+
const noop = () => undefined
|
|
231
|
+
|
|
232
|
+
export default () => (
|
|
233
|
+
<div style={{ display: 'flex', gap: 8, flexWrap: 'wrap', alignItems: 'center' }}>
|
|
234
|
+
<Tag disabled>禁用</Tag>
|
|
235
|
+
<Tag disabled color="brand">
|
|
236
|
+
禁用品牌色
|
|
237
|
+
</Tag>
|
|
238
|
+
<Tag disabled onClose={noop}>
|
|
239
|
+
禁用且不显示关闭
|
|
240
|
+
</Tag>
|
|
241
|
+
</div>
|
|
242
|
+
)
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### 链接标签
|
|
246
|
+
|
|
247
|
+
指定 `href` 时渲染为链接,同时保留标签外观。
|
|
248
|
+
|
|
249
|
+
```tsx
|
|
250
|
+
import { Tag } from '@apexhub/apex-ui-react'
|
|
251
|
+
|
|
252
|
+
export default () => (
|
|
253
|
+
<div style={{ display: 'flex', gap: 8, flexWrap: 'wrap', alignItems: 'center' }}>
|
|
254
|
+
<Tag href="https://example.com" target="_blank" color="brand">
|
|
255
|
+
链接标签
|
|
256
|
+
</Tag>
|
|
257
|
+
<Tag href="https://example.com" target="_blank" variant="outlined" color="success">
|
|
258
|
+
描边链接
|
|
259
|
+
</Tag>
|
|
260
|
+
</div>
|
|
261
|
+
)
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### 尺寸
|
|
265
|
+
|
|
266
|
+
提供 `lg`、`md`(默认)与 `sm` 三种尺寸。
|
|
267
|
+
|
|
268
|
+
```tsx
|
|
269
|
+
import { Tag } from '@apexhub/apex-ui-react'
|
|
270
|
+
|
|
271
|
+
export default () => (
|
|
272
|
+
<div style={{ display: 'flex', gap: 12, alignItems: 'center', flexWrap: 'wrap' }}>
|
|
273
|
+
<Tag size="md">中等 md</Tag>
|
|
274
|
+
<Tag size="sm">小号 sm</Tag>
|
|
275
|
+
</div>
|
|
276
|
+
)
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
## DOM 结构
|
|
280
|
+
|
|
281
|
+
源码声明的静态 `data-slot`:`tag-content`、`tag-close`。具体节点随模式和状态出现,不表示固定嵌套顺序。
|
|
282
|
+
|
|
283
|
+
## 样式定制
|
|
284
|
+
|
|
285
|
+
优先使用本组件公开的尺寸、类型和状态属性。换肤与变量覆盖方式见 [主题指南](../../llms-theme.txt)。
|
|
286
|
+
|
|
287
|
+
需要定制具体样式时再读取 [Token 明细](./tokens.txt),其中包含用途、定义值及适用作用域。常规组件使用无需加载该文件。
|
|
288
|
+
|
|
289
|
+
## FAQ
|
|
290
|
+
|
|
291
|
+
### 关闭标签后如何阻止它消失?
|
|
292
|
+
|
|
293
|
+
在 `onClose` 回调中调用 `event.preventDefault()`。组件不提供 `visible` 受控 API;若需完全受控显隐,请通过父级 `key` 重建或自行管理列表状态。
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
### `onClose` 和 `closeIcon` 是什么关系?
|
|
298
|
+
|
|
299
|
+
传入 `onClose` 或 `closeIcon` 为真值(非 `false`/`null`)时都会渲染关闭区。`closeIcon` 可自定义关闭按钮外观,`true` 使用默认图标。
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
### 图标只能放在文案前面吗?
|
|
304
|
+
|
|
305
|
+
`icon` 只支持前置。若要后置或与文案混排,把图标写进 `children` 即可,例如 `<Tag>标签 <StarIcon /></Tag>`。注意 `children` 内的图标不会自动套用 `--tag-icon` 尺寸,需自行控制样式。
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Tag Token 明细
|
|
2
|
+
|
|
3
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照)。
|
|
4
|
+
|
|
5
|
+
按需读取:[组件用法](./llm.txt) · [主题与覆盖规则](../../llms-theme.txt)。
|
|
6
|
+
|
|
7
|
+
以下组件变量在设计 Token 源中已定义,并被组件或其共享样式使用;不包含仅在实现中声明的临时变量。用途来自实际 CSS 属性,不是对外新增的 Props。
|
|
8
|
+
|
|
9
|
+
定义值依赖所列尺寸、变体、状态和媒体作用域;Alias 引用还会随 light/dark 主题改变。它们不是统一默认值或最终计算值。作用域用于解释定义位置,不代表内部选择器是稳定的定制 API。
|
|
10
|
+
|
|
11
|
+
| Token | 用途(CSS 属性) | 定义值 | 定义作用域 |
|
|
12
|
+
| --- | --- | --- | --- |
|
|
13
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-20)` | `.apex-font.apex-text-cn-body-font` |
|
|
14
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-18)` | `.apex-font.apex-text-cn-caption-font` |
|
|
15
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-36)` | `.apex-font.apex-text-cn-heading-1-font` |
|
|
16
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-28)` | `.apex-font.apex-text-cn-heading-2-font` |
|
|
17
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-24)` | `.apex-font.apex-text-cn-heading-3-font` |
|
|
18
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-24)` | `.apex-font.apex-text-cn-heading-4-font` |
|
|
19
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-20)` | `.apex-font.apex-text-en-body-font` |
|
|
20
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-18)` | `.apex-font.apex-text-en-caption-font` |
|
|
21
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-36)` | `.apex-font.apex-text-en-heading-1-font` |
|
|
22
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-28)` | `.apex-font.apex-text-en-heading-2-font` |
|
|
23
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-24)` | `.apex-font.apex-text-en-heading-3-font` |
|
|
24
|
+
| `--font-fontheight` | `line-height` | `var(--apex-fontheight-24)` | `.apex-font.apex-text-en-heading-4-font` |
|
|
25
|
+
| `--tag-active` | `color` | `var(--apex-icon-neutral-tertiary)` | `.apex-tag.apex-close-tag` |
|
|
26
|
+
| `--tag-default` | `color` | `var(--apex-icon-neutral-primary)` | `.apex-tag.apex-close-tag` |
|
|
27
|
+
| `--tag-fill-default` | `background-color` | `var(--apex-fill-brand-alpha-secondary)` | `.apex-tag.apex-filled-default-brand-tag` |
|
|
28
|
+
| `--tag-fill-default` | `background-color` | `var(--apex-fill-neutral-secondary)` | `.apex-tag.apex-filled-default-default-tag` |
|
|
29
|
+
| `--tag-fill-default` | `background-color` | `var(--apex-fill-error-alpha-secondary)` | `.apex-tag.apex-filled-default-error-tag` |
|
|
30
|
+
| `--tag-fill-default` | `background-color` | `var(--apex-fill-neutral-quaternary)` | `.apex-tag.apex-filled-default-grey-tag` |
|
|
31
|
+
| `--tag-fill-default` | `background-color` | `var(--apex-fill-success-alpha-secondary)` | `.apex-tag.apex-filled-default-success-tag` |
|
|
32
|
+
| `--tag-fill-default` | `background-color` | `var(--apex-fill-warning-alpha-secondary)` | `.apex-tag.apex-filled-default-warning-tag` |
|
|
33
|
+
| `--tag-fill-default` | `background-color` | `var(--apex-fill-neutral-secondary)` | `.apex-tag.apex-outlined-default-tag` |
|
|
34
|
+
| `--tag-hover` | `color` | `var(--apex-icon-neutral-tertiary)` | `.apex-tag.apex-close-tag` |
|
|
35
|
+
| `--tag-icon-default` | `color` | `var(--apex-icon-brand-primary)` | `.apex-tag.apex-filled-default-brand-tag` |
|
|
36
|
+
| `--tag-icon-default` | `color` | `var(--apex-icon-neutral-primary)` | `.apex-tag.apex-filled-default-default-tag` |
|
|
37
|
+
| `--tag-icon-default` | `color` | `var(--apex-icon-error-primary)` | `.apex-tag.apex-filled-default-error-tag` |
|
|
38
|
+
| `--tag-icon-default` | `color` | `var(--apex-icon-neutral-primary)` | `.apex-tag.apex-filled-default-grey-tag` |
|
|
39
|
+
| `--tag-icon-default` | `color` | `var(--apex-icon-success-primary)` | `.apex-tag.apex-filled-default-success-tag` |
|
|
40
|
+
| `--tag-icon-default` | `color` | `var(--apex-icon-warning-primary)` | `.apex-tag.apex-filled-default-warning-tag` |
|
|
41
|
+
| `--tag-icon-default` | `color` | `var(--apex-icon-neutral-primary)` | `.apex-tag.apex-outlined-default-tag` |
|
|
42
|
+
| `--tag-icon-icon` | `font-size`、`height`、`width` | `var(--apex-icon-20)` | `.apex-tag.apex-lg-tag` |
|
|
43
|
+
| `--tag-icon-icon` | `font-size`、`height`、`width` | `var(--apex-icon-16)` | `.apex-tag.apex-md-tag` |
|
|
44
|
+
| `--tag-icon-icon` | `font-size`、`height`、`width` | `var(--apex-icon-16)` | `.apex-tag.apex-sm-tag` |
|
|
45
|
+
| `--tag-radius-radius` | `border-radius` | `var(--apex-radius-8)` | `.apex-tag.apex-lg-tag` |
|
|
46
|
+
| `--tag-radius-radius` | `border-radius` | `var(--apex-radius-8)` | `.apex-tag.apex-md-tag` |
|
|
47
|
+
| `--tag-radius-radius` | `border-radius` | `var(--apex-radius-8)` | `.apex-tag.apex-sm-tag` |
|
|
48
|
+
| `--tag-size-height` | `height` | `var(--apex-size-28)` | `.apex-tag.apex-lg-tag` |
|
|
49
|
+
| `--tag-size-height` | `height` | `var(--apex-size-24)` | `.apex-tag.apex-md-tag` |
|
|
50
|
+
| `--tag-size-height` | `height` | `var(--apex-size-20)` | `.apex-tag.apex-sm-tag` |
|
|
51
|
+
| `--tag-size-width-max` | `max-width` | `var(--apex-size-180)` | `.apex-tag.apex-lg-tag` |
|
|
52
|
+
| `--tag-size-width-max` | `max-width` | `var(--apex-size-180)` | `.apex-tag.apex-md-tag` |
|
|
53
|
+
| `--tag-size-width-max` | `max-width` | `var(--apex-size-180)` | `.apex-tag.apex-sm-tag` |
|
|
54
|
+
| `--tag-spacing-gap` | `gap` | `var(--apex-spacing-4)` | `.apex-tag.apex-lg-tag` |
|
|
55
|
+
| `--tag-spacing-gap` | `gap` | `var(--apex-spacing-4)` | `.apex-tag.apex-md-tag` |
|
|
56
|
+
| `--tag-spacing-gap` | `gap` | `var(--apex-spacing-4)` | `.apex-tag.apex-sm-tag` |
|
|
57
|
+
| `--tag-spacing-padding-x` | `padding` | `var(--apex-spacing-8)` | `.apex-tag.apex-lg-tag` |
|
|
58
|
+
| `--tag-spacing-padding-x` | `padding` | `var(--apex-spacing-8)` | `.apex-tag.apex-md-tag` |
|
|
59
|
+
| `--tag-spacing-padding-x` | `padding` | `var(--apex-spacing-6)` | `.apex-tag.apex-sm-tag` |
|
|
60
|
+
| `--tag-stroke-default` | `border-color` | `var(--apex-stroke-brand-transparent)` | `.apex-tag.apex-filled-default-brand-tag` |
|
|
61
|
+
| `--tag-stroke-default` | `border-color` | `var(--apex-stroke-neutral-transparent)` | `.apex-tag.apex-filled-default-default-tag` |
|
|
62
|
+
| `--tag-stroke-default` | `border-color` | `var(--apex-stroke-error-transparent)` | `.apex-tag.apex-filled-default-error-tag` |
|
|
63
|
+
| `--tag-stroke-default` | `border-color` | `var(--apex-stroke-neutral-transparent)` | `.apex-tag.apex-filled-default-grey-tag` |
|
|
64
|
+
| `--tag-stroke-default` | `border-color` | `var(--apex-stroke-success-transparent)` | `.apex-tag.apex-filled-default-success-tag` |
|
|
65
|
+
| `--tag-stroke-default` | `border-color` | `var(--apex-stroke-warning-transparent)` | `.apex-tag.apex-filled-default-warning-tag` |
|
|
66
|
+
| `--tag-stroke-default` | `border-color` | `var(--apex-stroke-neutral-quinary)` | `.apex-tag.apex-outlined-default-tag` |
|
|
67
|
+
| `--tag-stroke-stroke` | `border-width` | `var(--apex-border-1)` | `.apex-tag.apex-lg-tag` |
|
|
68
|
+
| `--tag-stroke-stroke` | `border-width` | `var(--apex-border-1)` | `.apex-tag.apex-md-tag` |
|
|
69
|
+
| `--tag-stroke-stroke` | `border-width` | `var(--apex-border-1)` | `.apex-tag.apex-sm-tag` |
|
|
70
|
+
| `--tag-text-default` | `color` | `var(--apex-text-neutral-secondary)` | `.apex-tag.apex-filled-default-brand-tag` |
|
|
71
|
+
| `--tag-text-default` | `color` | `var(--apex-text-neutral-secondary)` | `.apex-tag.apex-filled-default-default-tag` |
|
|
72
|
+
| `--tag-text-default` | `color` | `var(--apex-text-neutral-secondary)` | `.apex-tag.apex-filled-default-error-tag` |
|
|
73
|
+
| `--tag-text-default` | `color` | `var(--apex-text-neutral-secondary)` | `.apex-tag.apex-filled-default-grey-tag` |
|
|
74
|
+
| `--tag-text-default` | `color` | `var(--apex-text-neutral-secondary)` | `.apex-tag.apex-filled-default-success-tag` |
|
|
75
|
+
| `--tag-text-default` | `color` | `var(--apex-text-neutral-secondary)` | `.apex-tag.apex-filled-default-warning-tag` |
|
|
76
|
+
| `--tag-text-default` | `color` | `var(--apex-text-neutral-primary)` | `.apex-tag.apex-outlined-default-tag` |
|
|
@@ -0,0 +1,304 @@
|
|
|
1
|
+
# Tooltip
|
|
2
|
+
|
|
3
|
+
> Tooltip:图标按钮、缩写、截断文本等需要补充说明时。
|
|
4
|
+
|
|
5
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照,发布状态以安装包版本为准)。
|
|
6
|
+
|
|
7
|
+
公开导出:`Tooltip`。
|
|
8
|
+
|
|
9
|
+
以下 API 属于 Apex UI;不要据 antd 的同名组件推断额外属性或默认值。默认值列的空缺表示未声明,不代表 `false`。
|
|
10
|
+
|
|
11
|
+
## 快速开始
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Button, Tooltip } from '@apexhub/apex-ui-react'
|
|
15
|
+
|
|
16
|
+
import '@apexhub/apex-ui-react/style.css'
|
|
17
|
+
|
|
18
|
+
export default () => (
|
|
19
|
+
<Tooltip title="鼠标悬停查看提示">
|
|
20
|
+
<Button>悬停我</Button>
|
|
21
|
+
</Tooltip>
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## 何时使用
|
|
26
|
+
|
|
27
|
+
- 图标按钮、缩写、截断文本等需要补充说明时。
|
|
28
|
+
- 提示内容为短文本,不宜用 Modal 或 Popover 承载时。
|
|
29
|
+
- 若需承载复杂交互或大块内容,请使用 Popover。
|
|
30
|
+
|
|
31
|
+
## API
|
|
32
|
+
|
|
33
|
+
仅使用类型定义支持的属性;原生属性、ref 目标和事件签名因组件而异。关联类型用于解释字段结构;只有「导出类型」中的名称可从包根导入。
|
|
34
|
+
|
|
35
|
+
### Tooltip
|
|
36
|
+
|
|
37
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
38
|
+
| --- | --- | --- | --- | --- |
|
|
39
|
+
| title | 提示内容 | `React.ReactNode \| (() => React.ReactNode)` | 否 | — |
|
|
40
|
+
| children | 触发 Tooltip 的子元素(必须是**单个可聚焦元素** —— `<button>` / `<a>` / `<input>` 等)。<br>非 valid React element 时 dev 模式会 `console.warn` 并用 `<button>` 兜底以保证键盘可达。 | `React.ReactNode` | 是 | — |
|
|
41
|
+
| color | 浮层背景色;文本色仍走 `--tooltip-text-default`。<br>推荐传入 token (`var(--apex-fill-*)`) 而非字面 hex/rgb。 | `string` | 否 | — |
|
|
42
|
+
| arrow | 是否展示箭头,或配置箭头是否指向触发元素中心 | `boolean \| TooltipArrowConfig` | 否 | `true` |
|
|
43
|
+
| autoAdjustOverflow | 气泡被遮挡时是否自动调整位置 | `boolean` | 否 | `true` |
|
|
44
|
+
| defaultOpen | 非受控初始显隐 | `boolean` | 否 | `false` |
|
|
45
|
+
| destroyOnHidden | 关闭后是否销毁浮层 DOM | `boolean` | 否 | `false` |
|
|
46
|
+
| fresh | 每次打开时重新渲染内容 | `boolean` | 否 | `false` |
|
|
47
|
+
| mouseEnterDelay | 鼠标移入后延时显示,单位:秒。**仅在 `trigger` 包含 `'hover'` 时生效** | `number` | 否 | `0.1` |
|
|
48
|
+
| mouseLeaveDelay | 鼠标移出后延时隐藏,单位:秒。**仅在 `trigger` 包含 `'hover'` 时生效** | `number` | 否 | `0.1` |
|
|
49
|
+
| placement | 气泡相对触发元素的方位 | `"top" \| "left" \| "right" \| "bottom" \| "topLeft" \| "topRight" \| "bottomLeft" \| "bottomRight" \| "leftTop" \| "leftBottom" \| "rightTop" \| "rightBottom"` | 否 | `'top'` |
|
|
50
|
+
| trigger | 触发方式,支持单值或数组组合 | `TooltipTrigger \| TooltipTrigger[]` | 否 | `'hover'` |
|
|
51
|
+
| open | 受控显隐;传入后与 `onOpenChange` 配合使用 | `boolean` | 否 | — |
|
|
52
|
+
| onOpenChange | 显隐变化回调 | `(open: boolean) => void` | 否 | — |
|
|
53
|
+
|
|
54
|
+
### TooltipPlacement
|
|
55
|
+
|
|
56
|
+
12 方位 placement
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
type TooltipPlacement = | 'top'
|
|
60
|
+
| 'left'
|
|
61
|
+
| 'right'
|
|
62
|
+
| 'bottom'
|
|
63
|
+
| 'topLeft'
|
|
64
|
+
| 'topRight'
|
|
65
|
+
| 'bottomLeft'
|
|
66
|
+
| 'bottomRight'
|
|
67
|
+
| 'leftTop'
|
|
68
|
+
| 'leftBottom'
|
|
69
|
+
| 'rightTop'
|
|
70
|
+
| 'rightBottom'
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### TooltipTrigger
|
|
74
|
+
|
|
75
|
+
触发方式
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
type TooltipTrigger = 'hover' | 'focus' | 'click' | 'contextMenu'
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### TooltipArrowConfig
|
|
82
|
+
|
|
83
|
+
`arrow` 为对象时的配置
|
|
84
|
+
|
|
85
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
86
|
+
| --- | --- | --- | --- | --- |
|
|
87
|
+
| pointAtCenter | 箭头是否指向触发元素中心 | `boolean` | 否 | `true` |
|
|
88
|
+
|
|
89
|
+
### 导出类型
|
|
90
|
+
|
|
91
|
+
另可从 `@apexhub/apex-ui-react` 导入:`TooltipArrowConfig`、`TooltipPlacement`、`TooltipProps`、`TooltipTrigger`(与上文子类型配合使用)。
|
|
92
|
+
|
|
93
|
+
## 代码演示
|
|
94
|
+
|
|
95
|
+
### 十二方位
|
|
96
|
+
|
|
97
|
+
通过 `placement` 指定气泡相对触发元素的位置。
|
|
98
|
+
|
|
99
|
+
```tsx
|
|
100
|
+
import { Button, Tooltip } from '@apexhub/apex-ui-react'
|
|
101
|
+
|
|
102
|
+
const title = 'prompt text'
|
|
103
|
+
|
|
104
|
+
const btnStyle = { width: 80, margin: 4, whiteSpace: 'nowrap' as const }
|
|
105
|
+
|
|
106
|
+
export default () => (
|
|
107
|
+
<div
|
|
108
|
+
style={{
|
|
109
|
+
display: 'flex',
|
|
110
|
+
flexDirection: 'column',
|
|
111
|
+
justifyContent: 'center',
|
|
112
|
+
alignItems: 'center',
|
|
113
|
+
}}
|
|
114
|
+
>
|
|
115
|
+
<div style={{ display: 'flex', justifyContent: 'center', alignItems: 'center' }}>
|
|
116
|
+
<Tooltip placement="topLeft" title={title} defaultOpen>
|
|
117
|
+
<Button style={btnStyle}>TL</Button>
|
|
118
|
+
</Tooltip>
|
|
119
|
+
<Tooltip placement="top" title={title}>
|
|
120
|
+
<Button style={btnStyle}>Top</Button>
|
|
121
|
+
</Tooltip>
|
|
122
|
+
<Tooltip placement="topRight" title={title}>
|
|
123
|
+
<Button style={btnStyle}>TR</Button>
|
|
124
|
+
</Tooltip>
|
|
125
|
+
</div>
|
|
126
|
+
<div
|
|
127
|
+
style={{
|
|
128
|
+
display: 'flex',
|
|
129
|
+
width: 80 * 5 + 32,
|
|
130
|
+
justifyContent: 'space-between',
|
|
131
|
+
alignItems: 'center',
|
|
132
|
+
}}
|
|
133
|
+
>
|
|
134
|
+
<div style={{ display: 'flex', flexDirection: 'column', alignItems: 'center' }}>
|
|
135
|
+
<Tooltip placement="leftTop" title={title}>
|
|
136
|
+
<Button style={btnStyle}>LT</Button>
|
|
137
|
+
</Tooltip>
|
|
138
|
+
<Tooltip placement="left" title={title}>
|
|
139
|
+
<Button style={btnStyle}>Left</Button>
|
|
140
|
+
</Tooltip>
|
|
141
|
+
<Tooltip placement="leftBottom" title={title}>
|
|
142
|
+
<Button style={btnStyle}>LB</Button>
|
|
143
|
+
</Tooltip>
|
|
144
|
+
</div>
|
|
145
|
+
<div style={{ display: 'flex', flexDirection: 'column', alignItems: 'center' }}>
|
|
146
|
+
<Tooltip placement="rightTop" title={title}>
|
|
147
|
+
<Button style={btnStyle}>RT</Button>
|
|
148
|
+
</Tooltip>
|
|
149
|
+
<Tooltip placement="right" title={title}>
|
|
150
|
+
<Button style={btnStyle}>Right</Button>
|
|
151
|
+
</Tooltip>
|
|
152
|
+
<Tooltip placement="rightBottom" title={title}>
|
|
153
|
+
<Button style={btnStyle}>RB</Button>
|
|
154
|
+
</Tooltip>
|
|
155
|
+
</div>
|
|
156
|
+
</div>
|
|
157
|
+
<div style={{ display: 'flex', justifyContent: 'center', alignItems: 'center' }}>
|
|
158
|
+
<Tooltip placement="bottomLeft" title={title}>
|
|
159
|
+
<Button style={btnStyle}>BL</Button>
|
|
160
|
+
</Tooltip>
|
|
161
|
+
<Tooltip placement="bottom" title={title}>
|
|
162
|
+
<Button style={btnStyle}>Bottom</Button>
|
|
163
|
+
</Tooltip>
|
|
164
|
+
<Tooltip placement="bottomRight" title={title}>
|
|
165
|
+
<Button style={btnStyle}>BR</Button>
|
|
166
|
+
</Tooltip>
|
|
167
|
+
</div>
|
|
168
|
+
</div>
|
|
169
|
+
)
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### 触发方式
|
|
173
|
+
|
|
174
|
+
`trigger` 支持 `hover`、`focus`、`click`、`contextMenu`,也可传入数组组合多种触发方式。
|
|
175
|
+
|
|
176
|
+
```tsx
|
|
177
|
+
import { Button, Tooltip } from '@apexhub/apex-ui-react'
|
|
178
|
+
|
|
179
|
+
export default () => (
|
|
180
|
+
<div style={{ display: 'flex', flexWrap: 'wrap', gap: 24, alignItems: 'center' }}>
|
|
181
|
+
<Tooltip title="hover 触发" trigger="hover">
|
|
182
|
+
<Button>Hover</Button>
|
|
183
|
+
</Tooltip>
|
|
184
|
+
<Tooltip title="focus 触发" trigger="focus">
|
|
185
|
+
<Button>Focus</Button>
|
|
186
|
+
</Tooltip>
|
|
187
|
+
<Tooltip title="click 触发" trigger="click">
|
|
188
|
+
<Button>Click</Button>
|
|
189
|
+
</Tooltip>
|
|
190
|
+
<Tooltip title="右键菜单" trigger="contextMenu">
|
|
191
|
+
<Button>ContextMenu</Button>
|
|
192
|
+
</Tooltip>
|
|
193
|
+
</div>
|
|
194
|
+
)
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### 受控模式
|
|
198
|
+
|
|
199
|
+
传入 `open` 与 展开变化事件 由外部控制显隐。
|
|
200
|
+
|
|
201
|
+
```tsx
|
|
202
|
+
import { Button, Tooltip } from '@apexhub/apex-ui-react'
|
|
203
|
+
|
|
204
|
+
import { useState } from 'react'
|
|
205
|
+
|
|
206
|
+
export default () => {
|
|
207
|
+
const [open, setOpen] = useState(false)
|
|
208
|
+
return (
|
|
209
|
+
<div style={{ display: 'flex', flexDirection: 'column', gap: 12, alignItems: 'center' }}>
|
|
210
|
+
<Tooltip title="受控提示" open={open} onOpenChange={setOpen} trigger="click">
|
|
211
|
+
<Button>点击切换</Button>
|
|
212
|
+
</Tooltip>
|
|
213
|
+
<span>{open ? '当前:打开' : '当前:关闭'}</span>
|
|
214
|
+
</div>
|
|
215
|
+
)
|
|
216
|
+
}
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### 显隐行为
|
|
220
|
+
|
|
221
|
+
通过 `defaultOpen`、`destroyOnHidden`、`fresh` 与延时属性控制浮层挂载和显示时机。
|
|
222
|
+
|
|
223
|
+
```tsx
|
|
224
|
+
import { Button, Tooltip } from '@apexhub/apex-ui-react'
|
|
225
|
+
|
|
226
|
+
export default () => (
|
|
227
|
+
<div style={{ display: 'flex', gap: 16, flexWrap: 'wrap', alignItems: 'center' }}>
|
|
228
|
+
<Tooltip
|
|
229
|
+
title={() => '每次打开时重新渲染内容'}
|
|
230
|
+
defaultOpen
|
|
231
|
+
fresh
|
|
232
|
+
destroyOnHidden
|
|
233
|
+
mouseEnterDelay={0.3}
|
|
234
|
+
mouseLeaveDelay={0.2}
|
|
235
|
+
>
|
|
236
|
+
<Button>延时与 fresh</Button>
|
|
237
|
+
</Tooltip>
|
|
238
|
+
<Tooltip title="禁用碰撞避让" autoAdjustOverflow={false}>
|
|
239
|
+
<Button>浮层配置</Button>
|
|
240
|
+
</Tooltip>
|
|
241
|
+
</div>
|
|
242
|
+
)
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### 自定义颜色
|
|
246
|
+
|
|
247
|
+
`color` 设置浮层背景色;文本色仍走 `--tooltip-text-default`,请自行保证对比度达标,推荐传入 CSS Token。
|
|
248
|
+
|
|
249
|
+
```tsx
|
|
250
|
+
import { Button, Tooltip } from '@apexhub/apex-ui-react'
|
|
251
|
+
|
|
252
|
+
export default () => (
|
|
253
|
+
<Tooltip title="自定义背景色" color="var(--apex-fill-brand-primary)" defaultOpen>
|
|
254
|
+
<Button>彩色提示</Button>
|
|
255
|
+
</Tooltip>
|
|
256
|
+
)
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
### 箭头
|
|
260
|
+
|
|
261
|
+
`arrow` 可设为 `false` 隐藏箭头,或通过 `{ pointAtCenter: false }` 调整箭头相对触发元素的对齐方式。
|
|
262
|
+
|
|
263
|
+
```tsx
|
|
264
|
+
import { Button, Tooltip } from '@apexhub/apex-ui-react'
|
|
265
|
+
|
|
266
|
+
export default () => (
|
|
267
|
+
<div style={{ display: 'flex', gap: 24, flexWrap: 'wrap' }}>
|
|
268
|
+
<Tooltip title="默认箭头" defaultOpen>
|
|
269
|
+
<Button>有箭头</Button>
|
|
270
|
+
</Tooltip>
|
|
271
|
+
<Tooltip title="无箭头" arrow={false} defaultOpen>
|
|
272
|
+
<Button>无箭头</Button>
|
|
273
|
+
</Tooltip>
|
|
274
|
+
<Tooltip title="箭头偏移" arrow={{ pointAtCenter: false }} placement="topLeft" defaultOpen>
|
|
275
|
+
<Button>非居中</Button>
|
|
276
|
+
</Tooltip>
|
|
277
|
+
</div>
|
|
278
|
+
)
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
## DOM 结构
|
|
282
|
+
|
|
283
|
+
源码声明的静态 `data-slot`:`tooltip-trigger`、`tooltip`、`tooltip-content`、`tooltip-arrow`。具体节点随模式和状态出现,不表示固定嵌套顺序。
|
|
284
|
+
|
|
285
|
+
## 样式定制
|
|
286
|
+
|
|
287
|
+
优先使用本组件公开的尺寸、类型和状态属性。换肤与变量覆盖方式见 [主题指南](../../llms-theme.txt)。
|
|
288
|
+
|
|
289
|
+
需要定制具体样式时再读取 [Token 明细](./tokens.txt),其中包含用途、定义值及适用作用域。常规组件使用无需加载该文件。
|
|
290
|
+
|
|
291
|
+
## FAQ
|
|
292
|
+
|
|
293
|
+
### 为什么 Tooltip 没有显示?
|
|
294
|
+
|
|
295
|
+
常见原因:`title` 为空;`children` 不是单个可聚焦元素(须为单一 React 元素,如 `button` / `a` / `input`)。开发模式下非合法元素会 `console.warn` 并用 `<button>` 兜底。
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
### 长文本会被截断吗?
|
|
299
|
+
|
|
300
|
+
浮层宽度受 `--tooltip-width-max`(320px)约束,长文本在该宽度内自动换行,高度按内容撑开,不做纵向截断。若需限制高度,可在消费方覆盖 `.apex-tooltip` 的 `max-height`。
|
|
301
|
+
|
|
302
|
+
### 滚动后触发元素不可见时会怎样?
|
|
303
|
+
|
|
304
|
+
触发元素被滚动容器完全裁切时,Tooltip 会隐藏;仅部分裁切时仍显示。滚回可视区域且提示仍处于打开状态时,Tooltip 恢复显示。
|