@agentscope-ai/design 1.0.16 → 1.0.17
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/styles/index.style.js +3 -1
- package/lib/antd/styles/tree.style.d.ts +6 -0
- package/lib/antd/styles/tree.style.js +18 -0
- package/lib/antd/themes/bailianDarkTheme.json +3 -1
- package/lib/antd/themes/bailianTheme.json +4 -2
- package/lib/antd/themes/carbonDarkTheme.json +3 -1
- package/lib/antd/themes/carbonTheme.json +3 -1
- package/lib/components/commonComponents/Audio/Control.d.ts +53 -0
- package/lib/components/commonComponents/{Video → Audio}/Control.js +18 -15
- package/lib/components/commonComponents/Audio/Control.style.d.ts +1 -0
- package/lib/components/commonComponents/Audio/Control.style.js +14 -0
- package/lib/components/commonComponents/Audio/index.d.ts +14 -0
- package/lib/components/commonComponents/Audio/index.js +165 -0
- package/lib/components/commonComponents/Audio/index.style.d.ts +1 -0
- package/lib/components/commonComponents/Audio/index.style.js +10 -0
- package/lib/components/commonComponents/Button/demo/demo1.js +7 -0
- package/lib/components/commonComponents/Button/index.js +2 -1
- package/lib/components/commonComponents/CollapsePanel/demo/demo1.js +1 -1
- package/lib/components/commonComponents/CollapsePanel/index.js +4 -4
- package/lib/components/commonComponents/EllipsisTip/index.d.ts +8 -1
- package/lib/components/commonComponents/EllipsisTip/index.js +33 -3
- package/lib/components/commonComponents/Empty/index.d.ts +6 -0
- package/lib/components/commonComponents/Empty/index.js +22 -7
- package/lib/components/commonComponents/Empty/index.style.js +1 -1
- package/lib/components/commonComponents/Pagination/index.js +33 -42
- package/lib/components/commonComponents/Pagination/index.style.js +1 -1
- package/lib/components/commonComponents/SliderSelector/index.d.ts +1 -1
- package/lib/components/commonComponents/SliderSelector/index.js +8 -4
- package/lib/components/commonComponents/Steps/index.js +2 -1
- package/lib/components/commonComponents/Steps/index.style.js +5 -1
- package/lib/components/commonComponents/Table/index.style.js +27 -1
- package/lib/components/commonComponents/Tabs/index.js +9 -8
- package/lib/components/commonComponents/Tooltip/demo/demo3.d.ts +3 -0
- package/lib/components/commonComponents/Tooltip/demo/demo3.js +25 -0
- package/lib/components/commonComponents/Tooltip/index.d.ts +7 -1
- package/lib/components/commonComponents/Tooltip/index.js +12 -1
- package/lib/components/commonComponents/Tooltip/index.style.js +1 -1
- package/lib/components/commonComponents/Video/index.d.ts +2 -6
- package/lib/components/commonComponents/Video/index.js +8 -8
- package/lib/components/commonComponents/Video/index.style.js +2 -6
- package/lib/components/mobileComponents/MobileDrawer/index.style.js +7 -1
- package/lib/index.d.ts +2 -1
- package/lib/index.js +1 -0
- package/lib/libs/env/index.d.ts +1 -1
- package/lib/typings.d.ts +12 -0
- package/llms/all.llms.txt +570 -561
- package/llms/components/commonComponents/Empty/index.zh-CN.llms.txt +1 -0
- package/llms/components/commonComponents/Tooltip/index.zh-CN.llms.txt +2 -1
- package/llms/docs/guide/tokens&variables.zh-CN.llms.txt +13 -5
- package/llms/index.llms.txt +47 -47
- package/package.json +3 -3
- package/scripts/mcp-docs-server.js +3 -3
- package/lib/components/commonComponents/Video/Control.d.ts +0 -19
package/llms/all.llms.txt
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
|
+
<DemoTitle title="Video" desc="视频展示">
|
|
4
|
+
#### API
|
|
5
|
+
|
|
6
|
+
<AntdApiRef url="https://ant.design/components/upload-cn/#api"></AntdApiRef>
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
3
12
|
<DemoTitle title="Upload" desc="文件选择上传和拖拽上传控件。">
|
|
4
13
|
#### API
|
|
5
14
|
|
|
@@ -96,21 +105,13 @@
|
|
|
96
105
|
|
|
97
106
|
|
|
98
107
|
|
|
99
|
-
<DemoTitle title="Video" desc="视频展示">
|
|
100
|
-
#### API
|
|
101
|
-
|
|
102
|
-
<AntdApiRef url="https://ant.design/components/upload-cn/#api"></AntdApiRef>
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
108
|
<DemoTitle title="Tooltip" desc="简单的文本提示气泡框">
|
|
109
109
|
#### API
|
|
110
110
|
|
|
111
111
|
| 属性名 | 描述 | 类型 | 默认值 |
|
|
112
112
|
|--------|--------|--------|--------|
|
|
113
|
-
| mode | 颜色模式 | 'dark' \| 'light' | '
|
|
113
|
+
| mode | 颜色模式 | 'dark' \| 'light' | 'dark' |
|
|
114
|
+
| maxHeight | 最大高度 | number \| string | '90vh' |
|
|
114
115
|
|
|
115
116
|
|
|
116
117
|
<AntdApiRef url="https://ant.design/components/tooltip-cn/#api"></AntdApiRef>
|
|
@@ -624,6 +625,82 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
624
625
|
|
|
625
626
|
|
|
626
627
|
|
|
628
|
+
<DemoTitle title="Steps" desc="引导用户按照流程完成任务的导航条。">
|
|
629
|
+
#### API
|
|
630
|
+
|
|
631
|
+
<AntdApiRef url="https://ant.design/components/steps-cn/#api"></AntdApiRef>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
## antd API
|
|
635
|
+
|
|
636
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
637
|
+
|
|
638
|
+
### Steps
|
|
639
|
+
|
|
640
|
+
整体步骤条。
|
|
641
|
+
|
|
642
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
643
|
+
|--------|--------|--------|--------|--------|
|
|
644
|
+
| className | 步骤条类名 | string | - | |
|
|
645
|
+
| current | 指定当前步骤,从 0 开始记数。在子 Step 元素中,可以通过 | number | 0 | |
|
|
646
|
+
| direction | 指定步骤条方向。目前支持水平( | string | horizontal | |
|
|
647
|
+
| initial | 起始序号,从 0 开始记数 | number | 0 | |
|
|
648
|
+
| labelPlacement | 指定标签放置位置,默认水平放图标右侧,可选 | string | horizontal | |
|
|
649
|
+
| percent | 当前 | number | - | 4.5.0 |
|
|
650
|
+
| progressDot | 点状步骤条,可以设置为一个 function,labelPlacement 将强制为 | boolean \| (iconDot, {index, status, title, description}) => ReactNode | false | |
|
|
651
|
+
| responsive | 当屏幕宽度小于 | boolean | true | |
|
|
652
|
+
| size | 指定大小,目前支持普通( | string | default | |
|
|
653
|
+
| status | 指定当前步骤的状态,可选 | string | process | |
|
|
654
|
+
| type | 步骤条类型,可选 | string | default | inline: 5.0 |
|
|
655
|
+
| onChange | 点击切换步骤时触发 | (current) => void | - | |
|
|
656
|
+
| items | 配置选项卡内容 | | [] | 4.24.0 |
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
### `type="inline"`
|
|
660
|
+
|
|
661
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
662
|
+
|--------|--------|--------|--------|--------|
|
|
663
|
+
| className | 步骤条类名 | string | - | |
|
|
664
|
+
| current | 指定当前步骤,从 0 开始记数。在子 Step 元素中,可以通过 | number | 0 | |
|
|
665
|
+
| initial | 起始序号,从 0 开始记数 | number | 0 | |
|
|
666
|
+
| status | 指定当前步骤的状态,可选 | string | process | |
|
|
667
|
+
| onChange | 点击切换步骤时触发 | (current) => void | - | |
|
|
668
|
+
| items | 配置选项卡内容,不支持 | | [] | 4.24.0 |
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
### StepItem
|
|
672
|
+
|
|
673
|
+
步骤条内的每一个步骤。
|
|
674
|
+
|
|
675
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
676
|
+
|--------|--------|--------|--------|--------|
|
|
677
|
+
| description | 步骤的详情描述,可选 | ReactNode | - | |
|
|
678
|
+
| disabled | 禁用点击 | boolean | false | |
|
|
679
|
+
| icon | 步骤图标的类型,可选 | ReactNode | - | |
|
|
680
|
+
| status | 指定状态。当不配置该属性时,会使用 Steps 的 | string | wait | |
|
|
681
|
+
| subTitle | 子标题 | ReactNode | - | |
|
|
682
|
+
| title | 标题 | ReactNode | - | |
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
<DemoTitle title="Spinner" desc="指示页面或区块的加载中状态">
|
|
688
|
+
#### API
|
|
689
|
+
|
|
690
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
691
|
+
|--------|--------|--------|--------|
|
|
692
|
+
| tip | indicator下方的tip | React.ReactNode | - |
|
|
693
|
+
| indicator | 自定义indicator,用于展示progress的百分比和加载文案 | React.ReactNode | - |
|
|
694
|
+
| children | 被spinner包裹的子元素 | React.ReactNode | - |
|
|
695
|
+
| style | spinner最外层的样式 | React.CSSProperties | - |
|
|
696
|
+
| className | spinner的类名 | string | - |
|
|
697
|
+
| percent | 进度条的百分比 | number | - |
|
|
698
|
+
| spinning | 是否为加载中状态 | boolean | false |
|
|
699
|
+
| showProgress | 是否显示进度条,如果为true,不需要手动在children中添加Progress组件 | boolean | false |
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
627
704
|
<DemoTitle title="Statistic" desc="展示统计数值">
|
|
628
705
|
#### API
|
|
629
706
|
|
|
@@ -725,65 +802,6 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
725
802
|
|
|
726
803
|
|
|
727
804
|
|
|
728
|
-
<DemoTitle title="Steps" desc="引导用户按照流程完成任务的导航条。">
|
|
729
|
-
#### API
|
|
730
|
-
|
|
731
|
-
<AntdApiRef url="https://ant.design/components/steps-cn/#api"></AntdApiRef>
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
## antd API
|
|
735
|
-
|
|
736
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
737
|
-
|
|
738
|
-
### Steps
|
|
739
|
-
|
|
740
|
-
整体步骤条。
|
|
741
|
-
|
|
742
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
743
|
-
|--------|--------|--------|--------|--------|
|
|
744
|
-
| className | 步骤条类名 | string | - | |
|
|
745
|
-
| current | 指定当前步骤,从 0 开始记数。在子 Step 元素中,可以通过 | number | 0 | |
|
|
746
|
-
| direction | 指定步骤条方向。目前支持水平( | string | horizontal | |
|
|
747
|
-
| initial | 起始序号,从 0 开始记数 | number | 0 | |
|
|
748
|
-
| labelPlacement | 指定标签放置位置,默认水平放图标右侧,可选 | string | horizontal | |
|
|
749
|
-
| percent | 当前 | number | - | 4.5.0 |
|
|
750
|
-
| progressDot | 点状步骤条,可以设置为一个 function,labelPlacement 将强制为 | boolean \| (iconDot, {index, status, title, description}) => ReactNode | false | |
|
|
751
|
-
| responsive | 当屏幕宽度小于 | boolean | true | |
|
|
752
|
-
| size | 指定大小,目前支持普通( | string | default | |
|
|
753
|
-
| status | 指定当前步骤的状态,可选 | string | process | |
|
|
754
|
-
| type | 步骤条类型,可选 | string | default | inline: 5.0 |
|
|
755
|
-
| onChange | 点击切换步骤时触发 | (current) => void | - | |
|
|
756
|
-
| items | 配置选项卡内容 | | [] | 4.24.0 |
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
### `type="inline"`
|
|
760
|
-
|
|
761
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
762
|
-
|--------|--------|--------|--------|--------|
|
|
763
|
-
| className | 步骤条类名 | string | - | |
|
|
764
|
-
| current | 指定当前步骤,从 0 开始记数。在子 Step 元素中,可以通过 | number | 0 | |
|
|
765
|
-
| initial | 起始序号,从 0 开始记数 | number | 0 | |
|
|
766
|
-
| status | 指定当前步骤的状态,可选 | string | process | |
|
|
767
|
-
| onChange | 点击切换步骤时触发 | (current) => void | - | |
|
|
768
|
-
| items | 配置选项卡内容,不支持 | | [] | 4.24.0 |
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
### StepItem
|
|
772
|
-
|
|
773
|
-
步骤条内的每一个步骤。
|
|
774
|
-
|
|
775
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
776
|
-
|--------|--------|--------|--------|--------|
|
|
777
|
-
| description | 步骤的详情描述,可选 | ReactNode | - | |
|
|
778
|
-
| disabled | 禁用点击 | boolean | false | |
|
|
779
|
-
| icon | 步骤图标的类型,可选 | ReactNode | - | |
|
|
780
|
-
| status | 指定状态。当不配置该属性时,会使用 Steps 的 | string | wait | |
|
|
781
|
-
| subTitle | 子标题 | ReactNode | - | |
|
|
782
|
-
| title | 标题 | ReactNode | - | |
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
805
|
<DemoTitle title="Slider" desc="滑动型输入器,展示当前值和可选范围。">
|
|
788
806
|
#### API
|
|
789
807
|
|
|
@@ -1007,23 +1025,6 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1007
1025
|
|
|
1008
1026
|
|
|
1009
1027
|
|
|
1010
|
-
<DemoTitle title="Spinner" desc="指示页面或区块的加载中状态">
|
|
1011
|
-
#### API
|
|
1012
|
-
|
|
1013
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1014
|
-
|--------|--------|--------|--------|
|
|
1015
|
-
| tip | indicator下方的tip | React.ReactNode | - |
|
|
1016
|
-
| indicator | 自定义indicator,用于展示progress的百分比和加载文案 | React.ReactNode | - |
|
|
1017
|
-
| children | 被spinner包裹的子元素 | React.ReactNode | - |
|
|
1018
|
-
| style | spinner最外层的样式 | React.CSSProperties | - |
|
|
1019
|
-
| className | spinner的类名 | string | - |
|
|
1020
|
-
| percent | 进度条的百分比 | number | - |
|
|
1021
|
-
| spinning | 是否为加载中状态 | boolean | false |
|
|
1022
|
-
| showProgress | 是否显示进度条,如果为true,不需要手动在children中添加Progress组件 | boolean | false |
|
|
1023
|
-
|
|
1024
|
-
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
1028
|
<DemoTitle title="RadioButton" desc="用于在多个备选项中选中单个状态。">
|
|
1028
1029
|
#### API
|
|
1029
1030
|
|
|
@@ -1099,6 +1100,23 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1099
1100
|
|
|
1100
1101
|
|
|
1101
1102
|
|
|
1103
|
+
<DemoTitle title="MdEditor" desc="提示词编辑器,可以高亮 Markdown 的语法,支持自定义槽位变量的插入">
|
|
1104
|
+
#### API
|
|
1105
|
+
|
|
1106
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1107
|
+
|--------|--------|--------|--------|
|
|
1108
|
+
| maxLength | 可以输入内容的最大长度 | number | |
|
|
1109
|
+
| value | 输入的内容 | string | (必填) |
|
|
1110
|
+
| className | 输入内容的类名 | string | |
|
|
1111
|
+
| onChange | 输入内容的回调 | (value: string) => void | |
|
|
1112
|
+
| variables | 可以插入的变量列表 | Array | |
|
|
1113
|
+
| onCreate | 新增变量的触发回调 | () => void | |
|
|
1114
|
+
| createBtnText | 新增变量的按钮文本 | string | |
|
|
1115
|
+
| tipsText | 提示文本,传入 false 时隐藏提示 | string \| React.ReactNode \| false | |
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
|
|
1102
1120
|
<DemoTitle title="Result" desc="为操作结果提供反馈信息的展示。">
|
|
1103
1121
|
## API
|
|
1104
1122
|
|
|
@@ -1111,78 +1129,54 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1111
1129
|
|
|
1112
1130
|
|
|
1113
1131
|
|
|
1114
|
-
<DemoTitle title="
|
|
1132
|
+
<DemoTitle title="Popover" desc="点击/鼠标移入元素,弹出气泡式的卡片浮层">
|
|
1115
1133
|
#### API
|
|
1116
1134
|
|
|
1117
|
-
<AntdApiRef url="https://ant.design/components/
|
|
1135
|
+
<AntdApiRef url="https://ant.design/components/popover-cn/#api"></AntdApiRef>
|
|
1118
1136
|
|
|
1119
1137
|
|
|
1120
1138
|
## antd API
|
|
1121
1139
|
|
|
1122
1140
|
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1123
1141
|
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
|
1128
|
-
|--------|--------|--------|--------|
|
|
1129
|
-
| autoFocus | 自动获取焦点 | boolean | false |
|
|
1130
|
-
| checked | 指定当前是否选中 | boolean | false |
|
|
1131
|
-
| defaultChecked | 初始是否选中 | boolean | false |
|
|
1132
|
-
| disabled | 禁用 Radio | boolean | false |
|
|
1133
|
-
| value | 根据 value 进行比较,判断是否选中 | any | - |
|
|
1134
|
-
|
|
1142
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1143
|
+
|--------|--------|--------|--------|--------|
|
|
1144
|
+
| content | 卡片内容 | ReactNode \| () => ReactNode | - | |
|
|
1145
|
+
| title | 卡片标题 | ReactNode \| () => ReactNode | - | |
|
|
1135
1146
|
|
|
1136
|
-
### Radio.Group
|
|
1137
1147
|
|
|
1138
|
-
|
|
1148
|
+
<!-- 共同的 API -->
|
|
1149
|
+
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
|
|
1139
1150
|
|
|
1140
1151
|
<!-- prettier-ignore -->
|
|
1141
1152
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1142
1153
|
|--------|--------|--------|--------|--------|
|
|
1143
|
-
|
|
|
1144
|
-
|
|
|
1145
|
-
|
|
|
1146
|
-
|
|
|
1147
|
-
|
|
|
1148
|
-
|
|
|
1149
|
-
|
|
|
1150
|
-
|
|
|
1151
|
-
|
|
|
1152
|
-
|
|
|
1154
|
+
| align | 该值将合并到 placement 的配置中,设置参考 | object | - | |
|
|
1155
|
+
| arrow | 修改箭头的显示状态以及修改箭头是否指向目标元素中心 | boolean \| { pointAtCenter: boolean } | true | 5.2.0 |
|
|
1156
|
+
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | true | |
|
|
1157
|
+
| color | 背景颜色 | string | - | 4.3.0 |
|
|
1158
|
+
| defaultOpen | 默认是否显隐 | boolean | false | 4.23.0 |
|
|
1159
|
+
| destroyOnHidden | 关闭后是否销毁 dom | boolean | false | 5.25.0 |
|
|
1160
|
+
| fresh | 默认情况下,Tooltip 在关闭时会缓存内容。设置该属性后会始终保持更新 | boolean | false | 5.10.0 |
|
|
1161
|
+
| getPopupContainer | 浮层渲染父节点,默认渲染到 body 上 | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
|
1162
|
+
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip,单位:秒 | number | 0.1 | |
|
|
1163
|
+
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip,单位:秒 | number | 0.1 | |
|
|
1164
|
+
| placement | 气泡框位置,可选 | string | top | |
|
|
1165
|
+
| trigger | 触发行为,可选 | string \| string[] | hover | |
|
|
1166
|
+
| open | 用于手动控制浮层显隐,小于 4.23.0 使用 | boolean | false | 4.23.0 |
|
|
1167
|
+
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
1168
|
+
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
1153
1169
|
|
|
1170
|
+
## 注意
|
|
1154
1171
|
|
|
1155
|
-
|
|
1172
|
+
请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
|
|
1156
1173
|
|
|
1157
|
-
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1158
|
-
|--------|--------|--------|--------|--------|
|
|
1159
|
-
| label | 用于作为 Radio 选项展示的文本 | string | - | 4.4.0 |
|
|
1160
|
-
| value | 关联 Radio 选项的值 | string | - | 4.4.0 |
|
|
1161
|
-
| style | 应用到 Radio 选项的 style | React.CSSProperties | - | 4.4.0 |
|
|
1162
|
-
| className | Radio 选项的类名 | string | - | 5.25.0 |
|
|
1163
|
-
| disabled | 指定 Radio 选项是否要禁用 | boolean | false | 4.4.0 |
|
|
1164
|
-
| title | 添加 Title 属性值 | string | - | 4.4.0 |
|
|
1165
|
-
| id | 添加 Radio Id 属性值 | string | - | 4.4.0 |
|
|
1166
|
-
| onChange | 当 Radio Group 的值发送改变时触发 | (e: CheckboxChangeEvent) => void; | - | 4.4.0 |
|
|
1167
|
-
| required | 指定 Radio 选项是否必填 | boolean | false | 4.4.0 |
|
|
1168
1174
|
|
|
1169
1175
|
|
|
1170
|
-
|
|
1176
|
+
<DemoTitle title="Progress" desc="用于指示任务的完成进度">
|
|
1177
|
+
## antd API
|
|
1171
1178
|
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
| 名称 | 描述 |
|
|
1175
|
-
|--------|--------|
|
|
1176
|
-
| blur() | 移除焦点 |
|
|
1177
|
-
| focus() | 获取焦点 |
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
<DemoTitle title="Progress" desc="用于指示任务的完成进度">
|
|
1183
|
-
## antd API
|
|
1184
|
-
|
|
1185
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1179
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1186
1180
|
|
|
1187
1181
|
各类型共用的属性。
|
|
1188
1182
|
|
|
@@ -1231,63 +1225,117 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1231
1225
|
|
|
1232
1226
|
|
|
1233
1227
|
|
|
1234
|
-
<DemoTitle title="
|
|
1228
|
+
<DemoTitle title="Radio" desc="用于在多个备选项中选中单个状态。">
|
|
1235
1229
|
#### API
|
|
1236
1230
|
|
|
1237
|
-
<AntdApiRef url="https://ant.design/components/
|
|
1231
|
+
<AntdApiRef url="https://ant.design/components/radio-cn/#api"></AntdApiRef>
|
|
1238
1232
|
|
|
1239
1233
|
|
|
1240
1234
|
## antd API
|
|
1241
1235
|
|
|
1242
1236
|
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1243
1237
|
|
|
1244
|
-
|
|
1245
|
-
|--------|--------|--------|--------|--------|
|
|
1246
|
-
| content | 卡片内容 | ReactNode \| () => ReactNode | - | |
|
|
1247
|
-
| title | 卡片标题 | ReactNode \| () => ReactNode | - | |
|
|
1238
|
+
### Radio/Radio.Button
|
|
1248
1239
|
|
|
1240
|
+
<!-- prettier-ignore -->
|
|
1241
|
+
| 参数 | 说明 | 类型 | 默认值 |
|
|
1242
|
+
|--------|--------|--------|--------|
|
|
1243
|
+
| autoFocus | 自动获取焦点 | boolean | false |
|
|
1244
|
+
| checked | 指定当前是否选中 | boolean | false |
|
|
1245
|
+
| defaultChecked | 初始是否选中 | boolean | false |
|
|
1246
|
+
| disabled | 禁用 Radio | boolean | false |
|
|
1247
|
+
| value | 根据 value 进行比较,判断是否选中 | any | - |
|
|
1249
1248
|
|
|
1250
|
-
|
|
1251
|
-
|
|
1249
|
+
|
|
1250
|
+
### Radio.Group
|
|
1251
|
+
|
|
1252
|
+
单选框组合,用于包裹一组 `Radio`。
|
|
1252
1253
|
|
|
1253
1254
|
<!-- prettier-ignore -->
|
|
1254
1255
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1255
1256
|
|--------|--------|--------|--------|--------|
|
|
1256
|
-
|
|
|
1257
|
-
|
|
|
1258
|
-
|
|
|
1259
|
-
|
|
|
1260
|
-
|
|
|
1261
|
-
|
|
|
1262
|
-
|
|
|
1263
|
-
|
|
|
1264
|
-
|
|
|
1265
|
-
|
|
|
1266
|
-
| placement | 气泡框位置,可选 | string | top | |
|
|
1267
|
-
| trigger | 触发行为,可选 | string \| string[] | hover | |
|
|
1268
|
-
| open | 用于手动控制浮层显隐,小于 4.23.0 使用 | boolean | false | 4.23.0 |
|
|
1269
|
-
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
1270
|
-
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
1257
|
+
| buttonStyle | RadioButton 的风格样式,目前有描边和填色两种风格 | outline | outline | | |
|
|
1258
|
+
| defaultValue | 默认选中的值 | any | - | | |
|
|
1259
|
+
| disabled | 禁选所有子单选器 | boolean | false | | |
|
|
1260
|
+
| name | RadioGroup 下所有 | string | - | | |
|
|
1261
|
+
| options | 以配置形式设置子元素 | string[] \| number[] \| Array< | - | | |
|
|
1262
|
+
| optionType | 用于设置 Radio | default | default | 4.4.0 | |
|
|
1263
|
+
| size | 大小,只对按钮样式生效 | large | - | | |
|
|
1264
|
+
| value | 用于设置当前选中的值 | any | - | | |
|
|
1265
|
+
| block | 将 RadioGroup 宽度调整为其父宽度的选项 | boolean | false | 5.21.0 | |
|
|
1266
|
+
| onChange | 选项变化时的回调函数 | function(e:Event) | - | | |
|
|
1271
1267
|
|
|
1272
|
-
## 注意
|
|
1273
1268
|
|
|
1274
|
-
|
|
1269
|
+
### CheckboxOptionType
|
|
1270
|
+
|
|
1271
|
+
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1272
|
+
|--------|--------|--------|--------|--------|
|
|
1273
|
+
| label | 用于作为 Radio 选项展示的文本 | string | - | 4.4.0 |
|
|
1274
|
+
| value | 关联 Radio 选项的值 | string | - | 4.4.0 |
|
|
1275
|
+
| style | 应用到 Radio 选项的 style | React.CSSProperties | - | 4.4.0 |
|
|
1276
|
+
| className | Radio 选项的类名 | string | - | 5.25.0 |
|
|
1277
|
+
| disabled | 指定 Radio 选项是否要禁用 | boolean | false | 4.4.0 |
|
|
1278
|
+
| title | 添加 Title 属性值 | string | - | 4.4.0 |
|
|
1279
|
+
| id | 添加 Radio Id 属性值 | string | - | 4.4.0 |
|
|
1280
|
+
| onChange | 当 Radio Group 的值发送改变时触发 | (e: CheckboxChangeEvent) => void; | - | 4.4.0 |
|
|
1281
|
+
| required | 指定 Radio 选项是否必填 | boolean | false | 4.4.0 |
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
## 方法
|
|
1285
|
+
|
|
1286
|
+
### Radio
|
|
1287
|
+
|
|
1288
|
+
| 名称 | 描述 |
|
|
1289
|
+
|--------|--------|
|
|
1290
|
+
| blur() | 移除焦点 |
|
|
1291
|
+
| focus() | 获取焦点 |
|
|
1275
1292
|
|
|
1276
1293
|
|
|
1277
1294
|
|
|
1278
|
-
|
|
1279
|
-
|
|
1295
|
+
|
|
1296
|
+
<DemoTitle title="Pagination" desc="分页器用于分隔长列表,每次只加载一个页面。">
|
|
1297
|
+
## API
|
|
1280
1298
|
|
|
1281
1299
|
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1282
1300
|
|--------|--------|--------|--------|
|
|
1283
|
-
|
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1301
|
+
| hideSwitchButton | 是否展示上一页/下一页的切换按钮 | boolean | false |
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
<AntdApiRef url="https://ant.design/components/pagination-cn/#api"></AntdApiRef>
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
## antd API
|
|
1308
|
+
|
|
1309
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
```jsx
|
|
1313
|
+
<Pagination onChange={onChange} total={50} />
|
|
1314
|
+
```
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1318
|
+
|--------|--------|--------|--------|--------|
|
|
1319
|
+
| align | 对齐方式 | start \| center \| end | - | 5.19.0 |
|
|
1320
|
+
| current | 当前页数 | number | - | |
|
|
1321
|
+
| defaultCurrent | 默认的当前页数 | number | 1 | |
|
|
1322
|
+
| defaultPageSize | 默认的每页条数 | number | 10 | |
|
|
1323
|
+
| disabled | 禁用分页 | boolean | - | |
|
|
1324
|
+
| hideOnSinglePage | 只有一页时是否隐藏分页器 | boolean | false | |
|
|
1325
|
+
| itemRender | 用于自定义页码的结构,可用于优化 SEO | (page, type: 'page' \| 'prev' \| 'next', originalElement) => React.ReactNode | - | |
|
|
1326
|
+
| pageSize | 每页条数 | number | - | |
|
|
1327
|
+
| pageSizeOptions | 指定每页可以显示多少条 | number[] | [ | |
|
|
1328
|
+
| responsive | 当 size 未指定时,根据屏幕宽度自动调整尺寸 | boolean | - | |
|
|
1329
|
+
| showLessItems | 是否显示较少页面内容 | boolean | false | |
|
|
1330
|
+
| showQuickJumper | 是否可以快速跳转至某页 | boolean \| { goButton: ReactNode } | false | |
|
|
1331
|
+
| showSizeChanger | 是否展示 | boolean \| | - | SelectProps: 5.21.0 |
|
|
1332
|
+
| showTitle | 是否显示原生 tooltip 页码提示 | boolean | true | |
|
|
1333
|
+
| showTotal | 用于显示数据总量和当前数据顺序 | function(total, range) | - | |
|
|
1334
|
+
| simple | 当添加该属性时,显示为简单分页 | boolean \| { readOnly?: boolean } | - | |
|
|
1335
|
+
| size | 当为 | default | default | |
|
|
1336
|
+
| total | 数据总数 | number | 0 | |
|
|
1337
|
+
| onChange | 页码或 | function(page, pageSize) | - | |
|
|
1338
|
+
| onShowSizeChange | pageSize 变化的回调 | function(current, size) | - | |
|
|
1291
1339
|
|
|
1292
1340
|
|
|
1293
1341
|
|
|
@@ -1349,53 +1397,6 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1349
1397
|
|
|
1350
1398
|
|
|
1351
1399
|
|
|
1352
|
-
<DemoTitle title="Pagination" desc="分页器用于分隔长列表,每次只加载一个页面。">
|
|
1353
|
-
## API
|
|
1354
|
-
|
|
1355
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1356
|
-
|--------|--------|--------|--------|
|
|
1357
|
-
| hideSwitchButton | 是否展示上一页/下一页的切换按钮 | boolean | false |
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
<AntdApiRef url="https://ant.design/components/pagination-cn/#api"></AntdApiRef>
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
## antd API
|
|
1364
|
-
|
|
1365
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
```jsx
|
|
1369
|
-
<Pagination onChange={onChange} total={50} />
|
|
1370
|
-
```
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1374
|
-
|--------|--------|--------|--------|--------|
|
|
1375
|
-
| align | 对齐方式 | start \| center \| end | - | 5.19.0 |
|
|
1376
|
-
| current | 当前页数 | number | - | |
|
|
1377
|
-
| defaultCurrent | 默认的当前页数 | number | 1 | |
|
|
1378
|
-
| defaultPageSize | 默认的每页条数 | number | 10 | |
|
|
1379
|
-
| disabled | 禁用分页 | boolean | - | |
|
|
1380
|
-
| hideOnSinglePage | 只有一页时是否隐藏分页器 | boolean | false | |
|
|
1381
|
-
| itemRender | 用于自定义页码的结构,可用于优化 SEO | (page, type: 'page' \| 'prev' \| 'next', originalElement) => React.ReactNode | - | |
|
|
1382
|
-
| pageSize | 每页条数 | number | - | |
|
|
1383
|
-
| pageSizeOptions | 指定每页可以显示多少条 | number[] | [ | |
|
|
1384
|
-
| responsive | 当 size 未指定时,根据屏幕宽度自动调整尺寸 | boolean | - | |
|
|
1385
|
-
| showLessItems | 是否显示较少页面内容 | boolean | false | |
|
|
1386
|
-
| showQuickJumper | 是否可以快速跳转至某页 | boolean \| { goButton: ReactNode } | false | |
|
|
1387
|
-
| showSizeChanger | 是否展示 | boolean \| | - | SelectProps: 5.21.0 |
|
|
1388
|
-
| showTitle | 是否显示原生 tooltip 页码提示 | boolean | true | |
|
|
1389
|
-
| showTotal | 用于显示数据总量和当前数据顺序 | function(total, range) | - | |
|
|
1390
|
-
| simple | 当添加该属性时,显示为简单分页 | boolean \| { readOnly?: boolean } | - | |
|
|
1391
|
-
| size | 当为 | default | default | |
|
|
1392
|
-
| total | 数据总数 | number | 0 | |
|
|
1393
|
-
| onChange | 页码或 | function(page, pageSize) | - | |
|
|
1394
|
-
| onShowSizeChange | pageSize 变化的回调 | function(current, size) | - | |
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
1400
|
<DemoTitle title="Notification" desc="用于指示任务的完成进度">
|
|
1400
1401
|
#### API
|
|
1401
1402
|
|
|
@@ -1774,43 +1775,178 @@ const confirmed = await modal.confirm({ ... });
|
|
|
1774
1775
|
|
|
1775
1776
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1776
1777
|
|--------|--------|--------|--------|--------|
|
|
1777
|
-
| addonAfter | 带标签的 input,设置后置标签 | ReactNode | - | 4.17.0 |
|
|
1778
|
-
| addonBefore | 带标签的 input,设置前置标签 | ReactNode | - | 4.17.0 |
|
|
1779
|
-
| autoFocus | 自动获取焦点 | boolean | false | - |
|
|
1780
|
-
| changeOnBlur | 是否在失去焦点时,触发 | boolean | true | 5.11.0 |
|
|
1781
|
-
| changeOnWheel | 允许鼠标滚轮改变数值 | boolean | - | 5.14.0 |
|
|
1782
|
-
| controls | 是否显示增减按钮,也可设置自定义箭头图标 | boolean \| { upIcon?: React.ReactNode; downIcon?: React.ReactNode; } | - | 4.19.0 |
|
|
1783
|
-
| decimalSeparator | 小数点 | string | - | - |
|
|
1784
|
-
| placeholder | 占位符 | string | - | |
|
|
1785
|
-
| defaultValue | 初始值 | number | - | - |
|
|
1786
|
-
| disabled | 禁用 | boolean | false | - |
|
|
1787
|
-
| formatter | 指定输入框展示值的格式 | function(value: number \| string, info: { userTyping: boolean, input: string }): string | - | info: 4.17.0 |
|
|
1788
|
-
| keyboard | 是否启用键盘快捷行为 | boolean | true | 4.12.0 |
|
|
1789
|
-
| max | 最大值 | number | | - |
|
|
1790
|
-
| min | 最小值 | number | | - |
|
|
1791
|
-
| parser | 指定从 | function(string): number | - | - |
|
|
1792
|
-
| precision | 数值精度,配置 | number | - | - |
|
|
1793
|
-
| readOnly | 只读 | boolean | false | - |
|
|
1794
|
-
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
1795
|
-
| prefix | 带有前缀图标的 input | ReactNode | - | 4.17.0 |
|
|
1796
|
-
| suffix | 带有后缀图标的 input | ReactNode | - | 5.20.0 |
|
|
1797
|
-
| size | 输入框大小 | large | - | - |
|
|
1798
|
-
| step | 每次改变步数,可以为小数 | number \| string | 1 | - |
|
|
1799
|
-
| stringMode | 字符值模式,开启后支持高精度小数。同时 | boolean | false | 4.13.0 |
|
|
1800
|
-
| value | 当前值 | number | - | - |
|
|
1801
|
-
| variant | 形态变体 | outlined | outlined | 5.13.0 \| |
|
|
1802
|
-
| onChange | 变化回调 | function(value: number \| string \| null) | - | - |
|
|
1803
|
-
| onPressEnter | 按下回车的回调 | function(e) | - | - |
|
|
1804
|
-
| onStep | 点击上下箭头的回调 | (value: number, info: { offset: number, type: 'up' \| 'down' }) => void | - | 4.7.0 |
|
|
1778
|
+
| addonAfter | 带标签的 input,设置后置标签 | ReactNode | - | 4.17.0 |
|
|
1779
|
+
| addonBefore | 带标签的 input,设置前置标签 | ReactNode | - | 4.17.0 |
|
|
1780
|
+
| autoFocus | 自动获取焦点 | boolean | false | - |
|
|
1781
|
+
| changeOnBlur | 是否在失去焦点时,触发 | boolean | true | 5.11.0 |
|
|
1782
|
+
| changeOnWheel | 允许鼠标滚轮改变数值 | boolean | - | 5.14.0 |
|
|
1783
|
+
| controls | 是否显示增减按钮,也可设置自定义箭头图标 | boolean \| { upIcon?: React.ReactNode; downIcon?: React.ReactNode; } | - | 4.19.0 |
|
|
1784
|
+
| decimalSeparator | 小数点 | string | - | - |
|
|
1785
|
+
| placeholder | 占位符 | string | - | |
|
|
1786
|
+
| defaultValue | 初始值 | number | - | - |
|
|
1787
|
+
| disabled | 禁用 | boolean | false | - |
|
|
1788
|
+
| formatter | 指定输入框展示值的格式 | function(value: number \| string, info: { userTyping: boolean, input: string }): string | - | info: 4.17.0 |
|
|
1789
|
+
| keyboard | 是否启用键盘快捷行为 | boolean | true | 4.12.0 |
|
|
1790
|
+
| max | 最大值 | number | | - |
|
|
1791
|
+
| min | 最小值 | number | | - |
|
|
1792
|
+
| parser | 指定从 | function(string): number | - | - |
|
|
1793
|
+
| precision | 数值精度,配置 | number | - | - |
|
|
1794
|
+
| readOnly | 只读 | boolean | false | - |
|
|
1795
|
+
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
1796
|
+
| prefix | 带有前缀图标的 input | ReactNode | - | 4.17.0 |
|
|
1797
|
+
| suffix | 带有后缀图标的 input | ReactNode | - | 5.20.0 |
|
|
1798
|
+
| size | 输入框大小 | large | - | - |
|
|
1799
|
+
| step | 每次改变步数,可以为小数 | number \| string | 1 | - |
|
|
1800
|
+
| stringMode | 字符值模式,开启后支持高精度小数。同时 | boolean | false | 4.13.0 |
|
|
1801
|
+
| value | 当前值 | number | - | - |
|
|
1802
|
+
| variant | 形态变体 | outlined | outlined | 5.13.0 \| |
|
|
1803
|
+
| onChange | 变化回调 | function(value: number \| string \| null) | - | - |
|
|
1804
|
+
| onPressEnter | 按下回车的回调 | function(e) | - | - |
|
|
1805
|
+
| onStep | 点击上下箭头的回调 | (value: number, info: { offset: number, type: 'up' \| 'down' }) => void | - | 4.7.0 |
|
|
1806
|
+
|
|
1807
|
+
|
|
1808
|
+
## Ref
|
|
1809
|
+
|
|
1810
|
+
| 名称 | 说明 | 参数 | 版本 |
|
|
1811
|
+
|--------|--------|--------|--------|
|
|
1812
|
+
| blur() | 移除焦点 | - | |
|
|
1813
|
+
| focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 |
|
|
1814
|
+
| nativeElement | 获取原生 DOM 元素 | - | 5.17.3 |
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
<DemoTitle title="Input" desc="通过鼠标或键盘输入内容,为表单提供输入字段的基础容器。。">
|
|
1820
|
+
#### API
|
|
1821
|
+
|
|
1822
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1823
|
+
|--------|--------|--------|--------|
|
|
1824
|
+
| shape | 形态 | 'default' \| 'round' | default 默认 |
|
|
1825
|
+
|
|
1826
|
+
|
|
1827
|
+
<AntdApiRef url="https://ant.design/components/input-cn/#api"></AntdApiRef>
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
## antd API
|
|
1831
|
+
|
|
1832
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1833
|
+
|
|
1834
|
+
### Input
|
|
1835
|
+
|
|
1836
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1837
|
+
|--------|--------|--------|--------|--------|
|
|
1838
|
+
| addonAfter | 带标签的 input,设置后置标签 | ReactNode | - | |
|
|
1839
|
+
| addonBefore | 带标签的 input,设置前置标签 | ReactNode | - | |
|
|
1840
|
+
| allowClear | 可以点击清除图标删除内容 | boolean \| { clearIcon: ReactNode } | - | |
|
|
1841
|
+
| classNames | 语义化结构 class | Record< | - | 5.4.0 |
|
|
1842
|
+
| count | 字符计数配置 | | - | 5.10.0 |
|
|
1843
|
+
| defaultValue | 输入框默认内容 | string | - | |
|
|
1844
|
+
| disabled | 是否禁用状态,默认为 false | boolean | false | |
|
|
1845
|
+
| id | 输入框的 id | string | - | |
|
|
1846
|
+
| maxLength | 最大长度 | number | - | |
|
|
1847
|
+
| prefix | 带有前缀图标的 input | ReactNode | - | |
|
|
1848
|
+
| showCount | 是否展示字数 | boolean \| { formatter: (info: { value: string, count: number, maxLength?: number }) => ReactNode } | false | 4.18.0 info.value: 4.23.0 |
|
|
1849
|
+
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
1850
|
+
| styles | 语义化结构 style | Record< | - | 5.4.0 |
|
|
1851
|
+
| size | 控件大小。注:标准表单内的输入框大小限制为 | large | - | |
|
|
1852
|
+
| suffix | 带有后缀图标的 input | ReactNode | - | |
|
|
1853
|
+
| type | 声明 input 类型,同原生 input 标签的 type 属性,见: | string | text | |
|
|
1854
|
+
| value | 输入框内容 | string | - | |
|
|
1855
|
+
| variant | 形态变体 | outlined | outlined | 5.13.0 \| |
|
|
1856
|
+
| onChange | 输入框内容变化时的回调 | function(e) | - | |
|
|
1857
|
+
| onPressEnter | 按下回车的回调 | function(e) | - | |
|
|
1858
|
+
| onClear | 按下清除按钮的回调 | () => void | - | 5.20.0 |
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
如果 `Input` 在 `Form.Item` 内,并且 `Form.Item` 设置了 `id` 属性,则 `value` `defaultValue` 和 `id` 属性会被自动设置。
|
|
1862
|
+
|
|
1863
|
+
Input 的其他属性和 React 自带的 [input](https://reactjs.org/docs/dom-elements.html#all-supported-html-attributes) 一致。
|
|
1864
|
+
|
|
1865
|
+
#### CountConfig
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
```tsx
|
|
1869
|
+
interface CountConfig {
|
|
1870
|
+
// 最大字符数,不同于原生 `maxLength`,超出后标红但不会截断
|
|
1871
|
+
max?: number;
|
|
1872
|
+
// 自定义字符计数,例如标准 emoji 长度大于 1,可以自定义计数策略将其改为 1
|
|
1873
|
+
strategy?: (value: string) => number;
|
|
1874
|
+
// 同 `showCount`
|
|
1875
|
+
show?: boolean | ((args: { value: string; count: number; maxLength?: number }) => ReactNode);
|
|
1876
|
+
// 当字符数超出 `count.max` 时的自定义裁剪逻辑,不配置时不进行裁剪
|
|
1877
|
+
exceedFormatter?: (value: string, config: { max: number }) => string;
|
|
1878
|
+
}
|
|
1879
|
+
```
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
### Input.TextArea
|
|
1883
|
+
|
|
1884
|
+
同 Input 属性,外加:
|
|
1885
|
+
|
|
1886
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1887
|
+
|--------|--------|--------|--------|--------|
|
|
1888
|
+
| autoSize | 自适应内容高度,可设置为 true \| false 或对象:{ minRows: 2, maxRows: 6 } | boolean \| object | false | |
|
|
1889
|
+
| classNames | 语义化结构 class | Record< | - | 5.4.0 |
|
|
1890
|
+
| styles | 语义化结构 style | Record< | - | 5.4.0 |
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
`Input.TextArea` 的其他属性和浏览器自带的 [textarea](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) 一致。
|
|
1894
|
+
|
|
1895
|
+
### Input.Search
|
|
1896
|
+
|
|
1897
|
+
| 参数 | 说明 | 类型 | 默认值 |
|
|
1898
|
+
|--------|--------|--------|--------|
|
|
1899
|
+
| enterButton | 是否有确认按钮,可设为按钮文字。该属性会与 | ReactNode | false |
|
|
1900
|
+
| loading | 搜索 loading | boolean | false |
|
|
1901
|
+
| onSearch | 点击搜索图标、清除图标,或按下回车键时的回调 | function(value, event, { source: "input" \| "clear" }) | - |
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
其余属性和 Input 一致。
|
|
1905
|
+
|
|
1906
|
+
### Input.Password
|
|
1907
|
+
|
|
1908
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1909
|
+
|--------|--------|--------|--------|--------|
|
|
1910
|
+
| iconRender | 自定义切换按钮 | (visible) => ReactNode | (visible) => (visible ? : ) | 4.3.0 |
|
|
1911
|
+
| visibilityToggle | 是否显示切换按钮或者控制密码显隐 | boolean \| | true | |
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
### Input.OTP
|
|
1915
|
+
|
|
1916
|
+
`5.16.0` 新增。
|
|
1917
|
+
|
|
1918
|
+
开发者注意事项:当 `mask` 属性的类型为 string 时,我们强烈推荐接收单个字符或单个 emoji,如果传入多个字符或多个 emoji,则会在控制台抛出警告。
|
|
1919
|
+
|
|
1920
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1921
|
+
|--------|--------|--------|--------|--------|
|
|
1922
|
+
| defaultValue | 默认值 | string | - | |
|
|
1923
|
+
| disabled | 是否禁用 | boolean | false | |
|
|
1924
|
+
| formatter | 格式化展示,留空字段会被 | (value: string) => string | - | |
|
|
1925
|
+
| separator | 分隔符,在指定索引的输入框后渲染分隔符 | ReactNode \|((i: number) => ReactNode) | - | 5.24.0 |
|
|
1926
|
+
| mask | 自定义展示,和 | boolean \| string | false | 5.17.0 |
|
|
1927
|
+
| length | 输入元素数量 | number | 6 | |
|
|
1928
|
+
| status | 设置校验状态 | 'error' \| 'warning' | - | |
|
|
1929
|
+
| size | 输入框大小 | small | middle | |
|
|
1930
|
+
| variant | 形态变体 | outlined | outlined | underlined |
|
|
1931
|
+
| value | 输入框内容 | string | - | |
|
|
1932
|
+
| onChange | 当输入框内容全部填充时触发回调 | (value: string) => void | - | |
|
|
1933
|
+
| onInput | 输入值变化时触发的回调 | (value: string[]) => void | - | 5.22.0 |
|
|
1934
|
+
|
|
1935
|
+
|
|
1936
|
+
#### VisibilityToggle
|
|
1937
|
+
|
|
1938
|
+
| Property | Description | Type | Default | Version |
|
|
1939
|
+
|--------|--------|--------|--------|--------|
|
|
1940
|
+
| visible | 用于手动控制密码显隐 | boolean | false | 4.24 |
|
|
1941
|
+
| onVisibleChange | 显隐密码的回调 | (visible) => void | - | 4.24 |
|
|
1805
1942
|
|
|
1806
1943
|
|
|
1807
|
-
|
|
1944
|
+
#### Input Methods
|
|
1808
1945
|
|
|
1809
1946
|
| 名称 | 说明 | 参数 | 版本 |
|
|
1810
1947
|
|--------|--------|--------|--------|
|
|
1811
|
-
| blur
|
|
1812
|
-
| focus
|
|
1813
|
-
| nativeElement | 获取原生 DOM 元素 | - | 5.17.3 |
|
|
1948
|
+
| blur | 取消焦点 | - | |
|
|
1949
|
+
| focus | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | option - 4.10.0 |
|
|
1814
1950
|
|
|
1815
1951
|
|
|
1816
1952
|
|
|
@@ -2028,141 +2164,6 @@ type PresetColors = 'blue' | 'purple' | 'cyan' | 'green' | 'magenta' | 'pink' |
|
|
|
2028
2164
|
|
|
2029
2165
|
|
|
2030
2166
|
|
|
2031
|
-
<DemoTitle title="Input" desc="通过鼠标或键盘输入内容,为表单提供输入字段的基础容器。。">
|
|
2032
|
-
#### API
|
|
2033
|
-
|
|
2034
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
2035
|
-
|--------|--------|--------|--------|
|
|
2036
|
-
| shape | 形态 | 'default' \| 'round' | default 默认 |
|
|
2037
|
-
|
|
2038
|
-
|
|
2039
|
-
<AntdApiRef url="https://ant.design/components/input-cn/#api"></AntdApiRef>
|
|
2040
|
-
|
|
2041
|
-
|
|
2042
|
-
## antd API
|
|
2043
|
-
|
|
2044
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
2045
|
-
|
|
2046
|
-
### Input
|
|
2047
|
-
|
|
2048
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2049
|
-
|--------|--------|--------|--------|--------|
|
|
2050
|
-
| addonAfter | 带标签的 input,设置后置标签 | ReactNode | - | |
|
|
2051
|
-
| addonBefore | 带标签的 input,设置前置标签 | ReactNode | - | |
|
|
2052
|
-
| allowClear | 可以点击清除图标删除内容 | boolean \| { clearIcon: ReactNode } | - | |
|
|
2053
|
-
| classNames | 语义化结构 class | Record< | - | 5.4.0 |
|
|
2054
|
-
| count | 字符计数配置 | | - | 5.10.0 |
|
|
2055
|
-
| defaultValue | 输入框默认内容 | string | - | |
|
|
2056
|
-
| disabled | 是否禁用状态,默认为 false | boolean | false | |
|
|
2057
|
-
| id | 输入框的 id | string | - | |
|
|
2058
|
-
| maxLength | 最大长度 | number | - | |
|
|
2059
|
-
| prefix | 带有前缀图标的 input | ReactNode | - | |
|
|
2060
|
-
| showCount | 是否展示字数 | boolean \| { formatter: (info: { value: string, count: number, maxLength?: number }) => ReactNode } | false | 4.18.0 info.value: 4.23.0 |
|
|
2061
|
-
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
2062
|
-
| styles | 语义化结构 style | Record< | - | 5.4.0 |
|
|
2063
|
-
| size | 控件大小。注:标准表单内的输入框大小限制为 | large | - | |
|
|
2064
|
-
| suffix | 带有后缀图标的 input | ReactNode | - | |
|
|
2065
|
-
| type | 声明 input 类型,同原生 input 标签的 type 属性,见: | string | text | |
|
|
2066
|
-
| value | 输入框内容 | string | - | |
|
|
2067
|
-
| variant | 形态变体 | outlined | outlined | 5.13.0 \| |
|
|
2068
|
-
| onChange | 输入框内容变化时的回调 | function(e) | - | |
|
|
2069
|
-
| onPressEnter | 按下回车的回调 | function(e) | - | |
|
|
2070
|
-
| onClear | 按下清除按钮的回调 | () => void | - | 5.20.0 |
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
如果 `Input` 在 `Form.Item` 内,并且 `Form.Item` 设置了 `id` 属性,则 `value` `defaultValue` 和 `id` 属性会被自动设置。
|
|
2074
|
-
|
|
2075
|
-
Input 的其他属性和 React 自带的 [input](https://reactjs.org/docs/dom-elements.html#all-supported-html-attributes) 一致。
|
|
2076
|
-
|
|
2077
|
-
#### CountConfig
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
```tsx
|
|
2081
|
-
interface CountConfig {
|
|
2082
|
-
// 最大字符数,不同于原生 `maxLength`,超出后标红但不会截断
|
|
2083
|
-
max?: number;
|
|
2084
|
-
// 自定义字符计数,例如标准 emoji 长度大于 1,可以自定义计数策略将其改为 1
|
|
2085
|
-
strategy?: (value: string) => number;
|
|
2086
|
-
// 同 `showCount`
|
|
2087
|
-
show?: boolean | ((args: { value: string; count: number; maxLength?: number }) => ReactNode);
|
|
2088
|
-
// 当字符数超出 `count.max` 时的自定义裁剪逻辑,不配置时不进行裁剪
|
|
2089
|
-
exceedFormatter?: (value: string, config: { max: number }) => string;
|
|
2090
|
-
}
|
|
2091
|
-
```
|
|
2092
|
-
|
|
2093
|
-
|
|
2094
|
-
### Input.TextArea
|
|
2095
|
-
|
|
2096
|
-
同 Input 属性,外加:
|
|
2097
|
-
|
|
2098
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2099
|
-
|--------|--------|--------|--------|--------|
|
|
2100
|
-
| autoSize | 自适应内容高度,可设置为 true \| false 或对象:{ minRows: 2, maxRows: 6 } | boolean \| object | false | |
|
|
2101
|
-
| classNames | 语义化结构 class | Record< | - | 5.4.0 |
|
|
2102
|
-
| styles | 语义化结构 style | Record< | - | 5.4.0 |
|
|
2103
|
-
|
|
2104
|
-
|
|
2105
|
-
`Input.TextArea` 的其他属性和浏览器自带的 [textarea](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) 一致。
|
|
2106
|
-
|
|
2107
|
-
### Input.Search
|
|
2108
|
-
|
|
2109
|
-
| 参数 | 说明 | 类型 | 默认值 |
|
|
2110
|
-
|--------|--------|--------|--------|
|
|
2111
|
-
| enterButton | 是否有确认按钮,可设为按钮文字。该属性会与 | ReactNode | false |
|
|
2112
|
-
| loading | 搜索 loading | boolean | false |
|
|
2113
|
-
| onSearch | 点击搜索图标、清除图标,或按下回车键时的回调 | function(value, event, { source: "input" \| "clear" }) | - |
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
其余属性和 Input 一致。
|
|
2117
|
-
|
|
2118
|
-
### Input.Password
|
|
2119
|
-
|
|
2120
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2121
|
-
|--------|--------|--------|--------|--------|
|
|
2122
|
-
| iconRender | 自定义切换按钮 | (visible) => ReactNode | (visible) => (visible ? : ) | 4.3.0 |
|
|
2123
|
-
| visibilityToggle | 是否显示切换按钮或者控制密码显隐 | boolean \| | true | |
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
### Input.OTP
|
|
2127
|
-
|
|
2128
|
-
`5.16.0` 新增。
|
|
2129
|
-
|
|
2130
|
-
开发者注意事项:当 `mask` 属性的类型为 string 时,我们强烈推荐接收单个字符或单个 emoji,如果传入多个字符或多个 emoji,则会在控制台抛出警告。
|
|
2131
|
-
|
|
2132
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2133
|
-
|--------|--------|--------|--------|--------|
|
|
2134
|
-
| defaultValue | 默认值 | string | - | |
|
|
2135
|
-
| disabled | 是否禁用 | boolean | false | |
|
|
2136
|
-
| formatter | 格式化展示,留空字段会被 | (value: string) => string | - | |
|
|
2137
|
-
| separator | 分隔符,在指定索引的输入框后渲染分隔符 | ReactNode \|((i: number) => ReactNode) | - | 5.24.0 |
|
|
2138
|
-
| mask | 自定义展示,和 | boolean \| string | false | 5.17.0 |
|
|
2139
|
-
| length | 输入元素数量 | number | 6 | |
|
|
2140
|
-
| status | 设置校验状态 | 'error' \| 'warning' | - | |
|
|
2141
|
-
| size | 输入框大小 | small | middle | |
|
|
2142
|
-
| variant | 形态变体 | outlined | outlined | underlined |
|
|
2143
|
-
| value | 输入框内容 | string | - | |
|
|
2144
|
-
| onChange | 当输入框内容全部填充时触发回调 | (value: string) => void | - | |
|
|
2145
|
-
| onInput | 输入值变化时触发的回调 | (value: string[]) => void | - | 5.22.0 |
|
|
2146
|
-
|
|
2147
|
-
|
|
2148
|
-
#### VisibilityToggle
|
|
2149
|
-
|
|
2150
|
-
| Property | Description | Type | Default | Version |
|
|
2151
|
-
|--------|--------|--------|--------|--------|
|
|
2152
|
-
| visible | 用于手动控制密码显隐 | boolean | false | 4.24 |
|
|
2153
|
-
| onVisibleChange | 显隐密码的回调 | (visible) => void | - | 4.24 |
|
|
2154
|
-
|
|
2155
|
-
|
|
2156
|
-
#### Input Methods
|
|
2157
|
-
|
|
2158
|
-
| 名称 | 说明 | 参数 | 版本 |
|
|
2159
|
-
|--------|--------|--------|--------|
|
|
2160
|
-
| blur | 取消焦点 | - | |
|
|
2161
|
-
| focus | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | option - 4.10.0 |
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
2167
|
<DemoTitle title="Form" desc="高性能表单控件,自带数据域管理。包含数据录入、校验以及对应样式。">
|
|
2167
2168
|
#### API
|
|
2168
2169
|
|
|
@@ -2776,48 +2777,6 @@ type Rule = RuleConfig | ((form: FormInstance) => RuleConfig);
|
|
|
2776
2777
|
|
|
2777
2778
|
|
|
2778
2779
|
|
|
2779
|
-
<DemoTitle title="Empty" desc="用于空状态的占位图形展示。">
|
|
2780
|
-
## API
|
|
2781
|
-
|
|
2782
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
2783
|
-
|--------|--------|--------|--------|
|
|
2784
|
-
| type | 空状态类型 | \| 'noData'
|
|
2785
|
-
\| 'networkError'
|
|
2786
|
-
\| '404'
|
|
2787
|
-
\| 'arrears'
|
|
2788
|
-
\| 'desktopOnly'
|
|
2789
|
-
\| 'noAudio'
|
|
2790
|
-
\| 'noImage'
|
|
2791
|
-
\| 'noVideo'
|
|
2792
|
-
\| 'noAccess'
|
|
2793
|
-
\| 'error'
|
|
2794
|
-
\| 'noModel'
|
|
2795
|
-
\| 'noApp'
|
|
2796
|
-
\| 'success'
|
|
2797
|
-
\| 'failed'
|
|
2798
|
-
\| 'inProgress'
|
|
2799
|
-
\| 'stayTuned' | 'noData' |
|
|
2800
|
-
| texture | 是否显示纹理 | boolean | true |
|
|
2801
|
-
| image | 图片地址 | string | 默认是no data的图片 |
|
|
2802
|
-
| imageStyle | 图片样式 | React.CSSProperties | |
|
|
2803
|
-
| title | 标题内容 | React.ReactNode | |
|
|
2804
|
-
| description | 自定义描述内容 | React.ReactNode | |
|
|
2805
|
-
| onOk | ok按钮的点击事件 | (e: React.MouseEvent) => void | |
|
|
2806
|
-
| okText | ok按钮的文本 | React.ReactNode | |
|
|
2807
|
-
| okType | ok按钮的类型 | SparkButtonProps['type'] | 'primary' |
|
|
2808
|
-
| okButtonProps | ok按钮的props | SparkButtonProps | |
|
|
2809
|
-
| children | 自定义空状态的内容 | React.ReactNode | |
|
|
2810
|
-
| className | 自定义空状态的类名 | string | |
|
|
2811
|
-
| style | 自定义空状态的样式 | React.CSSProperties | |
|
|
2812
|
-
| size | 自定义空状态的大小 | React.CSSProperties['width'] | |
|
|
2813
|
-
|
|
2814
|
-
|
|
2815
|
-
<AntdApiRef url="https://ant.design/components/empty-cn/#api"></AntdApiRef>
|
|
2816
|
-
|
|
2817
|
-
|
|
2818
|
-
|
|
2819
|
-
|
|
2820
|
-
|
|
2821
2780
|
<DemoTitle title="Dropdown" desc="向下弹出的列表。">
|
|
2822
2781
|
#### API
|
|
2823
2782
|
|
|
@@ -2969,6 +2928,49 @@ const dividerItem = {
|
|
|
2969
2928
|
|
|
2970
2929
|
|
|
2971
2930
|
|
|
2931
|
+
<DemoTitle title="Empty" desc="用于空状态的占位图形展示。">
|
|
2932
|
+
## API
|
|
2933
|
+
|
|
2934
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
2935
|
+
|--------|--------|--------|--------|
|
|
2936
|
+
| type | 空状态类型 | \| 'noData'
|
|
2937
|
+
\| 'networkError'
|
|
2938
|
+
\| '404'
|
|
2939
|
+
\| 'arrears'
|
|
2940
|
+
\| 'desktopOnly'
|
|
2941
|
+
\| 'noAudio'
|
|
2942
|
+
\| 'noImage'
|
|
2943
|
+
\| 'noVideo'
|
|
2944
|
+
\| 'noAccess'
|
|
2945
|
+
\| 'error'
|
|
2946
|
+
\| 'noModel'
|
|
2947
|
+
\| 'noApp'
|
|
2948
|
+
\| 'success'
|
|
2949
|
+
\| 'failed'
|
|
2950
|
+
\| 'inProgress'
|
|
2951
|
+
\| 'stayTuned' | 'noData' |
|
|
2952
|
+
| texture | 是否显示纹理 | boolean | true |
|
|
2953
|
+
| image | 图片地址 | string | 默认是no data的图片 |
|
|
2954
|
+
| imageStyle | 图片样式 | React.CSSProperties | |
|
|
2955
|
+
| title | 标题内容 | React.ReactNode | |
|
|
2956
|
+
| description | 自定义描述内容 | React.ReactNode | |
|
|
2957
|
+
| onOk | ok按钮的点击事件 | (e: React.MouseEvent) => void | |
|
|
2958
|
+
| okText | ok按钮的文本 | React.ReactNode | |
|
|
2959
|
+
| okType | ok按钮的类型 | SparkButtonProps['type'] | 'primary' |
|
|
2960
|
+
| okButtonProps | ok按钮的props | SparkButtonProps | |
|
|
2961
|
+
| children | 自定义空状态的内容 | React.ReactNode | |
|
|
2962
|
+
| className | 自定义空状态的类名 | string | |
|
|
2963
|
+
| style | 自定义空状态的样式 | React.CSSProperties | |
|
|
2964
|
+
| size | 自定义空状态的大小 | React.CSSProperties['width'] | |
|
|
2965
|
+
| autoFit | 是否自适应容器宽度,当容器宽度小于 size 时自动缩放 | boolean | false |
|
|
2966
|
+
|
|
2967
|
+
|
|
2968
|
+
<AntdApiRef url="https://ant.design/components/empty-cn/#api"></AntdApiRef>
|
|
2969
|
+
|
|
2970
|
+
|
|
2971
|
+
|
|
2972
|
+
|
|
2973
|
+
|
|
2972
2974
|
<DemoTitle title="Drawer" desc="从页面一侧滑入的操作面板,用于承载临时界面内容。">
|
|
2973
2975
|
#### API
|
|
2974
2976
|
|
|
@@ -3364,21 +3366,6 @@ export type FormatType =
|
|
|
3364
3366
|
|
|
3365
3367
|
|
|
3366
3368
|
|
|
3367
|
-
<DemoTitle title="CodeBlock" desc="代码块">
|
|
3368
|
-
#### API
|
|
3369
|
-
|
|
3370
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3371
|
-
|--------|--------|--------|--------|
|
|
3372
|
-
| language | 语言 | string \| string[] | (必填) |
|
|
3373
|
-
| value | 值 | string | (必填) |
|
|
3374
|
-
| className | 类名 | string | |
|
|
3375
|
-
| theme | 主题 | 'dark' \| 'light' | |
|
|
3376
|
-
| readOnly | 只读 | boolean | |
|
|
3377
|
-
| onChange | | (value: string) => void | |
|
|
3378
|
-
|
|
3379
|
-
|
|
3380
|
-
|
|
3381
|
-
|
|
3382
3369
|
<DemoTitle title="Collapse" desc="可以折叠/展开的内容区域">
|
|
3383
3370
|
#### API
|
|
3384
3371
|
|
|
@@ -3437,6 +3424,21 @@ export type FormatType =
|
|
|
3437
3424
|
|
|
3438
3425
|
|
|
3439
3426
|
|
|
3427
|
+
<DemoTitle title="CodeBlock" desc="代码块">
|
|
3428
|
+
#### API
|
|
3429
|
+
|
|
3430
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3431
|
+
|--------|--------|--------|--------|
|
|
3432
|
+
| language | 语言 | string \| string[] | (必填) |
|
|
3433
|
+
| value | 值 | string | (必填) |
|
|
3434
|
+
| className | 类名 | string | |
|
|
3435
|
+
| theme | 主题 | 'dark' \| 'light' | |
|
|
3436
|
+
| readOnly | 只读 | boolean | |
|
|
3437
|
+
| onChange | | (value: string) => void | |
|
|
3438
|
+
|
|
3439
|
+
|
|
3440
|
+
|
|
3441
|
+
|
|
3440
3442
|
<DemoTitle title="Checkbox" desc="收集用户的多项选择。">
|
|
3441
3443
|
#### API
|
|
3442
3444
|
|
|
@@ -4387,6 +4389,32 @@ export default App;
|
|
|
4387
4389
|
|
|
4388
4390
|
|
|
4389
4391
|
|
|
4392
|
+
# 使用
|
|
4393
|
+
|
|
4394
|
+
|
|
4395
|
+
|
|
4396
|
+
```tsx
|
|
4397
|
+
import { SparkLoadingLine } from '@agentscope-ai/icons';
|
|
4398
|
+
|
|
4399
|
+
export default () => {
|
|
4400
|
+
return (
|
|
4401
|
+
<SparkLoadingLine
|
|
4402
|
+
className="your-class-name"
|
|
4403
|
+
style={{ color: 'var(--sps-color-primary)' }}
|
|
4404
|
+
spin
|
|
4405
|
+
size={48}
|
|
4406
|
+
/>
|
|
4407
|
+
);
|
|
4408
|
+
};
|
|
4409
|
+
|
|
4410
|
+
```
|
|
4411
|
+
|
|
4412
|
+
基本用法
|
|
4413
|
+
|
|
4414
|
+
访问 [Icon Library](https://sparkdesign.agentscope.io/#/resources/icons) 查看全部 Icon
|
|
4415
|
+
|
|
4416
|
+
|
|
4417
|
+
|
|
4390
4418
|
# Vibe 编程
|
|
4391
4419
|
|
|
4392
4420
|
## LLMs.txt
|
|
@@ -4417,6 +4445,91 @@ export default App;
|
|
|
4417
4445
|
|
|
4418
4446
|
|
|
4419
4447
|
|
|
4448
|
+
# 从零开始使用
|
|
4449
|
+
|
|
4450
|
+
## 📦 安装
|
|
4451
|
+
|
|
4452
|
+
|
|
4453
|
+
```bash
|
|
4454
|
+
$ npm install antd @agentscope-ai/icons @agentscope-ai/design --save
|
|
4455
|
+
```
|
|
4456
|
+
|
|
4457
|
+
|
|
4458
|
+
## 🔨 使用
|
|
4459
|
+
|
|
4460
|
+
|
|
4461
|
+
```tsx
|
|
4462
|
+
import {
|
|
4463
|
+
Button,
|
|
4464
|
+
Image,
|
|
4465
|
+
ConfigProvider,
|
|
4466
|
+
purpleDarkTheme,
|
|
4467
|
+
purpleTheme,
|
|
4468
|
+
} from '@agentscope-ai/design';
|
|
4469
|
+
import { SparkSunLine, SparkMoonLine } from '@agentscope-ai/icons';
|
|
4470
|
+
import { Flex } from 'antd';
|
|
4471
|
+
import zhCN from 'antd/locale/zh_CN';
|
|
4472
|
+
import { useState } from 'react';
|
|
4473
|
+
|
|
4474
|
+
const App = () => {
|
|
4475
|
+
const [colorMode, setColorMode] = useState('light');
|
|
4476
|
+
const theme = colorMode === 'light' ? purpleTheme : purpleDarkTheme;
|
|
4477
|
+
|
|
4478
|
+
const prefix = 'sps';
|
|
4479
|
+
return (
|
|
4480
|
+
<ConfigProvider
|
|
4481
|
+
{...theme} // 您可以从 purpleTheme、purpleDarkTheme、carbonTheme 和 carbonDarkTheme 中选择
|
|
4482
|
+
prefix={prefix} // Ant Design 和 @agentscope-ai/design 的前缀
|
|
4483
|
+
prefixCls={prefix}
|
|
4484
|
+
iconfont="//at.alicdn.com/t/a/font_4807885_ugexdeaoq7.js" // 可选参数,您可以从 https://www.iconfont.cn/ 获取
|
|
4485
|
+
locale={zhCN} // 来自 Ant Design 的语言包
|
|
4486
|
+
style={{
|
|
4487
|
+
width: '100%',
|
|
4488
|
+
height: '100%',
|
|
4489
|
+
}}
|
|
4490
|
+
>
|
|
4491
|
+
<div
|
|
4492
|
+
style={{
|
|
4493
|
+
width: '100%',
|
|
4494
|
+
height: '100%',
|
|
4495
|
+
backgroundColor: `var(--${prefix}-color-bg-base)`,
|
|
4496
|
+
}}
|
|
4497
|
+
>
|
|
4498
|
+
<Flex vertical gap={16} align="center" style={{ padding: '12px 0' }}>
|
|
4499
|
+
<Image
|
|
4500
|
+
width={120}
|
|
4501
|
+
src="https://img.alicdn.com/imgextra/i1/O1CN01Py27NU1re2pgohzqU_!!6000000005655-0-tps-480-480.jpg"
|
|
4502
|
+
/>
|
|
4503
|
+
<div
|
|
4504
|
+
style={{
|
|
4505
|
+
color: `var(--${prefix}-ant-color-text-base)`,
|
|
4506
|
+
fontSize: '24px',
|
|
4507
|
+
textAlign: 'center',
|
|
4508
|
+
}}
|
|
4509
|
+
>
|
|
4510
|
+
Hello Spark Design!
|
|
4511
|
+
</div>
|
|
4512
|
+
<Button
|
|
4513
|
+
type="primary"
|
|
4514
|
+
onClick={() => {
|
|
4515
|
+
setColorMode(colorMode === 'light' ? 'dark' : 'light');
|
|
4516
|
+
}}
|
|
4517
|
+
icon={colorMode === 'light' ? <SparkMoonLine /> : <SparkSunLine />}
|
|
4518
|
+
>
|
|
4519
|
+
{colorMode === 'light' ? '暗色' : '亮色'} 模式
|
|
4520
|
+
</Button>
|
|
4521
|
+
</Flex>
|
|
4522
|
+
</div>
|
|
4523
|
+
</ConfigProvider>
|
|
4524
|
+
);
|
|
4525
|
+
};
|
|
4526
|
+
|
|
4527
|
+
export default App;
|
|
4528
|
+
```
|
|
4529
|
+
|
|
4530
|
+
|
|
4531
|
+
|
|
4532
|
+
|
|
4420
4533
|
# Tokens
|
|
4421
4534
|
|
|
4422
4535
|
除了来自 [antd](https://ant.design/theme-editor) 的固有 tokens 之外,Spark Design 在原有基础上扩展了更多变量。完整的 token 示例如下所示:
|
|
@@ -4432,7 +4545,7 @@ export default App;
|
|
|
4432
4545
|
"borderRadiusXL": 12,
|
|
4433
4546
|
"borderRadiusFull": 999,
|
|
4434
4547
|
"wireframe": false,
|
|
4435
|
-
"colorPrimaryBg": "
|
|
4548
|
+
"colorPrimaryBg": "rgba(97, 92, 237, 0.08)",
|
|
4436
4549
|
"colorPrimaryBgHover": "#F2F0FF",
|
|
4437
4550
|
"colorPrimaryBorder": "#E2DEFF",
|
|
4438
4551
|
"colorPrimaryBorderHover": "#BCB5FF",
|
|
@@ -4487,7 +4600,9 @@ export default App;
|
|
|
4487
4600
|
"colorLink": "#615CED",
|
|
4488
4601
|
"boxShadow": "0px 4px 6px 0px rgba(0, 0, 0, 0.08)",
|
|
4489
4602
|
"boxShadowSecondary": "0px 12px 24px -16px rgba(0, 0, 0, 0.06),0px 8px 40px 0px rgba(0, 0, 0, 0.12),0px 0px 1px 0px rgba(0, 0, 0, 0.04)",
|
|
4490
|
-
|
|
4603
|
+
|
|
4604
|
+
"colorTextWhite": "#ffffff",
|
|
4605
|
+
"colorTextOnPrimary": "#ffffff",
|
|
4491
4606
|
"colorFillDisable": "#DBDAE7",
|
|
4492
4607
|
"colorPurple": "#615CED",
|
|
4493
4608
|
"colorPurpleHover": "#8080FF",
|
|
@@ -4589,7 +4704,9 @@ export default App;
|
|
|
4589
4704
|
"colorLink": "#5551CC",
|
|
4590
4705
|
"boxShadow": "0px 4px 6px 0px rgba(255, 255, 255, 0.08)",
|
|
4591
4706
|
"boxShadowSecondary": "0px 12px 24px -16px rgba(255, 255, 255, 0.04),0px 8px 40px 0px rgba(255, 255, 255, 0.06),0px 0px 1px 0px rgba(255, 255, 255, 0.02)",
|
|
4592
|
-
|
|
4707
|
+
|
|
4708
|
+
"colorTextWhite": "#fff",
|
|
4709
|
+
"colorTextOnPrimary": "#fff",
|
|
4593
4710
|
"colorFillDisable": "#8D8C98",
|
|
4594
4711
|
"colorPurple": "#5551CC",
|
|
4595
4712
|
"colorPurpleHover": "#8383F0",
|
|
@@ -4692,7 +4809,9 @@ export default App;
|
|
|
4692
4809
|
"colorLink": "rgba(0, 77, 255, 1)",
|
|
4693
4810
|
"boxShadow": "0px 4px 6px 0px rgba(0, 0, 0, 0.08)",
|
|
4694
4811
|
"boxShadowSecondary": "0px 12px 24px -16px rgba(0, 0, 0, 0.06),0px 8px 40px 0px rgba(0, 0, 0, 0.12),0px 0px 1px 0px rgba(0, 0, 0, 0.04)",
|
|
4695
|
-
|
|
4812
|
+
|
|
4813
|
+
"colorTextWhite": "#ffffff",
|
|
4814
|
+
"colorTextOnPrimary": "#ffffff",
|
|
4696
4815
|
"colorFillDisable": "rgba(232, 232, 235, 1)",
|
|
4697
4816
|
"colorPurple": "rgba(97, 92, 237, 1)",
|
|
4698
4817
|
"colorPurpleHover": "#8080FF",
|
|
@@ -4791,7 +4910,9 @@ export default App;
|
|
|
4791
4910
|
"colorLink": "#4D7DFF",
|
|
4792
4911
|
"boxShadow": "0px 4px 6px 0px rgba(255, 255, 255, 0.08)",
|
|
4793
4912
|
"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)",
|
|
4794
|
-
|
|
4913
|
+
|
|
4914
|
+
"colorTextWhite": "#ffffff",
|
|
4915
|
+
"colorTextOnPrimary": "#000000",
|
|
4795
4916
|
"colorFillDisable": "#898989",
|
|
4796
4917
|
"colorPurple": "#615CED",
|
|
4797
4918
|
"colorPurpleHover": "#8383F0",
|
|
@@ -4840,115 +4961,3 @@ Spark Design 默认启用 cssVar 模式,因此您可以利用 从 token 派生
|
|
|
4840
4961
|
}
|
|
4841
4962
|
// 提示:您可以将 'sps' 替换为您自己的前缀
|
|
4842
4963
|
```
|
|
4843
|
-
|
|
4844
|
-
|
|
4845
|
-
|
|
4846
|
-
|
|
4847
|
-
# 从零开始使用
|
|
4848
|
-
|
|
4849
|
-
## 📦 安装
|
|
4850
|
-
|
|
4851
|
-
|
|
4852
|
-
```bash
|
|
4853
|
-
$ npm install antd @agentscope-ai/icons @agentscope-ai/design --save
|
|
4854
|
-
```
|
|
4855
|
-
|
|
4856
|
-
|
|
4857
|
-
## 🔨 使用
|
|
4858
|
-
|
|
4859
|
-
|
|
4860
|
-
```tsx
|
|
4861
|
-
import {
|
|
4862
|
-
Button,
|
|
4863
|
-
Image,
|
|
4864
|
-
ConfigProvider,
|
|
4865
|
-
purpleDarkTheme,
|
|
4866
|
-
purpleTheme,
|
|
4867
|
-
} from '@agentscope-ai/design';
|
|
4868
|
-
import { SparkSunLine, SparkMoonLine } from '@agentscope-ai/icons';
|
|
4869
|
-
import { Flex } from 'antd';
|
|
4870
|
-
import zhCN from 'antd/locale/zh_CN';
|
|
4871
|
-
import { useState } from 'react';
|
|
4872
|
-
|
|
4873
|
-
const App = () => {
|
|
4874
|
-
const [colorMode, setColorMode] = useState('light');
|
|
4875
|
-
const theme = colorMode === 'light' ? purpleTheme : purpleDarkTheme;
|
|
4876
|
-
|
|
4877
|
-
const prefix = 'sps';
|
|
4878
|
-
return (
|
|
4879
|
-
<ConfigProvider
|
|
4880
|
-
{...theme} // 您可以从 purpleTheme、purpleDarkTheme、carbonTheme 和 carbonDarkTheme 中选择
|
|
4881
|
-
prefix={prefix} // Ant Design 和 @agentscope-ai/design 的前缀
|
|
4882
|
-
prefixCls={prefix}
|
|
4883
|
-
iconfont="//at.alicdn.com/t/a/font_4807885_ugexdeaoq7.js" // 可选参数,您可以从 https://www.iconfont.cn/ 获取
|
|
4884
|
-
locale={zhCN} // 来自 Ant Design 的语言包
|
|
4885
|
-
style={{
|
|
4886
|
-
width: '100%',
|
|
4887
|
-
height: '100%',
|
|
4888
|
-
}}
|
|
4889
|
-
>
|
|
4890
|
-
<div
|
|
4891
|
-
style={{
|
|
4892
|
-
width: '100%',
|
|
4893
|
-
height: '100%',
|
|
4894
|
-
backgroundColor: `var(--${prefix}-color-bg-base)`,
|
|
4895
|
-
}}
|
|
4896
|
-
>
|
|
4897
|
-
<Flex vertical gap={16} align="center" style={{ padding: '12px 0' }}>
|
|
4898
|
-
<Image
|
|
4899
|
-
width={120}
|
|
4900
|
-
src="https://img.alicdn.com/imgextra/i1/O1CN01Py27NU1re2pgohzqU_!!6000000005655-0-tps-480-480.jpg"
|
|
4901
|
-
/>
|
|
4902
|
-
<div
|
|
4903
|
-
style={{
|
|
4904
|
-
color: `var(--${prefix}-ant-color-text-base)`,
|
|
4905
|
-
fontSize: '24px',
|
|
4906
|
-
textAlign: 'center',
|
|
4907
|
-
}}
|
|
4908
|
-
>
|
|
4909
|
-
Hello Spark Design!
|
|
4910
|
-
</div>
|
|
4911
|
-
<Button
|
|
4912
|
-
type="primary"
|
|
4913
|
-
onClick={() => {
|
|
4914
|
-
setColorMode(colorMode === 'light' ? 'dark' : 'light');
|
|
4915
|
-
}}
|
|
4916
|
-
icon={colorMode === 'light' ? <SparkMoonLine /> : <SparkSunLine />}
|
|
4917
|
-
>
|
|
4918
|
-
{colorMode === 'light' ? '暗色' : '亮色'} 模式
|
|
4919
|
-
</Button>
|
|
4920
|
-
</Flex>
|
|
4921
|
-
</div>
|
|
4922
|
-
</ConfigProvider>
|
|
4923
|
-
);
|
|
4924
|
-
};
|
|
4925
|
-
|
|
4926
|
-
export default App;
|
|
4927
|
-
```
|
|
4928
|
-
|
|
4929
|
-
|
|
4930
|
-
|
|
4931
|
-
|
|
4932
|
-
# 使用
|
|
4933
|
-
|
|
4934
|
-
|
|
4935
|
-
|
|
4936
|
-
```tsx
|
|
4937
|
-
import { SparkLoadingLine } from '@agentscope-ai/icons';
|
|
4938
|
-
|
|
4939
|
-
export default () => {
|
|
4940
|
-
return (
|
|
4941
|
-
<SparkLoadingLine
|
|
4942
|
-
className="your-class-name"
|
|
4943
|
-
style={{ color: 'var(--sps-color-primary)' }}
|
|
4944
|
-
spin
|
|
4945
|
-
size={48}
|
|
4946
|
-
/>
|
|
4947
|
-
);
|
|
4948
|
-
};
|
|
4949
|
-
|
|
4950
|
-
```
|
|
4951
|
-
|
|
4952
|
-
基本用法
|
|
4953
|
-
|
|
4954
|
-
访问 [Icon Library](https://sparkdesign.agentscope.io/#/resources/icons) 查看全部 Icon
|