@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,369 @@
|
|
|
1
|
+
# Drawer
|
|
2
|
+
|
|
3
|
+
> Drawer:需要从屏幕边缘滑出面板展示详情、表单或临时任务,且保留原页面上下文时。
|
|
4
|
+
|
|
5
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照,发布状态以安装包版本为准)。
|
|
6
|
+
|
|
7
|
+
公开导出:`Drawer`。
|
|
8
|
+
|
|
9
|
+
以下 API 属于 Apex UI;不要据 antd 的同名组件推断额外属性或默认值。默认值列的空缺表示未声明,不代表 `false`。
|
|
10
|
+
|
|
11
|
+
## 快速开始
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Button, Drawer } from '@apexhub/apex-ui-react'
|
|
15
|
+
|
|
16
|
+
import { useState } from 'react'
|
|
17
|
+
|
|
18
|
+
import '@apexhub/apex-ui-react/style.css'
|
|
19
|
+
|
|
20
|
+
export default () => {
|
|
21
|
+
const [open, setOpen] = useState(false)
|
|
22
|
+
return (
|
|
23
|
+
<>
|
|
24
|
+
<Button type="primary" onClick={() => setOpen(true)}>
|
|
25
|
+
打开抽屉
|
|
26
|
+
</Button>
|
|
27
|
+
<Drawer
|
|
28
|
+
open={open}
|
|
29
|
+
title="编辑资料"
|
|
30
|
+
onClose={() => setOpen(false)}
|
|
31
|
+
footer={
|
|
32
|
+
<>
|
|
33
|
+
<Button style={{ marginRight: 10 }} onClick={() => setOpen(false)}>
|
|
34
|
+
取消
|
|
35
|
+
</Button>
|
|
36
|
+
<Button type="primary" onClick={() => setOpen(false)}>
|
|
37
|
+
保存
|
|
38
|
+
</Button>
|
|
39
|
+
</>
|
|
40
|
+
}
|
|
41
|
+
>
|
|
42
|
+
<p>抽屉主体内容。</p>
|
|
43
|
+
</Drawer>
|
|
44
|
+
</>
|
|
45
|
+
)
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## 何时使用
|
|
50
|
+
|
|
51
|
+
- 需要从屏幕边缘滑出面板展示详情、表单或临时任务,且保留原页面上下文时。
|
|
52
|
+
- 交互强度低于全屏弹窗、适合次要流程或辅助信息区时。
|
|
53
|
+
- 若需阻断全页并强制用户决策,请使用 Modal,而不是 Drawer。
|
|
54
|
+
|
|
55
|
+
## API
|
|
56
|
+
|
|
57
|
+
仅使用类型定义支持的属性;原生属性、ref 目标和事件签名因组件而异。关联类型用于解释字段结构;只有「导出类型」中的名称可从包根导入。
|
|
58
|
+
|
|
59
|
+
### Drawer
|
|
60
|
+
|
|
61
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
62
|
+
| --- | --- | --- | --- | --- |
|
|
63
|
+
| ref | 转发至 Drawer 面板的 ref | `React.Ref<HTMLDivElement>` | 否 | — |
|
|
64
|
+
| open | 是否显示抽屉 | `boolean` | 否 | `false` |
|
|
65
|
+
| placement | 滑出方向 | `"left" \| "right"` | 否 | `'right'` |
|
|
66
|
+
| size | 面板宽度(px);省略时使用 `--drawer-width` token | `DrawerSize` | 否 | — |
|
|
67
|
+
| title | 标题 | `React.ReactNode` | 否 | — |
|
|
68
|
+
| footer | 底部区域 | `React.ReactNode` | 否 | — |
|
|
69
|
+
| children | 主体内容 | `React.ReactNode` | 否 | — |
|
|
70
|
+
| mask | 蒙层配置 | `DrawerMask` | 否 | `true` |
|
|
71
|
+
| keyboard | 是否支持 Esc 关闭 | `boolean` | 否 | `true` |
|
|
72
|
+
| destroyOnHidden | 关闭后是否卸载子组件 | `boolean` | 否 | `false` |
|
|
73
|
+
| getContainer | 已弃用:已废弃,浮层统一挂载 overlay-root;`false` 仍表示不 Portal<br>挂载容器;`false` 表示挂载到父节点 | `DrawerContainer` | 否 | `overlay-root` |
|
|
74
|
+
| focusable | 焦点管理配置 | `DrawerFocusable` | 否 | — |
|
|
75
|
+
| className | 面板(Content)class | `string` | 否 | — |
|
|
76
|
+
| style | 面板内联样式;仅定制 body 请用 `styles.body` | `React.CSSProperties` | 否 | — |
|
|
77
|
+
| rootStyle | 含蒙层的 wrapper 样式 | `React.CSSProperties` | 否 | — |
|
|
78
|
+
| classNames | 各语义节点 class | `DrawerClassNames` | 否 | — |
|
|
79
|
+
| styles | 各语义节点内联样式 | `DrawerStyles` | 否 | — |
|
|
80
|
+
| drawerRender | 自定义面板内容渲染 | `(node: React.ReactNode) => React.ReactNode` | 否 | — |
|
|
81
|
+
| onClose | 关闭时回调(蒙层外点击、Esc、关闭按钮)。<br>- **关闭按钮**:真实 `MouseEvent`<br>- **非模态蒙层点击**:真实 `MouseEvent`<br>- **Esc / 模态层外 pointer**:`KeyboardEvent` | `(e: DrawerCloseEvent) => void` | 否 | — |
|
|
82
|
+
| afterOpenChange | 开关动画结束后的回调。<br>由面板 `onAnimationEnd`(`apex-drawer-slide-*`)触发;Cancel/OK 等 footer 按钮直接关抽屉<br>时不保证触发(父组件 `setOpen(false)` 驱动,仍会在动画结束后回调)。 | `(open: boolean) => void` | 否 | — |
|
|
83
|
+
|
|
84
|
+
### DrawerSemanticDOM
|
|
85
|
+
|
|
86
|
+
Drawer 语义化 DOM,用于 `classNames` / `styles`
|
|
87
|
+
|
|
88
|
+
```typescript
|
|
89
|
+
type DrawerSemanticDOM = | 'wrapper'
|
|
90
|
+
| 'mask'
|
|
91
|
+
| 'content'
|
|
92
|
+
| 'header'
|
|
93
|
+
| 'title'
|
|
94
|
+
| 'body'
|
|
95
|
+
| 'footer'
|
|
96
|
+
| 'close'
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### DrawerPlacement
|
|
100
|
+
|
|
101
|
+
```typescript
|
|
102
|
+
type DrawerPlacement = 'left' | 'right'
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### DrawerSize
|
|
106
|
+
|
|
107
|
+
面板宽度(px);省略时使用 `--drawer-width` token
|
|
108
|
+
|
|
109
|
+
```typescript
|
|
110
|
+
type DrawerSize = number
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### DrawerMask
|
|
114
|
+
|
|
115
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
116
|
+
| --- | --- | --- | --- | --- |
|
|
117
|
+
| enabled | — | `boolean` | 否 | — |
|
|
118
|
+
| blur | — | `boolean` | 否 | — |
|
|
119
|
+
| closable | — | `boolean` | 否 | — |
|
|
120
|
+
|
|
121
|
+
### DrawerFocusable
|
|
122
|
+
|
|
123
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
124
|
+
| --- | --- | --- | --- | --- |
|
|
125
|
+
| trap | 是否启用模态焦点管理。`false` 时允许与 Drawer 外页面继续交互 | `boolean` | 否 | `true` |
|
|
126
|
+
| focusTriggerAfterClose | 关闭后是否将焦点还原到触发器 | `boolean` | 否 | `true` |
|
|
127
|
+
|
|
128
|
+
### DrawerContainer
|
|
129
|
+
|
|
130
|
+
Portal 挂载目标
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
type DrawerContainer = HTMLElement | (() => HTMLElement) | string | false
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### DrawerClassNames
|
|
137
|
+
|
|
138
|
+
```typescript
|
|
139
|
+
type DrawerClassNames = | Partial<Record<DrawerSemanticDOM, string>>
|
|
140
|
+
| ((info: { props: DrawerProps }) => Partial<Record<DrawerSemanticDOM, string>>)
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### DrawerStyles
|
|
144
|
+
|
|
145
|
+
```typescript
|
|
146
|
+
type DrawerStyles = | Partial<Record<DrawerSemanticDOM, React.CSSProperties>>
|
|
147
|
+
| ((info: { props: DrawerProps }) => Partial<Record<DrawerSemanticDOM, React.CSSProperties>>)
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### DrawerCloseEvent
|
|
151
|
+
|
|
152
|
+
```typescript
|
|
153
|
+
type DrawerCloseEvent = React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### 导出类型
|
|
157
|
+
|
|
158
|
+
另可从 `@apexhub/apex-ui-react` 导入:`DrawerClassNames`、`DrawerCloseEvent`、`DrawerContainer`、`DrawerFocusable`、`DrawerMask`、`DrawerPlacement`、`DrawerProps`、`DrawerSemanticDOM`、`DrawerSize`、`DrawerStyles`(与上文子类型配合使用)。
|
|
159
|
+
|
|
160
|
+
## 代码演示
|
|
161
|
+
|
|
162
|
+
### 方向与尺寸
|
|
163
|
+
|
|
164
|
+
`placement` 支持从左侧或右侧滑出;`size` 为面板宽度(px),省略时使用设计默认宽度。
|
|
165
|
+
|
|
166
|
+
```tsx
|
|
167
|
+
import type { DrawerPlacement } from '@apexhub/apex-ui-react'
|
|
168
|
+
|
|
169
|
+
import { Button, Drawer } from '@apexhub/apex-ui-react'
|
|
170
|
+
|
|
171
|
+
import { useState } from 'react'
|
|
172
|
+
|
|
173
|
+
export default () => {
|
|
174
|
+
const [open, setOpen] = useState(false)
|
|
175
|
+
const [placement, setPlacement] = useState<DrawerPlacement>('right')
|
|
176
|
+
|
|
177
|
+
return (
|
|
178
|
+
<>
|
|
179
|
+
<div style={{ display: 'flex', gap: 8, flexWrap: 'wrap' }}>
|
|
180
|
+
{(['left', 'right'] as const).map((p) => (
|
|
181
|
+
<Button
|
|
182
|
+
key={p}
|
|
183
|
+
onClick={() => {
|
|
184
|
+
setPlacement(p)
|
|
185
|
+
setOpen(true)
|
|
186
|
+
}}
|
|
187
|
+
>
|
|
188
|
+
{p}
|
|
189
|
+
</Button>
|
|
190
|
+
))}
|
|
191
|
+
</div>
|
|
192
|
+
<Drawer
|
|
193
|
+
open={open}
|
|
194
|
+
placement={placement}
|
|
195
|
+
size={480}
|
|
196
|
+
title={`Drawer — ${placement}`}
|
|
197
|
+
onClose={() => setOpen(false)}
|
|
198
|
+
>
|
|
199
|
+
{placement} 方向滑出的内容。
|
|
200
|
+
</Drawer>
|
|
201
|
+
</>
|
|
202
|
+
)
|
|
203
|
+
}
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### 蒙层
|
|
207
|
+
|
|
208
|
+
`mask` 可设为 `false` 或 `{ enabled, blur, closable }`;`blur` 为 true 时蒙层带模糊效果。
|
|
209
|
+
|
|
210
|
+
```tsx
|
|
211
|
+
import { Button, Drawer } from '@apexhub/apex-ui-react'
|
|
212
|
+
|
|
213
|
+
import { useState } from 'react'
|
|
214
|
+
|
|
215
|
+
export default () => {
|
|
216
|
+
const [open, setOpen] = useState(false)
|
|
217
|
+
return (
|
|
218
|
+
<>
|
|
219
|
+
<Button onClick={() => setOpen(true)}>模糊蒙层</Button>
|
|
220
|
+
<Drawer
|
|
221
|
+
open={open}
|
|
222
|
+
mask={{ enabled: true, blur: true, closable: true }}
|
|
223
|
+
keyboard
|
|
224
|
+
destroyOnHidden
|
|
225
|
+
title="模糊蒙层"
|
|
226
|
+
onClose={() => setOpen(false)}
|
|
227
|
+
>
|
|
228
|
+
点击蒙层或按 Esc 关闭;关闭后内容会卸载。
|
|
229
|
+
</Drawer>
|
|
230
|
+
</>
|
|
231
|
+
)
|
|
232
|
+
}
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### 遮罩不可点关
|
|
236
|
+
|
|
237
|
+
将 `mask` 设为 `{ closable: false }`(或等效配置)后,点击蒙层不会触发 关闭事件。
|
|
238
|
+
|
|
239
|
+
```tsx
|
|
240
|
+
import { Button, Drawer } from '@apexhub/apex-ui-react'
|
|
241
|
+
|
|
242
|
+
import { useState } from 'react'
|
|
243
|
+
|
|
244
|
+
export default () => {
|
|
245
|
+
const [open, setOpen] = useState(false)
|
|
246
|
+
|
|
247
|
+
return (
|
|
248
|
+
<>
|
|
249
|
+
<Button type="primary" onClick={() => setOpen(true)}>
|
|
250
|
+
打开抽屉
|
|
251
|
+
</Button>
|
|
252
|
+
<Drawer
|
|
253
|
+
open={open}
|
|
254
|
+
title="遮罩不可点关"
|
|
255
|
+
mask={{ enabled: true, closable: false }}
|
|
256
|
+
onClose={() => setOpen(false)}
|
|
257
|
+
>
|
|
258
|
+
<p>点击蒙层不会关闭抽屉,请使用关闭按钮。</p>
|
|
259
|
+
</Drawer>
|
|
260
|
+
</>
|
|
261
|
+
)
|
|
262
|
+
}
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Esc 不关闭
|
|
266
|
+
|
|
267
|
+
设置 `keyboard` 设为 `false` 后,按 Esc 不会关闭抽屉。
|
|
268
|
+
|
|
269
|
+
```tsx
|
|
270
|
+
import { Button, Drawer } from '@apexhub/apex-ui-react'
|
|
271
|
+
|
|
272
|
+
import { useState } from 'react'
|
|
273
|
+
|
|
274
|
+
export default () => {
|
|
275
|
+
const [open, setOpen] = useState(false)
|
|
276
|
+
|
|
277
|
+
return (
|
|
278
|
+
<>
|
|
279
|
+
<Button type="primary" onClick={() => setOpen(true)}>
|
|
280
|
+
打开抽屉
|
|
281
|
+
</Button>
|
|
282
|
+
<Drawer open={open} keyboard={false} title="Esc 不关闭" onClose={() => setOpen(false)}>
|
|
283
|
+
<p>按 Esc 键不会关闭此抽屉。</p>
|
|
284
|
+
</Drawer>
|
|
285
|
+
</>
|
|
286
|
+
)
|
|
287
|
+
}
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### 关闭后卸载
|
|
291
|
+
|
|
292
|
+
`destroyOnHidden` 为 true 时,关闭动画结束后卸载抽屉子树,适合重置内部状态或释放资源。
|
|
293
|
+
|
|
294
|
+
```tsx
|
|
295
|
+
import { Button, Drawer } from '@apexhub/apex-ui-react'
|
|
296
|
+
|
|
297
|
+
import { useState } from 'react'
|
|
298
|
+
|
|
299
|
+
export default () => {
|
|
300
|
+
const [open, setOpen] = useState(false)
|
|
301
|
+
|
|
302
|
+
return (
|
|
303
|
+
<>
|
|
304
|
+
<Button type="primary" onClick={() => setOpen(true)}>
|
|
305
|
+
打开抽屉
|
|
306
|
+
</Button>
|
|
307
|
+
<Drawer open={open} destroyOnHidden title="关闭后卸载" onClose={() => setOpen(false)}>
|
|
308
|
+
<p>关闭动画结束后,抽屉内容会从 DOM 中卸载。</p>
|
|
309
|
+
</Drawer>
|
|
310
|
+
</>
|
|
311
|
+
)
|
|
312
|
+
}
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### 自定义面板
|
|
316
|
+
|
|
317
|
+
通过 `classNames`、`styles` 和 `drawerRender` 定制面板结构与局部样式。
|
|
318
|
+
|
|
319
|
+
```tsx
|
|
320
|
+
import { Button, Drawer } from '@apexhub/apex-ui-react'
|
|
321
|
+
|
|
322
|
+
import { useState } from 'react'
|
|
323
|
+
|
|
324
|
+
export default () => {
|
|
325
|
+
const [open, setOpen] = useState(false)
|
|
326
|
+
|
|
327
|
+
return (
|
|
328
|
+
<>
|
|
329
|
+
<Button onClick={() => setOpen(true)}>自定义面板</Button>
|
|
330
|
+
<Drawer
|
|
331
|
+
open={open}
|
|
332
|
+
title="自定义面板"
|
|
333
|
+
size={420}
|
|
334
|
+
focusable={{ trap: true, focusTriggerAfterClose: true }}
|
|
335
|
+
classNames={{
|
|
336
|
+
body: 'custom-drawer-body',
|
|
337
|
+
}}
|
|
338
|
+
styles={{
|
|
339
|
+
body: { paddingBlock: 'var(--drawer-padding)' },
|
|
340
|
+
}}
|
|
341
|
+
drawerRender={(node) => <div data-demo="drawer-shell">{node}</div>}
|
|
342
|
+
onClose={() => setOpen(false)}
|
|
343
|
+
>
|
|
344
|
+
使用语义节点配置局部样式,也可以通过 drawerRender 包裹默认面板。
|
|
345
|
+
</Drawer>
|
|
346
|
+
</>
|
|
347
|
+
)
|
|
348
|
+
}
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
## DOM 结构
|
|
352
|
+
|
|
353
|
+
源码声明的静态 `data-slot`:`drawer-header`、`drawer-title`、`drawer-close`、`drawer-body`、`drawer-footer`、`drawer-wrapper`、`drawer-mask`。具体节点随模式和状态出现,不表示固定嵌套顺序。
|
|
354
|
+
|
|
355
|
+
## 样式定制
|
|
356
|
+
|
|
357
|
+
优先使用本组件公开的尺寸、类型和状态属性。换肤与变量覆盖方式见 [主题指南](../llms-theme.txt)。
|
|
358
|
+
|
|
359
|
+
需要定制具体样式时再读取 [Token 明细](./drawer.tokens.txt),其中包含用途、定义值及适用作用域。常规组件使用无需加载该文件。
|
|
360
|
+
|
|
361
|
+
## FAQ
|
|
362
|
+
|
|
363
|
+
### `className` 和 `style` 作用在哪个节点?
|
|
364
|
+
|
|
365
|
+
二者作用于面板(Content),不是含蒙层的 wrapper。仅定制主体区域请用 `styles.body`。
|
|
366
|
+
|
|
367
|
+
### 关闭按钮可以隐藏吗?
|
|
368
|
+
|
|
369
|
+
首期不提供独立的 `closable` prop,关闭按钮默认显示。若需完全自定义头部结构,可使用 `drawerRender` 包裹默认内容。
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Dropdown Token 明细
|
|
2
|
+
|
|
3
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照)。
|
|
4
|
+
|
|
5
|
+
按需读取:[组件用法](./dropdown.txt) · [主题与覆盖规则](../llms-theme.txt)。
|
|
6
|
+
|
|
7
|
+
以下组件变量在设计 Token 源中已定义,并被组件或其共享样式使用;不包含仅在实现中声明的临时变量。用途来自实际 CSS 属性,不是对外新增的 Props。
|
|
8
|
+
|
|
9
|
+
定义值依赖所列尺寸、变体、状态和媒体作用域;Alias 引用还会随 light/dark 主题改变。它们不是统一默认值或最终计算值。作用域用于解释定义位置,不代表内部选择器是稳定的定制 API。
|
|
10
|
+
|
|
11
|
+
| Token | 用途(CSS 属性) | 定义值 | 定义作用域 |
|
|
12
|
+
| --- | --- | --- | --- |
|
|
13
|
+
| `--dropdown-fill-active` | `background-color` | `var(--apex-fill-neutral-quaternary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
14
|
+
| `--dropdown-fill-container-default` | `background-color` | `var(--apex-fill-neutral-secondary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
15
|
+
| `--dropdown-fill-default` | `background-color` | `var(--apex-fill-neutral-transparent)` | `.apex-dropdown.apex-default-dropdown` |
|
|
16
|
+
| `--dropdown-fill-disabled` | `background-color` | `var(--apex-fill-neutral-transparent)` | `.apex-dropdown.apex-default-dropdown` |
|
|
17
|
+
| `--dropdown-fill-hover` | `background-color` | `var(--apex-fill-neutral-tertiary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
18
|
+
| `--dropdown-fill-loading` | `background-color` | `var(--apex-fill-neutral-quaternary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
19
|
+
| `--dropdown-fill-selected` | `background-color` | `var(--apex-fill-neutral-transparent)` | `.apex-dropdown.apex-default-dropdown` |
|
|
20
|
+
| `--dropdown-icon-active` | `color` | `var(--apex-icon-neutral-primary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
21
|
+
| `--dropdown-icon-default` | `color` | `var(--apex-icon-neutral-primary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
22
|
+
| `--dropdown-icon-disabled` | `color` | `var(--apex-icon-neutral-disabled)` | `.apex-dropdown.apex-default-dropdown` |
|
|
23
|
+
| `--dropdown-icon-hover` | `color` | `var(--apex-icon-neutral-primary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
24
|
+
| `--dropdown-icon-item` | `height`、`width` | `var(--apex-icon-16)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
25
|
+
| `--dropdown-icon-item` | `height`、`width` | `var(--apex-icon-16)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
26
|
+
| `--dropdown-icon-loading` | `color` | `var(--apex-icon-neutral-disabled)` | `.apex-dropdown.apex-default-dropdown` |
|
|
27
|
+
| `--dropdown-icon-selected` | `color` | `var(--apex-icon-brand-primary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
28
|
+
| `--dropdown-radius-container` | `border-radius` | `var(--apex-radius-8)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
29
|
+
| `--dropdown-radius-container` | `border-radius` | `var(--apex-radius-8)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
30
|
+
| `--dropdown-radius-item` | `border-radius` | `var(--apex-radius-8)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
31
|
+
| `--dropdown-radius-item` | `border-radius` | `var(--apex-radius-8)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
32
|
+
| `--dropdown-size-container-gap` | `gap` | `var(--apex-spacing-2)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
33
|
+
| `--dropdown-size-container-gap` | `gap` | `var(--apex-spacing-2)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
34
|
+
| `--dropdown-size-container-height-max` | `max-height` | `var(--apex-size-320)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
35
|
+
| `--dropdown-size-container-height-max` | `max-height` | `var(--apex-size-320)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
36
|
+
| `--dropdown-size-item-gap-check-min-item` | `padding-left` | `var(--apex-spacing-12)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
37
|
+
| `--dropdown-size-item-gap-check-min-item` | `padding-left` | `var(--apex-spacing-8)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
38
|
+
| `--dropdown-size-item-gap-item` | `gap` | `var(--apex-spacing-4)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
39
|
+
| `--dropdown-size-item-gap-item` | `gap` | `var(--apex-spacing-4)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
40
|
+
| `--dropdown-size-item-height-item` | `min-height` | `var(--apex-size-32)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
41
|
+
| `--dropdown-size-item-height-item` | `min-height` | `var(--apex-size-24)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
42
|
+
| `--dropdown-size-item-width-min-item` | `min-width` | `var(--apex-size-80)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
43
|
+
| `--dropdown-size-item-width-min-item` | `min-width` | `var(--apex-size-80)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
44
|
+
| `--dropdown-spacing-container-padding-x` | `padding` | `var(--apex-spacing-6)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
45
|
+
| `--dropdown-spacing-container-padding-x` | `padding` | `var(--apex-spacing-6)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
46
|
+
| `--dropdown-spacing-container-padding-y` | `padding` | `var(--apex-spacing-6)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
47
|
+
| `--dropdown-spacing-container-padding-y` | `padding` | `var(--apex-spacing-6)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
48
|
+
| `--dropdown-spacing-item-padding-x-item` | `padding`、`padding-inline` | `var(--apex-spacing-12)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
49
|
+
| `--dropdown-spacing-item-padding-x-item` | `padding`、`padding-inline` | `var(--apex-spacing-12)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
50
|
+
| `--dropdown-stroke` | `border-width` | `var(--apex-border-1)` | `.apex-dropdown.apex-lg-dropdown` |
|
|
51
|
+
| `--dropdown-stroke` | `border-width` | `var(--apex-border-1)` | `.apex-dropdown.apex-sm-dropdown` |
|
|
52
|
+
| `--dropdown-stroke-container-default` | `border-color` | `var(--apex-stroke-neutral-quinary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
53
|
+
| `--dropdown-text-active` | `color` | `var(--apex-text-neutral-primary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
54
|
+
| `--dropdown-text-default` | `color` | `var(--apex-text-neutral-primary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
55
|
+
| `--dropdown-text-disabled` | `color` | `var(--apex-text-neutral-disabled)` | `.apex-dropdown.apex-default-dropdown` |
|
|
56
|
+
| `--dropdown-text-hover` | `color` | `var(--apex-text-neutral-primary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
57
|
+
| `--dropdown-text-loading` | `color` | `var(--apex-text-neutral-disabled)` | `.apex-dropdown.apex-default-dropdown` |
|
|
58
|
+
| `--dropdown-text-selected` | `color` | `var(--apex-text-brand-primary)` | `.apex-dropdown.apex-default-dropdown` |
|
|
59
|
+
| `--dropdown-text-subtitle-default` | `color` | `var(--apex-text-neutral-alpha-primary)` | `.apex-dropdown.apex-default-dropdown` |
|