@agentscope-ai/design 1.0.22 → 1.0.23-beta.1767091755248
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/themes/generateTheme.d.ts +47 -24
- package/lib/antd/themes/generateTheme.js +165 -102
- package/llms/all.llms.txt +551 -572
- package/llms/docs/guide/tokens&variables.zh-CN.llms.txt +3 -4
- package/llms/index.llms.txt +13 -14
- package/package.json +1 -1
- package/llms/docs/changelog/index.zh-CN.llms.txt +0 -18
package/llms/all.llms.txt
CHANGED
|
@@ -96,6 +96,19 @@
|
|
|
96
96
|
|
|
97
97
|
|
|
98
98
|
|
|
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
|
+
|
|
99
112
|
<DemoTitle title="Tooltip" desc="简单的文本提示气泡框">
|
|
100
113
|
#### API
|
|
101
114
|
|
|
@@ -143,54 +156,6 @@
|
|
|
143
156
|
|
|
144
157
|
|
|
145
158
|
|
|
146
|
-
<DemoTitle title="Tag" desc="进行标记和分类的小标签">
|
|
147
|
-
#### API
|
|
148
|
-
|
|
149
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
150
|
-
|--------|--------|--------|--------|
|
|
151
|
-
| size | 尺寸 | 'small' \| 'middle' | 'middle' |
|
|
152
|
-
| color | 标签色 | SparkTagColors \| string | 'purple' |
|
|
153
|
-
|
|
154
|
-
<AntdApiRef url="https://ant.design/components/tag-cn/#api"></AntdApiRef>
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
## antd API
|
|
158
|
-
|
|
159
|
-
通用属性参考：[通用属性](/docs/react/common-props)
|
|
160
|
-
|
|
161
|
-
### Tag
|
|
162
|
-
|
|
163
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
164
|
-
|--------|--------|--------|--------|--------|
|
|
165
|
-
| closeIcon | 自定义关闭按钮。5.7.0：设置为 | ReactNode | false | 4.4.0 |
|
|
166
|
-
| icon | 设置图标 | ReactNode | - | |
|
|
167
|
-
| bordered | 是否有边框 | boolean | true | 5.4.0 |
|
|
168
|
-
| onClose | 关闭时的回调（可通过 | (e: React.MouseEvent) => void | - | |
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
### Tag.CheckableTag
|
|
172
|
-
|
|
173
|
-
| 参数 | 说明 | 类型 | 默认值 |
|
|
174
|
-
|--------|--------|--------|--------|
|
|
175
|
-
| checked | 设置标签的选中状态 | boolean | false |
|
|
176
|
-
| onChange | 点击标签时触发的回调 | (checked) => void | - |
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
<DemoTitle title="Video" desc="视频展示">
|
|
182
|
-
#### API
|
|
183
|
-
|
|
184
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
185
|
-
|--------|--------|--------|--------|
|
|
186
|
-
| mouseEnterAutoPlay | 鼠标进入时是否自动播放 | boolean | false |
|
|
187
|
-
| children | video内部设置了按钮在暗色背景下的样式，如果有一些操作按钮想继承这个样式可以在这里传入 | React.ReactNode | |
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
159
|
<DemoTitle title="TimePicker" desc="输入或选择时间的控件。">
|
|
195
160
|
#### API
|
|
196
161
|
|
|
@@ -304,72 +269,37 @@ type RangeDisabledTime = (
|
|
|
304
269
|
|
|
305
270
|
|
|
306
271
|
|
|
307
|
-
<DemoTitle title="
|
|
272
|
+
<DemoTitle title="Tag" desc="进行标记和分类的小标签">
|
|
308
273
|
#### API
|
|
309
274
|
|
|
310
275
|
| 属性名 | 描述 | 类型 | 默认值 |
|
|
311
276
|
|--------|--------|--------|--------|
|
|
312
|
-
|
|
|
313
|
-
|
|
277
|
+
| size | 尺寸 | 'small' \| 'middle' | 'middle' |
|
|
278
|
+
| color | 标签色 | SparkTagColors \| string | 'purple' |
|
|
314
279
|
|
|
315
|
-
<AntdApiRef url="https://ant.design/components/
|
|
280
|
+
<AntdApiRef url="https://ant.design/components/tag-cn/#api"></AntdApiRef>
|
|
316
281
|
|
|
317
282
|
|
|
318
283
|
## antd API
|
|
319
284
|
|
|
320
285
|
通用属性参考：[通用属性](/docs/react/common-props)
|
|
321
286
|
|
|
322
|
-
###
|
|
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
|
|
287
|
+
### Tag
|
|
353
288
|
|
|
354
289
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
355
290
|
|--------|--------|--------|--------|--------|
|
|
356
|
-
| closeIcon |
|
|
357
|
-
|
|
|
358
|
-
|
|
|
359
|
-
|
|
|
360
|
-
| key | 对应 activeKey | string | - | |
|
|
361
|
-
| label | 选项卡头显示文字 | ReactNode | - | |
|
|
362
|
-
| icon | 选项卡头显示图标 | ReactNode | - | 5.12.0 |
|
|
363
|
-
| children | 选项卡头显示内容 | ReactNode | - | |
|
|
364
|
-
| closable | 是否显示选项卡的关闭按钮，在 | boolean | true | |
|
|
291
|
+
| closeIcon | 自定义关闭按钮。5.7.0：设置为 | ReactNode | false | 4.4.0 |
|
|
292
|
+
| icon | 设置图标 | ReactNode | - | |
|
|
293
|
+
| bordered | 是否有边框 | boolean | true | 5.4.0 |
|
|
294
|
+
| onClose | 关闭时的回调（可通过 | (e: React.MouseEvent) => void | - | |
|
|
365
295
|
|
|
366
296
|
|
|
367
|
-
###
|
|
297
|
+
### Tag.CheckableTag
|
|
368
298
|
|
|
369
|
-
| 参数 | 说明 | 类型 | 默认值 |
|
|
370
|
-
|
|
371
|
-
|
|
|
372
|
-
|
|
|
299
|
+
| 参数 | 说明 | 类型 | 默认值 |
|
|
300
|
+
|--------|--------|--------|--------|
|
|
301
|
+
| checked | 设置标签的选中状态 | boolean | false |
|
|
302
|
+
| onChange | 点击标签时触发的回调 | (checked) => void | - |
|
|
373
303
|
|
|
374
304
|
|
|
375
305
|
|
|
@@ -629,6 +559,76 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
629
559
|
|
|
630
560
|
|
|
631
561
|
|
|
562
|
+
<DemoTitle title="Tabs" desc="用户可以通过点击不同的标签在同一页面中查看不同的内容区域。">
|
|
563
|
+
#### API
|
|
564
|
+
|
|
565
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
566
|
+
|--------|--------|--------|--------|
|
|
567
|
+
| type | 类型 | 'line' \| 'card' \| 'editable-card' \| 'segmented' | true |
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
<AntdApiRef url="https://ant.design/components/tabs-cn/#api"></AntdApiRef>
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
## antd API
|
|
574
|
+
|
|
575
|
+
通用属性参考：[通用属性](/docs/react/common-props)
|
|
576
|
+
|
|
577
|
+
### Tabs
|
|
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
632
|
<DemoTitle title="Switch" desc="使用开关切换两种状态之间。">
|
|
633
633
|
#### API
|
|
634
634
|
|
|
@@ -1029,18 +1029,6 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1029
1029
|
|
|
1030
1030
|
|
|
1031
1031
|
|
|
1032
|
-
<DemoTitle title="Result" desc="为操作结果提供反馈信息的展示。">
|
|
1033
|
-
## API
|
|
1034
|
-
|
|
1035
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1036
|
-
|--------|--------|--------|--------|
|
|
1037
|
-
| texture | 是否显示纹理 | boolean | false |
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
1032
|
<DemoTitle title="RadioButton" desc="用于在多个备选项中选中单个状态。">
|
|
1045
1033
|
#### API
|
|
1046
1034
|
|
|
@@ -1116,6 +1104,18 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1116
1104
|
|
|
1117
1105
|
|
|
1118
1106
|
|
|
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
|
|
|
@@ -1201,84 +1201,40 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1201
1201
|
|
|
1202
1202
|
|
|
1203
1203
|
|
|
1204
|
-
<DemoTitle title="
|
|
1205
|
-
|
|
1204
|
+
<DemoTitle title="Progress" desc="用于指示任务的完成进度">
|
|
1205
|
+
## antd API
|
|
1206
1206
|
|
|
1207
|
-
|
|
1207
|
+
通用属性参考：[通用属性](/docs/react/common-props)
|
|
1208
1208
|
|
|
1209
|
+
各类型共用的属性。
|
|
1209
1210
|
|
|
1210
|
-
|
|
1211
|
+
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1212
|
+
|--------|--------|--------|--------|--------|
|
|
1213
|
+
| format | 内容的模板函数 | function(percent, successPercent) | (percent) => percent + | - |
|
|
1214
|
+
| percent | 百分比 | number | 0 | - |
|
|
1215
|
+
| showInfo | 是否显示进度数值或状态图标 | boolean | true | - |
|
|
1216
|
+
| status | 状态，可选： | string | - | - |
|
|
1217
|
+
| strokeColor | 进度条的色彩 | string | - | - |
|
|
1218
|
+
| strokeLinecap | 进度条的样式 | round | round | - |
|
|
1219
|
+
| success | 成功进度条相关配置 | { percent: number, strokeColor: string } | - | - |
|
|
1220
|
+
| trailColor | 未完成的分段的颜色 | string | - | - |
|
|
1221
|
+
| type | 类型，可选 | string | line | - |
|
|
1222
|
+
| size | 进度条的尺寸 | number \| [number \| string, number] \| { width: number, height: number } \| "small" \| "default" | "default" | 5.3.0, Object: 5.18.0 |
|
|
1211
1223
|
|
|
1212
|
-
通用属性参考：[通用属性](/docs/react/common-props)
|
|
1213
1224
|
|
|
1214
|
-
|
|
1225
|
+
### `type="line"`
|
|
1226
|
+
|
|
1227
|
+
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1215
1228
|
|--------|--------|--------|--------|--------|
|
|
1216
|
-
|
|
|
1217
|
-
|
|
|
1229
|
+
| steps | 进度条总共步数 | number | - | - |
|
|
1230
|
+
| rounding | 用于四舍五入数值的函数 | (step: number) => number | Math.round | 5.24.0 |
|
|
1231
|
+
| strokeColor | 进度条的色彩，传入 object 时为渐变。当有 | string \| string[] \| { from: string; to: string; direction: string } | - | 4.21.0: |
|
|
1232
|
+
| percentPosition | 进度数值位置，传入对象， | { align: string; type: string } | { align: "end", type: "outer" } | 5.18.0 |
|
|
1218
1233
|
|
|
1219
1234
|
|
|
1220
|
-
|
|
1221
|
-
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
|
|
1235
|
+
### `type="circle"`
|
|
1222
1236
|
|
|
1223
|
-
|
|
1224
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1225
|
-
|--------|--------|--------|--------|--------|
|
|
1226
|
-
| align | 该值将合并到 placement 的配置中，设置参考 | object | - | |
|
|
1227
|
-
| arrow | 修改箭头的显示状态以及修改箭头是否指向目标元素中心 | boolean \| { pointAtCenter: boolean } | true | 5.2.0 |
|
|
1228
|
-
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | true | |
|
|
1229
|
-
| color | 背景颜色 | string | - | 4.3.0 |
|
|
1230
|
-
| defaultOpen | 默认是否显隐 | boolean | false | 4.23.0 |
|
|
1231
|
-
| destroyOnHidden | 关闭后是否销毁 dom | boolean | false | 5.25.0 |
|
|
1232
|
-
| fresh | 默认情况下，Tooltip 在关闭时会缓存内容。设置该属性后会始终保持更新 | boolean | false | 5.10.0 |
|
|
1233
|
-
| getPopupContainer | 浮层渲染父节点，默认渲染到 body 上 | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
|
1234
|
-
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip，单位：秒 | number | 0.1 | |
|
|
1235
|
-
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip，单位：秒 | number | 0.1 | |
|
|
1236
|
-
| placement | 气泡框位置，可选 | string | top | |
|
|
1237
|
-
| trigger | 触发行为，可选 | string \| string[] | hover | |
|
|
1238
|
-
| open | 用于手动控制浮层显隐，小于 4.23.0 使用 | boolean | false | 4.23.0 |
|
|
1239
|
-
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
1240
|
-
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
1241
|
-
|
|
1242
|
-
## 注意
|
|
1243
|
-
|
|
1244
|
-
请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
<DemoTitle title="Progress" desc="用于指示任务的完成进度">
|
|
1249
|
-
## antd API
|
|
1250
|
-
|
|
1251
|
-
通用属性参考：[通用属性](/docs/react/common-props)
|
|
1252
|
-
|
|
1253
|
-
各类型共用的属性。
|
|
1254
|
-
|
|
1255
|
-
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1256
|
-
|--------|--------|--------|--------|--------|
|
|
1257
|
-
| format | 内容的模板函数 | function(percent, successPercent) | (percent) => percent + | - |
|
|
1258
|
-
| percent | 百分比 | number | 0 | - |
|
|
1259
|
-
| showInfo | 是否显示进度数值或状态图标 | boolean | true | - |
|
|
1260
|
-
| status | 状态，可选： | string | - | - |
|
|
1261
|
-
| strokeColor | 进度条的色彩 | string | - | - |
|
|
1262
|
-
| strokeLinecap | 进度条的样式 | round | round | - |
|
|
1263
|
-
| success | 成功进度条相关配置 | { percent: number, strokeColor: string } | - | - |
|
|
1264
|
-
| trailColor | 未完成的分段的颜色 | string | - | - |
|
|
1265
|
-
| type | 类型，可选 | string | line | - |
|
|
1266
|
-
| size | 进度条的尺寸 | number \| [number \| string, number] \| { width: number, height: number } \| "small" \| "default" | "default" | 5.3.0, Object: 5.18.0 |
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
### `type="line"`
|
|
1270
|
-
|
|
1271
|
-
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1272
|
-
|--------|--------|--------|--------|--------|
|
|
1273
|
-
| steps | 进度条总共步数 | number | - | - |
|
|
1274
|
-
| rounding | 用于四舍五入数值的函数 | (step: number) => number | Math.round | 5.24.0 |
|
|
1275
|
-
| strokeColor | 进度条的色彩，传入 object 时为渐变。当有 | string \| string[] \| { from: string; to: string; direction: string } | - | 4.21.0: |
|
|
1276
|
-
| percentPosition | 进度数值位置，传入对象， | { align: string; type: string } | { align: "end", type: "outer" } | 5.18.0 |
|
|
1277
|
-
|
|
1278
|
-
|
|
1279
|
-
### `type="circle"`
|
|
1280
|
-
|
|
1281
|
-
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1237
|
+
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1282
1238
|
|--------|--------|--------|--------|--------|
|
|
1283
1239
|
| steps | 进度条总共步数，传入 object 时，count 指步数，gap 指间隔大小。传 number 类型时，gap 默认为 2。 | number \| { count: number, gap: number } | - | 5.16.0 |
|
|
1284
1240
|
| strokeColor | 圆形进度条线的色彩，传入 object 时为渐变 | string \| { number%: string } | - | - |
|
|
@@ -1297,15 +1253,10 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1297
1253
|
|
|
1298
1254
|
|
|
1299
1255
|
|
|
1300
|
-
<DemoTitle title="
|
|
1256
|
+
<DemoTitle title="Popover" desc="点击/鼠标移入元素，弹出气泡式的卡片浮层">
|
|
1301
1257
|
#### API
|
|
1302
1258
|
|
|
1303
|
-
|
|
1304
|
-
|--------|--------|--------|--------|
|
|
1305
|
-
| type | 类型 | 'info' \| 'warning' \| 'error' \| 'success' \| 'confirm' | 'confirm' |
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
<AntdApiRef url="https://ant.design/components/popconfirm-cn/#api"></AntdApiRef>
|
|
1259
|
+
<AntdApiRef url="https://ant.design/components/popover-cn/#api"></AntdApiRef>
|
|
1309
1260
|
|
|
1310
1261
|
|
|
1311
1262
|
## antd API
|
|
@@ -1314,19 +1265,8 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1314
1265
|
|
|
1315
1266
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1316
1267
|
|--------|--------|--------|--------|--------|
|
|
1317
|
-
|
|
|
1318
|
-
|
|
|
1319
|
-
| disabled | 阻止点击 Popconfirm 子元素时弹出确认框 | boolean | false | |
|
|
1320
|
-
| icon | 自定义弹出气泡 Icon 图标 | ReactNode | | |
|
|
1321
|
-
| okButtonProps | ok 按钮 props | | - | |
|
|
1322
|
-
| okText | 确认按钮文字 | string | 确定 | |
|
|
1323
|
-
| okType | 确认按钮类型 | string | primary | |
|
|
1324
|
-
| showCancel | 是否显示取消按钮 | boolean | true | 4.18.0 |
|
|
1325
|
-
| title | 确认框标题 | ReactNode \| () => ReactNode | - | |
|
|
1326
|
-
| description | 确认内容的详细描述 | ReactNode \| () => ReactNode | - | 5.1.0 |
|
|
1327
|
-
| onCancel | 点击取消的回调 | function(e) | - | |
|
|
1328
|
-
| onConfirm | 点击确认的回调 | function(e) | - | |
|
|
1329
|
-
| onPopupClick | 弹出气泡点击事件 | function(e) | - | 5.5.0 |
|
|
1268
|
+
| content | 卡片内容 | ReactNode \| () => ReactNode | - | |
|
|
1269
|
+
| title | 卡片标题 | ReactNode \| () => ReactNode | - | |
|
|
1330
1270
|
|
|
1331
1271
|
|
|
1332
1272
|
<!-- 共同的 API -->
|
|
@@ -1351,6 +1291,9 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1351
1291
|
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
1352
1292
|
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
1353
1293
|
|
|
1294
|
+
## 注意
|
|
1295
|
+
|
|
1296
|
+
请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
|
|
1354
1297
|
|
|
1355
1298
|
|
|
1356
1299
|
|
|
@@ -1401,98 +1344,59 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1401
1344
|
|
|
1402
1345
|
|
|
1403
1346
|
|
|
1404
|
-
<DemoTitle title="
|
|
1347
|
+
<DemoTitle title="Popconfirm" desc="点击元素，弹出气泡式的确认框。">
|
|
1405
1348
|
#### API
|
|
1406
1349
|
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
## antd API
|
|
1411
|
-
|
|
1412
|
-
通用属性参考：[通用属性](/docs/react/common-props)
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
- `notification.success(config)`
|
|
1416
|
-
- `notification.error(config)`
|
|
1417
|
-
- `notification.info(config)`
|
|
1418
|
-
- `notification.warning(config)`
|
|
1419
|
-
- `notification.open(config)`
|
|
1420
|
-
- `notification.destroy(key?: String)`
|
|
1421
|
-
|
|
1422
|
-
config 参数如下：
|
|
1350
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1351
|
+
|--------|--------|--------|--------|
|
|
1352
|
+
| type | 类型 | 'info' \| 'warning' \| 'error' \| 'success' \| 'confirm' | 'confirm' |
|
|
1423
1353
|
|
|
1424
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1425
|
-
|--------|--------|--------|--------|--------|
|
|
1426
|
-
| actions | 自定义按钮组 | ReactNode | - | 5.24.0 |
|
|
1427
|
-
| className | 自定义 CSS class | string | - | - |
|
|
1428
|
-
| closeIcon | 自定义关闭图标 | ReactNode | true | 5.7.0：设置为 null 或 false 时隐藏关闭按钮 |
|
|
1429
|
-
| description | 通知提醒内容，必选 | ReactNode | - | - |
|
|
1430
|
-
| duration | 默认 4.5 秒后自动关闭，配置为 null 则不自动关闭 | number | 4.5 | - |
|
|
1431
|
-
| showProgress | 显示自动关闭通知框的进度条 | boolean | | 5.18.0 |
|
|
1432
|
-
| pauseOnHover | 悬停时是否暂停计时器 | boolean | true | 5.18.0 |
|
|
1433
|
-
| icon | 自定义图标 | ReactNode | - | - |
|
|
1434
|
-
| key | 当前通知唯一标志 | string | - | - |
|
|
1435
|
-
| message | 通知提醒标题，必选 | ReactNode | - | - |
|
|
1436
|
-
| placement | 弹出位置，可选 | string | topRight | - |
|
|
1437
|
-
| style | 自定义内联样式 | | - | - |
|
|
1438
|
-
| role | 供屏幕阅读器识别的通知内容语义，默认为 | alert \| status | alert | 5.6.0 |
|
|
1439
|
-
| onClick | 点击通知时触发的回调函数 | function | - | - |
|
|
1440
|
-
| onClose | 当通知关闭时触发 | function | - | - |
|
|
1441
|
-
| props | 透传至通知 | Object | - | - |
|
|
1442
1354
|
|
|
1355
|
+
<AntdApiRef url="https://ant.design/components/popconfirm-cn/#api"></AntdApiRef>
|
|
1443
1356
|
|
|
1444
1357
|
|
|
1445
|
-
|
|
1358
|
+
## antd API
|
|
1446
1359
|
|
|
1447
|
-
|
|
1360
|
+
通用属性参考：[通用属性](/docs/react/common-props)
|
|
1448
1361
|
|
|
1449
1362
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1450
1363
|
|--------|--------|--------|--------|--------|
|
|
1451
|
-
|
|
|
1452
|
-
|
|
|
1453
|
-
|
|
|
1454
|
-
|
|
|
1455
|
-
|
|
|
1456
|
-
|
|
|
1457
|
-
|
|
|
1458
|
-
|
|
|
1459
|
-
|
|
|
1460
|
-
|
|
|
1461
|
-
|
|
1462
|
-
|
|
1463
|
-
|
|
1464
|
-
|
|
1465
|
-
还提供了一个全局配置方法，在调用前提前配置，全局一次生效。
|
|
1466
|
-
|
|
1467
|
-
`notification.config(options)`
|
|
1468
|
-
|
|
1469
|
-
当你使用 `ConfigProvider` 进行全局化配置时，系统会默认自动开启 RTL 模式。(4.3.0+)当你想单独使用，可通过如下设置开启 RTL 模式。
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
```js
|
|
1473
|
-
notification.config({
|
|
1474
|
-
placement: 'bottomRight',
|
|
1475
|
-
bottom: 50,
|
|
1476
|
-
duration: 3,
|
|
1477
|
-
rtl: true,
|
|
1478
|
-
});
|
|
1479
|
-
```
|
|
1364
|
+
| cancelButtonProps | cancel 按钮 props | | - | |
|
|
1365
|
+
| cancelText | 取消按钮文字 | string | 取消 | |
|
|
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 |
|
|
1480
1377
|
|
|
1481
1378
|
|
|
1482
|
-
|
|
1379
|
+
<!-- 共同的 API -->
|
|
1380
|
+
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
|
|
1483
1381
|
|
|
1382
|
+
<!-- prettier-ignore -->
|
|
1484
1383
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1485
1384
|
|--------|--------|--------|--------|--------|
|
|
1486
|
-
|
|
|
1487
|
-
|
|
|
1488
|
-
|
|
|
1489
|
-
|
|
|
1490
|
-
|
|
|
1491
|
-
|
|
|
1492
|
-
|
|
|
1493
|
-
|
|
|
1494
|
-
|
|
|
1495
|
-
|
|
|
1385
|
+
| align | 该值将合并到 placement 的配置中，设置参考 | object | - | |
|
|
1386
|
+
| arrow | 修改箭头的显示状态以及修改箭头是否指向目标元素中心 | boolean \| { pointAtCenter: boolean } | true | 5.2.0 |
|
|
1387
|
+
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | true | |
|
|
1388
|
+
| color | 背景颜色 | string | - | 4.3.0 |
|
|
1389
|
+
| defaultOpen | 默认是否显隐 | boolean | false | 4.23.0 |
|
|
1390
|
+
| destroyOnHidden | 关闭后是否销毁 dom | boolean | false | 5.25.0 |
|
|
1391
|
+
| fresh | 默认情况下，Tooltip 在关闭时会缓存内容。设置该属性后会始终保持更新 | boolean | false | 5.10.0 |
|
|
1392
|
+
| getPopupContainer | 浮层渲染父节点，默认渲染到 body 上 | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
|
1393
|
+
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip，单位：秒 | number | 0.1 | |
|
|
1394
|
+
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip，单位：秒 | number | 0.1 | |
|
|
1395
|
+
| placement | 气泡框位置，可选 | string | top | |
|
|
1396
|
+
| trigger | 触发行为，可选 | string \| string[] | hover | |
|
|
1397
|
+
| open | 用于手动控制浮层显隐，小于 4.23.0 使用 | boolean | false | 4.23.0 |
|
|
1398
|
+
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
1399
|
+
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
1496
1400
|
|
|
1497
1401
|
|
|
1498
1402
|
|
|
@@ -1654,15 +1558,164 @@ return <div>{contextHolder}</div>;
|
|
|
1654
1558
|
`modal.confirm` 返回方法：
|
|
1655
1559
|
|
|
1656
1560
|
|
|
1657
|
-
- `destroy`：销毁当前窗口
|
|
1658
|
-
- `update`：更新当前窗口
|
|
1659
|
-
- `then`：Promise 链式调用，支持 `await` 操作。该方法为 Hooks 仅有
|
|
1561
|
+
- `destroy`：销毁当前窗口
|
|
1562
|
+
- `update`：更新当前窗口
|
|
1563
|
+
- `then`：Promise 链式调用，支持 `await` 操作。该方法为 Hooks 仅有
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
```tsx
|
|
1567
|
+
//点击 `onOk` 时返回 `true`，点击 `onCancel` 时返回 `false`
|
|
1568
|
+
const confirmed = await modal.confirm({ ... });
|
|
1569
|
+
```
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
<DemoTitle title="Notification" desc="用于指示任务的完成进度">
|
|
1575
|
+
#### API
|
|
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 参数如下：
|
|
1618
|
+
|
|
1619
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1620
|
+
|--------|--------|--------|--------|--------|
|
|
1621
|
+
| bottom | 消息从底部弹出时，距离底部的位置，单位像素 | number | 24 | |
|
|
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 |
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
### 全局配置
|
|
1634
|
+
|
|
1635
|
+
还提供了一个全局配置方法，在调用前提前配置，全局一次生效。
|
|
1636
|
+
|
|
1637
|
+
`notification.config(options)`
|
|
1638
|
+
|
|
1639
|
+
当你使用 `ConfigProvider` 进行全局化配置时，系统会默认自动开启 RTL 模式。(4.3.0+)当你想单独使用，可通过如下设置开启 RTL 模式。
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
```js
|
|
1643
|
+
notification.config({
|
|
1644
|
+
placement: 'bottomRight',
|
|
1645
|
+
bottom: 50,
|
|
1646
|
+
duration: 3,
|
|
1647
|
+
rtl: true,
|
|
1648
|
+
});
|
|
1649
|
+
```
|
|
1650
|
+
|
|
1651
|
+
|
|
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
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1681
|
+
|--------|--------|--------|--------|--------|
|
|
1682
|
+
| addonAfter | 带标签的 input，设置后置标签 | ReactNode | - | 4.17.0 |
|
|
1683
|
+
| addonBefore | 带标签的 input，设置前置标签 | ReactNode | - | 4.17.0 |
|
|
1684
|
+
| autoFocus | 自动获取焦点 | boolean | false | - |
|
|
1685
|
+
| changeOnBlur | 是否在失去焦点时，触发 | boolean | true | 5.11.0 |
|
|
1686
|
+
| changeOnWheel | 允许鼠标滚轮改变数值 | boolean | - | 5.14.0 |
|
|
1687
|
+
| controls | 是否显示增减按钮，也可设置自定义箭头图标 | boolean \| { upIcon?: React.ReactNode; downIcon?: React.ReactNode; } | - | 4.19.0 |
|
|
1688
|
+
| decimalSeparator | 小数点 | string | - | - |
|
|
1689
|
+
| placeholder | 占位符 | string | - | |
|
|
1690
|
+
| defaultValue | 初始值 | number | - | - |
|
|
1691
|
+
| disabled | 禁用 | boolean | false | - |
|
|
1692
|
+
| formatter | 指定输入框展示值的格式 | function(value: number \| string, info: { userTyping: boolean, input: string }): string | - | info: 4.17.0 |
|
|
1693
|
+
| keyboard | 是否启用键盘快捷行为 | boolean | true | 4.12.0 |
|
|
1694
|
+
| max | 最大值 | number | | - |
|
|
1695
|
+
| min | 最小值 | number | | - |
|
|
1696
|
+
| parser | 指定从 | function(string): number | - | - |
|
|
1697
|
+
| precision | 数值精度，配置 | number | - | - |
|
|
1698
|
+
| readOnly | 只读 | boolean | false | - |
|
|
1699
|
+
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
1700
|
+
| prefix | 带有前缀图标的 input | ReactNode | - | 4.17.0 |
|
|
1701
|
+
| suffix | 带有后缀图标的 input | ReactNode | - | 5.20.0 |
|
|
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
|
+
|
|
1660
1711
|
|
|
1712
|
+
## Ref
|
|
1661
1713
|
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1714
|
+
| 名称 | 说明 | 参数 | 版本 |
|
|
1715
|
+
|--------|--------|--------|--------|
|
|
1716
|
+
| blur() | 移除焦点 | - | |
|
|
1717
|
+
| focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 |
|
|
1718
|
+
| nativeElement | 获取原生 DOM 元素 | - | 5.17.3 |
|
|
1666
1719
|
|
|
1667
1720
|
|
|
1668
1721
|
|
|
@@ -1767,59 +1820,6 @@ message.config({
|
|
|
1767
1820
|
|
|
1768
1821
|
|
|
1769
1822
|
|
|
1770
|
-
<DemoTitle title="InputNumber" desc="通过鼠标或键盘，输入范围内的数值。">
|
|
1771
|
-
#### API
|
|
1772
|
-
|
|
1773
|
-
<AntdApiRef url="https://ant.design/components/input-number-cn/#api"></AntdApiRef>
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
## antd API
|
|
1777
|
-
|
|
1778
|
-
通用属性参考：[通用属性](/docs/react/common-props)
|
|
1779
|
-
|
|
1780
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1781
|
-
|--------|--------|--------|--------|--------|
|
|
1782
|
-
| addonAfter | 带标签的 input，设置后置标签 | ReactNode | - | 4.17.0 |
|
|
1783
|
-
| addonBefore | 带标签的 input，设置前置标签 | ReactNode | - | 4.17.0 |
|
|
1784
|
-
| autoFocus | 自动获取焦点 | boolean | false | - |
|
|
1785
|
-
| changeOnBlur | 是否在失去焦点时，触发 | boolean | true | 5.11.0 |
|
|
1786
|
-
| changeOnWheel | 允许鼠标滚轮改变数值 | boolean | - | 5.14.0 |
|
|
1787
|
-
| controls | 是否显示增减按钮，也可设置自定义箭头图标 | boolean \| { upIcon?: React.ReactNode; downIcon?: React.ReactNode; } | - | 4.19.0 |
|
|
1788
|
-
| decimalSeparator | 小数点 | string | - | - |
|
|
1789
|
-
| placeholder | 占位符 | string | - | |
|
|
1790
|
-
| defaultValue | 初始值 | number | - | - |
|
|
1791
|
-
| disabled | 禁用 | boolean | false | - |
|
|
1792
|
-
| formatter | 指定输入框展示值的格式 | function(value: number \| string, info: { userTyping: boolean, input: string }): string | - | info: 4.17.0 |
|
|
1793
|
-
| keyboard | 是否启用键盘快捷行为 | boolean | true | 4.12.0 |
|
|
1794
|
-
| max | 最大值 | number | | - |
|
|
1795
|
-
| min | 最小值 | number | | - |
|
|
1796
|
-
| parser | 指定从 | function(string): number | - | - |
|
|
1797
|
-
| precision | 数值精度，配置 | number | - | - |
|
|
1798
|
-
| readOnly | 只读 | boolean | false | - |
|
|
1799
|
-
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
1800
|
-
| prefix | 带有前缀图标的 input | ReactNode | - | 4.17.0 |
|
|
1801
|
-
| suffix | 带有后缀图标的 input | ReactNode | - | 5.20.0 |
|
|
1802
|
-
| size | 输入框大小 | large | - | - |
|
|
1803
|
-
| step | 每次改变步数，可以为小数 | number \| string | 1 | - |
|
|
1804
|
-
| stringMode | 字符值模式，开启后支持高精度小数。同时 | boolean | false | 4.13.0 |
|
|
1805
|
-
| value | 当前值 | number | - | - |
|
|
1806
|
-
| variant | 形态变体 | outlined | outlined | 5.13.0 \| |
|
|
1807
|
-
| onChange | 变化回调 | function(value: number \| string \| null) | - | - |
|
|
1808
|
-
| onPressEnter | 按下回车的回调 | function(e) | - | - |
|
|
1809
|
-
| onStep | 点击上下箭头的回调 | (value: number, info: { offset: number, type: 'up' \| 'down' }) => void | - | 4.7.0 |
|
|
1810
|
-
|
|
1811
|
-
|
|
1812
|
-
## Ref
|
|
1813
|
-
|
|
1814
|
-
| 名称 | 说明 | 参数 | 版本 |
|
|
1815
|
-
|--------|--------|--------|--------|
|
|
1816
|
-
| blur() | 移除焦点 | - | |
|
|
1817
|
-
| focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 |
|
|
1818
|
-
| nativeElement | 获取原生 DOM 元素 | - | 5.17.3 |
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
1823
|
<DemoTitle title="Input" desc="通过鼠标或键盘输入内容，为表单提供输入字段的基础容器。。">
|
|
1824
1824
|
#### API
|
|
1825
1825
|
|
|
@@ -2122,105 +2122,6 @@ type TransformAction =
|
|
|
2122
2122
|
|
|
2123
2123
|
|
|
2124
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>
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
## antd API
|
|
2178
|
-
|
|
2179
|
-
通用属性参考：[通用属性](/docs/react/common-props)
|
|
2180
|
-
|
|
2181
|
-
自 `antd@5.0.0` 版本开始提供该组件。
|
|
2182
|
-
|
|
2183
|
-
### 共同的 API
|
|
2184
|
-
|
|
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 |
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
### FloatButton.Group
|
|
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 |
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
### FloatButton.BackTop
|
|
2213
|
-
|
|
2214
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2215
|
-
|--------|--------|--------|--------|--------|
|
|
2216
|
-
| duration | 回到顶部所需时间（ms） | number | 450 | |
|
|
2217
|
-
| target | 设置需要监听其滚动事件的元素 | () => HTMLElement | () => window | |
|
|
2218
|
-
| visibilityHeight | 滚动高度达到此参数值才出现 BackTop | number | 400 | |
|
|
2219
|
-
| onClick | 点击按钮的回调函数 | () => void | - | |
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
|
|
2224
2125
|
<DemoTitle title="Form" desc="高性能表单控件，自带数据域管理。包含数据录入、校验以及对应样式。">
|
|
2225
2126
|
#### API
|
|
2226
2127
|
|
|
@@ -2771,12 +2672,111 @@ type Rule = RuleConfig | ((form: FormInstance) => RuleConfig);
|
|
|
2771
2672
|
| whitespace | 如果字段仅包含空格则校验不通过，只在 | boolean | |
|
|
2772
2673
|
|
|
2773
2674
|
|
|
2774
|
-
### WatchOptions
|
|
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
|
|
2775
2760
|
|
|
2776
|
-
|
|
|
2761
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2777
2762
|
|--------|--------|--------|--------|--------|
|
|
2778
|
-
|
|
|
2779
|
-
|
|
|
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
2780
|
|
|
2781
2781
|
|
|
2782
2782
|
|
|
@@ -2975,6 +2975,44 @@ const dividerItem = {
|
|
|
2975
2975
|
|
|
2976
2976
|
|
|
2977
2977
|
|
|
2978
|
+
<DemoTitle title="Descriptions" desc="展示多个只读字段的组合">
|
|
2979
|
+
#### API
|
|
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 |
|
|
3002
|
+
|
|
3003
|
+
|
|
3004
|
+
### DescriptionItem
|
|
3005
|
+
|
|
3006
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3007
|
+
|--------|--------|--------|--------|--------|
|
|
3008
|
+
| label | 内容的描述 | ReactNode | - | |
|
|
3009
|
+
| span | 包含列的数量（ | number\| | 1 | screens: 5.9.0 |
|
|
3010
|
+
|
|
3011
|
+
|
|
3012
|
+
span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。当同时配置 `style` 和 `labelStyle`（或 `contentStyle`）时，两者会同时作用。样式冲突时，后者会覆盖前者。
|
|
3013
|
+
|
|
3014
|
+
|
|
3015
|
+
|
|
2978
3016
|
<DemoTitle title="Drawer" desc="从页面一侧滑入的操作面板，用于承载临时界面内容。">
|
|
2979
3017
|
#### API
|
|
2980
3018
|
|
|
@@ -3039,44 +3077,6 @@ v5 使用 `rootClassName` 与 `rootStyle` 来配置最外层元素样式。原 v
|
|
|
3039
3077
|
|
|
3040
3078
|
|
|
3041
3079
|
|
|
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
|
|
|
@@ -3443,69 +3443,6 @@ export type FormatType =
|
|
|
3443
3443
|
|
|
3444
3444
|
|
|
3445
3445
|
|
|
3446
|
-
<DemoTitle title="Card" desc="通用卡片容器">
|
|
3447
|
-
#### API
|
|
3448
|
-
|
|
3449
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3450
|
-
|--------|--------|--------|--------|
|
|
3451
|
-
| info | 副标题 | ReactNode | |
|
|
3452
|
-
|
|
3453
|
-
<AntdApiRef url="https://ant.design/components/card-cn/#api"></AntdApiRef>
|
|
3454
|
-
|
|
3455
|
-
|
|
3456
|
-
## antd API
|
|
3457
|
-
|
|
3458
|
-
通用属性参考：[通用属性](/docs/react/common-props)
|
|
3459
|
-
|
|
3460
|
-
|
|
3461
|
-
```jsx
|
|
3462
|
-
<Card title="卡片标题">卡片内容</Card>
|
|
3463
|
-
```
|
|
3464
|
-
|
|
3465
|
-
|
|
3466
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3467
|
-
|--------|--------|--------|--------|--------|
|
|
3468
|
-
| actions | 卡片操作组，位置在卡片底部 | Array | - | |
|
|
3469
|
-
| activeTabKey | 当前激活页签的 key | string | - | |
|
|
3470
|
-
| variant | 形态变体 | outlined | outlined | 5.24.0 |
|
|
3471
|
-
| cover | 卡片封面 | ReactNode | - | |
|
|
3472
|
-
| defaultActiveTabKey | 初始化选中页签的 key，如果没有设置 activeTabKey | string | 第一个页签的 key | |
|
|
3473
|
-
| extra | 卡片右上角的操作区域 | ReactNode | - | |
|
|
3474
|
-
| hoverable | 鼠标移过时可浮起 | boolean | false | |
|
|
3475
|
-
| loading | 当卡片内容还在加载中时，可以用 loading 展示一个占位 | boolean | false | |
|
|
3476
|
-
| size | card 的尺寸 | default | default | |
|
|
3477
|
-
| tabBarExtraContent | tab bar 上额外的元素 | ReactNode | - | |
|
|
3478
|
-
| tabList | 页签标题列表 | | - | |
|
|
3479
|
-
| tabProps | | - | - | |
|
|
3480
|
-
| title | 卡片标题 | ReactNode | - | |
|
|
3481
|
-
| type | 卡片类型，可设置为 | string | - | |
|
|
3482
|
-
| classNames | 配置卡片内置模块的 className | | - | 5.14.0 |
|
|
3483
|
-
| styles | 配置卡片内置模块的 style | | - | 5.14.0 |
|
|
3484
|
-
| onTabChange | 页签切换的回调 | (key) => void | - | |
|
|
3485
|
-
|
|
3486
|
-
|
|
3487
|
-
### Card.Grid
|
|
3488
|
-
|
|
3489
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3490
|
-
|--------|--------|--------|--------|--------|
|
|
3491
|
-
| className | 网格容器类名 | string | - | |
|
|
3492
|
-
| hoverable | 鼠标移过时可浮起 | boolean | true | |
|
|
3493
|
-
| style | 定义网格容器类名的样式 | CSSProperties | - | |
|
|
3494
|
-
|
|
3495
|
-
|
|
3496
|
-
### Card.Meta
|
|
3497
|
-
|
|
3498
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3499
|
-
|--------|--------|--------|--------|--------|
|
|
3500
|
-
| avatar | 头像/图标 | ReactNode | - | |
|
|
3501
|
-
| className | 容器类名 | string | - | |
|
|
3502
|
-
| description | 描述内容 | ReactNode | - | |
|
|
3503
|
-
| style | 定义容器类名的样式 | CSSProperties | - | |
|
|
3504
|
-
| title | 标题内容 | ReactNode | - | |
|
|
3505
|
-
|
|
3506
|
-
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
3446
|
<DemoTitle title="Checkbox" desc="收集用户的多项选择。">
|
|
3510
3447
|
#### API
|
|
3511
3448
|
|
|
@@ -3577,6 +3514,69 @@ interface Option {
|
|
|
3577
3514
|
|
|
3578
3515
|
|
|
3579
3516
|
|
|
3517
|
+
<DemoTitle title="Card" desc="通用卡片容器">
|
|
3518
|
+
#### API
|
|
3519
|
+
|
|
3520
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3521
|
+
|--------|--------|--------|--------|
|
|
3522
|
+
| info | 副标题 | ReactNode | |
|
|
3523
|
+
|
|
3524
|
+
<AntdApiRef url="https://ant.design/components/card-cn/#api"></AntdApiRef>
|
|
3525
|
+
|
|
3526
|
+
|
|
3527
|
+
## antd API
|
|
3528
|
+
|
|
3529
|
+
通用属性参考：[通用属性](/docs/react/common-props)
|
|
3530
|
+
|
|
3531
|
+
|
|
3532
|
+
```jsx
|
|
3533
|
+
<Card title="卡片标题">卡片内容</Card>
|
|
3534
|
+
```
|
|
3535
|
+
|
|
3536
|
+
|
|
3537
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3538
|
+
|--------|--------|--------|--------|--------|
|
|
3539
|
+
| actions | 卡片操作组，位置在卡片底部 | Array | - | |
|
|
3540
|
+
| activeTabKey | 当前激活页签的 key | string | - | |
|
|
3541
|
+
| variant | 形态变体 | outlined | outlined | 5.24.0 |
|
|
3542
|
+
| cover | 卡片封面 | ReactNode | - | |
|
|
3543
|
+
| defaultActiveTabKey | 初始化选中页签的 key，如果没有设置 activeTabKey | string | 第一个页签的 key | |
|
|
3544
|
+
| extra | 卡片右上角的操作区域 | ReactNode | - | |
|
|
3545
|
+
| hoverable | 鼠标移过时可浮起 | boolean | false | |
|
|
3546
|
+
| loading | 当卡片内容还在加载中时，可以用 loading 展示一个占位 | boolean | false | |
|
|
3547
|
+
| size | card 的尺寸 | default | default | |
|
|
3548
|
+
| tabBarExtraContent | tab bar 上额外的元素 | ReactNode | - | |
|
|
3549
|
+
| tabList | 页签标题列表 | | - | |
|
|
3550
|
+
| tabProps | | - | - | |
|
|
3551
|
+
| title | 卡片标题 | ReactNode | - | |
|
|
3552
|
+
| type | 卡片类型，可设置为 | string | - | |
|
|
3553
|
+
| classNames | 配置卡片内置模块的 className | | - | 5.14.0 |
|
|
3554
|
+
| styles | 配置卡片内置模块的 style | | - | 5.14.0 |
|
|
3555
|
+
| onTabChange | 页签切换的回调 | (key) => void | - | |
|
|
3556
|
+
|
|
3557
|
+
|
|
3558
|
+
### Card.Grid
|
|
3559
|
+
|
|
3560
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3561
|
+
|--------|--------|--------|--------|--------|
|
|
3562
|
+
| className | 网格容器类名 | string | - | |
|
|
3563
|
+
| hoverable | 鼠标移过时可浮起 | boolean | true | |
|
|
3564
|
+
| style | 定义网格容器类名的样式 | CSSProperties | - | |
|
|
3565
|
+
|
|
3566
|
+
|
|
3567
|
+
### Card.Meta
|
|
3568
|
+
|
|
3569
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
3570
|
+
|--------|--------|--------|--------|--------|
|
|
3571
|
+
| avatar | 头像/图标 | ReactNode | - | |
|
|
3572
|
+
| className | 容器类名 | string | - | |
|
|
3573
|
+
| description | 描述内容 | ReactNode | - | |
|
|
3574
|
+
| style | 定义容器类名的样式 | CSSProperties | - | |
|
|
3575
|
+
| title | 标题内容 | ReactNode | - | |
|
|
3576
|
+
|
|
3577
|
+
|
|
3578
|
+
|
|
3579
|
+
|
|
3580
3580
|
<DemoTitle title="Button" desc="按钮用于开始一个即时操作。">
|
|
3581
3581
|
#### API
|
|
3582
3582
|
|
|
@@ -3790,15 +3790,6 @@ Tip：你可以设置 `icon` 或 `children` 作为图片加载失败的默认 fa
|
|
|
3790
3790
|
|
|
3791
3791
|
|
|
3792
3792
|
|
|
3793
|
-
<DemoTitle title="Audio" desc="音频展示">
|
|
3794
|
-
#### API
|
|
3795
|
-
|
|
3796
|
-
ApiParser解析结果为空
|
|
3797
|
-
|
|
3798
|
-
|
|
3799
|
-
|
|
3800
|
-
|
|
3801
|
-
|
|
3802
3793
|
<DemoTitle title="Anchor" desc="用于跳转到页面指定位置。">
|
|
3803
3794
|
#### API
|
|
3804
3795
|
|
|
@@ -3852,6 +3843,15 @@ ApiParser解析结果为空
|
|
|
3852
3843
|
|
|
3853
3844
|
|
|
3854
3845
|
|
|
3846
|
+
<DemoTitle title="Audio" desc="音频展示">
|
|
3847
|
+
#### API
|
|
3848
|
+
|
|
3849
|
+
ApiParser解析结果为空
|
|
3850
|
+
|
|
3851
|
+
|
|
3852
|
+
|
|
3853
|
+
|
|
3854
|
+
|
|
3855
3855
|
<DemoTitle title="AlertDialog" desc="一种在界面中弹出的对话框，用来向用户传达重要信息，并引导其进行确认或取消等操作。">
|
|
3856
3856
|
#### API
|
|
3857
3857
|
|
|
@@ -4925,8 +4925,7 @@ 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
|
-
"
|
|
4929
|
-
"colorTextOnPrimary": "#ffffff",
|
|
4928
|
+
"colorTextOnPrimary": "#000000",
|
|
4930
4929
|
"colorFillDisable": "#898989",
|
|
4931
4930
|
"colorPurple": "#615CED",
|
|
4932
4931
|
"colorPurpleHover": "#8383F0",
|
|
@@ -4958,8 +4957,8 @@ export default App;
|
|
|
4958
4957
|
|
|
4959
4958
|
"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)",
|
|
4960
4959
|
"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)",
|
|
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
|
-
|
|
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
|
+
"colorTextBlack": "#000000"
|
|
4963
4962
|
}
|
|
4964
4963
|
```
|
|
4965
4964
|
|
|
@@ -4975,23 +4974,3 @@ Spark Design 默认启用 cssVar 模式，因此您可以利用 从 token 派生
|
|
|
4975
4974
|
}
|
|
4976
4975
|
// 提示：您可以将 'sps' 替换为您自己的前缀
|
|
4977
4976
|
```
|
|
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 在最左侧与最右侧不超出滑动轨道宽度
|