@agentscope-ai/design 1.0.15-rc.1 → 1.0.16-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/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/llms/all.llms.txt +614 -614
- package/llms/index.llms.txt +47 -47
- package/package.json +3 -3
package/llms/all.llms.txt
CHANGED
|
@@ -151,41 +151,6 @@
|
|
|
151
151
|
|
|
152
152
|
|
|
153
153
|
|
|
154
|
-
<DemoTitle title="Tag" desc="进行标记和分类的小标签">
|
|
155
|
-
#### API
|
|
156
|
-
|
|
157
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
158
|
-
|--------|--------|--------|--------|
|
|
159
|
-
| size | 尺寸 | 'small' \| 'middle' | 'middle' |
|
|
160
|
-
| color | 标签色 | SparkTagColors \| string | 'purple' |
|
|
161
|
-
|
|
162
|
-
<AntdApiRef url="https://ant.design/components/tag-cn/#api"></AntdApiRef>
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
## antd API
|
|
166
|
-
|
|
167
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
168
|
-
|
|
169
|
-
### Tag
|
|
170
|
-
|
|
171
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
172
|
-
|--------|--------|--------|--------|--------|
|
|
173
|
-
| closeIcon | 自定义关闭按钮。5.7.0:设置为 | ReactNode | false | 4.4.0 |
|
|
174
|
-
| icon | 设置图标 | ReactNode | - | |
|
|
175
|
-
| bordered | 是否有边框 | boolean | true | 5.4.0 |
|
|
176
|
-
| onClose | 关闭时的回调(可通过 | (e: React.MouseEvent) => void | - | |
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
### Tag.CheckableTag
|
|
180
|
-
|
|
181
|
-
| 参数 | 说明 | 类型 | 默认值 |
|
|
182
|
-
|--------|--------|--------|--------|
|
|
183
|
-
| checked | 设置标签的选中状态 | boolean | false |
|
|
184
|
-
| onChange | 点击标签时触发的回调 | (checked) => void | - |
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
154
|
<DemoTitle title="TimePicker" desc="输入或选择时间的控件。">
|
|
190
155
|
#### API
|
|
191
156
|
|
|
@@ -299,6 +264,41 @@ type RangeDisabledTime = (
|
|
|
299
264
|
|
|
300
265
|
|
|
301
266
|
|
|
267
|
+
<DemoTitle title="Tag" desc="进行标记和分类的小标签">
|
|
268
|
+
#### API
|
|
269
|
+
|
|
270
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
271
|
+
|--------|--------|--------|--------|
|
|
272
|
+
| size | 尺寸 | 'small' \| 'middle' | 'middle' |
|
|
273
|
+
| color | 标签色 | SparkTagColors \| string | 'purple' |
|
|
274
|
+
|
|
275
|
+
<AntdApiRef url="https://ant.design/components/tag-cn/#api"></AntdApiRef>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
## antd API
|
|
279
|
+
|
|
280
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
281
|
+
|
|
282
|
+
### Tag
|
|
283
|
+
|
|
284
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
285
|
+
|--------|--------|--------|--------|--------|
|
|
286
|
+
| closeIcon | 自定义关闭按钮。5.7.0:设置为 | ReactNode | false | 4.4.0 |
|
|
287
|
+
| icon | 设置图标 | ReactNode | - | |
|
|
288
|
+
| bordered | 是否有边框 | boolean | true | 5.4.0 |
|
|
289
|
+
| onClose | 关闭时的回调(可通过 | (e: React.MouseEvent) => void | - | |
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
### Tag.CheckableTag
|
|
293
|
+
|
|
294
|
+
| 参数 | 说明 | 类型 | 默认值 |
|
|
295
|
+
|--------|--------|--------|--------|
|
|
296
|
+
| checked | 设置标签的选中状态 | boolean | false |
|
|
297
|
+
| onChange | 点击标签时触发的回调 | (checked) => void | - |
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
302
|
<DemoTitle title="Tabs" desc="用户可以通过点击不同的标签在同一页面中查看不同的内容区域。">
|
|
303
303
|
#### API
|
|
304
304
|
|
|
@@ -724,6 +724,70 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
724
724
|
|
|
725
725
|
|
|
726
726
|
|
|
727
|
+
<DemoTitle title="Slider" desc="滑动型输入器,展示当前值和可选范围。">
|
|
728
|
+
#### API
|
|
729
|
+
|
|
730
|
+
<AntdApiRef url="https://ant.design/components/slider-cn/#api"></AntdApiRef>
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
## antd API
|
|
734
|
+
|
|
735
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
736
|
+
|
|
737
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
738
|
+
|--------|--------|--------|--------|--------|
|
|
739
|
+
| autoFocus | 自动获取焦点 | boolean | false | |
|
|
740
|
+
| classNames | 语义化结构 className | | - | 5.10.0 |
|
|
741
|
+
| defaultValue | 设置初始取值。当 | number \| [number, number] | 0 \| [0, 0] | |
|
|
742
|
+
| disabled | 值为 true 时,滑块为禁用状态 | boolean | false | |
|
|
743
|
+
| keyboard | 支持使用键盘操作 handler | boolean | true | 5.2.0+ |
|
|
744
|
+
| dots | 是否只能拖拽到刻度上 | boolean | false | |
|
|
745
|
+
| included | marks | boolean | true | |
|
|
746
|
+
| marks | 刻度标记,key 的类型必须为 | object | { number: ReactNode } or { number: { style: CSSProperties, label: ReactNode } } | |
|
|
747
|
+
| max | 最大值 | number | 100 | |
|
|
748
|
+
| min | 最小值 | number | 0 | |
|
|
749
|
+
| range | 双滑块模式 | boolean \| | false | |
|
|
750
|
+
| reverse | 反向坐标轴 | boolean | false | |
|
|
751
|
+
| step | 步长,取值必须大于 0,并且可被 (max - min) 整除。当 | number \| null | 1 | |
|
|
752
|
+
| styles | 语义化结构 styles | | - | 5.10.0 |
|
|
753
|
+
| tooltip | 设置 Tooltip 相关属性 | | - | 4.23.0 |
|
|
754
|
+
| value | 设置当前取值。当 | number \| [number, number] | - | |
|
|
755
|
+
| vertical | 值为 true 时,Slider 为垂直方向 | boolean | false | |
|
|
756
|
+
| onChangeComplete | 与 | (value) => void | - | |
|
|
757
|
+
| onChange | 当 Slider 的值发生改变时,会触发 onChange 事件,并把改变后的值作为参数传入 | (value) => void | - | |
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
### range
|
|
761
|
+
|
|
762
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
763
|
+
|--------|--------|--------|--------|--------|
|
|
764
|
+
| draggableTrack | 范围刻度是否可被拖拽 | boolean | false | |
|
|
765
|
+
| editable | 启动动态增减节点,不能和 | boolean | false | 5.20.0 |
|
|
766
|
+
| minCount | 配置 | number | 0 | 5.20.0 |
|
|
767
|
+
| maxCount | 配置 | number | - | 5.20.0 |
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
### tooltip
|
|
771
|
+
|
|
772
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
773
|
+
|--------|--------|--------|--------|--------|
|
|
774
|
+
| autoAdjustOverflow | 是否自动调整弹出位置 | boolean | true | 5.8.0 |
|
|
775
|
+
| open | 值为 true 时,Tooltip 将会始终显示;否则始终不显示,哪怕在拖拽及移入时 | boolean | - | 4.23.0 |
|
|
776
|
+
| placement | 设置 Tooltip 展示位置。参考 | string | - | 4.23.0 |
|
|
777
|
+
| getPopupContainer | Tooltip 渲染父节点,默认渲染到 body 上 | (triggerNode) => HTMLElement | () => document.body | 4.23.0 |
|
|
778
|
+
| formatter | Slider 会把当前值传给 | value => ReactNode \| null | IDENTITY | 4.23.0 |
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
## 方法
|
|
782
|
+
|
|
783
|
+
| 名称 | 描述 | 版本 |
|
|
784
|
+
|--------|--------|--------|
|
|
785
|
+
| blur() | 移除焦点 | |
|
|
786
|
+
| focus() | 获取焦点 | |
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
727
791
|
<DemoTitle title="Statistic" desc="展示统计数值">
|
|
728
792
|
#### API
|
|
729
793
|
|
|
@@ -801,70 +865,6 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
801
865
|
|
|
802
866
|
|
|
803
867
|
|
|
804
|
-
<DemoTitle title="Slider" desc="滑动型输入器,展示当前值和可选范围。">
|
|
805
|
-
#### API
|
|
806
|
-
|
|
807
|
-
<AntdApiRef url="https://ant.design/components/slider-cn/#api"></AntdApiRef>
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
## antd API
|
|
811
|
-
|
|
812
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
813
|
-
|
|
814
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
815
|
-
|--------|--------|--------|--------|--------|
|
|
816
|
-
| autoFocus | 自动获取焦点 | boolean | false | |
|
|
817
|
-
| classNames | 语义化结构 className | | - | 5.10.0 |
|
|
818
|
-
| defaultValue | 设置初始取值。当 | number \| [number, number] | 0 \| [0, 0] | |
|
|
819
|
-
| disabled | 值为 true 时,滑块为禁用状态 | boolean | false | |
|
|
820
|
-
| keyboard | 支持使用键盘操作 handler | boolean | true | 5.2.0+ |
|
|
821
|
-
| dots | 是否只能拖拽到刻度上 | boolean | false | |
|
|
822
|
-
| included | marks | boolean | true | |
|
|
823
|
-
| marks | 刻度标记,key 的类型必须为 | object | { number: ReactNode } or { number: { style: CSSProperties, label: ReactNode } } | |
|
|
824
|
-
| max | 最大值 | number | 100 | |
|
|
825
|
-
| min | 最小值 | number | 0 | |
|
|
826
|
-
| range | 双滑块模式 | boolean \| | false | |
|
|
827
|
-
| reverse | 反向坐标轴 | boolean | false | |
|
|
828
|
-
| step | 步长,取值必须大于 0,并且可被 (max - min) 整除。当 | number \| null | 1 | |
|
|
829
|
-
| styles | 语义化结构 styles | | - | 5.10.0 |
|
|
830
|
-
| tooltip | 设置 Tooltip 相关属性 | | - | 4.23.0 |
|
|
831
|
-
| value | 设置当前取值。当 | number \| [number, number] | - | |
|
|
832
|
-
| vertical | 值为 true 时,Slider 为垂直方向 | boolean | false | |
|
|
833
|
-
| onChangeComplete | 与 | (value) => void | - | |
|
|
834
|
-
| onChange | 当 Slider 的值发生改变时,会触发 onChange 事件,并把改变后的值作为参数传入 | (value) => void | - | |
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
### range
|
|
838
|
-
|
|
839
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
840
|
-
|--------|--------|--------|--------|--------|
|
|
841
|
-
| draggableTrack | 范围刻度是否可被拖拽 | boolean | false | |
|
|
842
|
-
| editable | 启动动态增减节点,不能和 | boolean | false | 5.20.0 |
|
|
843
|
-
| minCount | 配置 | number | 0 | 5.20.0 |
|
|
844
|
-
| maxCount | 配置 | number | - | 5.20.0 |
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
### tooltip
|
|
848
|
-
|
|
849
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
850
|
-
|--------|--------|--------|--------|--------|
|
|
851
|
-
| autoAdjustOverflow | 是否自动调整弹出位置 | boolean | true | 5.8.0 |
|
|
852
|
-
| open | 值为 true 时,Tooltip 将会始终显示;否则始终不显示,哪怕在拖拽及移入时 | boolean | - | 4.23.0 |
|
|
853
|
-
| placement | 设置 Tooltip 展示位置。参考 | string | - | 4.23.0 |
|
|
854
|
-
| getPopupContainer | Tooltip 渲染父节点,默认渲染到 body 上 | (triggerNode) => HTMLElement | () => document.body | 4.23.0 |
|
|
855
|
-
| formatter | Slider 会把当前值传给 | value => ReactNode \| null | IDENTITY | 4.23.0 |
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
## 方法
|
|
859
|
-
|
|
860
|
-
| 名称 | 描述 | 版本 |
|
|
861
|
-
|--------|--------|--------|
|
|
862
|
-
| blur() | 移除焦点 | |
|
|
863
|
-
| focus() | 获取焦点 | |
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
868
868
|
<DemoTitle title="Skeleton" desc="在内容加载时提供占位图形展示。">
|
|
869
869
|
## antd API
|
|
870
870
|
|
|
@@ -926,99 +926,12 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
926
926
|
|
|
927
927
|
|
|
928
928
|
|
|
929
|
-
<DemoTitle title="
|
|
930
|
-
## API
|
|
931
|
-
|
|
932
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
933
|
-
|--------|--------|--------|--------|
|
|
934
|
-
| texture | 是否显示纹理 | boolean | false |
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
<DemoTitle title="RadioButton" desc="用于在多个备选项中选中单个状态。">
|
|
942
|
-
#### API
|
|
943
|
-
|
|
944
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
945
|
-
|--------|--------|--------|--------|
|
|
946
|
-
| bordered | 边框 | boolean | false |
|
|
947
|
-
| ghost | 按钮背景色类型 | boolean | true |
|
|
948
|
-
| gap | 间距 | number | 12 px |
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
<AntdApiRef url="https://ant.design/components/radio-cn/#api"></AntdApiRef>
|
|
952
|
-
|
|
953
|
-
|
|
929
|
+
<DemoTitle title="Select" desc="下拉选择器">
|
|
954
930
|
## antd API
|
|
955
931
|
|
|
956
932
|
通用属性参考:[通用属性](/docs/react/common-props)
|
|
957
933
|
|
|
958
|
-
###
|
|
959
|
-
|
|
960
|
-
<!-- prettier-ignore -->
|
|
961
|
-
| 参数 | 说明 | 类型 | 默认值 |
|
|
962
|
-
|--------|--------|--------|--------|
|
|
963
|
-
| autoFocus | 自动获取焦点 | boolean | false |
|
|
964
|
-
| checked | 指定当前是否选中 | boolean | false |
|
|
965
|
-
| defaultChecked | 初始是否选中 | boolean | false |
|
|
966
|
-
| disabled | 禁用 Radio | boolean | false |
|
|
967
|
-
| value | 根据 value 进行比较,判断是否选中 | any | - |
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
### Radio.Group
|
|
971
|
-
|
|
972
|
-
单选框组合,用于包裹一组 `Radio`。
|
|
973
|
-
|
|
974
|
-
<!-- prettier-ignore -->
|
|
975
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
976
|
-
|--------|--------|--------|--------|--------|
|
|
977
|
-
| buttonStyle | RadioButton 的风格样式,目前有描边和填色两种风格 | outline | outline | | |
|
|
978
|
-
| defaultValue | 默认选中的值 | any | - | | |
|
|
979
|
-
| disabled | 禁选所有子单选器 | boolean | false | | |
|
|
980
|
-
| name | RadioGroup 下所有 | string | - | | |
|
|
981
|
-
| options | 以配置形式设置子元素 | string[] \| number[] \| Array< | - | | |
|
|
982
|
-
| optionType | 用于设置 Radio | default | default | 4.4.0 | |
|
|
983
|
-
| size | 大小,只对按钮样式生效 | large | - | | |
|
|
984
|
-
| value | 用于设置当前选中的值 | any | - | | |
|
|
985
|
-
| block | 将 RadioGroup 宽度调整为其父宽度的选项 | boolean | false | 5.21.0 | |
|
|
986
|
-
| onChange | 选项变化时的回调函数 | function(e:Event) | - | | |
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
### CheckboxOptionType
|
|
990
|
-
|
|
991
|
-
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
992
|
-
|--------|--------|--------|--------|--------|
|
|
993
|
-
| label | 用于作为 Radio 选项展示的文本 | string | - | 4.4.0 |
|
|
994
|
-
| value | 关联 Radio 选项的值 | string | - | 4.4.0 |
|
|
995
|
-
| style | 应用到 Radio 选项的 style | React.CSSProperties | - | 4.4.0 |
|
|
996
|
-
| className | Radio 选项的类名 | string | - | 5.25.0 |
|
|
997
|
-
| disabled | 指定 Radio 选项是否要禁用 | boolean | false | 4.4.0 |
|
|
998
|
-
| title | 添加 Title 属性值 | string | - | 4.4.0 |
|
|
999
|
-
| id | 添加 Radio Id 属性值 | string | - | 4.4.0 |
|
|
1000
|
-
| onChange | 当 Radio Group 的值发送改变时触发 | (e: CheckboxChangeEvent) => void; | - | 4.4.0 |
|
|
1001
|
-
| required | 指定 Radio 选项是否必填 | boolean | false | 4.4.0 |
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
## 方法
|
|
1005
|
-
|
|
1006
|
-
### Radio
|
|
1007
|
-
|
|
1008
|
-
| 名称 | 描述 |
|
|
1009
|
-
|--------|--------|
|
|
1010
|
-
| blur() | 移除焦点 |
|
|
1011
|
-
| focus() | 获取焦点 |
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
<DemoTitle title="Select" desc="下拉选择器">
|
|
1017
|
-
## antd API
|
|
1018
|
-
|
|
1019
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1020
|
-
|
|
1021
|
-
### Select props
|
|
934
|
+
### Select props
|
|
1022
935
|
|
|
1023
936
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1024
937
|
|--------|--------|--------|--------|--------|
|
|
@@ -1111,19 +1024,89 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1111
1024
|
|
|
1112
1025
|
|
|
1113
1026
|
|
|
1114
|
-
<DemoTitle title="
|
|
1027
|
+
<DemoTitle title="Result" desc="为操作结果提供反馈信息的展示。">
|
|
1028
|
+
## API
|
|
1029
|
+
|
|
1030
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1031
|
+
|--------|--------|--------|--------|
|
|
1032
|
+
| texture | 是否显示纹理 | boolean | false |
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
<DemoTitle title="RadioButton" desc="用于在多个备选项中选中单个状态。">
|
|
1115
1040
|
#### API
|
|
1116
1041
|
|
|
1117
1042
|
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1118
1043
|
|--------|--------|--------|--------|
|
|
1119
|
-
|
|
|
1120
|
-
|
|
|
1121
|
-
|
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1044
|
+
| bordered | 边框 | boolean | false |
|
|
1045
|
+
| ghost | 按钮背景色类型 | boolean | true |
|
|
1046
|
+
| gap | 间距 | number | 12 px |
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
<AntdApiRef url="https://ant.design/components/radio-cn/#api"></AntdApiRef>
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
## antd API
|
|
1053
|
+
|
|
1054
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1055
|
+
|
|
1056
|
+
### Radio/Radio.Button
|
|
1057
|
+
|
|
1058
|
+
<!-- prettier-ignore -->
|
|
1059
|
+
| 参数 | 说明 | 类型 | 默认值 |
|
|
1060
|
+
|--------|--------|--------|--------|
|
|
1061
|
+
| autoFocus | 自动获取焦点 | boolean | false |
|
|
1062
|
+
| checked | 指定当前是否选中 | boolean | false |
|
|
1063
|
+
| defaultChecked | 初始是否选中 | boolean | false |
|
|
1064
|
+
| disabled | 禁用 Radio | boolean | false |
|
|
1065
|
+
| value | 根据 value 进行比较,判断是否选中 | any | - |
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
### Radio.Group
|
|
1069
|
+
|
|
1070
|
+
单选框组合,用于包裹一组 `Radio`。
|
|
1071
|
+
|
|
1072
|
+
<!-- prettier-ignore -->
|
|
1073
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1074
|
+
|--------|--------|--------|--------|--------|
|
|
1075
|
+
| buttonStyle | RadioButton 的风格样式,目前有描边和填色两种风格 | outline | outline | | |
|
|
1076
|
+
| defaultValue | 默认选中的值 | any | - | | |
|
|
1077
|
+
| disabled | 禁选所有子单选器 | boolean | false | | |
|
|
1078
|
+
| name | RadioGroup 下所有 | string | - | | |
|
|
1079
|
+
| options | 以配置形式设置子元素 | string[] \| number[] \| Array< | - | | |
|
|
1080
|
+
| optionType | 用于设置 Radio | default | default | 4.4.0 | |
|
|
1081
|
+
| size | 大小,只对按钮样式生效 | large | - | | |
|
|
1082
|
+
| value | 用于设置当前选中的值 | any | - | | |
|
|
1083
|
+
| block | 将 RadioGroup 宽度调整为其父宽度的选项 | boolean | false | 5.21.0 | |
|
|
1084
|
+
| onChange | 选项变化时的回调函数 | function(e:Event) | - | | |
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
### CheckboxOptionType
|
|
1088
|
+
|
|
1089
|
+
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
1090
|
+
|--------|--------|--------|--------|--------|
|
|
1091
|
+
| label | 用于作为 Radio 选项展示的文本 | string | - | 4.4.0 |
|
|
1092
|
+
| value | 关联 Radio 选项的值 | string | - | 4.4.0 |
|
|
1093
|
+
| style | 应用到 Radio 选项的 style | React.CSSProperties | - | 4.4.0 |
|
|
1094
|
+
| className | Radio 选项的类名 | string | - | 5.25.0 |
|
|
1095
|
+
| disabled | 指定 Radio 选项是否要禁用 | boolean | false | 4.4.0 |
|
|
1096
|
+
| title | 添加 Title 属性值 | string | - | 4.4.0 |
|
|
1097
|
+
| id | 添加 Radio Id 属性值 | string | - | 4.4.0 |
|
|
1098
|
+
| onChange | 当 Radio Group 的值发送改变时触发 | (e: CheckboxChangeEvent) => void; | - | 4.4.0 |
|
|
1099
|
+
| required | 指定 Radio 选项是否必填 | boolean | false | 4.4.0 |
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
## 方法
|
|
1103
|
+
|
|
1104
|
+
### Radio
|
|
1105
|
+
|
|
1106
|
+
| 名称 | 描述 |
|
|
1107
|
+
|--------|--------|
|
|
1108
|
+
| blur() | 移除焦点 |
|
|
1109
|
+
| focus() | 获取焦点 |
|
|
1127
1110
|
|
|
1128
1111
|
|
|
1129
1112
|
|
|
@@ -1196,6 +1179,23 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1196
1179
|
|
|
1197
1180
|
|
|
1198
1181
|
|
|
1182
|
+
<DemoTitle title="MdEditor" desc="提示词编辑器,可以高亮 Markdown 的语法,支持自定义槽位变量的插入">
|
|
1183
|
+
#### API
|
|
1184
|
+
|
|
1185
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1186
|
+
|--------|--------|--------|--------|
|
|
1187
|
+
| maxLength | 可以输入内容的最大长度 | number | |
|
|
1188
|
+
| value | 输入的内容 | string | (必填) |
|
|
1189
|
+
| className | 输入内容的类名 | string | |
|
|
1190
|
+
| onChange | 输入内容的回调 | (value: string) => void | |
|
|
1191
|
+
| variables | 可以插入的变量列表 | Array | |
|
|
1192
|
+
| onCreate | 新增变量的触发回调 | () => void | |
|
|
1193
|
+
| createBtnText | 新增变量的按钮文本 | string | |
|
|
1194
|
+
| tipsText | 提示文本,传入 false 时隐藏提示 | string \| React.ReactNode \| false | |
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
1199
|
<DemoTitle title="Progress" desc="用于指示任务的完成进度">
|
|
1200
1200
|
## antd API
|
|
1201
1201
|
|
|
@@ -1248,6 +1248,50 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1248
1248
|
|
|
1249
1249
|
|
|
1250
1250
|
|
|
1251
|
+
<DemoTitle title="Popover" desc="点击/鼠标移入元素,弹出气泡式的卡片浮层">
|
|
1252
|
+
#### API
|
|
1253
|
+
|
|
1254
|
+
<AntdApiRef url="https://ant.design/components/popover-cn/#api"></AntdApiRef>
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
## antd API
|
|
1258
|
+
|
|
1259
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1260
|
+
|
|
1261
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1262
|
+
|--------|--------|--------|--------|--------|
|
|
1263
|
+
| content | 卡片内容 | ReactNode \| () => ReactNode | - | |
|
|
1264
|
+
| title | 卡片标题 | ReactNode \| () => ReactNode | - | |
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
<!-- 共同的 API -->
|
|
1268
|
+
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
|
|
1269
|
+
|
|
1270
|
+
<!-- prettier-ignore -->
|
|
1271
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1272
|
+
|--------|--------|--------|--------|--------|
|
|
1273
|
+
| align | 该值将合并到 placement 的配置中,设置参考 | object | - | |
|
|
1274
|
+
| arrow | 修改箭头的显示状态以及修改箭头是否指向目标元素中心 | boolean \| { pointAtCenter: boolean } | true | 5.2.0 |
|
|
1275
|
+
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | true | |
|
|
1276
|
+
| color | 背景颜色 | string | - | 4.3.0 |
|
|
1277
|
+
| defaultOpen | 默认是否显隐 | boolean | false | 4.23.0 |
|
|
1278
|
+
| destroyOnHidden | 关闭后是否销毁 dom | boolean | false | 5.25.0 |
|
|
1279
|
+
| fresh | 默认情况下,Tooltip 在关闭时会缓存内容。设置该属性后会始终保持更新 | boolean | false | 5.10.0 |
|
|
1280
|
+
| getPopupContainer | 浮层渲染父节点,默认渲染到 body 上 | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
|
1281
|
+
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip,单位:秒 | number | 0.1 | |
|
|
1282
|
+
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip,单位:秒 | number | 0.1 | |
|
|
1283
|
+
| placement | 气泡框位置,可选 | string | top | |
|
|
1284
|
+
| trigger | 触发行为,可选 | string \| string[] | hover | |
|
|
1285
|
+
| open | 用于手动控制浮层显隐,小于 4.23.0 使用 | boolean | false | 4.23.0 |
|
|
1286
|
+
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
1287
|
+
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
1288
|
+
|
|
1289
|
+
## 注意
|
|
1290
|
+
|
|
1291
|
+
请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1251
1295
|
<DemoTitle title="Popconfirm" desc="点击元素,弹出气泡式的确认框。">
|
|
1252
1296
|
#### API
|
|
1253
1297
|
|
|
@@ -1305,6 +1349,53 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
|
|
|
1305
1349
|
|
|
1306
1350
|
|
|
1307
1351
|
|
|
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
|
+
|
|
1308
1399
|
<DemoTitle title="Notification" desc="用于指示任务的完成进度">
|
|
1309
1400
|
#### API
|
|
1310
1401
|
|
|
@@ -1401,97 +1492,6 @@ notification.config({
|
|
|
1401
1492
|
|
|
1402
1493
|
|
|
1403
1494
|
|
|
1404
|
-
<DemoTitle title="Pagination" desc="分页器用于分隔长列表,每次只加载一个页面。">
|
|
1405
|
-
## API
|
|
1406
|
-
|
|
1407
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1408
|
-
|--------|--------|--------|--------|
|
|
1409
|
-
| hideSwitchButton | 是否展示上一页/下一页的切换按钮 | boolean | false |
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
<AntdApiRef url="https://ant.design/components/pagination-cn/#api"></AntdApiRef>
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
## antd API
|
|
1416
|
-
|
|
1417
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
```jsx
|
|
1421
|
-
<Pagination onChange={onChange} total={50} />
|
|
1422
|
-
```
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1426
|
-
|--------|--------|--------|--------|--------|
|
|
1427
|
-
| align | 对齐方式 | start \| center \| end | - | 5.19.0 |
|
|
1428
|
-
| current | 当前页数 | number | - | |
|
|
1429
|
-
| defaultCurrent | 默认的当前页数 | number | 1 | |
|
|
1430
|
-
| defaultPageSize | 默认的每页条数 | number | 10 | |
|
|
1431
|
-
| disabled | 禁用分页 | boolean | - | |
|
|
1432
|
-
| hideOnSinglePage | 只有一页时是否隐藏分页器 | boolean | false | |
|
|
1433
|
-
| itemRender | 用于自定义页码的结构,可用于优化 SEO | (page, type: 'page' \| 'prev' \| 'next', originalElement) => React.ReactNode | - | |
|
|
1434
|
-
| pageSize | 每页条数 | number | - | |
|
|
1435
|
-
| pageSizeOptions | 指定每页可以显示多少条 | number[] | [ | |
|
|
1436
|
-
| responsive | 当 size 未指定时,根据屏幕宽度自动调整尺寸 | boolean | - | |
|
|
1437
|
-
| showLessItems | 是否显示较少页面内容 | boolean | false | |
|
|
1438
|
-
| showQuickJumper | 是否可以快速跳转至某页 | boolean \| { goButton: ReactNode } | false | |
|
|
1439
|
-
| showSizeChanger | 是否展示 | boolean \| | - | SelectProps: 5.21.0 |
|
|
1440
|
-
| showTitle | 是否显示原生 tooltip 页码提示 | boolean | true | |
|
|
1441
|
-
| showTotal | 用于显示数据总量和当前数据顺序 | function(total, range) | - | |
|
|
1442
|
-
| simple | 当添加该属性时,显示为简单分页 | boolean \| { readOnly?: boolean } | - | |
|
|
1443
|
-
| size | 当为 | default | default | |
|
|
1444
|
-
| total | 数据总数 | number | 0 | |
|
|
1445
|
-
| onChange | 页码或 | function(page, pageSize) | - | |
|
|
1446
|
-
| onShowSizeChange | pageSize 变化的回调 | function(current, size) | - | |
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
<DemoTitle title="Popover" desc="点击/鼠标移入元素,弹出气泡式的卡片浮层">
|
|
1452
|
-
#### API
|
|
1453
|
-
|
|
1454
|
-
<AntdApiRef url="https://ant.design/components/popover-cn/#api"></AntdApiRef>
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
## antd API
|
|
1458
|
-
|
|
1459
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1460
|
-
|
|
1461
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1462
|
-
|--------|--------|--------|--------|--------|
|
|
1463
|
-
| content | 卡片内容 | ReactNode \| () => ReactNode | - | |
|
|
1464
|
-
| title | 卡片标题 | ReactNode \| () => ReactNode | - | |
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
<!-- 共同的 API -->
|
|
1468
|
-
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
|
|
1469
|
-
|
|
1470
|
-
<!-- prettier-ignore -->
|
|
1471
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1472
|
-
|--------|--------|--------|--------|--------|
|
|
1473
|
-
| align | 该值将合并到 placement 的配置中,设置参考 | object | - | |
|
|
1474
|
-
| arrow | 修改箭头的显示状态以及修改箭头是否指向目标元素中心 | boolean \| { pointAtCenter: boolean } | true | 5.2.0 |
|
|
1475
|
-
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | true | |
|
|
1476
|
-
| color | 背景颜色 | string | - | 4.3.0 |
|
|
1477
|
-
| defaultOpen | 默认是否显隐 | boolean | false | 4.23.0 |
|
|
1478
|
-
| destroyOnHidden | 关闭后是否销毁 dom | boolean | false | 5.25.0 |
|
|
1479
|
-
| fresh | 默认情况下,Tooltip 在关闭时会缓存内容。设置该属性后会始终保持更新 | boolean | false | 5.10.0 |
|
|
1480
|
-
| getPopupContainer | 浮层渲染父节点,默认渲染到 body 上 | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
|
1481
|
-
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip,单位:秒 | number | 0.1 | |
|
|
1482
|
-
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip,单位:秒 | number | 0.1 | |
|
|
1483
|
-
| placement | 气泡框位置,可选 | string | top | |
|
|
1484
|
-
| trigger | 触发行为,可选 | string \| string[] | hover | |
|
|
1485
|
-
| open | 用于手动控制浮层显隐,小于 4.23.0 使用 | boolean | false | 4.23.0 |
|
|
1486
|
-
| zIndex | 设置 Tooltip 的 | number | - | |
|
|
1487
|
-
| onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 |
|
|
1488
|
-
|
|
1489
|
-
## 注意
|
|
1490
|
-
|
|
1491
|
-
请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
1495
|
<DemoTitle title="Modal" desc="用于叠加当前页面上的对话框窗口,提供标题、内容区、操作区。">
|
|
1496
1496
|
#### API
|
|
1497
1497
|
|
|
@@ -1762,190 +1762,55 @@ message.config({
|
|
|
1762
1762
|
|
|
1763
1763
|
|
|
1764
1764
|
|
|
1765
|
-
<DemoTitle title="InputNumber" desc="通过鼠标或键盘,输入范围内的数值。">
|
|
1766
|
-
#### API
|
|
1767
|
-
|
|
1768
|
-
<AntdApiRef url="https://ant.design/components/input-number-cn/#api"></AntdApiRef>
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
## antd API
|
|
1772
|
-
|
|
1773
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1774
|
-
|
|
1775
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1776
|
-
|--------|--------|--------|--------|--------|
|
|
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 |
|
|
1805
|
-
|
|
1806
|
-
|
|
1807
|
-
## Ref
|
|
1808
|
-
|
|
1809
|
-
| 名称 | 说明 | 参数 | 版本 |
|
|
1810
|
-
|--------|--------|--------|--------|
|
|
1811
|
-
| blur() | 移除焦点 | - | |
|
|
1812
|
-
| focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 |
|
|
1813
|
-
| nativeElement | 获取原生 DOM 元素 | - | 5.17.3 |
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
1817
|
-
|
|
1818
|
-
<DemoTitle title="Input" desc="通过鼠标或键盘输入内容,为表单提供输入字段的基础容器。。">
|
|
1819
|
-
#### API
|
|
1820
|
-
|
|
1821
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1822
|
-
|--------|--------|--------|--------|
|
|
1823
|
-
| shape | 形态 | 'default' \| 'round' | default 默认 |
|
|
1824
|
-
|
|
1825
|
-
|
|
1826
|
-
<AntdApiRef url="https://ant.design/components/input-cn/#api"></AntdApiRef>
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
## antd API
|
|
1830
|
-
|
|
1831
|
-
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1832
|
-
|
|
1833
|
-
### Input
|
|
1834
|
-
|
|
1835
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1836
|
-
|--------|--------|--------|--------|--------|
|
|
1837
|
-
| addonAfter | 带标签的 input,设置后置标签 | ReactNode | - | |
|
|
1838
|
-
| addonBefore | 带标签的 input,设置前置标签 | ReactNode | - | |
|
|
1839
|
-
| allowClear | 可以点击清除图标删除内容 | boolean \| { clearIcon: ReactNode } | - | |
|
|
1840
|
-
| classNames | 语义化结构 class | Record< | - | 5.4.0 |
|
|
1841
|
-
| count | 字符计数配置 | | - | 5.10.0 |
|
|
1842
|
-
| defaultValue | 输入框默认内容 | string | - | |
|
|
1843
|
-
| disabled | 是否禁用状态,默认为 false | boolean | false | |
|
|
1844
|
-
| id | 输入框的 id | string | - | |
|
|
1845
|
-
| maxLength | 最大长度 | number | - | |
|
|
1846
|
-
| prefix | 带有前缀图标的 input | ReactNode | - | |
|
|
1847
|
-
| showCount | 是否展示字数 | boolean \| { formatter: (info: { value: string, count: number, maxLength?: number }) => ReactNode } | false | 4.18.0 info.value: 4.23.0 |
|
|
1848
|
-
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
1849
|
-
| styles | 语义化结构 style | Record< | - | 5.4.0 |
|
|
1850
|
-
| size | 控件大小。注:标准表单内的输入框大小限制为 | large | - | |
|
|
1851
|
-
| suffix | 带有后缀图标的 input | ReactNode | - | |
|
|
1852
|
-
| type | 声明 input 类型,同原生 input 标签的 type 属性,见: | string | text | |
|
|
1853
|
-
| value | 输入框内容 | string | - | |
|
|
1854
|
-
| variant | 形态变体 | outlined | outlined | 5.13.0 \| |
|
|
1855
|
-
| onChange | 输入框内容变化时的回调 | function(e) | - | |
|
|
1856
|
-
| onPressEnter | 按下回车的回调 | function(e) | - | |
|
|
1857
|
-
| onClear | 按下清除按钮的回调 | () => void | - | 5.20.0 |
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
如果 `Input` 在 `Form.Item` 内,并且 `Form.Item` 设置了 `id` 属性,则 `value` `defaultValue` 和 `id` 属性会被自动设置。
|
|
1861
|
-
|
|
1862
|
-
Input 的其他属性和 React 自带的 [input](https://reactjs.org/docs/dom-elements.html#all-supported-html-attributes) 一致。
|
|
1863
|
-
|
|
1864
|
-
#### CountConfig
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
```tsx
|
|
1868
|
-
interface CountConfig {
|
|
1869
|
-
// 最大字符数,不同于原生 `maxLength`,超出后标红但不会截断
|
|
1870
|
-
max?: number;
|
|
1871
|
-
// 自定义字符计数,例如标准 emoji 长度大于 1,可以自定义计数策略将其改为 1
|
|
1872
|
-
strategy?: (value: string) => number;
|
|
1873
|
-
// 同 `showCount`
|
|
1874
|
-
show?: boolean | ((args: { value: string; count: number; maxLength?: number }) => ReactNode);
|
|
1875
|
-
// 当字符数超出 `count.max` 时的自定义裁剪逻辑,不配置时不进行裁剪
|
|
1876
|
-
exceedFormatter?: (value: string, config: { max: number }) => string;
|
|
1877
|
-
}
|
|
1878
|
-
```
|
|
1879
|
-
|
|
1880
|
-
|
|
1881
|
-
### Input.TextArea
|
|
1882
|
-
|
|
1883
|
-
同 Input 属性,外加:
|
|
1884
|
-
|
|
1885
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1886
|
-
|--------|--------|--------|--------|--------|
|
|
1887
|
-
| autoSize | 自适应内容高度,可设置为 true \| false 或对象:{ minRows: 2, maxRows: 6 } | boolean \| object | false | |
|
|
1888
|
-
| classNames | 语义化结构 class | Record< | - | 5.4.0 |
|
|
1889
|
-
| styles | 语义化结构 style | Record< | - | 5.4.0 |
|
|
1890
|
-
|
|
1891
|
-
|
|
1892
|
-
`Input.TextArea` 的其他属性和浏览器自带的 [textarea](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) 一致。
|
|
1893
|
-
|
|
1894
|
-
### Input.Search
|
|
1895
|
-
|
|
1896
|
-
| 参数 | 说明 | 类型 | 默认值 |
|
|
1897
|
-
|--------|--------|--------|--------|
|
|
1898
|
-
| enterButton | 是否有确认按钮,可设为按钮文字。该属性会与 | ReactNode | false |
|
|
1899
|
-
| loading | 搜索 loading | boolean | false |
|
|
1900
|
-
| onSearch | 点击搜索图标、清除图标,或按下回车键时的回调 | function(value, event, { source: "input" \| "clear" }) | - |
|
|
1901
|
-
|
|
1902
|
-
|
|
1903
|
-
其余属性和 Input 一致。
|
|
1904
|
-
|
|
1905
|
-
### Input.Password
|
|
1906
|
-
|
|
1907
|
-
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1908
|
-
|--------|--------|--------|--------|--------|
|
|
1909
|
-
| iconRender | 自定义切换按钮 | (visible) => ReactNode | (visible) => (visible ? : ) | 4.3.0 |
|
|
1910
|
-
| visibilityToggle | 是否显示切换按钮或者控制密码显隐 | boolean \| | true | |
|
|
1765
|
+
<DemoTitle title="InputNumber" desc="通过鼠标或键盘,输入范围内的数值。">
|
|
1766
|
+
#### API
|
|
1911
1767
|
|
|
1768
|
+
<AntdApiRef url="https://ant.design/components/input-number-cn/#api"></AntdApiRef>
|
|
1912
1769
|
|
|
1913
|
-
### Input.OTP
|
|
1914
1770
|
|
|
1915
|
-
|
|
1771
|
+
## antd API
|
|
1916
1772
|
|
|
1917
|
-
|
|
1773
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1918
1774
|
|
|
1919
1775
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
1920
1776
|
|--------|--------|--------|--------|--------|
|
|
1921
|
-
|
|
|
1922
|
-
|
|
|
1923
|
-
|
|
|
1924
|
-
|
|
|
1925
|
-
|
|
|
1926
|
-
|
|
|
1927
|
-
|
|
|
1928
|
-
|
|
|
1929
|
-
|
|
|
1930
|
-
|
|
|
1931
|
-
|
|
|
1932
|
-
|
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
|
|
1937
|
-
|
|
|
1938
|
-
|
|
1939
|
-
|
|
|
1940
|
-
|
|
|
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 |
|
|
1941
1805
|
|
|
1942
1806
|
|
|
1943
|
-
|
|
1807
|
+
## Ref
|
|
1944
1808
|
|
|
1945
1809
|
| 名称 | 说明 | 参数 | 版本 |
|
|
1946
1810
|
|--------|--------|--------|--------|
|
|
1947
|
-
| blur |
|
|
1948
|
-
| focus | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) |
|
|
1811
|
+
| blur() | 移除焦点 | - | |
|
|
1812
|
+
| focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 |
|
|
1813
|
+
| nativeElement | 获取原生 DOM 元素 | - | 5.17.3 |
|
|
1949
1814
|
|
|
1950
1815
|
|
|
1951
1816
|
|
|
@@ -2117,6 +1982,141 @@ type TransformAction =
|
|
|
2117
1982
|
|
|
2118
1983
|
|
|
2119
1984
|
|
|
1985
|
+
<DemoTitle title="Input" desc="通过鼠标或键盘输入内容,为表单提供输入字段的基础容器。。">
|
|
1986
|
+
#### API
|
|
1987
|
+
|
|
1988
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
1989
|
+
|--------|--------|--------|--------|
|
|
1990
|
+
| shape | 形态 | 'default' \| 'round' | default 默认 |
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
<AntdApiRef url="https://ant.design/components/input-cn/#api"></AntdApiRef>
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
## antd API
|
|
1997
|
+
|
|
1998
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
1999
|
+
|
|
2000
|
+
### Input
|
|
2001
|
+
|
|
2002
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2003
|
+
|--------|--------|--------|--------|--------|
|
|
2004
|
+
| addonAfter | 带标签的 input,设置后置标签 | ReactNode | - | |
|
|
2005
|
+
| addonBefore | 带标签的 input,设置前置标签 | ReactNode | - | |
|
|
2006
|
+
| allowClear | 可以点击清除图标删除内容 | boolean \| { clearIcon: ReactNode } | - | |
|
|
2007
|
+
| classNames | 语义化结构 class | Record< | - | 5.4.0 |
|
|
2008
|
+
| count | 字符计数配置 | | - | 5.10.0 |
|
|
2009
|
+
| defaultValue | 输入框默认内容 | string | - | |
|
|
2010
|
+
| disabled | 是否禁用状态,默认为 false | boolean | false | |
|
|
2011
|
+
| id | 输入框的 id | string | - | |
|
|
2012
|
+
| maxLength | 最大长度 | number | - | |
|
|
2013
|
+
| prefix | 带有前缀图标的 input | ReactNode | - | |
|
|
2014
|
+
| showCount | 是否展示字数 | boolean \| { formatter: (info: { value: string, count: number, maxLength?: number }) => ReactNode } | false | 4.18.0 info.value: 4.23.0 |
|
|
2015
|
+
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 |
|
|
2016
|
+
| styles | 语义化结构 style | Record< | - | 5.4.0 |
|
|
2017
|
+
| size | 控件大小。注:标准表单内的输入框大小限制为 | large | - | |
|
|
2018
|
+
| suffix | 带有后缀图标的 input | ReactNode | - | |
|
|
2019
|
+
| type | 声明 input 类型,同原生 input 标签的 type 属性,见: | string | text | |
|
|
2020
|
+
| value | 输入框内容 | string | - | |
|
|
2021
|
+
| variant | 形态变体 | outlined | outlined | 5.13.0 \| |
|
|
2022
|
+
| onChange | 输入框内容变化时的回调 | function(e) | - | |
|
|
2023
|
+
| onPressEnter | 按下回车的回调 | function(e) | - | |
|
|
2024
|
+
| onClear | 按下清除按钮的回调 | () => void | - | 5.20.0 |
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
如果 `Input` 在 `Form.Item` 内,并且 `Form.Item` 设置了 `id` 属性,则 `value` `defaultValue` 和 `id` 属性会被自动设置。
|
|
2028
|
+
|
|
2029
|
+
Input 的其他属性和 React 自带的 [input](https://reactjs.org/docs/dom-elements.html#all-supported-html-attributes) 一致。
|
|
2030
|
+
|
|
2031
|
+
#### CountConfig
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
```tsx
|
|
2035
|
+
interface CountConfig {
|
|
2036
|
+
// 最大字符数,不同于原生 `maxLength`,超出后标红但不会截断
|
|
2037
|
+
max?: number;
|
|
2038
|
+
// 自定义字符计数,例如标准 emoji 长度大于 1,可以自定义计数策略将其改为 1
|
|
2039
|
+
strategy?: (value: string) => number;
|
|
2040
|
+
// 同 `showCount`
|
|
2041
|
+
show?: boolean | ((args: { value: string; count: number; maxLength?: number }) => ReactNode);
|
|
2042
|
+
// 当字符数超出 `count.max` 时的自定义裁剪逻辑,不配置时不进行裁剪
|
|
2043
|
+
exceedFormatter?: (value: string, config: { max: number }) => string;
|
|
2044
|
+
}
|
|
2045
|
+
```
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
### Input.TextArea
|
|
2049
|
+
|
|
2050
|
+
同 Input 属性,外加:
|
|
2051
|
+
|
|
2052
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2053
|
+
|--------|--------|--------|--------|--------|
|
|
2054
|
+
| autoSize | 自适应内容高度,可设置为 true \| false 或对象:{ minRows: 2, maxRows: 6 } | boolean \| object | false | |
|
|
2055
|
+
| classNames | 语义化结构 class | Record< | - | 5.4.0 |
|
|
2056
|
+
| styles | 语义化结构 style | Record< | - | 5.4.0 |
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
`Input.TextArea` 的其他属性和浏览器自带的 [textarea](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) 一致。
|
|
2060
|
+
|
|
2061
|
+
### Input.Search
|
|
2062
|
+
|
|
2063
|
+
| 参数 | 说明 | 类型 | 默认值 |
|
|
2064
|
+
|--------|--------|--------|--------|
|
|
2065
|
+
| enterButton | 是否有确认按钮,可设为按钮文字。该属性会与 | ReactNode | false |
|
|
2066
|
+
| loading | 搜索 loading | boolean | false |
|
|
2067
|
+
| onSearch | 点击搜索图标、清除图标,或按下回车键时的回调 | function(value, event, { source: "input" \| "clear" }) | - |
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
其余属性和 Input 一致。
|
|
2071
|
+
|
|
2072
|
+
### Input.Password
|
|
2073
|
+
|
|
2074
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2075
|
+
|--------|--------|--------|--------|--------|
|
|
2076
|
+
| iconRender | 自定义切换按钮 | (visible) => ReactNode | (visible) => (visible ? : ) | 4.3.0 |
|
|
2077
|
+
| visibilityToggle | 是否显示切换按钮或者控制密码显隐 | boolean \| | true | |
|
|
2078
|
+
|
|
2079
|
+
|
|
2080
|
+
### Input.OTP
|
|
2081
|
+
|
|
2082
|
+
`5.16.0` 新增。
|
|
2083
|
+
|
|
2084
|
+
开发者注意事项:当 `mask` 属性的类型为 string 时,我们强烈推荐接收单个字符或单个 emoji,如果传入多个字符或多个 emoji,则会在控制台抛出警告。
|
|
2085
|
+
|
|
2086
|
+
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
2087
|
+
|--------|--------|--------|--------|--------|
|
|
2088
|
+
| defaultValue | 默认值 | string | - | |
|
|
2089
|
+
| disabled | 是否禁用 | boolean | false | |
|
|
2090
|
+
| formatter | 格式化展示,留空字段会被 | (value: string) => string | - | |
|
|
2091
|
+
| separator | 分隔符,在指定索引的输入框后渲染分隔符 | ReactNode \|((i: number) => ReactNode) | - | 5.24.0 |
|
|
2092
|
+
| mask | 自定义展示,和 | boolean \| string | false | 5.17.0 |
|
|
2093
|
+
| length | 输入元素数量 | number | 6 | |
|
|
2094
|
+
| status | 设置校验状态 | 'error' \| 'warning' | - | |
|
|
2095
|
+
| size | 输入框大小 | small | middle | |
|
|
2096
|
+
| variant | 形态变体 | outlined | outlined | underlined |
|
|
2097
|
+
| value | 输入框内容 | string | - | |
|
|
2098
|
+
| onChange | 当输入框内容全部填充时触发回调 | (value: string) => void | - | |
|
|
2099
|
+
| onInput | 输入值变化时触发的回调 | (value: string[]) => void | - | 5.22.0 |
|
|
2100
|
+
|
|
2101
|
+
|
|
2102
|
+
#### VisibilityToggle
|
|
2103
|
+
|
|
2104
|
+
| Property | Description | Type | Default | Version |
|
|
2105
|
+
|--------|--------|--------|--------|--------|
|
|
2106
|
+
| visible | 用于手动控制密码显隐 | boolean | false | 4.24 |
|
|
2107
|
+
| onVisibleChange | 显隐密码的回调 | (visible) => void | - | 4.24 |
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
#### Input Methods
|
|
2111
|
+
|
|
2112
|
+
| 名称 | 说明 | 参数 | 版本 |
|
|
2113
|
+
|--------|--------|--------|--------|
|
|
2114
|
+
| blur | 取消焦点 | - | |
|
|
2115
|
+
| focus | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | option - 4.10.0 |
|
|
2116
|
+
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
2120
|
<DemoTitle title="IconButton" desc="以图标为核心的轻量按钮组件,用于触发操作。">
|
|
2121
2121
|
#### API
|
|
2122
2122
|
|
|
@@ -3475,91 +3475,36 @@ export type FormatType =
|
|
|
3475
3475
|
| defaultValue | 默认选中的选项 | (string \| number)[] | [] | |
|
|
3476
3476
|
| disabled | 整组失效 | boolean | false | |
|
|
3477
3477
|
| name | CheckboxGroup 下所有 | string | - | |
|
|
3478
|
-
| options | 指定可选项 | string[] \| number[] \| Option[] | [] | |
|
|
3479
|
-
| value | 指定选中的选项 | (string \| number \| boolean)[] | [] | |
|
|
3480
|
-
| title | 选项的 title | string | - | |
|
|
3481
|
-
| className | 选项的类名 | string | - | 5.25.0 |
|
|
3482
|
-
| style | 选项的样式 | React.CSSProperties | - | |
|
|
3483
|
-
| onChange | 变化时的回调函数 | (checkedValue: T[]) => void | - | |
|
|
3484
|
-
|
|
3485
|
-
|
|
3486
|
-
##### Option
|
|
3487
|
-
|
|
3488
|
-
|
|
3489
|
-
```typescript
|
|
3490
|
-
interface Option {
|
|
3491
|
-
label: string;
|
|
3492
|
-
value: string;
|
|
3493
|
-
disabled?: boolean;
|
|
3494
|
-
}
|
|
3495
|
-
```
|
|
3496
|
-
|
|
3497
|
-
|
|
3498
|
-
### 方法
|
|
3499
|
-
|
|
3500
|
-
#### Checkbox
|
|
3501
|
-
|
|
3502
|
-
| 名称 | 描述 | 版本 |
|
|
3503
|
-
|--------|--------|--------|
|
|
3504
|
-
| blur() | 移除焦点 | |
|
|
3505
|
-
| focus() | 获取焦点 | |
|
|
3506
|
-
| nativeElement | 返回 Checkbox 的 DOM 节点 | 5.17.3 |
|
|
3507
|
-
|
|
3508
|
-
|
|
3509
|
-
|
|
3510
|
-
|
|
3511
|
-
<DemoTitle title="Button" desc="按钮用于开始一个即时操作。">
|
|
3512
|
-
#### API
|
|
3513
|
-
|
|
3514
|
-
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3515
|
-
|--------|--------|--------|--------|
|
|
3516
|
-
| size | 按钮大小 | 'small' \| 'middle' \| 'large' | 'middle' |
|
|
3517
|
-
| type | 类型 | \| 'primary'
|
|
3518
|
-
\| 'dashed'
|
|
3519
|
-
\| 'link'
|
|
3520
|
-
\| 'text'
|
|
3521
|
-
\| 'default'
|
|
3522
|
-
\| 'primaryLess'
|
|
3523
|
-
\| 'textCompact' | 'deafult' |
|
|
3524
|
-
| tooltipContent | hover上去tooltip的内容 | string \| ReactNode | |
|
|
3525
|
-
| iconType | 百炼图标iconfont的key,依赖ConfigProvider传入的iconfont,例如bl-icon-add | string | |
|
|
3526
|
-
| iconSize | 图标大小 | SparkIconFontProps['size'] | |
|
|
3527
|
-
|
|
3528
|
-
<AntdApiRef url="https://ant.design/components/button-cn/#api"></AntdApiRef>
|
|
3529
|
-
|
|
3478
|
+
| options | 指定可选项 | string[] \| number[] \| Option[] | [] | |
|
|
3479
|
+
| value | 指定选中的选项 | (string \| number \| boolean)[] | [] | |
|
|
3480
|
+
| title | 选项的 title | string | - | |
|
|
3481
|
+
| className | 选项的类名 | string | - | 5.25.0 |
|
|
3482
|
+
| style | 选项的样式 | React.CSSProperties | - | |
|
|
3483
|
+
| onChange | 变化时的回调函数 | (checkedValue: T[]) => void | - | |
|
|
3530
3484
|
|
|
3531
|
-
## antd API
|
|
3532
3485
|
|
|
3533
|
-
|
|
3486
|
+
##### Option
|
|
3534
3487
|
|
|
3535
|
-
通过设置 Button 的属性来产生不同的按钮样式,推荐顺序为:`type` -> `shape` -> `size` -> `loading` -> `disabled`。
|
|
3536
3488
|
|
|
3537
|
-
|
|
3489
|
+
```typescript
|
|
3490
|
+
interface Option {
|
|
3491
|
+
label: string;
|
|
3492
|
+
value: string;
|
|
3493
|
+
disabled?: boolean;
|
|
3494
|
+
}
|
|
3495
|
+
```
|
|
3538
3496
|
|
|
3539
|
-
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
3540
|
-
|--------|--------|--------|--------|--------|
|
|
3541
|
-
| autoInsertSpace | 我们默认提供两个汉字之间的空格,可以设置 | boolean | true | 5.17.0 |
|
|
3542
|
-
| block | 将按钮宽度调整为其父宽度的选项 | boolean | false | |
|
|
3543
|
-
| classNames | 语义化结构 class | | - | 5.4.0 |
|
|
3544
|
-
| color | 设置按钮的颜色 | default | - | default |
|
|
3545
|
-
| danger | 语法糖,设置危险按钮。当设置 | boolean | false | |
|
|
3546
|
-
| disabled | 设置按钮失效状态 | boolean | false | |
|
|
3547
|
-
| ghost | 幽灵属性,使按钮背景透明 | boolean | false | |
|
|
3548
|
-
| href | 点击跳转的地址,指定此属性 button 的行为和 a 链接一致 | string | - | |
|
|
3549
|
-
| htmlType | 设置 | submit | button | |
|
|
3550
|
-
| iconPosition | 设置按钮图标组件的位置 | start | start | 5.17.0 |
|
|
3551
|
-
| loading | 设置按钮载入状态 | boolean \| { delay: number, icon: ReactNode } | false | icon: 5.23.0 |
|
|
3552
|
-
| styles | 语义化结构 style | | - | 5.4.0 |
|
|
3553
|
-
| target | 相当于 a 链接的 target 属性,href 存在时生效 | string | - | |
|
|
3554
|
-
| onClick | 点击按钮时的回调 | (event: React.MouseEvent) => void | - | |
|
|
3555
|
-
| variant | 设置按钮的变体 | outlined | - | 5.21.0 |
|
|
3556
3497
|
|
|
3498
|
+
### 方法
|
|
3557
3499
|
|
|
3558
|
-
|
|
3500
|
+
#### Checkbox
|
|
3559
3501
|
|
|
3560
|
-
|
|
3502
|
+
| 名称 | 描述 | 版本 |
|
|
3503
|
+
|--------|--------|--------|
|
|
3504
|
+
| blur() | 移除焦点 | |
|
|
3505
|
+
| focus() | 获取焦点 | |
|
|
3506
|
+
| nativeElement | 返回 Checkbox 的 DOM 节点 | 5.17.3 |
|
|
3561
3507
|
|
|
3562
|
-
type PresetColors = 'blue' | 'purple' | 'cyan' | 'green' | 'magenta' | 'pink' | 'red' | 'orange' | 'yellow' | 'volcano' | 'geekblue' | 'lime' | 'gold';
|
|
3563
3508
|
|
|
3564
3509
|
|
|
3565
3510
|
|
|
@@ -3626,6 +3571,61 @@ type PresetColors = 'blue' | 'purple' | 'cyan' | 'green' | 'magenta' | 'pink' |
|
|
|
3626
3571
|
|
|
3627
3572
|
|
|
3628
3573
|
|
|
3574
|
+
<DemoTitle title="Button" desc="按钮用于开始一个即时操作。">
|
|
3575
|
+
#### API
|
|
3576
|
+
|
|
3577
|
+
| 属性名 | 描述 | 类型 | 默认值 |
|
|
3578
|
+
|--------|--------|--------|--------|
|
|
3579
|
+
| size | 按钮大小 | 'small' \| 'middle' \| 'large' | 'middle' |
|
|
3580
|
+
| type | 类型 | \| 'primary'
|
|
3581
|
+
\| 'dashed'
|
|
3582
|
+
\| 'link'
|
|
3583
|
+
\| 'text'
|
|
3584
|
+
\| 'default'
|
|
3585
|
+
\| 'primaryLess'
|
|
3586
|
+
\| 'textCompact' | 'deafult' |
|
|
3587
|
+
| tooltipContent | hover上去tooltip的内容 | string \| ReactNode | |
|
|
3588
|
+
| iconType | 百炼图标iconfont的key,依赖ConfigProvider传入的iconfont,例如bl-icon-add | string | |
|
|
3589
|
+
| iconSize | 图标大小 | SparkIconFontProps['size'] | |
|
|
3590
|
+
|
|
3591
|
+
<AntdApiRef url="https://ant.design/components/button-cn/#api"></AntdApiRef>
|
|
3592
|
+
|
|
3593
|
+
|
|
3594
|
+
## antd API
|
|
3595
|
+
|
|
3596
|
+
通用属性参考:[通用属性](/docs/react/common-props)
|
|
3597
|
+
|
|
3598
|
+
通过设置 Button 的属性来产生不同的按钮样式,推荐顺序为:`type` -> `shape` -> `size` -> `loading` -> `disabled`。
|
|
3599
|
+
|
|
3600
|
+
按钮的属性说明如下:
|
|
3601
|
+
|
|
3602
|
+
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
|
3603
|
+
|--------|--------|--------|--------|--------|
|
|
3604
|
+
| autoInsertSpace | 我们默认提供两个汉字之间的空格,可以设置 | boolean | true | 5.17.0 |
|
|
3605
|
+
| block | 将按钮宽度调整为其父宽度的选项 | boolean | false | |
|
|
3606
|
+
| classNames | 语义化结构 class | | - | 5.4.0 |
|
|
3607
|
+
| color | 设置按钮的颜色 | default | - | default |
|
|
3608
|
+
| danger | 语法糖,设置危险按钮。当设置 | boolean | false | |
|
|
3609
|
+
| disabled | 设置按钮失效状态 | boolean | false | |
|
|
3610
|
+
| ghost | 幽灵属性,使按钮背景透明 | boolean | false | |
|
|
3611
|
+
| href | 点击跳转的地址,指定此属性 button 的行为和 a 链接一致 | string | - | |
|
|
3612
|
+
| htmlType | 设置 | submit | button | |
|
|
3613
|
+
| iconPosition | 设置按钮图标组件的位置 | start | start | 5.17.0 |
|
|
3614
|
+
| loading | 设置按钮载入状态 | boolean \| { delay: number, icon: ReactNode } | false | icon: 5.23.0 |
|
|
3615
|
+
| styles | 语义化结构 style | | - | 5.4.0 |
|
|
3616
|
+
| target | 相当于 a 链接的 target 属性,href 存在时生效 | string | - | |
|
|
3617
|
+
| onClick | 点击按钮时的回调 | (event: React.MouseEvent) => void | - | |
|
|
3618
|
+
| variant | 设置按钮的变体 | outlined | - | 5.21.0 |
|
|
3619
|
+
|
|
3620
|
+
|
|
3621
|
+
支持原生 button 的其他所有属性。
|
|
3622
|
+
|
|
3623
|
+
### PresetColors
|
|
3624
|
+
|
|
3625
|
+
type PresetColors = 'blue' | 'purple' | 'cyan' | 'green' | 'magenta' | 'pink' | 'red' | 'orange' | 'yellow' | 'volcano' | 'geekblue' | 'lime' | 'gold';
|
|
3626
|
+
|
|
3627
|
+
|
|
3628
|
+
|
|
3629
3629
|
<DemoTitle title="Breadcrumb" desc="显示当前页面在系统层级结构中的位置,并能向上返回。">
|
|
3630
3630
|
#### API
|
|
3631
3631
|
|
|
@@ -4044,58 +4044,6 @@ const confirmed = await modal.confirm({ ... });
|
|
|
4044
4044
|
|
|
4045
4045
|
|
|
4046
4046
|
|
|
4047
|
-
<div align="center"><a name="readme-top"></a>
|
|
4048
|
-
<img height="120" src="https://img.alicdn.com/imgextra/i1/O1CN01ipemFb1EzmZI9LiTe_!!6000000000423-55-tps-28-28.svg" style="border: none">
|
|
4049
|
-
<h1>Alibaba Cloud Spark Design</h1>
|
|
4050
|
-
</div>
|
|
4051
|
-
|
|
4052
|
-
# 概述
|
|
4053
|
-
|
|
4054
|
-
Alibaba Cloud Spark Design 是一个基于 Ant Design 的 React UI 组件库,包含丰富的基础组件和场景组件,专为构建优秀的 LLM 产品而设计。
|
|
4055
|
-
<br />
|
|
4056
|
-
<br />
|
|
4057
|
-
|
|
4058
|
-
## ✨ 特性
|
|
4059
|
-
|
|
4060
|
-
|
|
4061
|
-
- <img height="15" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg"> 基于 Ant Design,兼容 Ant Design 生态系统。您可以无需修改代码即可切换到 Spark Design。
|
|
4062
|
-
- 🛡 使用 TypeScript 编写,具有可预测的静态类型。
|
|
4063
|
-
- 🧠 为 LLM 产品设计的各种场景组件。
|
|
4064
|
-
- 💡 与@agentscope-ai/chat 和 @agentscope-ai/flow 配合使用,构建企业级 LLM 应用。
|
|
4065
|
-
- 🎨 多种预设主题。
|
|
4066
|
-
- ☀️ 轻松切换明暗模式。
|
|
4067
|
-
|
|
4068
|
-
## 📦 安装
|
|
4069
|
-
|
|
4070
|
-
|
|
4071
|
-
```bash
|
|
4072
|
-
npm install antd @agentscope-ai/icons @agentscope-ai/design --save
|
|
4073
|
-
```
|
|
4074
|
-
|
|
4075
|
-
|
|
4076
|
-
## Tree Shaking 支持
|
|
4077
|
-
|
|
4078
|
-
@agentscope-ai/design 默认基于 ES 模块支持 tree shaking
|
|
4079
|
-
|
|
4080
|
-
## TypeScript
|
|
4081
|
-
|
|
4082
|
-
@agentscope-ai/chat 使用 TypeScript 编写并提供完整的定义文件。
|
|
4083
|
-
|
|
4084
|
-
## 内置主题
|
|
4085
|
-
|
|
4086
|
-
我们提供四种内置主题:
|
|
4087
|
-
|
|
4088
|
-
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #615CED;"></span> purpleTheme</div>
|
|
4089
|
-
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #5551CC;"></span> purpleDarkTheme(暗色模式)</div>
|
|
4090
|
-
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: rgba(26, 26, 29, 1);"></span> carbonTheme</div>
|
|
4091
|
-
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #676767;"></span> carbonDarkTheme(暗色模式)</div>
|
|
4092
|
-
|
|
4093
|
-
## 🏗️ 开源
|
|
4094
|
-
|
|
4095
|
-
[@agentscope-ai/design](https://www.npmjs.com/package/@agentscope-ai/design) 和 [@agentscope-ai/chat](https://www.npmjs.com/package/@agentscope-ai/chat) 正在积极推进开源,预计将在 2025 年底完成。目前,您可以通过 npm 访问我们的项目。
|
|
4096
|
-
|
|
4097
|
-
|
|
4098
|
-
|
|
4099
4047
|
## 内置主题
|
|
4100
4048
|
|
|
4101
4049
|
Alibaba Cloud Spark Design 提供四种内置主题:
|
|
@@ -4158,6 +4106,58 @@ export default App;
|
|
|
4158
4106
|
|
|
4159
4107
|
|
|
4160
4108
|
|
|
4109
|
+
<div align="center"><a name="readme-top"></a>
|
|
4110
|
+
<img height="120" src="https://img.alicdn.com/imgextra/i1/O1CN01ipemFb1EzmZI9LiTe_!!6000000000423-55-tps-28-28.svg" style="border: none">
|
|
4111
|
+
<h1>Alibaba Cloud Spark Design</h1>
|
|
4112
|
+
</div>
|
|
4113
|
+
|
|
4114
|
+
# 概述
|
|
4115
|
+
|
|
4116
|
+
Alibaba Cloud Spark Design 是一个基于 Ant Design 的 React UI 组件库,包含丰富的基础组件和场景组件,专为构建优秀的 LLM 产品而设计。
|
|
4117
|
+
<br />
|
|
4118
|
+
<br />
|
|
4119
|
+
|
|
4120
|
+
## ✨ 特性
|
|
4121
|
+
|
|
4122
|
+
|
|
4123
|
+
- <img height="15" src="https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg"> 基于 Ant Design,兼容 Ant Design 生态系统。您可以无需修改代码即可切换到 Spark Design。
|
|
4124
|
+
- 🛡 使用 TypeScript 编写,具有可预测的静态类型。
|
|
4125
|
+
- 🧠 为 LLM 产品设计的各种场景组件。
|
|
4126
|
+
- 💡 与@agentscope-ai/chat 和 @agentscope-ai/flow 配合使用,构建企业级 LLM 应用。
|
|
4127
|
+
- 🎨 多种预设主题。
|
|
4128
|
+
- ☀️ 轻松切换明暗模式。
|
|
4129
|
+
|
|
4130
|
+
## 📦 安装
|
|
4131
|
+
|
|
4132
|
+
|
|
4133
|
+
```bash
|
|
4134
|
+
npm install antd @agentscope-ai/icons @agentscope-ai/design --save
|
|
4135
|
+
```
|
|
4136
|
+
|
|
4137
|
+
|
|
4138
|
+
## Tree Shaking 支持
|
|
4139
|
+
|
|
4140
|
+
@agentscope-ai/design 默认基于 ES 模块支持 tree shaking
|
|
4141
|
+
|
|
4142
|
+
## TypeScript
|
|
4143
|
+
|
|
4144
|
+
@agentscope-ai/chat 使用 TypeScript 编写并提供完整的定义文件。
|
|
4145
|
+
|
|
4146
|
+
## 内置主题
|
|
4147
|
+
|
|
4148
|
+
我们提供四种内置主题:
|
|
4149
|
+
|
|
4150
|
+
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #615CED;"></span> purpleTheme</div>
|
|
4151
|
+
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #5551CC;"></span> purpleDarkTheme(暗色模式)</div>
|
|
4152
|
+
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: rgba(26, 26, 29, 1);"></span> carbonTheme</div>
|
|
4153
|
+
<div><span style="display: inline-block; width: 12px; height: 12px; background-color: #676767;"></span> carbonDarkTheme(暗色模式)</div>
|
|
4154
|
+
|
|
4155
|
+
## 🏗️ 开源
|
|
4156
|
+
|
|
4157
|
+
[@agentscope-ai/design](https://www.npmjs.com/package/@agentscope-ai/design) 和 [@agentscope-ai/chat](https://www.npmjs.com/package/@agentscope-ai/chat) 正在积极推进开源,预计将在 2025 年底完成。目前,您可以通过 npm 访问我们的项目。
|
|
4158
|
+
|
|
4159
|
+
|
|
4160
|
+
|
|
4161
4161
|
# 从 Antd 迁移
|
|
4162
4162
|
|
|
4163
4163
|
## 📦 安装
|
|
@@ -4316,32 +4316,6 @@ export default App;
|
|
|
4316
4316
|
|
|
4317
4317
|
|
|
4318
4318
|
|
|
4319
|
-
# 使用
|
|
4320
|
-
|
|
4321
|
-
|
|
4322
|
-
|
|
4323
|
-
```tsx
|
|
4324
|
-
import { SparkLoadingLine } from '@agentscope-ai/icons';
|
|
4325
|
-
|
|
4326
|
-
export default () => {
|
|
4327
|
-
return (
|
|
4328
|
-
<SparkLoadingLine
|
|
4329
|
-
className="your-class-name"
|
|
4330
|
-
style={{ color: 'var(--sps-color-primary)' }}
|
|
4331
|
-
spin
|
|
4332
|
-
size={48}
|
|
4333
|
-
/>
|
|
4334
|
-
);
|
|
4335
|
-
};
|
|
4336
|
-
|
|
4337
|
-
```
|
|
4338
|
-
|
|
4339
|
-
基本用法
|
|
4340
|
-
|
|
4341
|
-
访问 [Icon Library](https://sparkdesign.agentscope.io/#/resources/icons) 查看全部 Icon
|
|
4342
|
-
|
|
4343
|
-
|
|
4344
|
-
|
|
4345
4319
|
# 使用
|
|
4346
4320
|
|
|
4347
4321
|
如果您有自己的 iconfont 项目,可以将您的图标集成到 Spark Design 中,并通过简单的符号名称访问您的图标。
|
|
@@ -4413,6 +4387,32 @@ export default App;
|
|
|
4413
4387
|
|
|
4414
4388
|
|
|
4415
4389
|
|
|
4390
|
+
# 使用
|
|
4391
|
+
|
|
4392
|
+
|
|
4393
|
+
|
|
4394
|
+
```tsx
|
|
4395
|
+
import { SparkLoadingLine } from '@agentscope-ai/icons';
|
|
4396
|
+
|
|
4397
|
+
export default () => {
|
|
4398
|
+
return (
|
|
4399
|
+
<SparkLoadingLine
|
|
4400
|
+
className="your-class-name"
|
|
4401
|
+
style={{ color: 'var(--sps-color-primary)' }}
|
|
4402
|
+
spin
|
|
4403
|
+
size={48}
|
|
4404
|
+
/>
|
|
4405
|
+
);
|
|
4406
|
+
};
|
|
4407
|
+
|
|
4408
|
+
```
|
|
4409
|
+
|
|
4410
|
+
基本用法
|
|
4411
|
+
|
|
4412
|
+
访问 [Icon Library](https://sparkdesign.agentscope.io/#/resources/icons) 查看全部 Icon
|
|
4413
|
+
|
|
4414
|
+
|
|
4415
|
+
|
|
4416
4416
|
# Vibe 编程
|
|
4417
4417
|
|
|
4418
4418
|
## LLMs.txt
|