@agentscope-ai/design 1.0.23-beta.1767087061250 → 1.0.23
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/lib/antd/styles/button.style.js +13 -1
- package/lib/antd/themes/carbonDarkTheme.json +1 -1
- package/lib/antd/themes/generateTheme.d.ts +1 -1
- package/lib/antd/themes/generateTheme.js +39 -12
- package/lib/components/commonComponents/Button/index.js +3 -1
- package/lib/components/commonComponents/Tooltip/index.style.js +1 -1
- package/llms/all.llms.txt +1041 -1020
- package/llms/docs/changelog/index.zh-CN.llms.txt +18 -0
- package/llms/docs/guide/tokens&variables.zh-CN.llms.txt +4 -3
- package/llms/index.llms.txt +21 -20
- package/package.json +1 -1
package/llms/all.llms.txt
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
|
+
<DemoTitle title="Video" desc="视频展示">
|
|
4
|
+
#### API
|
|
5
|
+
|
|
6
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
7
|
+
|--------|--------|--------|--------|
|
|
8
|
+
| mouseEnterAutoPlay | 鼠标进入时是否自动播放 | boolean | false |
|
|
9
|
+
| children | video内部设置了按钮在暗色背景下的样式,如果有一些操作按钮想继承这个样式可以在这里传入 | React.ReactNode | |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
3
16
|
<DemoTitle title="Upload" desc="文件选择上传和拖拽上传控件。">
|
|
4
17
|
#### API
|
|
5
18
|
|
|
@@ -96,66 +109,6 @@
|
|
|
96
109
|
|
|
97
110
|
|
|
98
111
|
|
|
99
|
-
<DemoTitle title="Video" desc="视频展示">
|
|
100
|
-
#### API
|
|
101
|
-
|
|
102
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
103
|
-
|--------|--------|--------|--------|
|
|
104
|
-
| mouseEnterAutoPlay | 鼠标进入时是否自动播放 | boolean | false |
|
|
105
|
-
| children | video内部设置了按钮在暗色背景下的样式,如果有一些操作按钮想继承这个样式可以在这里传入 | React.ReactNode | |
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
<DemoTitle title="Tooltip" desc="简单的文本提示气泡框">
|
|
113
|
-
#### API
|
|
114
|
-
|
|
115
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
116
|
-
|--------|--------|--------|--------|
|
|
117
|
-
| mode | 颜色模式 | 'dark' \| 'light' | 'dark' |
|
|
118
|
-
| maxHeight | 最大高度 | number \| string | '90vh' |
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
<AntdApiRef url="https://ant.design/components/tooltip-cn/#api"></AntdApiRef>
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
## antd API
|
|
125
|
-
|
|
126
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
127
|
-
|
|
128
|
-
| 参数 | 说明 | 类型 | 默认值 |
|
|
129
|
-
|--------|--------|--------|--------|
|
|
130
|
-
| title | 提示文字 | ReactNode \| () => ReactNode | - |
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
### 共同的 API
|
|
134
|
-
|
|
135
|
-
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
|
|
136
|
-
|
|
137
|
-
<!-- prettier-ignore -->
|
|
138
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
139
|
-
|--------|--------|--------|--------|--------|
|
|
140
|
-
| align | 该值将合并到 placement 的配置中,设置参考 | object | - | |
|
|
141
|
-
| arrow | 修改箭头的显示状态以及修改箭头是否指向目标元素中心 | boolean \| { pointAtCenter: boolean } | true | 5.2.0 |
|
|
142
|
-
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | true | |
|
|
143
|
-
| color | 背景颜色 | string | - | 4.3.0 |
|
|
144
|
-
| defaultOpen | 默认是否显隐 | boolean | false | 4.23.0 |
|
|
145
|
-
| destroyOnHidden | 关闭后是否销毁 dom | boolean | false | 5.25.0 |
|
|
146
|
-
| fresh | 默认情况下,Tooltip 在关闭时会缓存内容。设置该属性后会始终保持更新 | boolean | false | 5.10.0 |
|
|
147
|
-
| getPopupContainer | 浮层渲染父节点,默认渲染到 body 上 | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
|
148
|
-
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip,单位:秒 | number | 0.1 | |
|
|
149
|
-
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip,单位:秒 | number | 0.1 | |
|
|
150
|
-
| placement | 气泡框位置,可选 | string | top | |
|
|
151
|
-
| trigger | 触发行为,可选 | string \| string[] | hover | |
|
|
152
|
-
| open | 用于手动控制浮层显隐,小于 4.23.0 使用 | boolean | false | 4.23.0 |
|
|
153
|
-
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
154
|
-
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
112
|
<DemoTitle title="TimePicker" desc="输入或选择时间的控件。">
|
|
160
113
|
#### API
|
|
161
114
|
|
|
@@ -269,6 +222,53 @@ type RangeDisabledTime = (
|
|
|
269
222
|
|
|
270
223
|
|
|
271
224
|
|
|
225
|
+
<DemoTitle title="Tooltip" desc="简单的文本提示气泡框">
|
|
226
|
+
#### API
|
|
227
|
+
|
|
228
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
229
|
+
|--------|--------|--------|--------|
|
|
230
|
+
| mode | 颜色模式 | 'dark' \| 'light' | 'dark' |
|
|
231
|
+
| maxHeight | 最大高度 | number \| string | '90vh' |
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<AntdApiRef url="https://ant.design/components/tooltip-cn/#api"></AntdApiRef>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
## antd API
|
|
238
|
+
|
|
239
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
240
|
+
|
|
241
|
+
| 参数 | 说明 | 类型 | 默认值 |
|
|
242
|
+
|--------|--------|--------|--------|
|
|
243
|
+
| title | 提示文字 | ReactNode \| () => ReactNode | - |
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
### 共同的 API
|
|
247
|
+
|
|
248
|
+
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
|
|
249
|
+
|
|
250
|
+
<!-- prettier-ignore -->
|
|
251
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
252
|
+
|--------|--------|--------|--------|--------|
|
|
253
|
+
| align | 该值将合并到 placement 的配置中,设置参考 | object | - | |
|
|
254
|
+
| arrow | 修改箭头的显示状态以及修改箭头是否指向目标元素中心 | boolean \| { pointAtCenter: boolean } | true | 5.2.0 |
|
|
255
|
+
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | true | |
|
|
256
|
+
| color | 背景颜色 | string | - | 4.3.0 |
|
|
257
|
+
| defaultOpen | 默认是否显隐 | boolean | false | 4.23.0 |
|
|
258
|
+
| destroyOnHidden | 关闭后是否销毁 dom | boolean | false | 5.25.0 |
|
|
259
|
+
| fresh | 默认情况下,Tooltip 在关闭时会缓存内容。设置该属性后会始终保持更新 | boolean | false | 5.10.0 |
|
|
260
|
+
| getPopupContainer | 浮层渲染父节点,默认渲染到 body 上 | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
|
261
|
+
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip,单位:秒 | number | 0.1 | |
|
|
262
|
+
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip,单位:秒 | number | 0.1 | |
|
|
263
|
+
| placement | 气泡框位置,可选 | string | top | |
|
|
264
|
+
| trigger | 触发行为,可选 | string \| string[] | hover | |
|
|
265
|
+
| open | 用于手动控制浮层显隐,小于 4.23.0 使用 | boolean | false | 4.23.0 |
|
|
266
|
+
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
267
|
+
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
272
|
<DemoTitle title="Tag" desc="进行标记和分类的小标签">
|
|
273
273
|
#### API
|
|
274
274
|
|
|
@@ -304,6 +304,117 @@ type RangeDisabledTime = (
|
|
|
304
304
|
|
|
305
305
|
|
|
306
306
|
|
|
307
|
+
<DemoTitle title="Tabs" desc="用户可以通过点击不同的标签在同一页面中查看不同的内容区域。">
|
|
308
|
+
#### API
|
|
309
|
+
|
|
310
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
311
|
+
|--------|--------|--------|--------|
|
|
312
|
+
| type | 类型 | 'line' \| 'card' \| 'editable-card' \| 'segmented' | true |
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
<AntdApiRef url="https://ant.design/components/tabs-cn/#api"></AntdApiRef>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
## antd API
|
|
319
|
+
|
|
320
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
321
|
+
|
|
322
|
+
### Tabs
|
|
323
|
+
|
|
324
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
325
|
+
|--------|--------|--------|--------|--------|
|
|
326
|
+
| activeKey | 当前激活 tab 面板的 key | string | - | |
|
|
327
|
+
| addIcon | 自定义添加按钮,设置 | ReactNode | | 4.4.0 |
|
|
328
|
+
| animated | 是否使用动画切换 Tabs | boolean\| { inkBar: boolean, tabPane: boolean } | { inkBar: true, tabPane: false } | |
|
|
329
|
+
| centered | 标签居中展示 | boolean | false | 4.4.0 |
|
|
330
|
+
| defaultActiveKey | 初始化选中面板的 key,如果没有设置 activeKey | string | 第一个面板的 key | |
|
|
331
|
+
| hideAdd | 是否隐藏加号图标,在 | boolean | false | |
|
|
332
|
+
| indicator | 自定义指示条的长度和对齐方式 | { size?: number \| (origin: number) => number; align: | - | 5.13.0 |
|
|
333
|
+
| items | 配置选项卡内容 | | [] | 4.23.0 |
|
|
334
|
+
| more | 自定义折叠菜单属性 | | { icon: | |
|
|
335
|
+
| removeIcon | 自定义删除按钮,设置 | ReactNode | | 5.15.0 |
|
|
336
|
+
| popupClassName | 更多菜单的 | string | - | 4.21.0 |
|
|
337
|
+
| renderTabBar | 替换 TabBar,用于二次封装标签头 | (props: DefaultTabBarProps, DefaultTabBar: React.ComponentClass) => React.ReactElement | - | |
|
|
338
|
+
| size | 大小,提供 | string | middle | |
|
|
339
|
+
| tabBarExtraContent | tab bar 上额外的元素 | ReactNode \| {left?: ReactNode, right?: ReactNode} | - | object: 4.6.0 |
|
|
340
|
+
| tabBarGutter | tabs 之间的间隙 | number | - | |
|
|
341
|
+
| tabBarStyle | tab bar 的样式对象 | CSSProperties | - | |
|
|
342
|
+
| tabPosition | 页签位置,可选值有 | string | top | |
|
|
343
|
+
| destroyOnHidden | 被隐藏时是否销毁 DOM 结构 | boolean | false | 5.25.0 |
|
|
344
|
+
| onChange | 切换面板的回调 | (activeKey: string) => void | - | |
|
|
345
|
+
| onEdit | 新增和删除页签的回调,在 | (action === 'add' ? event : targetKey, action) => void | - | |
|
|
346
|
+
| onTabClick | tab 被点击的回调 | (key: string, event: MouseEvent) => void | - | |
|
|
347
|
+
| onTabScroll | tab 滚动时触发 | ({ direction: | - | 4.3.0 |
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
更多属性查看 [rc-tabs tabs](https://github.com/react-component/tabs#tabs)
|
|
351
|
+
|
|
352
|
+
### TabItemType
|
|
353
|
+
|
|
354
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
355
|
+
|--------|--------|--------|--------|--------|
|
|
356
|
+
| closeIcon | 自定义关闭图标,在 | ReactNode | - | |
|
|
357
|
+
| destroyOnHidden | 被隐藏时是否销毁 DOM 结构 | boolean | false | 5.25.0 |
|
|
358
|
+
| disabled | 禁用某一项 | boolean | false | |
|
|
359
|
+
| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false | |
|
|
360
|
+
| key | 对应 activeKey | string | - | |
|
|
361
|
+
| label | 选项卡头显示文字 | ReactNode | - | |
|
|
362
|
+
| icon | 选项卡头显示图标 | ReactNode | - | 5.12.0 |
|
|
363
|
+
| children | 选项卡头显示内容 | ReactNode | - | |
|
|
364
|
+
| closable | 是否显示选项卡的关闭按钮,在 | boolean | true | |
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
### MoreProps
|
|
368
|
+
|
|
369
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
370
|
+
|--------|--------|--------|--------|--------|
|
|
371
|
+
| icon | 自定义折叠图标 | ReactNode | - | |
|
|
372
|
+
| | | | | |
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<DemoTitle title="Switch" desc="使用开关切换两种状态之间。">
|
|
378
|
+
#### API
|
|
379
|
+
|
|
380
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
381
|
+
|--------|--------|--------|--------|
|
|
382
|
+
| label | Switch后的内容 | ReactNode | |
|
|
383
|
+
|
|
384
|
+
<AntdApiRef url="https://ant.design/components/switch-cn/#api"></AntdApiRef>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
## antd API
|
|
388
|
+
|
|
389
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
390
|
+
|
|
391
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
392
|
+
|--------|--------|--------|--------|--------|
|
|
393
|
+
| autoFocus | 组件自动获取焦点 | boolean | false | |
|
|
394
|
+
| checked | 指定当前是否选中 | boolean | false | |
|
|
395
|
+
| checkedChildren | 选中时的内容 | ReactNode | - | |
|
|
396
|
+
| className | Switch 器类名 | string | - | |
|
|
397
|
+
| defaultChecked | 初始是否选中 | boolean | false | |
|
|
398
|
+
| defaultValue | defaultChecked | boolean | - | 5.12.0 |
|
|
399
|
+
| disabled | 是否禁用 | boolean | false | |
|
|
400
|
+
| loading | 加载中的开关 | boolean | false | |
|
|
401
|
+
| size | 开关大小,可选值: | string | default | |
|
|
402
|
+
| unCheckedChildren | 非选中时的内容 | ReactNode | - | |
|
|
403
|
+
| value | checked | boolean | - | 5.12.0 |
|
|
404
|
+
| onChange | 变化时的回调函数 | function(checked: boolean, event: Event) | - | |
|
|
405
|
+
| onClick | 点击时的回调函数 | function(checked: boolean, event: Event) | - | |
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
## 方法
|
|
409
|
+
|
|
410
|
+
| 名称 | 描述 |
|
|
411
|
+
|--------|--------|
|
|
412
|
+
| blur() | 移除焦点 |
|
|
413
|
+
| focus() | 获取焦点 |
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
307
418
|
<DemoTitle title="Table" desc="展示行列数据。">
|
|
308
419
|
#### API
|
|
309
420
|
|
|
@@ -559,130 +670,19 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
559
670
|
|
|
560
671
|
|
|
561
672
|
|
|
562
|
-
<DemoTitle title="
|
|
673
|
+
<DemoTitle title="Steps" desc="引导用户按照流程完成任务的导航条。">
|
|
563
674
|
#### API
|
|
564
675
|
|
|
565
|
-
|
|
566
|
-
|--------|--------|--------|--------|
|
|
567
|
-
| type | 类型 | 'line' \| 'card' \| 'editable-card' \| 'segmented' | true |
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
<AntdApiRef url="https://ant.design/components/tabs-cn/#api"></AntdApiRef>
|
|
676
|
+
<AntdApiRef url="https://ant.design/components/steps-cn/#api"></AntdApiRef>
|
|
571
677
|
|
|
572
678
|
|
|
573
679
|
## antd API
|
|
574
680
|
|
|
575
681
|
通用属性参考:[通用属性](/docs/react/common-props)
|
|
576
682
|
|
|
577
|
-
###
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|--------|--------|--------|--------|--------|
|
|
581
|
-
| activeKey | 当前激活 tab 面板的 key | string | - | |
|
|
582
|
-
| addIcon | 自定义添加按钮,设置 | ReactNode | | 4.4.0 |
|
|
583
|
-
| animated | 是否使用动画切换 Tabs | boolean\| { inkBar: boolean, tabPane: boolean } | { inkBar: true, tabPane: false } | |
|
|
584
|
-
| centered | 标签居中展示 | boolean | false | 4.4.0 |
|
|
585
|
-
| defaultActiveKey | 初始化选中面板的 key,如果没有设置 activeKey | string | 第一个面板的 key | |
|
|
586
|
-
| hideAdd | 是否隐藏加号图标,在 | boolean | false | |
|
|
587
|
-
| indicator | 自定义指示条的长度和对齐方式 | { size?: number \| (origin: number) => number; align: | - | 5.13.0 |
|
|
588
|
-
| items | 配置选项卡内容 | | [] | 4.23.0 |
|
|
589
|
-
| more | 自定义折叠菜单属性 | | { icon: | |
|
|
590
|
-
| removeIcon | 自定义删除按钮,设置 | ReactNode | | 5.15.0 |
|
|
591
|
-
| popupClassName | 更多菜单的 | string | - | 4.21.0 |
|
|
592
|
-
| renderTabBar | 替换 TabBar,用于二次封装标签头 | (props: DefaultTabBarProps, DefaultTabBar: React.ComponentClass) => React.ReactElement | - | |
|
|
593
|
-
| size | 大小,提供 | string | middle | |
|
|
594
|
-
| tabBarExtraContent | tab bar 上额外的元素 | ReactNode \| {left?: ReactNode, right?: ReactNode} | - | object: 4.6.0 |
|
|
595
|
-
| tabBarGutter | tabs 之间的间隙 | number | - | |
|
|
596
|
-
| tabBarStyle | tab bar 的样式对象 | CSSProperties | - | |
|
|
597
|
-
| tabPosition | 页签位置,可选值有 | string | top | |
|
|
598
|
-
| destroyOnHidden | 被隐藏时是否销毁 DOM 结构 | boolean | false | 5.25.0 |
|
|
599
|
-
| onChange | 切换面板的回调 | (activeKey: string) => void | - | |
|
|
600
|
-
| onEdit | 新增和删除页签的回调,在 | (action === 'add' ? event : targetKey, action) => void | - | |
|
|
601
|
-
| onTabClick | tab 被点击的回调 | (key: string, event: MouseEvent) => void | - | |
|
|
602
|
-
| onTabScroll | tab 滚动时触发 | ({ direction: | - | 4.3.0 |
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
更多属性查看 [rc-tabs tabs](https://github.com/react-component/tabs#tabs)
|
|
606
|
-
|
|
607
|
-
### TabItemType
|
|
608
|
-
|
|
609
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
610
|
-
|--------|--------|--------|--------|--------|
|
|
611
|
-
| closeIcon | 自定义关闭图标,在 | ReactNode | - | |
|
|
612
|
-
| destroyOnHidden | 被隐藏时是否销毁 DOM 结构 | boolean | false | 5.25.0 |
|
|
613
|
-
| disabled | 禁用某一项 | boolean | false | |
|
|
614
|
-
| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false | |
|
|
615
|
-
| key | 对应 activeKey | string | - | |
|
|
616
|
-
| label | 选项卡头显示文字 | ReactNode | - | |
|
|
617
|
-
| icon | 选项卡头显示图标 | ReactNode | - | 5.12.0 |
|
|
618
|
-
| children | 选项卡头显示内容 | ReactNode | - | |
|
|
619
|
-
| closable | 是否显示选项卡的关闭按钮,在 | boolean | true | |
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
### MoreProps
|
|
623
|
-
|
|
624
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
625
|
-
|--------|--------|--------|--------|--------|
|
|
626
|
-
| icon | 自定义折叠图标 | ReactNode | - | |
|
|
627
|
-
| | | | | |
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
<DemoTitle title="Switch" desc="使用开关切换两种状态之间。">
|
|
633
|
-
#### API
|
|
634
|
-
|
|
635
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
636
|
-
|--------|--------|--------|--------|
|
|
637
|
-
| label | Switch后的内容 | ReactNode | |
|
|
638
|
-
|
|
639
|
-
<AntdApiRef url="https://ant.design/components/switch-cn/#api"></AntdApiRef>
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
## antd API
|
|
643
|
-
|
|
644
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
645
|
-
|
|
646
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
647
|
-
|--------|--------|--------|--------|--------|
|
|
648
|
-
| autoFocus | 组件自动获取焦点 | boolean | false | |
|
|
649
|
-
| checked | 指定当前是否选中 | boolean | false | |
|
|
650
|
-
| checkedChildren | 选中时的内容 | ReactNode | - | |
|
|
651
|
-
| className | Switch 器类名 | string | - | |
|
|
652
|
-
| defaultChecked | 初始是否选中 | boolean | false | |
|
|
653
|
-
| defaultValue | defaultChecked | boolean | - | 5.12.0 |
|
|
654
|
-
| disabled | 是否禁用 | boolean | false | |
|
|
655
|
-
| loading | 加载中的开关 | boolean | false | |
|
|
656
|
-
| size | 开关大小,可选值: | string | default | |
|
|
657
|
-
| unCheckedChildren | 非选中时的内容 | ReactNode | - | |
|
|
658
|
-
| value | checked | boolean | - | 5.12.0 |
|
|
659
|
-
| onChange | 变化时的回调函数 | function(checked: boolean, event: Event) | - | |
|
|
660
|
-
| onClick | 点击时的回调函数 | function(checked: boolean, event: Event) | - | |
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
## 方法
|
|
664
|
-
|
|
665
|
-
| 名称 | 描述 |
|
|
666
|
-
|--------|--------|
|
|
667
|
-
| blur() | 移除焦点 |
|
|
668
|
-
| focus() | 获取焦点 |
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
<DemoTitle title="Steps" desc="引导用户按照流程完成任务的导航条。">
|
|
674
|
-
#### API
|
|
675
|
-
|
|
676
|
-
<AntdApiRef url="https://ant.design/components/steps-cn/#api"></AntdApiRef>
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
## antd API
|
|
680
|
-
|
|
681
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
682
|
-
|
|
683
|
-
### Steps
|
|
684
|
-
|
|
685
|
-
整体步骤条。
|
|
683
|
+
### Steps
|
|
684
|
+
|
|
685
|
+
整体步骤条。
|
|
686
686
|
|
|
687
687
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
688
688
|
|--------|--------|--------|--------|--------|
|
|
@@ -806,6 +806,67 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
806
806
|
|
|
807
807
|
|
|
808
808
|
|
|
809
|
+
<DemoTitle title="Skeleton" desc="在内容加载时提供占位图形展示。">
|
|
810
|
+
## antd API
|
|
811
|
+
|
|
812
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
813
|
+
|
|
814
|
+
### Skeleton
|
|
815
|
+
|
|
816
|
+
| 属性 | 说明 | 类型 | 默认值 |
|
|
817
|
+
|--------|--------|--------|--------|
|
|
818
|
+
| active | 是否展示动画效果 | boolean | false |
|
|
819
|
+
| avatar | 是否显示头像占位图 | boolean \| | false |
|
|
820
|
+
| loading | 为 true 时,显示占位图。反之则直接展示子组件 | boolean | - |
|
|
821
|
+
| paragraph | 是否显示段落占位图 | boolean \| | true |
|
|
822
|
+
| round | 为 true 时,段落和标题显示圆角 | boolean | false |
|
|
823
|
+
| title | 是否显示标题占位图 | boolean \| | true |
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
### SkeletonAvatarProps
|
|
827
|
+
|
|
828
|
+
| 属性 | 说明 | 类型 | 默认值 |
|
|
829
|
+
|--------|--------|--------|--------|
|
|
830
|
+
| active | 是否展示动画效果,仅在单独使用头像骨架时生效 | boolean | false |
|
|
831
|
+
| shape | 指定头像的形状 | circle | - |
|
|
832
|
+
| size | 设置头像占位图的大小 | number \| | - |
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
### SkeletonTitleProps
|
|
836
|
+
|
|
837
|
+
| 属性 | 说明 | 类型 | 默认值 |
|
|
838
|
+
|--------|--------|--------|--------|
|
|
839
|
+
| width | 设置标题占位图的宽度 | number \| string | - |
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
### SkeletonParagraphProps
|
|
843
|
+
|
|
844
|
+
| 属性 | 说明 | 类型 | 默认值 |
|
|
845
|
+
|--------|--------|--------|--------|
|
|
846
|
+
| rows | 设置段落占位图的行数 | number | - |
|
|
847
|
+
| width | 设置段落占位图的宽度,若为数组时则为对应的每行宽度,反之则是最后一行的宽度 | number \| string \| Array | - |
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
### SkeletonButtonProps
|
|
851
|
+
|
|
852
|
+
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
853
|
+
|--------|--------|--------|--------|--------|
|
|
854
|
+
| active | 是否展示动画效果 | boolean | false | |
|
|
855
|
+
| block | 将按钮宽度调整为其父宽度的选项 | boolean | false | 4.17.0 |
|
|
856
|
+
| shape | 指定按钮的形状 | circle | - | |
|
|
857
|
+
| size | 设置按钮的大小 | large | - | |
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
### SkeletonInputProps
|
|
861
|
+
|
|
862
|
+
| 属性 | 说明 | 类型 | 默认值 |
|
|
863
|
+
|--------|--------|--------|--------|
|
|
864
|
+
| active | 是否展示动画效果 | boolean | false |
|
|
865
|
+
| size | 设置输入框的大小 | large | - |
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
809
870
|
<DemoTitle title="Slider" desc="滑动型输入器,展示当前值和可选范围。">
|
|
810
871
|
#### API
|
|
811
872
|
|
|
@@ -870,6 +931,18 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
870
931
|
|
|
871
932
|
|
|
872
933
|
|
|
934
|
+
<DemoTitle title="Result" desc="为操作结果提供反馈信息的展示。">
|
|
935
|
+
## API
|
|
936
|
+
|
|
937
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
938
|
+
|--------|--------|--------|--------|
|
|
939
|
+
| texture | 是否显示纹理 | boolean | false |
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
|
|
873
946
|
<DemoTitle title="Select" desc="下拉选择器">
|
|
874
947
|
## antd API
|
|
875
948
|
|
|
@@ -968,67 +1041,6 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
968
1041
|
|
|
969
1042
|
|
|
970
1043
|
|
|
971
|
-
<DemoTitle title="Skeleton" desc="在内容加载时提供占位图形展示。">
|
|
972
|
-
## antd API
|
|
973
|
-
|
|
974
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
975
|
-
|
|
976
|
-
### Skeleton
|
|
977
|
-
|
|
978
|
-
| 属性 | 说明 | 类型 | 默认值 |
|
|
979
|
-
|--------|--------|--------|--------|
|
|
980
|
-
| active | 是否展示动画效果 | boolean | false |
|
|
981
|
-
| avatar | 是否显示头像占位图 | boolean \| | false |
|
|
982
|
-
| loading | 为 true 时,显示占位图。反之则直接展示子组件 | boolean | - |
|
|
983
|
-
| paragraph | 是否显示段落占位图 | boolean \| | true |
|
|
984
|
-
| round | 为 true 时,段落和标题显示圆角 | boolean | false |
|
|
985
|
-
| title | 是否显示标题占位图 | boolean \| | true |
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
### SkeletonAvatarProps
|
|
989
|
-
|
|
990
|
-
| 属性 | 说明 | 类型 | 默认值 |
|
|
991
|
-
|--------|--------|--------|--------|
|
|
992
|
-
| active | 是否展示动画效果,仅在单独使用头像骨架时生效 | boolean | false |
|
|
993
|
-
| shape | 指定头像的形状 | circle | - |
|
|
994
|
-
| size | 设置头像占位图的大小 | number \| | - |
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
### SkeletonTitleProps
|
|
998
|
-
|
|
999
|
-
| 属性 | 说明 | 类型 | 默认值 |
|
|
1000
|
-
|--------|--------|--------|--------|
|
|
1001
|
-
| width | 设置标题占位图的宽度 | number \| string | - |
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
### SkeletonParagraphProps
|
|
1005
|
-
|
|
1006
|
-
| 属性 | 说明 | 类型 | 默认值 |
|
|
1007
|
-
|--------|--------|--------|--------|
|
|
1008
|
-
| rows | 设置段落占位图的行数 | number | - |
|
|
1009
|
-
| width | 设置段落占位图的宽度,若为数组时则为对应的每行宽度,反之则是最后一行的宽度 | number \| string \| Array | - |
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
### SkeletonButtonProps
|
|
1013
|
-
|
|
1014
|
-
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1015
|
-
|--------|--------|--------|--------|--------|
|
|
1016
|
-
| active | 是否展示动画效果 | boolean | false | |
|
|
1017
|
-
| block | 将按钮宽度调整为其父宽度的选项 | boolean | false | 4.17.0 |
|
|
1018
|
-
| shape | 指定按钮的形状 | circle | - | |
|
|
1019
|
-
| size | 设置按钮的大小 | large | - | |
|
|
1020
|
-
|
|
1021
|
-
|
|
1022
|
-
### SkeletonInputProps
|
|
1023
|
-
|
|
1024
|
-
| 属性 | 说明 | 类型 | 默认值 |
|
|
1025
|
-
|--------|--------|--------|--------|
|
|
1026
|
-
| active | 是否展示动画效果 | boolean | false |
|
|
1027
|
-
| size | 设置输入框的大小 | large | - |
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
1044
|
<DemoTitle title="RadioButton" desc="用于在多个备选项中选中单个状态。">
|
|
1033
1045
|
#### API
|
|
1034
1046
|
|
|
@@ -1104,18 +1116,6 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1104
1116
|
|
|
1105
1117
|
|
|
1106
1118
|
|
|
1107
|
-
<DemoTitle title="Result" desc="为操作结果提供反馈信息的展示。">
|
|
1108
|
-
## API
|
|
1109
|
-
|
|
1110
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1111
|
-
|--------|--------|--------|--------|
|
|
1112
|
-
| texture | 是否显示纹理 | boolean | false |
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
1119
|
<DemoTitle title="Radio" desc="用于在多个备选项中选中单个状态。">
|
|
1120
1120
|
#### API
|
|
1121
1121
|
|
|
@@ -1184,25 +1184,8 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1184
1184
|
|
|
1185
1185
|
|
|
1186
1186
|
|
|
1187
|
-
<DemoTitle title="
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1191
|
-
|--------|--------|--------|--------|
|
|
1192
|
-
| maxLength | 可以输入内容的最大长度 | number | |
|
|
1193
|
-
| value | 输入的内容 | string | (必填) |
|
|
1194
|
-
| className | 输入内容的类名 | string | |
|
|
1195
|
-
| onChange | 输入内容的回调 | (value: string) => void | |
|
|
1196
|
-
| variables | 可以插入的变量列表 | Array | |
|
|
1197
|
-
| onCreate | 新增变量的触发回调 | () => void | |
|
|
1198
|
-
| createBtnText | 新增变量的按钮文本 | string | |
|
|
1199
|
-
| tipsText | 提示文本,传入 false 时隐藏提示 | string \| React.ReactNode \| false | |
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
<DemoTitle title="Progress" desc="用于指示任务的完成进度">
|
|
1205
|
-
## antd API
|
|
1187
|
+
<DemoTitle title="Progress" desc="用于指示任务的完成进度">
|
|
1188
|
+
## antd API
|
|
1206
1189
|
|
|
1207
1190
|
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1208
1191
|
|
|
@@ -1253,10 +1236,15 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1253
1236
|
|
|
1254
1237
|
|
|
1255
1238
|
|
|
1256
|
-
<DemoTitle title="
|
|
1239
|
+
<DemoTitle title="Popconfirm" desc="点击元素,弹出气泡式的确认框。">
|
|
1257
1240
|
#### API
|
|
1258
1241
|
|
|
1259
|
-
|
|
1242
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1243
|
+
|--------|--------|--------|--------|
|
|
1244
|
+
| type | 类型 | 'info' \| 'warning' \| 'error' \| 'success' \| 'confirm' | 'confirm' |
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
<AntdApiRef url="https://ant.design/components/popconfirm-cn/#api"></AntdApiRef>
|
|
1260
1248
|
|
|
1261
1249
|
|
|
1262
1250
|
## antd API
|
|
@@ -1265,8 +1253,19 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1265
1253
|
|
|
1266
1254
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1267
1255
|
|--------|--------|--------|--------|--------|
|
|
1268
|
-
|
|
|
1269
|
-
|
|
|
1256
|
+
| cancelButtonProps | cancel 按钮 props | | - | |
|
|
1257
|
+
| cancelText | 取消按钮文字 | string | 取消 | |
|
|
1258
|
+
| disabled | 阻止点击 Popconfirm 子元素时弹出确认框 | boolean | false | |
|
|
1259
|
+
| icon | 自定义弹出气泡 Icon 图标 | ReactNode | | |
|
|
1260
|
+
| okButtonProps | ok 按钮 props | | - | |
|
|
1261
|
+
| okText | 确认按钮文字 | string | 确定 | |
|
|
1262
|
+
| okType | 确认按钮类型 | string | primary | |
|
|
1263
|
+
| showCancel | 是否显示取消按钮 | boolean | true | 4.18.0 |
|
|
1264
|
+
| title | 确认框标题 | ReactNode \| () => ReactNode | - | |
|
|
1265
|
+
| description | 确认内容的详细描述 | ReactNode \| () => ReactNode | - | 5.1.0 |
|
|
1266
|
+
| onCancel | 点击取消的回调 | function(e) | - | |
|
|
1267
|
+
| onConfirm | 点击确认的回调 | function(e) | - | |
|
|
1268
|
+
| onPopupClick | 弹出气泡点击事件 | function(e) | - | 5.5.0 |
|
|
1270
1269
|
|
|
1271
1270
|
|
|
1272
1271
|
<!-- 共同的 API -->
|
|
@@ -1291,68 +1290,126 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1291
1290
|
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
1292
1291
|
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
1293
1292
|
|
|
1294
|
-
## 注意
|
|
1295
1293
|
|
|
1296
|
-
请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
|
|
1297
1294
|
|
|
1298
1295
|
|
|
1296
|
+
<DemoTitle title="Notification" desc="用于指示任务的完成进度">
|
|
1297
|
+
#### API
|
|
1299
1298
|
|
|
1300
|
-
<
|
|
1301
|
-
## API
|
|
1299
|
+
<AntdApiRef url="https://ant.design/components/notification-cn/#api"></AntdApiRef>
|
|
1302
1300
|
|
|
1303
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1304
|
-
|--------|--------|--------|--------|
|
|
1305
|
-
| hideSwitchButton | 是否展示上一页/下一页的切换按钮 | boolean | false |
|
|
1306
1301
|
|
|
1302
|
+
## antd API
|
|
1307
1303
|
|
|
1308
|
-
|
|
1304
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1309
1305
|
|
|
1310
1306
|
|
|
1311
|
-
|
|
1307
|
+
- `notification.success(config)`
|
|
1308
|
+
- `notification.error(config)`
|
|
1309
|
+
- `notification.info(config)`
|
|
1310
|
+
- `notification.warning(config)`
|
|
1311
|
+
- `notification.open(config)`
|
|
1312
|
+
- `notification.destroy(key?: String)`
|
|
1312
1313
|
|
|
1313
|
-
|
|
1314
|
+
config 参数如下:
|
|
1314
1315
|
|
|
1316
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1317
|
+
|--------|--------|--------|--------|--------|
|
|
1318
|
+
| actions | 自定义按钮组 | ReactNode | - | 5.24.0 |
|
|
1319
|
+
| className | 自定义 CSS class | string | - | - |
|
|
1320
|
+
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0:设置为 null 或 false 时隐藏关闭按钮 |
|
|
1321
|
+
| description | 通知提醒内容,必选 | ReactNode | - | - |
|
|
1322
|
+
| duration | 默认 4.5 秒后自动关闭,配置为 null 则不自动关闭 | number | 4.5 | - |
|
|
1323
|
+
| showProgress | 显示自动关闭通知框的进度条 | boolean | | 5.18.0 |
|
|
1324
|
+
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 |
|
|
1325
|
+
| icon | 自定义图标 | ReactNode | - | - |
|
|
1326
|
+
| key | 当前通知唯一标志 | string | - | - |
|
|
1327
|
+
| message | 通知提醒标题,必选 | ReactNode | - | - |
|
|
1328
|
+
| placement | 弹出位置,可选 | string | topRight | - |
|
|
1329
|
+
| style | 自定义内联样式 | | - | - |
|
|
1330
|
+
| role | 供屏幕阅读器识别的通知内容语义,默认为 | alert \| status | alert | 5.6.0 |
|
|
1331
|
+
| onClick | 点击通知时触发的回调函数 | function | - | - |
|
|
1332
|
+
| onClose | 当通知关闭时触发 | function | - | - |
|
|
1333
|
+
| props | 透传至通知 | Object | - | - |
|
|
1315
1334
|
|
|
1316
|
-
|
|
1317
|
-
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
- `notification.useNotification(config)`
|
|
1338
|
+
|
|
1339
|
+
config 参数如下:
|
|
1340
|
+
|
|
1341
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1342
|
+
|--------|--------|--------|--------|--------|
|
|
1343
|
+
| bottom | 消息从底部弹出时,距离底部的位置,单位像素 | number | 24 | |
|
|
1344
|
+
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0:设置为 null 或 false 时隐藏关闭按钮 |
|
|
1345
|
+
| getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body | |
|
|
1346
|
+
| placement | 弹出位置,可选 | string | topRight | |
|
|
1347
|
+
| showProgress | 显示自动关闭通知框的进度条 | boolean | | 5.18.0 |
|
|
1348
|
+
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 |
|
|
1349
|
+
| rtl | 是否开启 RTL 模式 | boolean | false | |
|
|
1350
|
+
| stack | 堆叠模式,超过阈值时会将所有消息收起 | boolean \| | { threshold: 3 } | 5.10.0 |
|
|
1351
|
+
| top | 消息从顶部弹出时,距离顶部的位置,单位像素 | number | 24 | |
|
|
1352
|
+
| maxCount | 最大显示数,超过限制时,最早的消息会被自动关闭 | number | - | 4.17.0 |
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
### 全局配置
|
|
1356
|
+
|
|
1357
|
+
还提供了一个全局配置方法,在调用前提前配置,全局一次生效。
|
|
1358
|
+
|
|
1359
|
+
`notification.config(options)`
|
|
1360
|
+
|
|
1361
|
+
当你使用 `ConfigProvider` 进行全局化配置时,系统会默认自动开启 RTL 模式。(4.3.0+)当你想单独使用,可通过如下设置开启 RTL 模式。
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
```js
|
|
1365
|
+
notification.config({
|
|
1366
|
+
placement: 'bottomRight',
|
|
1367
|
+
bottom: 50,
|
|
1368
|
+
duration: 3,
|
|
1369
|
+
rtl: true,
|
|
1370
|
+
});
|
|
1318
1371
|
```
|
|
1319
1372
|
|
|
1320
1373
|
|
|
1374
|
+
#### notification.config
|
|
1375
|
+
|
|
1321
1376
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1322
1377
|
|--------|--------|--------|--------|--------|
|
|
1323
|
-
|
|
|
1324
|
-
|
|
|
1325
|
-
|
|
|
1326
|
-
|
|
|
1327
|
-
|
|
|
1328
|
-
|
|
|
1329
|
-
|
|
|
1330
|
-
|
|
|
1331
|
-
|
|
|
1332
|
-
|
|
|
1333
|
-
| showLessItems | 是否显示较少页面内容 | boolean | false | |
|
|
1334
|
-
| showQuickJumper | 是否可以快速跳转至某页 | boolean \| { goButton: ReactNode } | false | |
|
|
1335
|
-
| showSizeChanger | 是否展示 | boolean \| | - | SelectProps: 5.21.0 |
|
|
1336
|
-
| showTitle | 是否显示原生 tooltip 页码提示 | boolean | true | |
|
|
1337
|
-
| showTotal | 用于显示数据总量和当前数据顺序 | function(total, range) | - | |
|
|
1338
|
-
| simple | 当添加该属性时,显示为简单分页 | boolean \| { readOnly?: boolean } | - | |
|
|
1339
|
-
| size | 当为 | default | default | |
|
|
1340
|
-
| total | 数据总数 | number | 0 | |
|
|
1341
|
-
| onChange | 页码或 | function(page, pageSize) | - | |
|
|
1342
|
-
| onShowSizeChange | pageSize 变化的回调 | function(current, size) | - | |
|
|
1378
|
+
| bottom | 消息从底部弹出时,距离底部的位置,单位像素 | number | 24 | |
|
|
1379
|
+
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0:设置为 null 或 false 时隐藏关闭按钮 |
|
|
1380
|
+
| duration | 默认自动关闭延时,单位秒 | number | 4.5 | |
|
|
1381
|
+
| showProgress | 显示自动关闭通知框的进度条 | boolean | | 5.18.0 |
|
|
1382
|
+
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 |
|
|
1383
|
+
| getContainer | 配置渲染节点的输出位置,但依旧为全屏展示 | () => HTMLNode | () => document.body | |
|
|
1384
|
+
| placement | 弹出位置,可选 | string | topRight | |
|
|
1385
|
+
| rtl | 是否开启 RTL 模式 | boolean | false | |
|
|
1386
|
+
| top | 消息从顶部弹出时,距离顶部的位置,单位像素 | number | 24 | |
|
|
1387
|
+
| maxCount | 最大显示数,超过限制时,最早的消息会被自动关闭 | number | - | 4.17.0 |
|
|
1343
1388
|
|
|
1344
1389
|
|
|
1345
1390
|
|
|
1346
1391
|
|
|
1347
|
-
<DemoTitle title="
|
|
1392
|
+
<DemoTitle title="MdEditor" desc="提示词编辑器,可以高亮 Markdown 的语法,支持自定义槽位变量的插入">
|
|
1348
1393
|
#### API
|
|
1349
1394
|
|
|
1350
1395
|
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1351
1396
|
|--------|--------|--------|--------|
|
|
1352
|
-
|
|
|
1397
|
+
| maxLength | 可以输入内容的最大长度 | number | |
|
|
1398
|
+
| value | 输入的内容 | string | (必填) |
|
|
1399
|
+
| className | 输入内容的类名 | string | |
|
|
1400
|
+
| onChange | 输入内容的回调 | (value: string) => void | |
|
|
1401
|
+
| variables | 可以插入的变量列表 | Array | |
|
|
1402
|
+
| onCreate | 新增变量的触发回调 | () => void | |
|
|
1403
|
+
| createBtnText | 新增变量的按钮文本 | string | |
|
|
1404
|
+
| tipsText | 提示文本,传入 false 时隐藏提示 | string \| React.ReactNode \| false | |
|
|
1353
1405
|
|
|
1354
1406
|
|
|
1355
|
-
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
<DemoTitle title="Popover" desc="点击/鼠标移入元素,弹出气泡式的卡片浮层">
|
|
1410
|
+
#### API
|
|
1411
|
+
|
|
1412
|
+
<AntdApiRef url="https://ant.design/components/popover-cn/#api"></AntdApiRef>
|
|
1356
1413
|
|
|
1357
1414
|
|
|
1358
1415
|
## antd API
|
|
@@ -1361,19 +1418,8 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1361
1418
|
|
|
1362
1419
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1363
1420
|
|--------|--------|--------|--------|--------|
|
|
1364
|
-
|
|
|
1365
|
-
|
|
|
1366
|
-
| disabled | 阻止点击 Popconfirm 子元素时弹出确认框 | boolean | false | |
|
|
1367
|
-
| icon | 自定义弹出气泡 Icon 图标 | ReactNode | | |
|
|
1368
|
-
| okButtonProps | ok 按钮 props | | - | |
|
|
1369
|
-
| okText | 确认按钮文字 | string | 确定 | |
|
|
1370
|
-
| okType | 确认按钮类型 | string | primary | |
|
|
1371
|
-
| showCancel | 是否显示取消按钮 | boolean | true | 4.18.0 |
|
|
1372
|
-
| title | 确认框标题 | ReactNode \| () => ReactNode | - | |
|
|
1373
|
-
| description | 确认内容的详细描述 | ReactNode \| () => ReactNode | - | 5.1.0 |
|
|
1374
|
-
| onCancel | 点击取消的回调 | function(e) | - | |
|
|
1375
|
-
| onConfirm | 点击确认的回调 | function(e) | - | |
|
|
1376
|
-
| onPopupClick | 弹出气泡点击事件 | function(e) | - | 5.5.0 |
|
|
1421
|
+
| content | 卡片内容 | ReactNode \| () => ReactNode | - | |
|
|
1422
|
+
| title | 卡片标题 | ReactNode \| () => ReactNode | - | |
|
|
1377
1423
|
|
|
1378
1424
|
|
|
1379
1425
|
<!-- 共同的 API -->
|
|
@@ -1398,6 +1444,9 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1398
1444
|
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
1399
1445
|
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
1400
1446
|
|
|
1447
|
+
## 注意
|
|
1448
|
+
|
|
1449
|
+
请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
|
|
1401
1450
|
|
|
1402
1451
|
|
|
1403
1452
|
|
|
@@ -1571,151 +1620,49 @@ const confirmed = await modal.confirm({ ... });
|
|
|
1571
1620
|
|
|
1572
1621
|
|
|
1573
1622
|
|
|
1574
|
-
<DemoTitle title="
|
|
1575
|
-
|
|
1576
|
-
|
|
1577
|
-
<AntdApiRef url="https://ant.design/components/notification-cn/#api"></AntdApiRef>
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
## antd API
|
|
1581
|
-
|
|
1582
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1583
|
-
|
|
1584
|
-
|
|
1585
|
-
- `notification.success(config)`
|
|
1586
|
-
- `notification.error(config)`
|
|
1587
|
-
- `notification.info(config)`
|
|
1588
|
-
- `notification.warning(config)`
|
|
1589
|
-
- `notification.open(config)`
|
|
1590
|
-
- `notification.destroy(key?: String)`
|
|
1591
|
-
|
|
1592
|
-
config 参数如下:
|
|
1593
|
-
|
|
1594
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1595
|
-
|--------|--------|--------|--------|--------|
|
|
1596
|
-
| actions | 自定义按钮组 | ReactNode | - | 5.24.0 |
|
|
1597
|
-
| className | 自定义 CSS class | string | - | - |
|
|
1598
|
-
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0:设置为 null 或 false 时隐藏关闭按钮 |
|
|
1599
|
-
| description | 通知提醒内容,必选 | ReactNode | - | - |
|
|
1600
|
-
| duration | 默认 4.5 秒后自动关闭,配置为 null 则不自动关闭 | number | 4.5 | - |
|
|
1601
|
-
| showProgress | 显示自动关闭通知框的进度条 | boolean | | 5.18.0 |
|
|
1602
|
-
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 |
|
|
1603
|
-
| icon | 自定义图标 | ReactNode | - | - |
|
|
1604
|
-
| key | 当前通知唯一标志 | string | - | - |
|
|
1605
|
-
| message | 通知提醒标题,必选 | ReactNode | - | - |
|
|
1606
|
-
| placement | 弹出位置,可选 | string | topRight | - |
|
|
1607
|
-
| style | 自定义内联样式 | | - | - |
|
|
1608
|
-
| role | 供屏幕阅读器识别的通知内容语义,默认为 | alert \| status | alert | 5.6.0 |
|
|
1609
|
-
| onClick | 点击通知时触发的回调函数 | function | - | - |
|
|
1610
|
-
| onClose | 当通知关闭时触发 | function | - | - |
|
|
1611
|
-
| props | 透传至通知 | Object | - | - |
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
- `notification.useNotification(config)`
|
|
1616
|
-
|
|
1617
|
-
config 参数如下:
|
|
1623
|
+
<DemoTitle title="Pagination" desc="分页器用于分隔长列表,每次只加载一个页面。">
|
|
1624
|
+
## API
|
|
1618
1625
|
|
|
1619
|
-
|
|
|
1620
|
-
|
|
1621
|
-
|
|
|
1622
|
-
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0:设置为 null 或 false 时隐藏关闭按钮 |
|
|
1623
|
-
| getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body | |
|
|
1624
|
-
| placement | 弹出位置,可选 | string | topRight | |
|
|
1625
|
-
| showProgress | 显示自动关闭通知框的进度条 | boolean | | 5.18.0 |
|
|
1626
|
-
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 |
|
|
1627
|
-
| rtl | 是否开启 RTL 模式 | boolean | false | |
|
|
1628
|
-
| stack | 堆叠模式,超过阈值时会将所有消息收起 | boolean \| | { threshold: 3 } | 5.10.0 |
|
|
1629
|
-
| top | 消息从顶部弹出时,距离顶部的位置,单位像素 | number | 24 | |
|
|
1630
|
-
| maxCount | 最大显示数,超过限制时,最早的消息会被自动关闭 | number | - | 4.17.0 |
|
|
1626
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1627
|
+
|--------|--------|--------|--------|
|
|
1628
|
+
| hideSwitchButton | 是否展示上一页/下一页的切换按钮 | boolean | false |
|
|
1631
1629
|
|
|
1632
1630
|
|
|
1633
|
-
|
|
1631
|
+
<AntdApiRef url="https://ant.design/components/pagination-cn/#api"></AntdApiRef>
|
|
1634
1632
|
|
|
1635
|
-
还提供了一个全局配置方法,在调用前提前配置,全局一次生效。
|
|
1636
1633
|
|
|
1637
|
-
|
|
1634
|
+
## antd API
|
|
1638
1635
|
|
|
1639
|
-
|
|
1636
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1640
1637
|
|
|
1641
1638
|
|
|
1642
|
-
```
|
|
1643
|
-
|
|
1644
|
-
placement: 'bottomRight',
|
|
1645
|
-
bottom: 50,
|
|
1646
|
-
duration: 3,
|
|
1647
|
-
rtl: true,
|
|
1648
|
-
});
|
|
1639
|
+
```jsx
|
|
1640
|
+
<Pagination onChange={onChange} total={50} />
|
|
1649
1641
|
```
|
|
1650
1642
|
|
|
1651
1643
|
|
|
1652
|
-
#### notification.config
|
|
1653
|
-
|
|
1654
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1655
|
-
|--------|--------|--------|--------|--------|
|
|
1656
|
-
| bottom | 消息从底部弹出时,距离底部的位置,单位像素 | number | 24 | |
|
|
1657
|
-
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0:设置为 null 或 false 时隐藏关闭按钮 |
|
|
1658
|
-
| duration | 默认自动关闭延时,单位秒 | number | 4.5 | |
|
|
1659
|
-
| showProgress | 显示自动关闭通知框的进度条 | boolean | | 5.18.0 |
|
|
1660
|
-
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 |
|
|
1661
|
-
| getContainer | 配置渲染节点的输出位置,但依旧为全屏展示 | () => HTMLNode | () => document.body | |
|
|
1662
|
-
| placement | 弹出位置,可选 | string | topRight | |
|
|
1663
|
-
| rtl | 是否开启 RTL 模式 | boolean | false | |
|
|
1664
|
-
| top | 消息从顶部弹出时,距离顶部的位置,单位像素 | number | 24 | |
|
|
1665
|
-
| maxCount | 最大显示数,超过限制时,最早的消息会被自动关闭 | number | - | 4.17.0 |
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
|
-
<DemoTitle title="InputNumber" desc="通过鼠标或键盘,输入范围内的数值。">
|
|
1671
|
-
#### API
|
|
1672
|
-
|
|
1673
|
-
<AntdApiRef url="https://ant.design/components/input-number-cn/#api"></AntdApiRef>
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
## antd API
|
|
1677
|
-
|
|
1678
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1679
|
-
|
|
1680
1644
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1681
1645
|
|--------|--------|--------|--------|--------|
|
|
1682
|
-
|
|
|
1683
|
-
|
|
|
1684
|
-
|
|
|
1685
|
-
|
|
|
1686
|
-
|
|
|
1687
|
-
|
|
|
1688
|
-
|
|
|
1689
|
-
|
|
|
1690
|
-
|
|
|
1691
|
-
|
|
|
1692
|
-
|
|
|
1693
|
-
|
|
|
1694
|
-
|
|
|
1695
|
-
|
|
|
1696
|
-
|
|
|
1697
|
-
|
|
|
1698
|
-
|
|
|
1699
|
-
|
|
|
1700
|
-
|
|
|
1701
|
-
|
|
|
1702
|
-
| size | 输入框大小 | large | - | - |
|
|
1703
|
-
| step | 每次改变步数,可以为小数 | number \| string | 1 | - |
|
|
1704
|
-
| stringMode | 字符值模式,开启后支持高精度小数。同时 | boolean | false | 4.13.0 |
|
|
1705
|
-
| value | 当前值 | number | - | - |
|
|
1706
|
-
| variant | 形态变体 | outlined | outlined | 5.13.0 \| |
|
|
1707
|
-
| onChange | 变化回调 | function(value: number \| string \| null) | - | - |
|
|
1708
|
-
| onPressEnter | 按下回车的回调 | function(e) | - | - |
|
|
1709
|
-
| onStep | 点击上下箭头的回调 | (value: number, info: { offset: number, type: 'up' \| 'down' }) => void | - | 4.7.0 |
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
## Ref
|
|
1713
|
-
|
|
1714
|
-
| 名称 | 说明 | 参数 | 版本 |
|
|
1715
|
-
|--------|--------|--------|--------|
|
|
1716
|
-
| blur() | 移除焦点 | - | |
|
|
1717
|
-
| focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 |
|
|
1718
|
-
| nativeElement | 获取原生 DOM 元素 | - | 5.17.3 |
|
|
1646
|
+
| align | 对齐方式 | start \| center \| end | - | 5.19.0 |
|
|
1647
|
+
| current | 当前页数 | number | - | |
|
|
1648
|
+
| defaultCurrent | 默认的当前页数 | number | 1 | |
|
|
1649
|
+
| defaultPageSize | 默认的每页条数 | number | 10 | |
|
|
1650
|
+
| disabled | 禁用分页 | boolean | - | |
|
|
1651
|
+
| hideOnSinglePage | 只有一页时是否隐藏分页器 | boolean | false | |
|
|
1652
|
+
| itemRender | 用于自定义页码的结构,可用于优化 SEO | (page, type: 'page' \| 'prev' \| 'next', originalElement) => React.ReactNode | - | |
|
|
1653
|
+
| pageSize | 每页条数 | number | - | |
|
|
1654
|
+
| pageSizeOptions | 指定每页可以显示多少条 | number[] | [ | |
|
|
1655
|
+
| responsive | 当 size 未指定时,根据屏幕宽度自动调整尺寸 | boolean | - | |
|
|
1656
|
+
| showLessItems | 是否显示较少页面内容 | boolean | false | |
|
|
1657
|
+
| showQuickJumper | 是否可以快速跳转至某页 | boolean \| { goButton: ReactNode } | false | |
|
|
1658
|
+
| showSizeChanger | 是否展示 | boolean \| | - | SelectProps: 5.21.0 |
|
|
1659
|
+
| showTitle | 是否显示原生 tooltip 页码提示 | boolean | true | |
|
|
1660
|
+
| showTotal | 用于显示数据总量和当前数据顺序 | function(total, range) | - | |
|
|
1661
|
+
| simple | 当添加该属性时,显示为简单分页 | boolean \| { readOnly?: boolean } | - | |
|
|
1662
|
+
| size | 当为 | default | default | |
|
|
1663
|
+
| total | 数据总数 | number | 0 | |
|
|
1664
|
+
| onChange | 页码或 | function(page, pageSize) | - | |
|
|
1665
|
+
| onShowSizeChange | pageSize 变化的回调 | function(current, size) | - | |
|
|
1719
1666
|
|
|
1720
1667
|
|
|
1721
1668
|
|
|
@@ -1955,6 +1902,59 @@ interface CountConfig {
|
|
|
1955
1902
|
|
|
1956
1903
|
|
|
1957
1904
|
|
|
1905
|
+
<DemoTitle title="InputNumber" desc="通过鼠标或键盘,输入范围内的数值。">
|
|
1906
|
+
#### API
|
|
1907
|
+
|
|
1908
|
+
<AntdApiRef url="https://ant.design/components/input-number-cn/#api"></AntdApiRef>
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
## antd API
|
|
1912
|
+
|
|
1913
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1914
|
+
|
|
1915
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1916
|
+
|--------|--------|--------|--------|--------|
|
|
1917
|
+
| addonAfter | 带标签的 input,设置后置标签 | ReactNode | - | 4.17.0 |
|
|
1918
|
+
| addonBefore | 带标签的 input,设置前置标签 | ReactNode | - | 4.17.0 |
|
|
1919
|
+
| autoFocus | 自动获取焦点 | boolean | false | - |
|
|
1920
|
+
| changeOnBlur | 是否在失去焦点时,触发 | boolean | true | 5.11.0 |
|
|
1921
|
+
| changeOnWheel | 允许鼠标滚轮改变数值 | boolean | - | 5.14.0 |
|
|
1922
|
+
| controls | 是否显示增减按钮,也可设置自定义箭头图标 | boolean \| { upIcon?: React.ReactNode; downIcon?: React.ReactNode; } | - | 4.19.0 |
|
|
1923
|
+
| decimalSeparator | 小数点 | string | - | - |
|
|
1924
|
+
| placeholder | 占位符 | string | - | |
|
|
1925
|
+
| defaultValue | 初始值 | number | - | - |
|
|
1926
|
+
| disabled | 禁用 | boolean | false | - |
|
|
1927
|
+
| formatter | 指定输入框展示值的格式 | function(value: number \| string, info: { userTyping: boolean, input: string }): string | - | info: 4.17.0 |
|
|
1928
|
+
| keyboard | 是否启用键盘快捷行为 | boolean | true | 4.12.0 |
|
|
1929
|
+
| max | 最大值 | number | | - |
|
|
1930
|
+
| min | 最小值 | number | | - |
|
|
1931
|
+
| parser | 指定从 | function(string): number | - | - |
|
|
1932
|
+
| precision | 数值精度,配置 | number | - | - |
|
|
1933
|
+
| readOnly | 只读 | boolean | false | - |
|
|
1934
|
+
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
1935
|
+
| prefix | 带有前缀图标的 input | ReactNode | - | 4.17.0 |
|
|
1936
|
+
| suffix | 带有后缀图标的 input | ReactNode | - | 5.20.0 |
|
|
1937
|
+
| size | 输入框大小 | large | - | - |
|
|
1938
|
+
| step | 每次改变步数,可以为小数 | number \| string | 1 | - |
|
|
1939
|
+
| stringMode | 字符值模式,开启后支持高精度小数。同时 | boolean | false | 4.13.0 |
|
|
1940
|
+
| value | 当前值 | number | - | - |
|
|
1941
|
+
| variant | 形态变体 | outlined | outlined | 5.13.0 \| |
|
|
1942
|
+
| onChange | 变化回调 | function(value: number \| string \| null) | - | - |
|
|
1943
|
+
| onPressEnter | 按下回车的回调 | function(e) | - | - |
|
|
1944
|
+
| onStep | 点击上下箭头的回调 | (value: number, info: { offset: number, type: 'up' \| 'down' }) => void | - | 4.7.0 |
|
|
1945
|
+
|
|
1946
|
+
|
|
1947
|
+
## Ref
|
|
1948
|
+
|
|
1949
|
+
| 名称 | 说明 | 参数 | 版本 |
|
|
1950
|
+
|--------|--------|--------|--------|
|
|
1951
|
+
| blur() | 移除焦点 | - | |
|
|
1952
|
+
| focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 |
|
|
1953
|
+
| nativeElement | 获取原生 DOM 元素 | - | 5.17.3 |
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
1958
|
<DemoTitle title="Image" desc="可预览的图片">
|
|
1959
1959
|
#### API
|
|
1960
1960
|
|
|
@@ -2053,71 +2053,170 @@ interface CountConfig {
|
|
|
2053
2053
|
```
|
|
2054
2054
|
|
|
2055
2055
|
|
|
2056
|
-
### TransformAction
|
|
2056
|
+
### TransformAction
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
```typescript
|
|
2060
|
+
type TransformAction =
|
|
2061
|
+
| 'flipY'
|
|
2062
|
+
| 'flipX'
|
|
2063
|
+
| 'rotateLeft'
|
|
2064
|
+
| 'rotateRight'
|
|
2065
|
+
| 'zoomIn'
|
|
2066
|
+
| 'zoomOut'
|
|
2067
|
+
| 'close'
|
|
2068
|
+
| 'prev'
|
|
2069
|
+
| 'next'
|
|
2070
|
+
| 'wheel'
|
|
2071
|
+
| 'doubleClick'
|
|
2072
|
+
| 'move'
|
|
2073
|
+
| 'dragRebound'
|
|
2074
|
+
| 'reset';
|
|
2075
|
+
```
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
### ToolbarRenderInfoType
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
```typescript
|
|
2082
|
+
{
|
|
2083
|
+
icons: {
|
|
2084
|
+
flipYIcon: React.ReactNode;
|
|
2085
|
+
flipXIcon: React.ReactNode;
|
|
2086
|
+
rotateLeftIcon: React.ReactNode;
|
|
2087
|
+
rotateRightIcon: React.ReactNode;
|
|
2088
|
+
zoomOutIcon: React.ReactNode;
|
|
2089
|
+
zoomInIcon: React.ReactNode;
|
|
2090
|
+
};
|
|
2091
|
+
actions: {
|
|
2092
|
+
onActive?: (index: number) => void; // 5.21.0 之后支持
|
|
2093
|
+
onFlipY: () => void;
|
|
2094
|
+
onFlipX: () => void;
|
|
2095
|
+
onRotateLeft: () => void;
|
|
2096
|
+
onRotateRight: () => void;
|
|
2097
|
+
onZoomOut: () => void;
|
|
2098
|
+
onZoomIn: () => void;
|
|
2099
|
+
onReset: () => void; // 5.17.3 之后支持
|
|
2100
|
+
onClose: () => void;
|
|
2101
|
+
};
|
|
2102
|
+
transform: TransformType,
|
|
2103
|
+
current: number;
|
|
2104
|
+
total: number;
|
|
2105
|
+
image: ImgInfo
|
|
2106
|
+
}
|
|
2107
|
+
```
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
### ImgInfo
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
```typescript
|
|
2114
|
+
{
|
|
2115
|
+
url: string;
|
|
2116
|
+
alt: string;
|
|
2117
|
+
width: string | number;
|
|
2118
|
+
height: string | number;
|
|
2119
|
+
}
|
|
2120
|
+
```
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
|
|
2124
|
+
|
|
2125
|
+
<DemoTitle title="IconButton" desc="以图标为核心的轻量按钮组件,用于触发操作。">
|
|
2126
|
+
#### API
|
|
2127
|
+
|
|
2128
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
2129
|
+
|--------|--------|--------|--------|
|
|
2130
|
+
| icon | icon | ReactNode \| string | |
|
|
2131
|
+
| iconType | 百炼图标iconfont的key,依赖百炼的iconFont,例如bl-icon-add | string | |
|
|
2132
|
+
| bordered | 边框 | boolean | true |
|
|
2133
|
+
| shape | 形状 | 'default' \| 'circle' | 'default' |
|
|
2134
|
+
|
|
2135
|
+
|
|
2136
|
+
## antd API
|
|
2137
|
+
|
|
2138
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
2139
|
+
|
|
2140
|
+
通过设置 Button 的属性来产生不同的按钮样式,推荐顺序为:`type` -> `shape` -> `size` -> `loading` -> `disabled`。
|
|
2141
|
+
|
|
2142
|
+
按钮的属性说明如下:
|
|
2143
|
+
|
|
2144
|
+
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
2145
|
+
|--------|--------|--------|--------|--------|
|
|
2146
|
+
| autoInsertSpace | 我们默认提供两个汉字之间的空格,可以设置 | boolean | true | 5.17.0 |
|
|
2147
|
+
| block | 将按钮宽度调整为其父宽度的选项 | boolean | false | |
|
|
2148
|
+
| classNames | 语义化结构 class | | - | 5.4.0 |
|
|
2149
|
+
| color | 设置按钮的颜色 | default | - | default |
|
|
2150
|
+
| danger | 语法糖,设置危险按钮。当设置 | boolean | false | |
|
|
2151
|
+
| disabled | 设置按钮失效状态 | boolean | false | |
|
|
2152
|
+
| ghost | 幽灵属性,使按钮背景透明 | boolean | false | |
|
|
2153
|
+
| href | 点击跳转的地址,指定此属性 button 的行为和 a 链接一致 | string | - | |
|
|
2154
|
+
| htmlType | 设置 | submit | button | |
|
|
2155
|
+
| iconPosition | 设置按钮图标组件的位置 | start | start | 5.17.0 |
|
|
2156
|
+
| loading | 设置按钮载入状态 | boolean \| { delay: number, icon: ReactNode } | false | icon: 5.23.0 |
|
|
2157
|
+
| styles | 语义化结构 style | | - | 5.4.0 |
|
|
2158
|
+
| target | 相当于 a 链接的 target 属性,href 存在时生效 | string | - | |
|
|
2159
|
+
| onClick | 点击按钮时的回调 | (event: React.MouseEvent) => void | - | |
|
|
2160
|
+
| variant | 设置按钮的变体 | outlined | - | 5.21.0 |
|
|
2161
|
+
|
|
2162
|
+
|
|
2163
|
+
支持原生 button 的其他所有属性。
|
|
2164
|
+
|
|
2165
|
+
### PresetColors
|
|
2166
|
+
|
|
2167
|
+
type PresetColors = 'blue' | 'purple' | 'cyan' | 'green' | 'magenta' | 'pink' | 'red' | 'orange' | 'yellow' | 'volcano' | 'geekblue' | 'lime' | 'gold';
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
|
|
2171
|
+
<DemoTitle title="FloatButton" desc="用于网站上的全局功能;无论浏览到何处都可以看见的按钮。">
|
|
2172
|
+
#### API
|
|
2173
|
+
|
|
2174
|
+
<AntdApiRef url="https://ant.design/components/float-button-cn/#api"></AntdApiRef>
|
|
2057
2175
|
|
|
2058
2176
|
|
|
2059
|
-
|
|
2060
|
-
type TransformAction =
|
|
2061
|
-
| 'flipY'
|
|
2062
|
-
| 'flipX'
|
|
2063
|
-
| 'rotateLeft'
|
|
2064
|
-
| 'rotateRight'
|
|
2065
|
-
| 'zoomIn'
|
|
2066
|
-
| 'zoomOut'
|
|
2067
|
-
| 'close'
|
|
2068
|
-
| 'prev'
|
|
2069
|
-
| 'next'
|
|
2070
|
-
| 'wheel'
|
|
2071
|
-
| 'doubleClick'
|
|
2072
|
-
| 'move'
|
|
2073
|
-
| 'dragRebound'
|
|
2074
|
-
| 'reset';
|
|
2075
|
-
```
|
|
2177
|
+
## antd API
|
|
2076
2178
|
|
|
2179
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
2077
2180
|
|
|
2078
|
-
|
|
2181
|
+
自 `antd@5.0.0` 版本开始提供该组件。
|
|
2079
2182
|
|
|
2183
|
+
### 共同的 API
|
|
2080
2184
|
|
|
2081
|
-
|
|
2082
|
-
|
|
2083
|
-
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
|
|
2088
|
-
|
|
2089
|
-
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
onFlipY: () => void;
|
|
2094
|
-
onFlipX: () => void;
|
|
2095
|
-
onRotateLeft: () => void;
|
|
2096
|
-
onRotateRight: () => void;
|
|
2097
|
-
onZoomOut: () => void;
|
|
2098
|
-
onZoomIn: () => void;
|
|
2099
|
-
onReset: () => void; // 5.17.3 之后支持
|
|
2100
|
-
onClose: () => void;
|
|
2101
|
-
};
|
|
2102
|
-
transform: TransformType,
|
|
2103
|
-
current: number;
|
|
2104
|
-
total: number;
|
|
2105
|
-
image: ImgInfo
|
|
2106
|
-
}
|
|
2107
|
-
```
|
|
2185
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2186
|
+
|--------|--------|--------|--------|--------|
|
|
2187
|
+
| icon | 自定义图标 | ReactNode | - | |
|
|
2188
|
+
| description | 文字及其它内容 | ReactNode | - | |
|
|
2189
|
+
| tooltip | 气泡卡片的内容 | ReactNode \| | - | TooltipProps: 5.25.0 |
|
|
2190
|
+
| type | 设置按钮类型 | default | default | |
|
|
2191
|
+
| shape | 设置按钮形状 | circle | circle | |
|
|
2192
|
+
| onClick | 点击按钮时的回调 | (event) => void | - | |
|
|
2193
|
+
| href | 点击跳转的地址,指定此属性 button 的行为和 a 链接一致 | string | - | |
|
|
2194
|
+
| target | 相当于 a 标签的 target 属性,href 存在时生效 | string | - | |
|
|
2195
|
+
| htmlType | 设置 | submit | button | 5.21.0 |
|
|
2196
|
+
| badge | 带徽标数字的悬浮按钮(不支持 | | - | 5.4.0 |
|
|
2108
2197
|
|
|
2109
2198
|
|
|
2110
|
-
###
|
|
2199
|
+
### FloatButton.Group
|
|
2111
2200
|
|
|
2201
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2202
|
+
|--------|--------|--------|--------|--------|
|
|
2203
|
+
| shape | 设置包含的 FloatButton 按钮形状 | circle | circle | |
|
|
2204
|
+
| trigger | 触发方式(有触发方式为菜单模式) | click | - | |
|
|
2205
|
+
| open | 受控展开,需配合 trigger 一起使用 | boolean | - | |
|
|
2206
|
+
| closeIcon | 自定义关闭按钮 | React.ReactNode | | |
|
|
2207
|
+
| placement | 自定义菜单弹出位置 | top | top | 5.21.0 |
|
|
2208
|
+
| onOpenChange | 展开收起时的回调,需配合 trigger 一起使用 | (open: boolean) => void | - | |
|
|
2209
|
+
| onClick | 点击按钮时的回调(仅在菜单模式中有效) | (event) => void | - | 5.3.0 |
|
|
2112
2210
|
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2211
|
+
|
|
2212
|
+
### FloatButton.BackTop
|
|
2213
|
+
|
|
2214
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2215
|
+
|--------|--------|--------|--------|--------|
|
|
2216
|
+
| duration | 回到顶部所需时间(ms) | number | 450 | |
|
|
2217
|
+
| target | 设置需要监听其滚动事件的元素 | () => HTMLElement | () => window | |
|
|
2218
|
+
| visibilityHeight | 滚动高度达到此参数值才出现 BackTop | number | 400 | |
|
|
2219
|
+
| onClick | 点击按钮的回调函数 | () => void | - | |
|
|
2121
2220
|
|
|
2122
2221
|
|
|
2123
2222
|
|
|
@@ -2653,173 +2752,31 @@ type Rule = RuleConfig | ((form: FormInstance) => RuleConfig);
|
|
|
2653
2752
|
```
|
|
2654
2753
|
|
|
2655
2754
|
|
|
2656
|
-
| 名称 | 说明 | 类型 | 版本 |
|
|
2657
|
-
|--------|--------|--------|--------|
|
|
2658
|
-
| defaultField | 仅在 | | |
|
|
2659
|
-
| enum | 是否匹配枚举中的值(需要将 | any[] | |
|
|
2660
|
-
| fields | 仅在 | Record<string, | |
|
|
2661
|
-
| len | string 类型时为字符串长度;number 类型时为确定数字; array 类型时为数组长度 | number | |
|
|
2662
|
-
| max | 必须设置 | number | |
|
|
2663
|
-
| message | 错误信息,不设置时会通过 | string \| ReactElement | |
|
|
2664
|
-
| min | 必须设置 | number | |
|
|
2665
|
-
| pattern | 正则表达式匹配 | RegExp | |
|
|
2666
|
-
| required | 是否为必选字段 | boolean | |
|
|
2667
|
-
| transform | 将字段值转换成目标值后进行校验 | (value) => any | |
|
|
2668
|
-
| type | 类型,常见有 | string | |
|
|
2669
|
-
| validateTrigger | 设置触发验证时机,必须是 Form.Item 的 | string \| string[] | |
|
|
2670
|
-
| validator | 自定义校验,接收 Promise 作为返回值。 | ( | |
|
|
2671
|
-
| warningOnly | 仅警告,不阻塞表单提交 | boolean | 4.17.0 |
|
|
2672
|
-
| whitespace | 如果字段仅包含空格则校验不通过,只在 | boolean | |
|
|
2673
|
-
|
|
2674
|
-
|
|
2675
|
-
### WatchOptions
|
|
2676
|
-
|
|
2677
|
-
| 名称 | 说明 | 类型 | 默认值 | 版本 |
|
|
2678
|
-
|--------|--------|--------|--------|--------|
|
|
2679
|
-
| form | 指定 Form 实例 | FormInstance | 当前 context 中的 Form | 5.4.0 |
|
|
2680
|
-
| preserve | 是否监视没有对应的 | boolean | false | 5.4.0 |
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
|
-
|
|
2684
|
-
|
|
2685
|
-
<DemoTitle title="IconButton" desc="以图标为核心的轻量按钮组件,用于触发操作。">
|
|
2686
|
-
#### API
|
|
2687
|
-
|
|
2688
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
2689
|
-
|--------|--------|--------|--------|
|
|
2690
|
-
| icon | icon | ReactNode \| string | |
|
|
2691
|
-
| iconType | 百炼图标iconfont的key,依赖百炼的iconFont,例如bl-icon-add | string | |
|
|
2692
|
-
| bordered | 边框 | boolean | true |
|
|
2693
|
-
| shape | 形状 | 'default' \| 'circle' | 'default' |
|
|
2694
|
-
|
|
2695
|
-
|
|
2696
|
-
## antd API
|
|
2697
|
-
|
|
2698
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
2699
|
-
|
|
2700
|
-
通过设置 Button 的属性来产生不同的按钮样式,推荐顺序为:`type` -> `shape` -> `size` -> `loading` -> `disabled`。
|
|
2701
|
-
|
|
2702
|
-
按钮的属性说明如下:
|
|
2703
|
-
|
|
2704
|
-
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
2705
|
-
|--------|--------|--------|--------|--------|
|
|
2706
|
-
| autoInsertSpace | 我们默认提供两个汉字之间的空格,可以设置 | boolean | true | 5.17.0 |
|
|
2707
|
-
| block | 将按钮宽度调整为其父宽度的选项 | boolean | false | |
|
|
2708
|
-
| classNames | 语义化结构 class | | - | 5.4.0 |
|
|
2709
|
-
| color | 设置按钮的颜色 | default | - | default |
|
|
2710
|
-
| danger | 语法糖,设置危险按钮。当设置 | boolean | false | |
|
|
2711
|
-
| disabled | 设置按钮失效状态 | boolean | false | |
|
|
2712
|
-
| ghost | 幽灵属性,使按钮背景透明 | boolean | false | |
|
|
2713
|
-
| href | 点击跳转的地址,指定此属性 button 的行为和 a 链接一致 | string | - | |
|
|
2714
|
-
| htmlType | 设置 | submit | button | |
|
|
2715
|
-
| iconPosition | 设置按钮图标组件的位置 | start | start | 5.17.0 |
|
|
2716
|
-
| loading | 设置按钮载入状态 | boolean \| { delay: number, icon: ReactNode } | false | icon: 5.23.0 |
|
|
2717
|
-
| styles | 语义化结构 style | | - | 5.4.0 |
|
|
2718
|
-
| target | 相当于 a 链接的 target 属性,href 存在时生效 | string | - | |
|
|
2719
|
-
| onClick | 点击按钮时的回调 | (event: React.MouseEvent) => void | - | |
|
|
2720
|
-
| variant | 设置按钮的变体 | outlined | - | 5.21.0 |
|
|
2721
|
-
|
|
2722
|
-
|
|
2723
|
-
支持原生 button 的其他所有属性。
|
|
2724
|
-
|
|
2725
|
-
### PresetColors
|
|
2726
|
-
|
|
2727
|
-
type PresetColors = 'blue' | 'purple' | 'cyan' | 'green' | 'magenta' | 'pink' | 'red' | 'orange' | 'yellow' | 'volcano' | 'geekblue' | 'lime' | 'gold';
|
|
2728
|
-
|
|
2729
|
-
|
|
2730
|
-
|
|
2731
|
-
<DemoTitle title="FloatButton" desc="用于网站上的全局功能;无论浏览到何处都可以看见的按钮。">
|
|
2732
|
-
#### API
|
|
2733
|
-
|
|
2734
|
-
<AntdApiRef url="https://ant.design/components/float-button-cn/#api"></AntdApiRef>
|
|
2735
|
-
|
|
2736
|
-
|
|
2737
|
-
## antd API
|
|
2738
|
-
|
|
2739
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
2740
|
-
|
|
2741
|
-
自 `antd@5.0.0` 版本开始提供该组件。
|
|
2742
|
-
|
|
2743
|
-
### 共同的 API
|
|
2744
|
-
|
|
2745
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2746
|
-
|--------|--------|--------|--------|--------|
|
|
2747
|
-
| icon | 自定义图标 | ReactNode | - | |
|
|
2748
|
-
| description | 文字及其它内容 | ReactNode | - | |
|
|
2749
|
-
| tooltip | 气泡卡片的内容 | ReactNode \| | - | TooltipProps: 5.25.0 |
|
|
2750
|
-
| type | 设置按钮类型 | default | default | |
|
|
2751
|
-
| shape | 设置按钮形状 | circle | circle | |
|
|
2752
|
-
| onClick | 点击按钮时的回调 | (event) => void | - | |
|
|
2753
|
-
| href | 点击跳转的地址,指定此属性 button 的行为和 a 链接一致 | string | - | |
|
|
2754
|
-
| target | 相当于 a 标签的 target 属性,href 存在时生效 | string | - | |
|
|
2755
|
-
| htmlType | 设置 | submit | button | 5.21.0 |
|
|
2756
|
-
| badge | 带徽标数字的悬浮按钮(不支持 | | - | 5.4.0 |
|
|
2757
|
-
|
|
2758
|
-
|
|
2759
|
-
### FloatButton.Group
|
|
2760
|
-
|
|
2761
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2762
|
-
|--------|--------|--------|--------|--------|
|
|
2763
|
-
| shape | 设置包含的 FloatButton 按钮形状 | circle | circle | |
|
|
2764
|
-
| trigger | 触发方式(有触发方式为菜单模式) | click | - | |
|
|
2765
|
-
| open | 受控展开,需配合 trigger 一起使用 | boolean | - | |
|
|
2766
|
-
| closeIcon | 自定义关闭按钮 | React.ReactNode | | |
|
|
2767
|
-
| placement | 自定义菜单弹出位置 | top | top | 5.21.0 |
|
|
2768
|
-
| onOpenChange | 展开收起时的回调,需配合 trigger 一起使用 | (open: boolean) => void | - | |
|
|
2769
|
-
| onClick | 点击按钮时的回调(仅在菜单模式中有效) | (event) => void | - | 5.3.0 |
|
|
2770
|
-
|
|
2771
|
-
|
|
2772
|
-
### FloatButton.BackTop
|
|
2773
|
-
|
|
2774
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2775
|
-
|--------|--------|--------|--------|--------|
|
|
2776
|
-
| duration | 回到顶部所需时间(ms) | number | 450 | |
|
|
2777
|
-
| target | 设置需要监听其滚动事件的元素 | () => HTMLElement | () => window | |
|
|
2778
|
-
| visibilityHeight | 滚动高度达到此参数值才出现 BackTop | number | 400 | |
|
|
2779
|
-
| onClick | 点击按钮的回调函数 | () => void | - | |
|
|
2780
|
-
|
|
2781
|
-
|
|
2782
|
-
|
|
2783
|
-
|
|
2784
|
-
<DemoTitle title="Empty" desc="用于空状态的占位图形展示。">
|
|
2785
|
-
## API
|
|
2786
|
-
|
|
2787
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
2788
|
-
|--------|--------|--------|--------|
|
|
2789
|
-
| type | 空状态类型 | \| 'noData'
|
|
2790
|
-
\| 'networkError'
|
|
2791
|
-
\| '404'
|
|
2792
|
-
\| 'arrears'
|
|
2793
|
-
\| 'desktopOnly'
|
|
2794
|
-
\| 'noAudio'
|
|
2795
|
-
\| 'noImage'
|
|
2796
|
-
\| 'noVideo'
|
|
2797
|
-
\| 'noAccess'
|
|
2798
|
-
\| 'error'
|
|
2799
|
-
\| 'noModel'
|
|
2800
|
-
\| 'noApp'
|
|
2801
|
-
\| 'success'
|
|
2802
|
-
\| 'failed'
|
|
2803
|
-
\| 'inProgress'
|
|
2804
|
-
\| 'stayTuned' | 'noData' |
|
|
2805
|
-
| texture | 是否显示纹理 | boolean | true |
|
|
2806
|
-
| image | 图片地址 | string | 默认是no data的图片 |
|
|
2807
|
-
| imageStyle | 图片样式 | React.CSSProperties | |
|
|
2808
|
-
| title | 标题内容 | React.ReactNode | |
|
|
2809
|
-
| description | 自定义描述内容 | React.ReactNode | |
|
|
2810
|
-
| onOk | ok按钮的点击事件 | (e: React.MouseEvent) => void | |
|
|
2811
|
-
| okText | ok按钮的文本 | React.ReactNode | |
|
|
2812
|
-
| okType | ok按钮的类型 | SparkButtonProps['type'] | 'primary' |
|
|
2813
|
-
| okButtonProps | ok按钮的props | SparkButtonProps | |
|
|
2814
|
-
| children | 自定义空状态的内容 | React.ReactNode | |
|
|
2815
|
-
| className | 自定义空状态的类名 | string | |
|
|
2816
|
-
| style | 自定义空状态的样式 | React.CSSProperties | |
|
|
2817
|
-
| size | 自定义空状态的大小 | React.CSSProperties['width'] | |
|
|
2818
|
-
| autoFit | 是否自适应容器宽度,当容器宽度小于 size 时自动缩放 | boolean | false |
|
|
2755
|
+
| 名称 | 说明 | 类型 | 版本 |
|
|
2756
|
+
|--------|--------|--------|--------|
|
|
2757
|
+
| defaultField | 仅在 | | |
|
|
2758
|
+
| enum | 是否匹配枚举中的值(需要将 | any[] | |
|
|
2759
|
+
| fields | 仅在 | Record<string, | |
|
|
2760
|
+
| len | string 类型时为字符串长度;number 类型时为确定数字; array 类型时为数组长度 | number | |
|
|
2761
|
+
| max | 必须设置 | number | |
|
|
2762
|
+
| message | 错误信息,不设置时会通过 | string \| ReactElement | |
|
|
2763
|
+
| min | 必须设置 | number | |
|
|
2764
|
+
| pattern | 正则表达式匹配 | RegExp | |
|
|
2765
|
+
| required | 是否为必选字段 | boolean | |
|
|
2766
|
+
| transform | 将字段值转换成目标值后进行校验 | (value) => any | |
|
|
2767
|
+
| type | 类型,常见有 | string | |
|
|
2768
|
+
| validateTrigger | 设置触发验证时机,必须是 Form.Item 的 | string \| string[] | |
|
|
2769
|
+
| validator | 自定义校验,接收 Promise 作为返回值。 | ( | |
|
|
2770
|
+
| warningOnly | 仅警告,不阻塞表单提交 | boolean | 4.17.0 |
|
|
2771
|
+
| whitespace | 如果字段仅包含空格则校验不通过,只在 | boolean | |
|
|
2819
2772
|
|
|
2820
2773
|
|
|
2821
|
-
|
|
2774
|
+
### WatchOptions
|
|
2822
2775
|
|
|
2776
|
+
| 名称 | 说明 | 类型 | 默认值 | 版本 |
|
|
2777
|
+
|--------|--------|--------|--------|--------|
|
|
2778
|
+
| form | 指定 Form 实例 | FormInstance | 当前 context 中的 Form | 5.4.0 |
|
|
2779
|
+
| preserve | 是否监视没有对应的 | boolean | false | 5.4.0 |
|
|
2823
2780
|
|
|
2824
2781
|
|
|
2825
2782
|
|
|
@@ -2975,41 +2932,46 @@ const dividerItem = {
|
|
|
2975
2932
|
|
|
2976
2933
|
|
|
2977
2934
|
|
|
2978
|
-
<DemoTitle title="
|
|
2979
|
-
|
|
2980
|
-
|
|
2981
|
-
<AntdApiRef url="https://ant.design/components/descriptions-cn/#api"></AntdApiRef>
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
## antd API
|
|
2985
|
-
|
|
2986
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
2987
|
-
|
|
2988
|
-
### Descriptions
|
|
2989
|
-
|
|
2990
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2991
|
-
|--------|--------|--------|--------|--------|
|
|
2992
|
-
| bordered | 是否展示边框 | boolean | false | |
|
|
2993
|
-
| colon | 配置 | boolean | true | |
|
|
2994
|
-
| column | 一行的 | number \| | 3 | |
|
|
2995
|
-
| extra | 描述列表的操作区域,显示在右上方 | ReactNode | - | 4.5.0 |
|
|
2996
|
-
| items | 描述列表项内容 | | - | 5.8.0 |
|
|
2997
|
-
| layout | 描述布局 | horizontal | horizontal | |
|
|
2998
|
-
| size | 设置列表的大小。可以设置为 | default | - | |
|
|
2999
|
-
| title | 描述列表的标题,显示在最顶部 | ReactNode | - | |
|
|
3000
|
-
| classNames | 语义化结构 class | | - | 5.23.0 |
|
|
3001
|
-
| styles | 语义化结构 style | | - | 5.23.0 |
|
|
2935
|
+
<DemoTitle title="Empty" desc="用于空状态的占位图形展示。">
|
|
2936
|
+
## API
|
|
3002
2937
|
|
|
2938
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
2939
|
+
|--------|--------|--------|--------|
|
|
2940
|
+
| type | 空状态类型 | \| 'noData'
|
|
2941
|
+
\| 'networkError'
|
|
2942
|
+
\| '404'
|
|
2943
|
+
\| 'arrears'
|
|
2944
|
+
\| 'desktopOnly'
|
|
2945
|
+
\| 'noAudio'
|
|
2946
|
+
\| 'noImage'
|
|
2947
|
+
\| 'noVideo'
|
|
2948
|
+
\| 'noAccess'
|
|
2949
|
+
\| 'error'
|
|
2950
|
+
\| 'noModel'
|
|
2951
|
+
\| 'noApp'
|
|
2952
|
+
\| 'success'
|
|
2953
|
+
\| 'failed'
|
|
2954
|
+
\| 'inProgress'
|
|
2955
|
+
\| 'stayTuned' | 'noData' |
|
|
2956
|
+
| texture | 是否显示纹理 | boolean | true |
|
|
2957
|
+
| image | 图片地址 | string | 默认是no data的图片 |
|
|
2958
|
+
| imageStyle | 图片样式 | React.CSSProperties | |
|
|
2959
|
+
| title | 标题内容 | React.ReactNode | |
|
|
2960
|
+
| description | 自定义描述内容 | React.ReactNode | |
|
|
2961
|
+
| onOk | ok按钮的点击事件 | (e: React.MouseEvent) => void | |
|
|
2962
|
+
| okText | ok按钮的文本 | React.ReactNode | |
|
|
2963
|
+
| okType | ok按钮的类型 | SparkButtonProps['type'] | 'primary' |
|
|
2964
|
+
| okButtonProps | ok按钮的props | SparkButtonProps | |
|
|
2965
|
+
| children | 自定义空状态的内容 | React.ReactNode | |
|
|
2966
|
+
| className | 自定义空状态的类名 | string | |
|
|
2967
|
+
| style | 自定义空状态的样式 | React.CSSProperties | |
|
|
2968
|
+
| size | 自定义空状态的大小 | React.CSSProperties['width'] | |
|
|
2969
|
+
| autoFit | 是否自适应容器宽度,当容器宽度小于 size 时自动缩放 | boolean | false |
|
|
3003
2970
|
|
|
3004
|
-
### DescriptionItem
|
|
3005
2971
|
|
|
3006
|
-
|
|
3007
|
-
|--------|--------|--------|--------|--------|
|
|
3008
|
-
| label | 内容的描述 | ReactNode | - | |
|
|
3009
|
-
| span | 包含列的数量( | number\| | 1 | screens: 5.9.0 |
|
|
2972
|
+
<AntdApiRef url="https://ant.design/components/empty-cn/#api"></AntdApiRef>
|
|
3010
2973
|
|
|
3011
2974
|
|
|
3012
|
-
span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。当同时配置 `style` 和 `labelStyle`(或 `contentStyle`)时,两者会同时作用。样式冲突时,后者会覆盖前者。
|
|
3013
2975
|
|
|
3014
2976
|
|
|
3015
2977
|
|
|
@@ -3077,6 +3039,44 @@ v5 使用 `rootClassName` 与 `rootStyle` 来配置最外层元素样式。原 v
|
|
|
3077
3039
|
|
|
3078
3040
|
|
|
3079
3041
|
|
|
3042
|
+
<DemoTitle title="Descriptions" desc="展示多个只读字段的组合">
|
|
3043
|
+
#### API
|
|
3044
|
+
|
|
3045
|
+
<AntdApiRef url="https://ant.design/components/descriptions-cn/#api"></AntdApiRef>
|
|
3046
|
+
|
|
3047
|
+
|
|
3048
|
+
## antd API
|
|
3049
|
+
|
|
3050
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
3051
|
+
|
|
3052
|
+
### Descriptions
|
|
3053
|
+
|
|
3054
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3055
|
+
|--------|--------|--------|--------|--------|
|
|
3056
|
+
| bordered | 是否展示边框 | boolean | false | |
|
|
3057
|
+
| colon | 配置 | boolean | true | |
|
|
3058
|
+
| column | 一行的 | number \| | 3 | |
|
|
3059
|
+
| extra | 描述列表的操作区域,显示在右上方 | ReactNode | - | 4.5.0 |
|
|
3060
|
+
| items | 描述列表项内容 | | - | 5.8.0 |
|
|
3061
|
+
| layout | 描述布局 | horizontal | horizontal | |
|
|
3062
|
+
| size | 设置列表的大小。可以设置为 | default | - | |
|
|
3063
|
+
| title | 描述列表的标题,显示在最顶部 | ReactNode | - | |
|
|
3064
|
+
| classNames | 语义化结构 class | | - | 5.23.0 |
|
|
3065
|
+
| styles | 语义化结构 style | | - | 5.23.0 |
|
|
3066
|
+
|
|
3067
|
+
|
|
3068
|
+
### DescriptionItem
|
|
3069
|
+
|
|
3070
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3071
|
+
|--------|--------|--------|--------|--------|
|
|
3072
|
+
| label | 内容的描述 | ReactNode | - | |
|
|
3073
|
+
| span | 包含列的数量( | number\| | 1 | screens: 5.9.0 |
|
|
3074
|
+
|
|
3075
|
+
|
|
3076
|
+
span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。当同时配置 `style` 和 `labelStyle`(或 `contentStyle`)时,两者会同时作用。样式冲突时,后者会覆盖前者。
|
|
3077
|
+
|
|
3078
|
+
|
|
3079
|
+
|
|
3080
3080
|
<DemoTitle title="DatePicker" desc="输入或选择时间的控件。">
|
|
3081
3081
|
#### API
|
|
3082
3082
|
|
|
@@ -3370,6 +3370,92 @@ export type FormatType =
|
|
|
3370
3370
|
|
|
3371
3371
|
|
|
3372
3372
|
|
|
3373
|
+
<DemoTitle title="CodeBlock" desc="代码块">
|
|
3374
|
+
#### API
|
|
3375
|
+
|
|
3376
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3377
|
+
|--------|--------|--------|--------|
|
|
3378
|
+
| language | 语言 | string \| string[] | (必填) |
|
|
3379
|
+
| value | 值 | string | (必填) |
|
|
3380
|
+
| className | 类名 | string | |
|
|
3381
|
+
| theme | 主题 | 'dark' \| 'light' | |
|
|
3382
|
+
| readOnly | 只读 | boolean | |
|
|
3383
|
+
| onChange | | (value: string) => void | |
|
|
3384
|
+
|
|
3385
|
+
|
|
3386
|
+
|
|
3387
|
+
|
|
3388
|
+
<DemoTitle title="Checkbox" desc="收集用户的多项选择。">
|
|
3389
|
+
#### API
|
|
3390
|
+
|
|
3391
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3392
|
+
|--------|--------|--------|--------|
|
|
3393
|
+
| description | 描述文本 | string | |
|
|
3394
|
+
| descriptionClassName | 描述文本的样式类名 | string | |
|
|
3395
|
+
| descriptionStyle | 描述文本的内联样式 | React.CSSProperties | |
|
|
3396
|
+
|
|
3397
|
+
|
|
3398
|
+
<AntdApiRef url="https://ant.design/components/checkbox-cn/#api"></AntdApiRef>
|
|
3399
|
+
|
|
3400
|
+
|
|
3401
|
+
## antd API
|
|
3402
|
+
|
|
3403
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
3404
|
+
|
|
3405
|
+
#### Checkbox
|
|
3406
|
+
|
|
3407
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3408
|
+
|--------|--------|--------|--------|--------|
|
|
3409
|
+
| autoFocus | 自动获取焦点 | boolean | false | |
|
|
3410
|
+
| checked | 指定当前是否选中 | boolean | false | |
|
|
3411
|
+
| defaultChecked | 初始是否选中 | boolean | false | |
|
|
3412
|
+
| disabled | 失效状态 | boolean | false | |
|
|
3413
|
+
| indeterminate | 设置 indeterminate 状态,只负责样式控制 | boolean | false | |
|
|
3414
|
+
| onChange | 变化时的回调函数 | (e: CheckboxChangeEvent) => void | - | |
|
|
3415
|
+
| onBlur | 失去焦点时的回调 | function() | - | |
|
|
3416
|
+
| onFocus | 获得焦点时的回调 | function() | - | |
|
|
3417
|
+
|
|
3418
|
+
|
|
3419
|
+
#### Checkbox.Group
|
|
3420
|
+
|
|
3421
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3422
|
+
|--------|--------|--------|--------|--------|
|
|
3423
|
+
| defaultValue | 默认选中的选项 | (string \| number)[] | [] | |
|
|
3424
|
+
| disabled | 整组失效 | boolean | false | |
|
|
3425
|
+
| name | CheckboxGroup 下所有 | string | - | |
|
|
3426
|
+
| options | 指定可选项 | string[] \| number[] \| Option[] | [] | |
|
|
3427
|
+
| value | 指定选中的选项 | (string \| number \| boolean)[] | [] | |
|
|
3428
|
+
| title | 选项的 title | string | - | |
|
|
3429
|
+
| className | 选项的类名 | string | - | 5.25.0 |
|
|
3430
|
+
| style | 选项的样式 | React.CSSProperties | - | |
|
|
3431
|
+
| onChange | 变化时的回调函数 | (checkedValue: T[]) => void | - | |
|
|
3432
|
+
|
|
3433
|
+
|
|
3434
|
+
##### Option
|
|
3435
|
+
|
|
3436
|
+
|
|
3437
|
+
```typescript
|
|
3438
|
+
interface Option {
|
|
3439
|
+
label: string;
|
|
3440
|
+
value: string;
|
|
3441
|
+
disabled?: boolean;
|
|
3442
|
+
}
|
|
3443
|
+
```
|
|
3444
|
+
|
|
3445
|
+
|
|
3446
|
+
### 方法
|
|
3447
|
+
|
|
3448
|
+
#### Checkbox
|
|
3449
|
+
|
|
3450
|
+
| 名称 | 描述 | 版本 |
|
|
3451
|
+
|--------|--------|--------|
|
|
3452
|
+
| blur() | 移除焦点 | |
|
|
3453
|
+
| focus() | 获取焦点 | |
|
|
3454
|
+
| nativeElement | 返回 Checkbox 的 DOM 节点 | 5.17.3 |
|
|
3455
|
+
|
|
3456
|
+
|
|
3457
|
+
|
|
3458
|
+
|
|
3373
3459
|
<DemoTitle title="Collapse" desc="可以折叠/展开的内容区域">
|
|
3374
3460
|
#### API
|
|
3375
3461
|
|
|
@@ -3428,89 +3514,58 @@ export type FormatType =
|
|
|
3428
3514
|
|
|
3429
3515
|
|
|
3430
3516
|
|
|
3431
|
-
<DemoTitle title="
|
|
3432
|
-
#### API
|
|
3433
|
-
|
|
3434
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3435
|
-
|--------|--------|--------|--------|
|
|
3436
|
-
| language | 语言 | string \| string[] | (必填) |
|
|
3437
|
-
| value | 值 | string | (必填) |
|
|
3438
|
-
| className | 类名 | string | |
|
|
3439
|
-
| theme | 主题 | 'dark' \| 'light' | |
|
|
3440
|
-
| readOnly | 只读 | boolean | |
|
|
3441
|
-
| onChange | | (value: string) => void | |
|
|
3442
|
-
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
|
|
3446
|
-
<DemoTitle title="Checkbox" desc="收集用户的多项选择。">
|
|
3517
|
+
<DemoTitle title="Button" desc="按钮用于开始一个即时操作。">
|
|
3447
3518
|
#### API
|
|
3448
3519
|
|
|
3449
3520
|
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3450
3521
|
|--------|--------|--------|--------|
|
|
3451
|
-
|
|
|
3452
|
-
|
|
|
3453
|
-
|
|
3454
|
-
|
|
3455
|
-
|
|
3456
|
-
|
|
3457
|
-
|
|
3458
|
-
|
|
3459
|
-
|
|
3460
|
-
|
|
3461
|
-
|
|
3462
|
-
|
|
3463
|
-
#### Checkbox
|
|
3464
|
-
|
|
3465
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3466
|
-
|--------|--------|--------|--------|--------|
|
|
3467
|
-
| autoFocus | 自动获取焦点 | boolean | false | |
|
|
3468
|
-
| checked | 指定当前是否选中 | boolean | false | |
|
|
3469
|
-
| defaultChecked | 初始是否选中 | boolean | false | |
|
|
3470
|
-
| disabled | 失效状态 | boolean | false | |
|
|
3471
|
-
| indeterminate | 设置 indeterminate 状态,只负责样式控制 | boolean | false | |
|
|
3472
|
-
| onChange | 变化时的回调函数 | (e: CheckboxChangeEvent) => void | - | |
|
|
3473
|
-
| onBlur | 失去焦点时的回调 | function() | - | |
|
|
3474
|
-
| onFocus | 获得焦点时的回调 | function() | - | |
|
|
3475
|
-
|
|
3522
|
+
| size | 按钮大小 | 'small' \| 'middle' \| 'large' | 'middle' |
|
|
3523
|
+
| type | 类型 | \| 'primary'
|
|
3524
|
+
\| 'dashed'
|
|
3525
|
+
\| 'link'
|
|
3526
|
+
\| 'text'
|
|
3527
|
+
\| 'default'
|
|
3528
|
+
\| 'primaryLess'
|
|
3529
|
+
\| 'textCompact' | 'deafult' |
|
|
3530
|
+
| tooltipContent | hover上去tooltip的内容 | string \| ReactNode | |
|
|
3531
|
+
| iconType | 百炼图标iconfont的key,依赖ConfigProvider传入的iconfont,例如bl-icon-add | string | |
|
|
3532
|
+
| iconSize | 图标大小 | SparkIconFontProps['size'] | |
|
|
3476
3533
|
|
|
3477
|
-
|
|
3534
|
+
<AntdApiRef url="https://ant.design/components/button-cn/#api"></AntdApiRef>
|
|
3478
3535
|
|
|
3479
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3480
|
-
|--------|--------|--------|--------|--------|
|
|
3481
|
-
| defaultValue | 默认选中的选项 | (string \| number)[] | [] | |
|
|
3482
|
-
| disabled | 整组失效 | boolean | false | |
|
|
3483
|
-
| name | CheckboxGroup 下所有 | string | - | |
|
|
3484
|
-
| options | 指定可选项 | string[] \| number[] \| Option[] | [] | |
|
|
3485
|
-
| value | 指定选中的选项 | (string \| number \| boolean)[] | [] | |
|
|
3486
|
-
| title | 选项的 title | string | - | |
|
|
3487
|
-
| className | 选项的类名 | string | - | 5.25.0 |
|
|
3488
|
-
| style | 选项的样式 | React.CSSProperties | - | |
|
|
3489
|
-
| onChange | 变化时的回调函数 | (checkedValue: T[]) => void | - | |
|
|
3490
3536
|
|
|
3537
|
+
## antd API
|
|
3491
3538
|
|
|
3492
|
-
|
|
3539
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
3493
3540
|
|
|
3541
|
+
通过设置 Button 的属性来产生不同的按钮样式,推荐顺序为:`type` -> `shape` -> `size` -> `loading` -> `disabled`。
|
|
3494
3542
|
|
|
3495
|
-
|
|
3496
|
-
interface Option {
|
|
3497
|
-
label: string;
|
|
3498
|
-
value: string;
|
|
3499
|
-
disabled?: boolean;
|
|
3500
|
-
}
|
|
3501
|
-
```
|
|
3543
|
+
按钮的属性说明如下:
|
|
3502
3544
|
|
|
3545
|
+
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
3546
|
+
|--------|--------|--------|--------|--------|
|
|
3547
|
+
| autoInsertSpace | 我们默认提供两个汉字之间的空格,可以设置 | boolean | true | 5.17.0 |
|
|
3548
|
+
| block | 将按钮宽度调整为其父宽度的选项 | boolean | false | |
|
|
3549
|
+
| classNames | 语义化结构 class | | - | 5.4.0 |
|
|
3550
|
+
| color | 设置按钮的颜色 | default | - | default |
|
|
3551
|
+
| danger | 语法糖,设置危险按钮。当设置 | boolean | false | |
|
|
3552
|
+
| disabled | 设置按钮失效状态 | boolean | false | |
|
|
3553
|
+
| ghost | 幽灵属性,使按钮背景透明 | boolean | false | |
|
|
3554
|
+
| href | 点击跳转的地址,指定此属性 button 的行为和 a 链接一致 | string | - | |
|
|
3555
|
+
| htmlType | 设置 | submit | button | |
|
|
3556
|
+
| iconPosition | 设置按钮图标组件的位置 | start | start | 5.17.0 |
|
|
3557
|
+
| loading | 设置按钮载入状态 | boolean \| { delay: number, icon: ReactNode } | false | icon: 5.23.0 |
|
|
3558
|
+
| styles | 语义化结构 style | | - | 5.4.0 |
|
|
3559
|
+
| target | 相当于 a 链接的 target 属性,href 存在时生效 | string | - | |
|
|
3560
|
+
| onClick | 点击按钮时的回调 | (event: React.MouseEvent) => void | - | |
|
|
3561
|
+
| variant | 设置按钮的变体 | outlined | - | 5.21.0 |
|
|
3503
3562
|
|
|
3504
|
-
### 方法
|
|
3505
3563
|
|
|
3506
|
-
|
|
3564
|
+
支持原生 button 的其他所有属性。
|
|
3507
3565
|
|
|
3508
|
-
|
|
3509
|
-
|--------|--------|--------|
|
|
3510
|
-
| blur() | 移除焦点 | |
|
|
3511
|
-
| focus() | 获取焦点 | |
|
|
3512
|
-
| nativeElement | 返回 Checkbox 的 DOM 节点 | 5.17.3 |
|
|
3566
|
+
### PresetColors
|
|
3513
3567
|
|
|
3568
|
+
type PresetColors = 'blue' | 'purple' | 'cyan' | 'green' | 'magenta' | 'pink' | 'red' | 'orange' | 'yellow' | 'volcano' | 'geekblue' | 'lime' | 'gold';
|
|
3514
3569
|
|
|
3515
3570
|
|
|
3516
3571
|
|
|
@@ -3577,61 +3632,6 @@ interface Option {
|
|
|
3577
3632
|
|
|
3578
3633
|
|
|
3579
3634
|
|
|
3580
|
-
<DemoTitle title="Button" desc="按钮用于开始一个即时操作。">
|
|
3581
|
-
#### API
|
|
3582
|
-
|
|
3583
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3584
|
-
|--------|--------|--------|--------|
|
|
3585
|
-
| size | 按钮大小 | 'small' \| 'middle' \| 'large' | 'middle' |
|
|
3586
|
-
| type | 类型 | \| 'primary'
|
|
3587
|
-
\| 'dashed'
|
|
3588
|
-
\| 'link'
|
|
3589
|
-
\| 'text'
|
|
3590
|
-
\| 'default'
|
|
3591
|
-
\| 'primaryLess'
|
|
3592
|
-
\| 'textCompact' | 'deafult' |
|
|
3593
|
-
| tooltipContent | hover上去tooltip的内容 | string \| ReactNode | |
|
|
3594
|
-
| iconType | 百炼图标iconfont的key,依赖ConfigProvider传入的iconfont,例如bl-icon-add | string | |
|
|
3595
|
-
| iconSize | 图标大小 | SparkIconFontProps['size'] | |
|
|
3596
|
-
|
|
3597
|
-
<AntdApiRef url="https://ant.design/components/button-cn/#api"></AntdApiRef>
|
|
3598
|
-
|
|
3599
|
-
|
|
3600
|
-
## antd API
|
|
3601
|
-
|
|
3602
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
3603
|
-
|
|
3604
|
-
通过设置 Button 的属性来产生不同的按钮样式,推荐顺序为:`type` -> `shape` -> `size` -> `loading` -> `disabled`。
|
|
3605
|
-
|
|
3606
|
-
按钮的属性说明如下:
|
|
3607
|
-
|
|
3608
|
-
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
3609
|
-
|--------|--------|--------|--------|--------|
|
|
3610
|
-
| autoInsertSpace | 我们默认提供两个汉字之间的空格,可以设置 | boolean | true | 5.17.0 |
|
|
3611
|
-
| block | 将按钮宽度调整为其父宽度的选项 | boolean | false | |
|
|
3612
|
-
| classNames | 语义化结构 class | | - | 5.4.0 |
|
|
3613
|
-
| color | 设置按钮的颜色 | default | - | default |
|
|
3614
|
-
| danger | 语法糖,设置危险按钮。当设置 | boolean | false | |
|
|
3615
|
-
| disabled | 设置按钮失效状态 | boolean | false | |
|
|
3616
|
-
| ghost | 幽灵属性,使按钮背景透明 | boolean | false | |
|
|
3617
|
-
| href | 点击跳转的地址,指定此属性 button 的行为和 a 链接一致 | string | - | |
|
|
3618
|
-
| htmlType | 设置 | submit | button | |
|
|
3619
|
-
| iconPosition | 设置按钮图标组件的位置 | start | start | 5.17.0 |
|
|
3620
|
-
| loading | 设置按钮载入状态 | boolean \| { delay: number, icon: ReactNode } | false | icon: 5.23.0 |
|
|
3621
|
-
| styles | 语义化结构 style | | - | 5.4.0 |
|
|
3622
|
-
| target | 相当于 a 链接的 target 属性,href 存在时生效 | string | - | |
|
|
3623
|
-
| onClick | 点击按钮时的回调 | (event: React.MouseEvent) => void | - | |
|
|
3624
|
-
| variant | 设置按钮的变体 | outlined | - | 5.21.0 |
|
|
3625
|
-
|
|
3626
|
-
|
|
3627
|
-
支持原生 button 的其他所有属性。
|
|
3628
|
-
|
|
3629
|
-
### PresetColors
|
|
3630
|
-
|
|
3631
|
-
type PresetColors = 'blue' | 'purple' | 'cyan' | 'green' | 'magenta' | 'pink' | 'red' | 'orange' | 'yellow' | 'volcano' | 'geekblue' | 'lime' | 'gold';
|
|
3632
|
-
|
|
3633
|
-
|
|
3634
|
-
|
|
3635
3635
|
<DemoTitle title="Breadcrumb" desc="显示当前页面在系统层级结构中的位置,并能向上返回。">
|
|
3636
3636
|
#### API
|
|
3637
3637
|
|
|
@@ -3852,6 +3852,40 @@ ApiParser解析结果为空
|
|
|
3852
3852
|
|
|
3853
3853
|
|
|
3854
3854
|
|
|
3855
|
+
<DemoTitle title="Alert" desc="向用户突出显示的重要提示信息。">
|
|
3856
|
+
#### API
|
|
3857
|
+
|
|
3858
|
+
<AntdApiRef url="https://ant.design/components/alert-cn/#api"></AntdApiRef>
|
|
3859
|
+
|
|
3860
|
+
|
|
3861
|
+
## antd API
|
|
3862
|
+
|
|
3863
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
3864
|
+
|
|
3865
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3866
|
+
|--------|--------|--------|--------|--------|
|
|
3867
|
+
| action | 自定义操作项 | ReactNode | - | 4.9.0 |
|
|
3868
|
+
| afterClose | 关闭动画结束后触发的回调函数 | () => void | - | |
|
|
3869
|
+
| banner | 是否用作顶部公告 | boolean | false | |
|
|
3870
|
+
| closable | 可关闭配置,>=5.15.0: 支持 | boolean \| ({ closeIcon?: React.ReactNode } & React.AriaAttributes) | false | |
|
|
3871
|
+
| description | 警告提示的辅助性文字介绍 | ReactNode | - | |
|
|
3872
|
+
| icon | 自定义图标, | ReactNode | - | |
|
|
3873
|
+
| message | 警告提示内容 | ReactNode | - | |
|
|
3874
|
+
| showIcon | 是否显示辅助图标 | boolean | false, | |
|
|
3875
|
+
| type | 指定警告提示的样式,有四种选择 | string | info | |
|
|
3876
|
+
| onClose | 关闭时触发的回调函数 | (e: MouseEvent) => void | - | |
|
|
3877
|
+
|
|
3878
|
+
|
|
3879
|
+
### Alert.ErrorBoundary
|
|
3880
|
+
|
|
3881
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3882
|
+
|--------|--------|--------|--------|--------|
|
|
3883
|
+
| description | 自定义错误内容,如果未指定会展示报错堆栈 | ReactNode | {{ error stack }} | |
|
|
3884
|
+
| message | 自定义错误标题,如果未指定会展示原生报错信息 | ReactNode | {{ error }} | |
|
|
3885
|
+
|
|
3886
|
+
|
|
3887
|
+
|
|
3888
|
+
|
|
3855
3889
|
<DemoTitle title="AlertDialog" desc="一种在界面中弹出的对话框,用来向用户传达重要信息,并引导其进行确认或取消等操作。">
|
|
3856
3890
|
#### API
|
|
3857
3891
|
|
|
@@ -4025,40 +4059,6 @@ const confirmed = await modal.confirm({ ... });
|
|
|
4025
4059
|
|
|
4026
4060
|
|
|
4027
4061
|
|
|
4028
|
-
<DemoTitle title="Alert" desc="向用户突出显示的重要提示信息。">
|
|
4029
|
-
#### API
|
|
4030
|
-
|
|
4031
|
-
<AntdApiRef url="https://ant.design/components/alert-cn/#api"></AntdApiRef>
|
|
4032
|
-
|
|
4033
|
-
|
|
4034
|
-
## antd API
|
|
4035
|
-
|
|
4036
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
4037
|
-
|
|
4038
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
4039
|
-
|--------|--------|--------|--------|--------|
|
|
4040
|
-
| action | 自定义操作项 | ReactNode | - | 4.9.0 |
|
|
4041
|
-
| afterClose | 关闭动画结束后触发的回调函数 | () => void | - | |
|
|
4042
|
-
| banner | 是否用作顶部公告 | boolean | false | |
|
|
4043
|
-
| closable | 可关闭配置,>=5.15.0: 支持 | boolean \| ({ closeIcon?: React.ReactNode } & React.AriaAttributes) | false | |
|
|
4044
|
-
| description | 警告提示的辅助性文字介绍 | ReactNode | - | |
|
|
4045
|
-
| icon | 自定义图标, | ReactNode | - | |
|
|
4046
|
-
| message | 警告提示内容 | ReactNode | - | |
|
|
4047
|
-
| showIcon | 是否显示辅助图标 | boolean | false, | |
|
|
4048
|
-
| type | 指定警告提示的样式,有四种选择 | string | info | |
|
|
4049
|
-
| onClose | 关闭时触发的回调函数 | (e: MouseEvent) => void | - | |
|
|
4050
|
-
|
|
4051
|
-
|
|
4052
|
-
### Alert.ErrorBoundary
|
|
4053
|
-
|
|
4054
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
4055
|
-
|--------|--------|--------|--------|--------|
|
|
4056
|
-
| description | 自定义错误内容,如果未指定会展示报错堆栈 | ReactNode | {{ error stack }} | |
|
|
4057
|
-
| message | 自定义错误标题,如果未指定会展示原生报错信息 | ReactNode | {{ error }} | |
|
|
4058
|
-
|
|
4059
|
-
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
4062
|
## 内置主题
|
|
4063
4063
|
|
|
4064
4064
|
Alibaba Cloud Spark Design 提供四种内置主题:
|
|
@@ -4084,92 +4084,40 @@ export default App;
|
|
|
4084
4084
|
|
|
4085
4085
|
## 从 Antd token 生成您自己的主题
|
|
4086
4086
|
|
|
4087
|
-
如果您已经有了 Antd 主题,仍然可以使用 generateThemeByToken 生成 spark 风格的主题
|
|
4088
|
-
|
|
4089
|
-
|
|
4090
|
-
```tsx
|
|
4091
|
-
import { ConfigProvider, generateThemeByToken } from '@agentscope-ai/design';
|
|
4092
|
-
const yourToken = {
|
|
4093
|
-
borderRadiusXS: 2,
|
|
4094
|
-
borderRadiusSM: 4,
|
|
4095
|
-
borderRadius: 6,
|
|
4096
|
-
borderRadiusLG: 8,
|
|
4097
|
-
borderRadiusXL: 12,
|
|
4098
|
-
borderRadiusFull: 999,
|
|
4099
|
-
wireframe: false,
|
|
4100
|
-
colorPrimaryBg: '#F2F0FF',
|
|
4101
|
-
colorPrimaryBgHover: '#F2F0FF',
|
|
4102
|
-
colorPrimaryBorder: '#E2DEFF',
|
|
4103
|
-
colorPrimaryBorderHover: '#BCB5FF',
|
|
4104
|
-
// ... 您可以在下一个文档中找到完整版本的 tokens:Tokens 和 CSS 变量
|
|
4105
|
-
};
|
|
4106
|
-
const darkMode = false;
|
|
4107
|
-
const yourThemeWithSparkStyle = generateThemeByToken(yourToken, darkMode);
|
|
4108
|
-
const App = () => {
|
|
4109
|
-
return (
|
|
4110
|
-
<ConfigProvider {...yourThemeWithSparkStyle}>
|
|
4111
|
-
Hello Spark Design!
|
|
4112
|
-
</ConfigProvider>
|
|
4113
|
-
);
|
|
4114
|
-
};
|
|
4115
|
-
|
|
4116
|
-
export default App;
|
|
4117
|
-
```
|
|
4118
|
-
|
|
4119
|
-
|
|
4120
|
-
您仍然可以修改生成的主题:`yourThemeWithSparkStyle`,但不建议这样做。我们建议您保持原始主题以获得 Spark Design 的最佳体验。
|
|
4121
|
-
|
|
4122
|
-
|
|
4123
|
-
|
|
4124
|
-
<div align="center"><a name="readme-top"></a>
|
|
4125
|
-
<img height="120" src="https://img.alicdn.com/imgextra/i1/O1CN01ipemFb1EzmZI9LiTe_!!6000000000423-55-tps-28-28.svg" style="border: none">
|
|
4126
|
-
<h1>Alibaba Cloud Spark Design</h1>
|
|
4127
|
-
</div>
|
|
4128
|
-
|
|
4129
|
-
# 概述
|
|
4130
|
-
|
|
4131
|
-
Alibaba Cloud Spark Design 是一个基于 Ant Design 的 React UI 组件库,包含丰富的基础组件和场景组件,专为构建优秀的 LLM 产品而设计。
|
|
4132
|
-
<br />
|
|
4133
|
-
<br />
|
|
4134
|
-
|
|
4135
|
-
## ✨ 特性
|
|
4136
|
-
|
|
4137
|
-
|
|
4138
|
-
- <img height="15" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg"> 基于 Ant Design,兼容 Ant Design 生态系统。您可以无需修改代码即可切换到 Spark Design。
|
|
4139
|
-
- 🛡 使用 TypeScript 编写,具有可预测的静态类型。
|
|
4140
|
-
- 🧠 为 LLM 产品设计的各种场景组件。
|
|
4141
|
-
- 💡 与@agentscope-ai/chat 和 @agentscope-ai/flow 配合使用,构建企业级 LLM 应用。
|
|
4142
|
-
- 🎨 多种预设主题。
|
|
4143
|
-
- ☀️ 轻松切换明暗模式。
|
|
4144
|
-
|
|
4145
|
-
## 📦 安装
|
|
4146
|
-
|
|
4147
|
-
|
|
4148
|
-
```bash
|
|
4149
|
-
npm install antd @agentscope-ai/icons @agentscope-ai/design --save
|
|
4150
|
-
```
|
|
4151
|
-
|
|
4152
|
-
|
|
4153
|
-
## Tree Shaking 支持
|
|
4154
|
-
|
|
4155
|
-
@agentscope-ai/design 默认基于 ES 模块支持 tree shaking
|
|
4156
|
-
|
|
4157
|
-
## TypeScript
|
|
4158
|
-
|
|
4159
|
-
@agentscope-ai/chat 使用 TypeScript 编写并提供完整的定义文件。
|
|
4087
|
+
如果您已经有了 Antd 主题,仍然可以使用 generateThemeByToken 生成 spark 风格的主题
|
|
4160
4088
|
|
|
4161
|
-
## 内置主题
|
|
4162
4089
|
|
|
4163
|
-
|
|
4090
|
+
```tsx
|
|
4091
|
+
import { ConfigProvider, generateThemeByToken } from '@agentscope-ai/design';
|
|
4092
|
+
const yourToken = {
|
|
4093
|
+
borderRadiusXS: 2,
|
|
4094
|
+
borderRadiusSM: 4,
|
|
4095
|
+
borderRadius: 6,
|
|
4096
|
+
borderRadiusLG: 8,
|
|
4097
|
+
borderRadiusXL: 12,
|
|
4098
|
+
borderRadiusFull: 999,
|
|
4099
|
+
wireframe: false,
|
|
4100
|
+
colorPrimaryBg: '#F2F0FF',
|
|
4101
|
+
colorPrimaryBgHover: '#F2F0FF',
|
|
4102
|
+
colorPrimaryBorder: '#E2DEFF',
|
|
4103
|
+
colorPrimaryBorderHover: '#BCB5FF',
|
|
4104
|
+
// ... 您可以在下一个文档中找到完整版本的 tokens:Tokens 和 CSS 变量
|
|
4105
|
+
};
|
|
4106
|
+
const darkMode = false;
|
|
4107
|
+
const yourThemeWithSparkStyle = generateThemeByToken(yourToken, darkMode);
|
|
4108
|
+
const App = () => {
|
|
4109
|
+
return (
|
|
4110
|
+
<ConfigProvider {...yourThemeWithSparkStyle}>
|
|
4111
|
+
Hello Spark Design!
|
|
4112
|
+
</ConfigProvider>
|
|
4113
|
+
);
|
|
4114
|
+
};
|
|
4164
4115
|
|
|
4165
|
-
|
|
4166
|
-
|
|
4167
|
-
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: rgba(26, 26, 29, 1);"></span> carbonTheme</div>
|
|
4168
|
-
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #676767;"></span> carbonDarkTheme(暗色模式)</div>
|
|
4116
|
+
export default App;
|
|
4117
|
+
```
|
|
4169
4118
|
|
|
4170
|
-
## 🏗️ 开源
|
|
4171
4119
|
|
|
4172
|
-
|
|
4120
|
+
您仍然可以修改生成的主题:`yourThemeWithSparkStyle`,但不建议这样做。我们建议您保持原始主题以获得 Spark Design 的最佳体验。
|
|
4173
4121
|
|
|
4174
4122
|
|
|
4175
4123
|
|
|
@@ -4244,19 +4192,95 @@ export default App;
|
|
|
4244
4192
|
|
|
4245
4193
|
|
|
4246
4194
|
|
|
4247
|
-
|
|
4195
|
+
<div align="center"><a name="readme-top"></a>
|
|
4196
|
+
<img height="120" src="https://img.alicdn.com/imgextra/i1/O1CN01ipemFb1EzmZI9LiTe_!!6000000000423-55-tps-28-28.svg" style="border: none">
|
|
4197
|
+
<h1>Alibaba Cloud Spark Design</h1>
|
|
4198
|
+
</div>
|
|
4199
|
+
|
|
4200
|
+
# 概述
|
|
4201
|
+
|
|
4202
|
+
Alibaba Cloud Spark Design 是一个基于 Ant Design 的 React UI 组件库,包含丰富的基础组件和场景组件,专为构建优秀的 LLM 产品而设计。
|
|
4203
|
+
<br />
|
|
4204
|
+
<br />
|
|
4205
|
+
|
|
4206
|
+
## ✨ 特性
|
|
4207
|
+
|
|
4208
|
+
|
|
4209
|
+
- <img height="15" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg"> 基于 Ant Design,兼容 Ant Design 生态系统。您可以无需修改代码即可切换到 Spark Design。
|
|
4210
|
+
- 🛡 使用 TypeScript 编写,具有可预测的静态类型。
|
|
4211
|
+
- 🧠 为 LLM 产品设计的各种场景组件。
|
|
4212
|
+
- 💡 与@agentscope-ai/chat 和 @agentscope-ai/flow 配合使用,构建企业级 LLM 应用。
|
|
4213
|
+
- 🎨 多种预设主题。
|
|
4214
|
+
- ☀️ 轻松切换明暗模式。
|
|
4248
4215
|
|
|
4249
4216
|
## 📦 安装
|
|
4250
4217
|
|
|
4251
4218
|
|
|
4252
4219
|
```bash
|
|
4253
|
-
|
|
4220
|
+
npm install antd @agentscope-ai/icons @agentscope-ai/design --save
|
|
4254
4221
|
```
|
|
4255
4222
|
|
|
4256
4223
|
|
|
4257
|
-
##
|
|
4224
|
+
## Tree Shaking 支持
|
|
4258
4225
|
|
|
4259
|
-
|
|
4226
|
+
@agentscope-ai/design 默认基于 ES 模块支持 tree shaking
|
|
4227
|
+
|
|
4228
|
+
## TypeScript
|
|
4229
|
+
|
|
4230
|
+
@agentscope-ai/chat 使用 TypeScript 编写并提供完整的定义文件。
|
|
4231
|
+
|
|
4232
|
+
## 内置主题
|
|
4233
|
+
|
|
4234
|
+
我们提供四种内置主题:
|
|
4235
|
+
|
|
4236
|
+
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #615CED;"></span> purpleTheme</div>
|
|
4237
|
+
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #5551CC;"></span> purpleDarkTheme(暗色模式)</div>
|
|
4238
|
+
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: rgba(26, 26, 29, 1);"></span> carbonTheme</div>
|
|
4239
|
+
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #676767;"></span> carbonDarkTheme(暗色模式)</div>
|
|
4240
|
+
|
|
4241
|
+
## 🏗️ 开源
|
|
4242
|
+
|
|
4243
|
+
[@agentscope-ai/design](https://www.npmjs.com/package/@agentscope-ai/design) 和 [@agentscope-ai/chat](https://www.npmjs.com/package/@agentscope-ai/chat) 正在积极推进开源,预计将在 2025 年底完成。目前,您可以通过 npm 访问我们的项目。
|
|
4244
|
+
|
|
4245
|
+
|
|
4246
|
+
|
|
4247
|
+
# 使用
|
|
4248
|
+
|
|
4249
|
+
|
|
4250
|
+
|
|
4251
|
+
```tsx
|
|
4252
|
+
import { SparkLoadingLine } from '@agentscope-ai/icons';
|
|
4253
|
+
|
|
4254
|
+
export default () => {
|
|
4255
|
+
return (
|
|
4256
|
+
<SparkLoadingLine
|
|
4257
|
+
className="your-class-name"
|
|
4258
|
+
style={{ color: 'var(--sps-color-primary)' }}
|
|
4259
|
+
spin
|
|
4260
|
+
size={48}
|
|
4261
|
+
/>
|
|
4262
|
+
);
|
|
4263
|
+
};
|
|
4264
|
+
|
|
4265
|
+
```
|
|
4266
|
+
|
|
4267
|
+
基本用法
|
|
4268
|
+
|
|
4269
|
+
访问 [Icon Library](https://sparkdesign.agentscope.io/#/resources/icons) 查看全部 Icon
|
|
4270
|
+
|
|
4271
|
+
|
|
4272
|
+
|
|
4273
|
+
# 从零开始使用
|
|
4274
|
+
|
|
4275
|
+
## 📦 安装
|
|
4276
|
+
|
|
4277
|
+
|
|
4278
|
+
```bash
|
|
4279
|
+
$ npm install antd @agentscope-ai/icons @agentscope-ai/design --save
|
|
4280
|
+
```
|
|
4281
|
+
|
|
4282
|
+
|
|
4283
|
+
## 🔨 使用
|
|
4260
4284
|
|
|
4261
4285
|
|
|
4262
4286
|
```tsx
|
|
@@ -4329,17 +4353,33 @@ export default App;
|
|
|
4329
4353
|
```
|
|
4330
4354
|
|
|
4331
4355
|
|
|
4332
|
-
|
|
4356
|
+
|
|
4357
|
+
|
|
4358
|
+
# 从 Antd 迁移
|
|
4359
|
+
|
|
4360
|
+
## 📦 安装
|
|
4361
|
+
|
|
4362
|
+
|
|
4363
|
+
```bash
|
|
4364
|
+
$ npm install @agentscope-ai/icons @agentscope-ai/design --save
|
|
4365
|
+
```
|
|
4366
|
+
|
|
4367
|
+
|
|
4368
|
+
## 🔨 使用
|
|
4369
|
+
|
|
4370
|
+
从 @agentscope-ai/design 导出的所有同名组件在 API 方面都与 antd 的对应组件兼容,这意味着您无需学习如何使用它们。如果您想充分利用 Alibaba Cloud Spark Design 的新功能,可以尝试使用这些组件而不是 antd 的组件。
|
|
4333
4371
|
|
|
4334
4372
|
|
|
4335
4373
|
```tsx
|
|
4336
4374
|
import {
|
|
4375
|
+
Button,
|
|
4376
|
+
Image,
|
|
4337
4377
|
ConfigProvider,
|
|
4338
4378
|
purpleDarkTheme,
|
|
4339
4379
|
purpleTheme,
|
|
4340
4380
|
} from '@agentscope-ai/design';
|
|
4341
|
-
import { Button, Image, Flex } from 'antd';
|
|
4342
4381
|
import { SparkSunLine, SparkMoonLine } from '@agentscope-ai/icons';
|
|
4382
|
+
import { Flex } from 'antd';
|
|
4343
4383
|
import zhCN from 'antd/locale/zh_CN';
|
|
4344
4384
|
import { useState } from 'react';
|
|
4345
4385
|
|
|
@@ -4400,87 +4440,17 @@ export default App;
|
|
|
4400
4440
|
```
|
|
4401
4441
|
|
|
4402
4442
|
|
|
4403
|
-
|
|
4404
|
-
|
|
4405
|
-
# 使用
|
|
4406
|
-
|
|
4407
|
-
|
|
4408
|
-
|
|
4409
|
-
```tsx
|
|
4410
|
-
import { SparkLoadingLine } from '@agentscope-ai/icons';
|
|
4411
|
-
|
|
4412
|
-
export default () => {
|
|
4413
|
-
return (
|
|
4414
|
-
<SparkLoadingLine
|
|
4415
|
-
className="your-class-name"
|
|
4416
|
-
style={{ color: 'var(--sps-color-primary)' }}
|
|
4417
|
-
spin
|
|
4418
|
-
size={48}
|
|
4419
|
-
/>
|
|
4420
|
-
);
|
|
4421
|
-
};
|
|
4422
|
-
|
|
4423
|
-
```
|
|
4424
|
-
|
|
4425
|
-
基本用法
|
|
4426
|
-
|
|
4427
|
-
访问 [Icon Library](https://sparkdesign.agentscope.io/#/resources/icons) 查看全部 Icon
|
|
4428
|
-
|
|
4429
|
-
|
|
4430
|
-
|
|
4431
|
-
# Vibe 编程
|
|
4432
|
-
|
|
4433
|
-
## LLMs.txt
|
|
4434
|
-
|
|
4435
|
-
为了让 Cursor 和 Claude Code 等工具理解 Spark Design,我们支持 LLMs.txt 文件,使 Spark Design 的文档可供大型语言模型使用。
|
|
4436
|
-
|
|
4437
|
-
|
|
4438
|
-
- [index.llms.txt](https://g.alicdn.com/code/npm/@ali/agentscope-ai-design/4.7.2/docs-dist/llms/index.llms.txt):主要的 LLMs.txt 索引文件
|
|
4439
|
-
- [all.llms.txt](https://g.alicdn.com/code/npm/@ali/agentscope-ai-design/4.7.2/docs-dist/llms/all.llms.txt):Spark Design 的完整文档
|
|
4440
|
-
|
|
4441
|
-
在 Cursor 中使用 @Docs 功能将 LLMs.txt 文件包含在您的项目中。[了解更多](https://docs.cursor.com/en/context/@-symbols/@-docs)
|
|
4442
|
-
|
|
4443
|
-
## D2C
|
|
4444
|
-
|
|
4445
|
-
在前端使用 Alibaba Cloud Spark Design、设计稿使用 Spark Design 套件的前提下,通过 masterGo 视觉稿生成代码可以做到以下几点:
|
|
4446
|
-
|
|
4447
|
-
|
|
4448
|
-
- 准确识别 icon
|
|
4449
|
-
- 使用标准 css token
|
|
4450
|
-
- 无需测量间距、圆角等数据,AI 直接还原布局(90%以上概率准确生成)
|
|
4451
|
-
- 使用标准组件还原页面,大部分标准组件可一次性正确生成,无需二次调整
|
|
4452
|
-
|
|
4453
|
-
<div>
|
|
4454
|
-
<video style="width: 100%" controls src="https://cloud.video.taobao.com/vod/PrrYzvYJkoDlbJwoL8Ei1Bo_60LrKAROCojWxB_EAYs.mp4" />
|
|
4455
|
-
</div>
|
|
4456
|
-
|
|
4457
|
-
我们会在不久的将来开放 masterGo 的设计套件和 rules,帮助您高效率还原视觉稿
|
|
4458
|
-
|
|
4459
|
-
|
|
4460
|
-
|
|
4461
|
-
# 从零开始使用
|
|
4462
|
-
|
|
4463
|
-
## 📦 安装
|
|
4464
|
-
|
|
4465
|
-
|
|
4466
|
-
```bash
|
|
4467
|
-
$ npm install antd @agentscope-ai/icons @agentscope-ai/design --save
|
|
4468
|
-
```
|
|
4469
|
-
|
|
4470
|
-
|
|
4471
|
-
## 🔨 使用
|
|
4443
|
+
如果您想继续使用 antd 的组件,那也没问题。您只需要将 antd 的 ConfigProvider 替换为 @agentscope-ai/design 的即可。
|
|
4472
4444
|
|
|
4473
4445
|
|
|
4474
4446
|
```tsx
|
|
4475
4447
|
import {
|
|
4476
|
-
Button,
|
|
4477
|
-
Image,
|
|
4478
4448
|
ConfigProvider,
|
|
4479
4449
|
purpleDarkTheme,
|
|
4480
4450
|
purpleTheme,
|
|
4481
4451
|
} from '@agentscope-ai/design';
|
|
4452
|
+
import { Button, Image, Flex } from 'antd';
|
|
4482
4453
|
import { SparkSunLine, SparkMoonLine } from '@agentscope-ai/icons';
|
|
4483
|
-
import { Flex } from 'antd';
|
|
4484
4454
|
import zhCN from 'antd/locale/zh_CN';
|
|
4485
4455
|
import { useState } from 'react';
|
|
4486
4456
|
|
|
@@ -4543,6 +4513,36 @@ export default App;
|
|
|
4543
4513
|
|
|
4544
4514
|
|
|
4545
4515
|
|
|
4516
|
+
# Vibe 编程
|
|
4517
|
+
|
|
4518
|
+
## LLMs.txt
|
|
4519
|
+
|
|
4520
|
+
为了让 Cursor 和 Claude Code 等工具理解 Spark Design,我们支持 LLMs.txt 文件,使 Spark Design 的文档可供大型语言模型使用。
|
|
4521
|
+
|
|
4522
|
+
|
|
4523
|
+
- [index.llms.txt](https://g.alicdn.com/code/npm/@ali/agentscope-ai-design/4.7.2/docs-dist/llms/index.llms.txt):主要的 LLMs.txt 索引文件
|
|
4524
|
+
- [all.llms.txt](https://g.alicdn.com/code/npm/@ali/agentscope-ai-design/4.7.2/docs-dist/llms/all.llms.txt):Spark Design 的完整文档
|
|
4525
|
+
|
|
4526
|
+
在 Cursor 中使用 @Docs 功能将 LLMs.txt 文件包含在您的项目中。[了解更多](https://docs.cursor.com/en/context/@-symbols/@-docs)
|
|
4527
|
+
|
|
4528
|
+
## D2C
|
|
4529
|
+
|
|
4530
|
+
在前端使用 Alibaba Cloud Spark Design、设计稿使用 Spark Design 套件的前提下,通过 masterGo 视觉稿生成代码可以做到以下几点:
|
|
4531
|
+
|
|
4532
|
+
|
|
4533
|
+
- 准确识别 icon
|
|
4534
|
+
- 使用标准 css token
|
|
4535
|
+
- 无需测量间距、圆角等数据,AI 直接还原布局(90%以上概率准确生成)
|
|
4536
|
+
- 使用标准组件还原页面,大部分标准组件可一次性正确生成,无需二次调整
|
|
4537
|
+
|
|
4538
|
+
<div>
|
|
4539
|
+
<video style="width: 100%" controls src="https://cloud.video.taobao.com/vod/PrrYzvYJkoDlbJwoL8Ei1Bo_60LrKAROCojWxB_EAYs.mp4" />
|
|
4540
|
+
</div>
|
|
4541
|
+
|
|
4542
|
+
我们会在不久的将来开放 masterGo 的设计套件和 rules,帮助您高效率还原视觉稿
|
|
4543
|
+
|
|
4544
|
+
|
|
4545
|
+
|
|
4546
4546
|
# Tokens
|
|
4547
4547
|
|
|
4548
4548
|
除了来自 [antd](https://ant.design/theme-editor) 的固有 tokens 之外,Spark Design 在原有基础上扩展了更多变量。完整的 token 示例如下所示:
|
|
@@ -4925,7 +4925,8 @@ export default App;
|
|
|
4925
4925
|
"boxShadowSecondary": "0px 12px 24px -16px rgba(255, 255, 255, 0.06),0px 8px 40px 0px rgba(255, 255, 255, 0.12),0px 0px 1px 0px rgba(255, 255, 255, 0.04)",
|
|
4926
4926
|
|
|
4927
4927
|
"colorTextWhite": "#ffffff",
|
|
4928
|
-
"
|
|
4928
|
+
"colorTextBlack": "#000000",
|
|
4929
|
+
"colorTextOnPrimary": "#ffffff",
|
|
4929
4930
|
"colorFillDisable": "#898989",
|
|
4930
4931
|
"colorPurple": "#615CED",
|
|
4931
4932
|
"colorPurpleHover": "#8383F0",
|
|
@@ -4957,8 +4958,8 @@ export default App;
|
|
|
4957
4958
|
|
|
4958
4959
|
"boxShadowTertiary": "0px 12px 32px -16px rgba(255, 255, 255, 0.24),0px 12px 60px 0px rgba(255, 255, 255, 0.12),0px 0px 1px 0px rgba(255, 255, 255, 0.04)",
|
|
4959
4960
|
"boxShadowTertiaryLeft": "-12px 0px 32px -16px rgba(255, 255, 255, 0.24),-12px 0px 60px 0px rgba(255, 255, 255, 0.12),0px 0px 1px 0px rgba(255, 255, 255, 0.04)",
|
|
4960
|
-
"boxShadowInput": "0px 12px 24px -16px rgba(255, 255, 255, 0.08),0px 12px 40px 0px rgba(255, 255, 255, 0.16),0px 0px 1px 0px rgba(255, 255, 255, 0.04)"
|
|
4961
|
-
|
|
4961
|
+
"boxShadowInput": "0px 12px 24px -16px rgba(255, 255, 255, 0.08),0px 12px 40px 0px rgba(255, 255, 255, 0.16),0px 0px 1px 0px rgba(255, 255, 255, 0.04)"
|
|
4962
|
+
|
|
4962
4963
|
}
|
|
4963
4964
|
```
|
|
4964
4965
|
|
|
@@ -4974,3 +4975,23 @@ Spark Design 默认启用 cssVar 模式,因此您可以利用 从 token 派生
|
|
|
4974
4975
|
}
|
|
4975
4976
|
// 提示:您可以将 'sps' 替换为您自己的前缀
|
|
4976
4977
|
```
|
|
4978
|
+
|
|
4979
|
+
|
|
4980
|
+
|
|
4981
|
+
|
|
4982
|
+
### 1.0.21
|
|
4983
|
+
`2025-12-25`
|
|
4984
|
+
|
|
4985
|
+
##### Changed
|
|
4986
|
+
|
|
4987
|
+
- AlertDialog 组件:定位距离顶部的默认高度调整为当前窗口高度的 36%
|
|
4988
|
+
- Table 组件:表格行 hover 背景色修改为 `color-bg-layout` 颜色变量;表格行选中背景色修改为 `color-primary-bg-hover` 颜色变量
|
|
4989
|
+
- Select 组件:多选模式的选中项背景色调整
|
|
4990
|
+
- 主题色变量更新:,
|
|
4991
|
+
- bailianDarkTheme:添加 `"colorLinkHover": "#857DE3"`
|
|
4992
|
+
- bailianTheme:添加 `"colorLinkHover": "#8080FF"`
|
|
4993
|
+
- carbonDarkTheme:修改 `"colorTextOnPrimary": "#ffffff"`
|
|
4994
|
+
|
|
4995
|
+
##### Fixed
|
|
4996
|
+
|
|
4997
|
+
- Slider 组件:水平滑动条组件取消默认左右两边的外边距 margin,操作按钮 handle 在最左侧与最右侧不超出滑动轨道宽度
|