@agentscope-ai/design 1.0.16-rc.0 → 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.
Files changed (52) hide show
  1. package/lib/antd/styles/button.style.js +13 -1
  2. package/lib/antd/styles/index.style.js +3 -1
  3. package/lib/antd/styles/tree.style.d.ts +6 -0
  4. package/lib/antd/styles/tree.style.js +18 -0
  5. package/lib/antd/themes/bailianDarkTheme.json +3 -1
  6. package/lib/antd/themes/bailianTheme.json +4 -2
  7. package/lib/antd/themes/carbonDarkTheme.json +3 -1
  8. package/lib/antd/themes/carbonTheme.json +3 -1
  9. package/lib/components/commonComponents/Audio/Control.d.ts +53 -0
  10. package/lib/components/commonComponents/{Video → Audio}/Control.js +18 -15
  11. package/lib/components/commonComponents/Audio/Control.style.d.ts +1 -0
  12. package/lib/components/commonComponents/Audio/Control.style.js +14 -0
  13. package/lib/components/commonComponents/Audio/index.d.ts +14 -0
  14. package/lib/components/commonComponents/Audio/index.js +165 -0
  15. package/lib/components/commonComponents/Audio/index.style.d.ts +1 -0
  16. package/lib/components/commonComponents/Audio/index.style.js +10 -0
  17. package/lib/components/commonComponents/Button/demo/demo1.js +7 -0
  18. package/lib/components/commonComponents/Button/index.js +2 -1
  19. package/lib/components/commonComponents/CollapsePanel/demo/demo1.js +1 -1
  20. package/lib/components/commonComponents/CollapsePanel/index.js +4 -4
  21. package/lib/components/commonComponents/EllipsisTip/index.d.ts +8 -1
  22. package/lib/components/commonComponents/EllipsisTip/index.js +33 -3
  23. package/lib/components/commonComponents/Empty/index.d.ts +6 -0
  24. package/lib/components/commonComponents/Empty/index.js +22 -7
  25. package/lib/components/commonComponents/Empty/index.style.js +1 -1
  26. package/lib/components/commonComponents/Pagination/index.js +33 -42
  27. package/lib/components/commonComponents/Pagination/index.style.js +1 -1
  28. package/lib/components/commonComponents/Steps/index.js +1 -1
  29. package/lib/components/commonComponents/Steps/index.style.js +5 -1
  30. package/lib/components/commonComponents/Table/index.style.js +27 -1
  31. package/lib/components/commonComponents/Tabs/index.js +9 -8
  32. package/lib/components/commonComponents/Tooltip/demo/demo3.d.ts +3 -0
  33. package/lib/components/commonComponents/Tooltip/demo/demo3.js +25 -0
  34. package/lib/components/commonComponents/Tooltip/index.d.ts +7 -1
  35. package/lib/components/commonComponents/Tooltip/index.js +12 -1
  36. package/lib/components/commonComponents/Tooltip/index.style.js +1 -1
  37. package/lib/components/commonComponents/Video/index.d.ts +2 -6
  38. package/lib/components/commonComponents/Video/index.js +8 -8
  39. package/lib/components/commonComponents/Video/index.style.js +2 -6
  40. package/lib/components/mobileComponents/MobileDrawer/index.style.js +7 -1
  41. package/lib/index.d.ts +2 -1
  42. package/lib/index.js +1 -0
  43. package/lib/libs/env/index.d.ts +1 -1
  44. package/lib/typings.d.ts +12 -0
  45. package/llms/all.llms.txt +704 -694
  46. package/llms/components/commonComponents/Empty/index.zh-CN.llms.txt +1 -0
  47. package/llms/components/commonComponents/Tooltip/index.zh-CN.llms.txt +2 -1
  48. package/llms/docs/guide/tokens&variables.zh-CN.llms.txt +13 -5
  49. package/llms/index.llms.txt +47 -47
  50. package/package.json +1 -1
  51. package/scripts/mcp-docs-server.js +3 -3
  52. package/lib/components/commonComponents/Video/Control.d.ts +0 -19
package/llms/all.llms.txt CHANGED
@@ -110,7 +110,8 @@
110
110
 
111
111
  | 属性名 | 描述 | 类型 | 默认值 |
112
112
  |--------|--------|--------|--------|
113
- | mode | 颜色模式 | 'dark' \| 'light' | '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>
@@ -264,41 +265,6 @@ type RangeDisabledTime = (
264
265
 
265
266
 
266
267
 
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
268
  <DemoTitle title="Tabs" desc="用户可以通过点击不同的标签在同一页面中查看不同的内容区域。">
303
269
  #### API
304
270
 
@@ -369,6 +335,41 @@ type RangeDisabledTime = (
369
335
 
370
336
 
371
337
 
338
+ <DemoTitle title="Tag" desc="进行标记和分类的小标签">
339
+ #### API
340
+
341
+ | 属性名 | 描述 | 类型 | 默认值 |
342
+ |--------|--------|--------|--------|
343
+ | size | 尺寸 | 'small' \| 'middle' | 'middle' |
344
+ | color | 标签色 | SparkTagColors \| string | 'purple' |
345
+
346
+ <AntdApiRef url="https://ant.design/components/tag-cn/#api"></AntdApiRef>
347
+
348
+
349
+ ## antd API
350
+
351
+ 通用属性参考:[通用属性](/docs/react/common-props)
352
+
353
+ ### Tag
354
+
355
+ | 参数 | 说明 | 类型 | 默认值 | 版本 |
356
+ |--------|--------|--------|--------|--------|
357
+ | closeIcon | 自定义关闭按钮。5.7.0:设置为 | ReactNode | false | 4.4.0 |
358
+ | icon | 设置图标 | ReactNode | - | |
359
+ | bordered | 是否有边框 | boolean | true | 5.4.0 |
360
+ | onClose | 关闭时的回调(可通过 | (e: React.MouseEvent) => void | - | |
361
+
362
+
363
+ ### Tag.CheckableTag
364
+
365
+ | 参数 | 说明 | 类型 | 默认值 |
366
+ |--------|--------|--------|--------|
367
+ | checked | 设置标签的选中状态 | boolean | false |
368
+ | onChange | 点击标签时触发的回调 | (checked) => void | - |
369
+
370
+
371
+
372
+
372
373
  <DemoTitle title="Table" desc="展示行列数据。">
373
374
  #### API
374
375
 
@@ -624,47 +625,6 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
624
625
 
625
626
 
626
627
 
627
- <DemoTitle title="Switch" desc="使用开关切换两种状态之间。">
628
- #### API
629
-
630
- | 属性名 | 描述 | 类型 | 默认值 |
631
- |--------|--------|--------|--------|
632
- | label | Switch后的内容 | ReactNode | |
633
-
634
- <AntdApiRef url="https://ant.design/components/switch-cn/#api"></AntdApiRef>
635
-
636
-
637
- ## antd API
638
-
639
- 通用属性参考:[通用属性](/docs/react/common-props)
640
-
641
- | 参数 | 说明 | 类型 | 默认值 | 版本 |
642
- |--------|--------|--------|--------|--------|
643
- | autoFocus | 组件自动获取焦点 | boolean | false | |
644
- | checked | 指定当前是否选中 | boolean | false | |
645
- | checkedChildren | 选中时的内容 | ReactNode | - | |
646
- | className | Switch 器类名 | string | - | |
647
- | defaultChecked | 初始是否选中 | boolean | false | |
648
- | defaultValue | defaultChecked | boolean | - | 5.12.0 |
649
- | disabled | 是否禁用 | boolean | false | |
650
- | loading | 加载中的开关 | boolean | false | |
651
- | size | 开关大小,可选值: | string | default | |
652
- | unCheckedChildren | 非选中时的内容 | ReactNode | - | |
653
- | value | checked | boolean | - | 5.12.0 |
654
- | onChange | 变化时的回调函数 | function(checked: boolean, event: Event) | - | |
655
- | onClick | 点击时的回调函数 | function(checked: boolean, event: Event) | - | |
656
-
657
-
658
- ## 方法
659
-
660
- | 名称 | 描述 |
661
- |--------|--------|
662
- | blur() | 移除焦点 |
663
- | focus() | 获取焦点 |
664
-
665
-
666
-
667
-
668
628
  <DemoTitle title="Steps" desc="引导用户按照流程完成任务的导航条。">
669
629
  #### API
670
630
 
@@ -724,66 +684,19 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
724
684
 
725
685
 
726
686
 
727
- <DemoTitle title="Slider" desc="滑动型输入器,展示当前值和可选范围。">
687
+ <DemoTitle title="Spinner" desc="指示页面或区块的加载中状态">
728
688
  #### API
729
689
 
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() | 获取焦点 | |
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 |
787
700
 
788
701
 
789
702
 
@@ -848,77 +761,165 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
848
761
 
849
762
 
850
763
 
851
- <DemoTitle title="Spinner" desc="指示页面或区块的加载中状态">
764
+ <DemoTitle title="Switch" desc="使用开关切换两种状态之间。">
852
765
  #### API
853
766
 
854
767
  | 属性名 | 描述 | 类型 | 默认值 |
855
768
  |--------|--------|--------|--------|
856
- | tip | indicator下方的tip | React.ReactNode | - |
857
- | indicator | 自定义indicator,用于展示progress的百分比和加载文案 | React.ReactNode | - |
858
- | children | 被spinner包裹的子元素 | React.ReactNode | - |
859
- | style | spinner最外层的样式 | React.CSSProperties | - |
860
- | className | spinner的类名 | string | - |
861
- | percent | 进度条的百分比 | number | - |
862
- | spinning | 是否为加载中状态 | boolean | false |
863
- | showProgress | 是否显示进度条,如果为true,不需要手动在children中添加Progress组件 | boolean | false |
864
-
769
+ | label | Switch后的内容 | ReactNode | |
865
770
 
771
+ <AntdApiRef url="https://ant.design/components/switch-cn/#api"></AntdApiRef>
866
772
 
867
773
 
868
- <DemoTitle title="Skeleton" desc="在内容加载时提供占位图形展示。">
869
774
  ## antd API
870
775
 
871
776
  通用属性参考:[通用属性](/docs/react/common-props)
872
777
 
873
- ### Skeleton
874
-
875
- | 属性 | 说明 | 类型 | 默认值 |
876
- |--------|--------|--------|--------|
877
- | active | 是否展示动画效果 | boolean | false |
878
- | avatar | 是否显示头像占位图 | boolean \| | false |
879
- | loading | true 时,显示占位图。反之则直接展示子组件 | boolean | - |
880
- | paragraph | 是否显示段落占位图 | boolean \| | true |
881
- | round | true 时,段落和标题显示圆角 | boolean | false |
882
- | title | 是否显示标题占位图 | boolean \| | true |
778
+ | 参数 | 说明 | 类型 | 默认值 | 版本 |
779
+ |--------|--------|--------|--------|--------|
780
+ | autoFocus | 组件自动获取焦点 | boolean | false | |
781
+ | checked | 指定当前是否选中 | boolean | false | |
782
+ | checkedChildren | 选中时的内容 | ReactNode | - | |
783
+ | className | Switch 器类名 | string | - | |
784
+ | defaultChecked | 初始是否选中 | boolean | false | |
785
+ | defaultValue | defaultChecked | boolean | - | 5.12.0 |
786
+ | disabled | 是否禁用 | boolean | false | |
787
+ | loading | 加载中的开关 | boolean | false | |
788
+ | size | 开关大小,可选值: | string | default | |
789
+ | unCheckedChildren | 非选中时的内容 | ReactNode | - | |
790
+ | value | checked | boolean | - | 5.12.0 |
791
+ | onChange | 变化时的回调函数 | function(checked: boolean, event: Event) | - | |
792
+ | onClick | 点击时的回调函数 | function(checked: boolean, event: Event) | - | |
883
793
 
884
794
 
885
- ### SkeletonAvatarProps
795
+ ## 方法
886
796
 
887
- | 属性 | 说明 | 类型 | 默认值 |
888
- |--------|--------|--------|--------|
889
- | active | 是否展示动画效果,仅在单独使用头像骨架时生效 | boolean | false |
890
- | shape | 指定头像的形状 | circle | - |
891
- | size | 设置头像占位图的大小 | number \| | - |
797
+ | 名称 | 描述 |
798
+ |--------|--------|
799
+ | blur() | 移除焦点 |
800
+ | focus() | 获取焦点 |
892
801
 
893
802
 
894
- ### SkeletonTitleProps
895
803
 
896
- | 属性 | 说明 | 类型 | 默认值 |
897
- |--------|--------|--------|--------|
898
- | width | 设置标题占位图的宽度 | number \| string | - |
899
804
 
805
+ <DemoTitle title="Slider" desc="滑动型输入器,展示当前值和可选范围。">
806
+ #### API
900
807
 
901
- ### SkeletonParagraphProps
808
+ <AntdApiRef url="https://ant.design/components/slider-cn/#api"></AntdApiRef>
902
809
 
903
- | 属性 | 说明 | 类型 | 默认值 |
904
- |--------|--------|--------|--------|
905
- | rows | 设置段落占位图的行数 | number | - |
906
- | width | 设置段落占位图的宽度,若为数组时则为对应的每行宽度,反之则是最后一行的宽度 | number \| string \| Array | - |
907
810
 
811
+ ## antd API
908
812
 
909
- ### SkeletonButtonProps
813
+ 通用属性参考:[通用属性](/docs/react/common-props)
910
814
 
911
- | 属性 | 说明 | 类型 | 默认值 | 版本 |
815
+ | 参数 | 说明 | 类型 | 默认值 | 版本 |
912
816
  |--------|--------|--------|--------|--------|
913
- | active | 是否展示动画效果 | boolean | false | |
914
- | block | 将按钮宽度调整为其父宽度的选项 | boolean | false | 4.17.0 |
915
- | shape | 指定按钮的形状 | circle | - | |
916
- | size | 设置按钮的大小 | large | - | |
917
-
918
-
919
- ### SkeletonInputProps
920
-
921
- | 属性 | 说明 | 类型 | 默认值 |
817
+ | autoFocus | 自动获取焦点 | boolean | false | |
818
+ | classNames | 语义化结构 className | | - | 5.10.0 |
819
+ | defaultValue | 设置初始取值。当 | number \| [number, number] | 0 \| [0, 0] | |
820
+ | disabled | 值为 true 时,滑块为禁用状态 | boolean | false | |
821
+ | keyboard | 支持使用键盘操作 handler | boolean | true | 5.2.0+ |
822
+ | dots | 是否只能拖拽到刻度上 | boolean | false | |
823
+ | included | marks | boolean | true | |
824
+ | marks | 刻度标记,key 的类型必须为 | object | { number: ReactNode } or { number: { style: CSSProperties, label: ReactNode } } | |
825
+ | max | 最大值 | number | 100 | |
826
+ | min | 最小值 | number | 0 | |
827
+ | range | 双滑块模式 | boolean \| | false | |
828
+ | reverse | 反向坐标轴 | boolean | false | |
829
+ | step | 步长,取值必须大于 0,并且可被 (max - min) 整除。当 | number \| null | 1 | |
830
+ | styles | 语义化结构 styles | | - | 5.10.0 |
831
+ | tooltip | 设置 Tooltip 相关属性 | | - | 4.23.0 |
832
+ | value | 设置当前取值。当 | number \| [number, number] | - | |
833
+ | vertical | 值为 true 时,Slider 为垂直方向 | boolean | false | |
834
+ | onChangeComplete | 与 | (value) => void | - | |
835
+ | onChange | 当 Slider 的值发生改变时,会触发 onChange 事件,并把改变后的值作为参数传入 | (value) => void | - | |
836
+
837
+
838
+ ### range
839
+
840
+ | 参数 | 说明 | 类型 | 默认值 | 版本 |
841
+ |--------|--------|--------|--------|--------|
842
+ | draggableTrack | 范围刻度是否可被拖拽 | boolean | false | |
843
+ | editable | 启动动态增减节点,不能和 | boolean | false | 5.20.0 |
844
+ | minCount | 配置 | number | 0 | 5.20.0 |
845
+ | maxCount | 配置 | number | - | 5.20.0 |
846
+
847
+
848
+ ### tooltip
849
+
850
+ | 参数 | 说明 | 类型 | 默认值 | 版本 |
851
+ |--------|--------|--------|--------|--------|
852
+ | autoAdjustOverflow | 是否自动调整弹出位置 | boolean | true | 5.8.0 |
853
+ | open | 值为 true 时,Tooltip 将会始终显示;否则始终不显示,哪怕在拖拽及移入时 | boolean | - | 4.23.0 |
854
+ | placement | 设置 Tooltip 展示位置。参考 | string | - | 4.23.0 |
855
+ | getPopupContainer | Tooltip 渲染父节点,默认渲染到 body 上 | (triggerNode) => HTMLElement | () => document.body | 4.23.0 |
856
+ | formatter | Slider 会把当前值传给 | value => ReactNode \| null | IDENTITY | 4.23.0 |
857
+
858
+
859
+ ## 方法
860
+
861
+ | 名称 | 描述 | 版本 |
862
+ |--------|--------|--------|
863
+ | blur() | 移除焦点 | |
864
+ | focus() | 获取焦点 | |
865
+
866
+
867
+
868
+
869
+ <DemoTitle title="Skeleton" desc="在内容加载时提供占位图形展示。">
870
+ ## antd API
871
+
872
+ 通用属性参考:[通用属性](/docs/react/common-props)
873
+
874
+ ### Skeleton
875
+
876
+ | 属性 | 说明 | 类型 | 默认值 |
877
+ |--------|--------|--------|--------|
878
+ | active | 是否展示动画效果 | boolean | false |
879
+ | avatar | 是否显示头像占位图 | boolean \| | false |
880
+ | loading | 为 true 时,显示占位图。反之则直接展示子组件 | boolean | - |
881
+ | paragraph | 是否显示段落占位图 | boolean \| | true |
882
+ | round | 为 true 时,段落和标题显示圆角 | boolean | false |
883
+ | title | 是否显示标题占位图 | boolean \| | true |
884
+
885
+
886
+ ### SkeletonAvatarProps
887
+
888
+ | 属性 | 说明 | 类型 | 默认值 |
889
+ |--------|--------|--------|--------|
890
+ | active | 是否展示动画效果,仅在单独使用头像骨架时生效 | boolean | false |
891
+ | shape | 指定头像的形状 | circle | - |
892
+ | size | 设置头像占位图的大小 | number \| | - |
893
+
894
+
895
+ ### SkeletonTitleProps
896
+
897
+ | 属性 | 说明 | 类型 | 默认值 |
898
+ |--------|--------|--------|--------|
899
+ | width | 设置标题占位图的宽度 | number \| string | - |
900
+
901
+
902
+ ### SkeletonParagraphProps
903
+
904
+ | 属性 | 说明 | 类型 | 默认值 |
905
+ |--------|--------|--------|--------|
906
+ | rows | 设置段落占位图的行数 | number | - |
907
+ | width | 设置段落占位图的宽度,若为数组时则为对应的每行宽度,反之则是最后一行的宽度 | number \| string \| Array | - |
908
+
909
+
910
+ ### SkeletonButtonProps
911
+
912
+ | 属性 | 说明 | 类型 | 默认值 | 版本 |
913
+ |--------|--------|--------|--------|--------|
914
+ | active | 是否展示动画效果 | boolean | false | |
915
+ | block | 将按钮宽度调整为其父宽度的选项 | boolean | false | 4.17.0 |
916
+ | shape | 指定按钮的形状 | circle | - | |
917
+ | size | 设置按钮的大小 | large | - | |
918
+
919
+
920
+ ### SkeletonInputProps
921
+
922
+ | 属性 | 说明 | 类型 | 默认值 |
922
923
  |--------|--------|--------|--------|
923
924
  | active | 是否展示动画效果 | boolean | false |
924
925
  | size | 设置输入框的大小 | large | - |
@@ -1024,18 +1025,6 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
1024
1025
 
1025
1026
 
1026
1027
 
1027
- <DemoTitle title="Result" desc="为操作结果提供反馈信息的展示。">
1028
- ## API
1029
-
1030
- | 属性名 | 描述 | 类型 | 默认值 |
1031
- |--------|--------|--------|--------|
1032
- | texture | 是否显示纹理 | boolean | false |
1033
-
1034
-
1035
-
1036
-
1037
-
1038
-
1039
1028
  <DemoTitle title="RadioButton" desc="用于在多个备选项中选中单个状态。">
1040
1029
  #### API
1041
1030
 
@@ -1111,88 +1100,76 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
1111
1100
 
1112
1101
 
1113
1102
 
1114
- <DemoTitle title="Radio" desc="用于在多个备选项中选中单个状态。">
1103
+ <DemoTitle title="MdEditor" desc="提示词编辑器,可以高亮 Markdown 的语法,支持自定义槽位变量的插入">
1115
1104
  #### API
1116
1105
 
1117
- <AntdApiRef url="https://ant.design/components/radio-cn/#api"></AntdApiRef>
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 | |
1118
1116
 
1119
1117
 
1120
- ## antd API
1121
1118
 
1122
- 通用属性参考:[通用属性](/docs/react/common-props)
1123
1119
 
1124
- ### Radio/Radio.Button
1120
+ <DemoTitle title="Result" desc="为操作结果提供反馈信息的展示。">
1121
+ ## API
1125
1122
 
1126
- <!-- prettier-ignore -->
1127
- | 参数 | 说明 | 类型 | 默认值 |
1123
+ | 属性名 | 描述 | 类型 | 默认值 |
1128
1124
  |--------|--------|--------|--------|
1129
- | autoFocus | 自动获取焦点 | boolean | false |
1130
- | checked | 指定当前是否选中 | boolean | false |
1131
- | defaultChecked | 初始是否选中 | boolean | false |
1132
- | disabled | 禁用 Radio | boolean | false |
1133
- | value | 根据 value 进行比较,判断是否选中 | any | - |
1134
-
1125
+ | texture | 是否显示纹理 | boolean | false |
1135
1126
 
1136
- ### Radio.Group
1137
1127
 
1138
- 单选框组合,用于包裹一组 `Radio`。
1139
1128
 
1140
- <!-- prettier-ignore -->
1141
- | 参数 | 说明 | 类型 | 默认值 | 版本 |
1142
- |--------|--------|--------|--------|--------|
1143
- | buttonStyle | RadioButton 的风格样式,目前有描边和填色两种风格 | outline | outline | | |
1144
- | defaultValue | 默认选中的值 | any | - | | |
1145
- | disabled | 禁选所有子单选器 | boolean | false | | |
1146
- | name | RadioGroup 下所有 | string | - | | |
1147
- | options | 以配置形式设置子元素 | string[] \| number[] \| Array< | - | | |
1148
- | optionType | 用于设置 Radio | default | default | 4.4.0 | |
1149
- | size | 大小,只对按钮样式生效 | large | - | | |
1150
- | value | 用于设置当前选中的值 | any | - | | |
1151
- | block | 将 RadioGroup 宽度调整为其父宽度的选项 | boolean | false | 5.21.0 | |
1152
- | onChange | 选项变化时的回调函数 | function(e:Event) | - | | |
1153
1129
 
1154
1130
 
1155
- ### CheckboxOptionType
1156
1131
 
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 |
1132
+ <DemoTitle title="Popover" desc="点击/鼠标移入元素,弹出气泡式的卡片浮层">
1133
+ #### API
1168
1134
 
1135
+ <AntdApiRef url="https://ant.design/components/popover-cn/#api"></AntdApiRef>
1169
1136
 
1170
- ## 方法
1171
1137
 
1172
- ### Radio
1138
+ ## antd API
1173
1139
 
1174
- | 名称 | 描述 |
1175
- |--------|--------|
1176
- | blur() | 移除焦点 |
1177
- | focus() | 获取焦点 |
1140
+ 通用属性参考:[通用属性](/docs/react/common-props)
1178
1141
 
1142
+ | 参数 | 说明 | 类型 | 默认值 | 版本 |
1143
+ |--------|--------|--------|--------|--------|
1144
+ | content | 卡片内容 | ReactNode \| () => ReactNode | - | |
1145
+ | title | 卡片标题 | ReactNode \| () => ReactNode | - | |
1179
1146
 
1180
1147
 
1148
+ <!-- 共同的 API -->
1149
+ 以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
1181
1150
 
1182
- <DemoTitle title="MdEditor" desc="提示词编辑器,可以高亮 Markdown 的语法,支持自定义槽位变量的插入">
1183
- #### API
1151
+ <!-- prettier-ignore -->
1152
+ | 参数 | 说明 | 类型 | 默认值 | 版本 |
1153
+ |--------|--------|--------|--------|--------|
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 |
1184
1169
 
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 | |
1170
+ ## 注意
1195
1171
 
1172
+ 请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
1196
1173
 
1197
1174
 
1198
1175
 
@@ -1248,47 +1225,118 @@ TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/ser
1248
1225
 
1249
1226
 
1250
1227
 
1251
- <DemoTitle title="Popover" desc="点击/鼠标移入元素,弹出气泡式的卡片浮层">
1228
+ <DemoTitle title="Radio" desc="用于在多个备选项中选中单个状态。">
1252
1229
  #### API
1253
1230
 
1254
- <AntdApiRef url="https://ant.design/components/popover-cn/#api"></AntdApiRef>
1231
+ <AntdApiRef url="https://ant.design/components/radio-cn/#api"></AntdApiRef>
1255
1232
 
1256
1233
 
1257
1234
  ## antd API
1258
1235
 
1259
1236
  通用属性参考:[通用属性](/docs/react/common-props)
1260
1237
 
1261
- | 参数 | 说明 | 类型 | 默认值 | 版本 |
1262
- |--------|--------|--------|--------|--------|
1263
- | content | 卡片内容 | ReactNode \| () => ReactNode | - | |
1264
- | title | 卡片标题 | ReactNode \| () => ReactNode | - | |
1238
+ ### Radio/Radio.Button
1265
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 | - |
1266
1248
 
1267
- <!-- 共同的 API -->
1268
- 以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
1249
+
1250
+ ### Radio.Group
1251
+
1252
+ 单选框组合,用于包裹一组 `Radio`。
1269
1253
 
1270
1254
  <!-- prettier-ignore -->
1271
1255
  | 参数 | 说明 | 类型 | 默认值 | 版本 |
1272
1256
  |--------|--------|--------|--------|--------|
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 |
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) | - | | |
1288
1267
 
1289
- ## 注意
1290
1268
 
1291
- 请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。
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() | 获取焦点 |
1292
+
1293
+
1294
+
1295
+
1296
+ <DemoTitle title="Pagination" desc="分页器用于分隔长列表,每次只加载一个页面。">
1297
+ ## API
1298
+
1299
+ | 属性名 | 描述 | 类型 | 默认值 |
1300
+ |--------|--------|--------|--------|
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) | - | |
1339
+
1292
1340
 
1293
1341
 
1294
1342
 
@@ -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
 
@@ -1492,6 +1493,106 @@ notification.config({
1492
1493
 
1493
1494
 
1494
1495
 
1496
+ <DemoTitle title="Message" desc="一条简洁且临时显示的消息,为操作提供全局反馈">
1497
+ #### API
1498
+
1499
+ | 属性名 | 描述 | 类型 | 默认值 |
1500
+ |--------|--------|--------|--------|
1501
+ | conent | 显示的内容 | string | "" |
1502
+
1503
+ <AntdApiRef url="https://ant.design/components/message-cn/#api"></AntdApiRef>
1504
+
1505
+
1506
+ ## antd API
1507
+
1508
+ 通用属性参考:[通用属性](/docs/react/common-props)
1509
+
1510
+ 组件提供了一些静态方法,使用方式和参数如下:
1511
+
1512
+
1513
+ - `message.success(content, [duration], onClose)`
1514
+ - `message.error(content, [duration], onClose)`
1515
+ - `message.info(content, [duration], onClose)`
1516
+ - `message.warning(content, [duration], onClose)`
1517
+ - `message.loading(content, [duration], onClose)`
1518
+
1519
+ | 参数 | 说明 | 类型 | 默认值 |
1520
+ |--------|--------|--------|--------|
1521
+ | content | 提示内容 | ReactNode \| config | - |
1522
+ | duration | 自动关闭的延时,单位秒。设为 0 时不自动关闭 | number | 3 |
1523
+ | onClose | 关闭时触发的回调函数 | function | - |
1524
+
1525
+
1526
+ 组件同时提供 promise 接口。
1527
+
1528
+
1529
+ - `message[level](content, [duration]).then(afterClose)`
1530
+ - `message[level](content, [duration], onClose).then(afterClose)`
1531
+
1532
+ 其中 `message[level]` 是组件已经提供的静态方法。`then` 接口返回值是 Promise。
1533
+
1534
+ 也可以对象的形式传递参数:
1535
+
1536
+
1537
+ - `message.open(config)`
1538
+ - `message.success(config)`
1539
+ - `message.error(config)`
1540
+ - `message.info(config)`
1541
+ - `message.warning(config)`
1542
+ - `message.loading(config)`
1543
+
1544
+ `config` 对象属性如下:
1545
+
1546
+ | 参数 | 说明 | 类型 | 默认值 |
1547
+ |--------|--------|--------|--------|
1548
+ | className | 自定义 CSS class | string | - |
1549
+ | content | 提示内容 | ReactNode | - |
1550
+ | duration | 自动关闭的延时,单位秒。设为 0 时不自动关闭 | number | 3 |
1551
+ | icon | 自定义图标 | ReactNode | - |
1552
+ | key | 当前提示的唯一标志 | string \| number | - |
1553
+ | style | 自定义内联样式 | | - |
1554
+ | onClick | 点击 message 时触发的回调函数 | function | - |
1555
+ | onClose | 关闭时触发的回调函数 | function | - |
1556
+
1557
+
1558
+ ### 全局方法
1559
+
1560
+ 还提供了全局配置和全局销毁方法:
1561
+
1562
+
1563
+ - `message.config(options)`
1564
+ - `message.destroy()`
1565
+
1566
+ 也可通过 `message.destroy(key)` 来关闭一条消息。
1567
+
1568
+ #### message.config
1569
+
1570
+ 当你使用 `ConfigProvider` 进行全局化配置时,系统会默认自动开启 RTL 模式。(4.3.0+)当你想单独使用,可通过如下设置开启 RTL 模式。
1571
+
1572
+
1573
+ ```js
1574
+ message.config({
1575
+ top: 100,
1576
+ duration: 2,
1577
+ maxCount: 3,
1578
+ rtl: true,
1579
+ prefixCls: 'my-message',
1580
+ });
1581
+ ```
1582
+
1583
+
1584
+ | 参数 | 说明 | 类型 | 默认值 | 版本 |
1585
+ |--------|--------|--------|--------|--------|
1586
+ | duration | 默认自动关闭延时,单位秒 | number | 3 | |
1587
+ | getContainer | 配置渲染节点的输出位置,但依旧为全屏展示 | () => HTMLElement | () => document.body | |
1588
+ | maxCount | 最大显示数,超过限制时,最早的消息会被自动关闭 | number | - | |
1589
+ | prefixCls | 消息节点的 className 前缀 | string | ant-message | 4.5.0 |
1590
+ | rtl | 是否开启 RTL 模式 | boolean | false | |
1591
+ | top | 消息距离顶部的位置 | string \| number | 8 | |
1592
+
1593
+
1594
+
1595
+
1495
1596
  <DemoTitle title="Modal" desc="用于叠加当前页面上的对话框窗口,提供标题、内容区、操作区。">
1496
1597
  #### API
1497
1598
 
@@ -1662,155 +1763,190 @@ const confirmed = await modal.confirm({ ... });
1662
1763
 
1663
1764
 
1664
1765
 
1665
- <DemoTitle title="Message" desc="一条简洁且临时显示的消息,为操作提供全局反馈">
1766
+ <DemoTitle title="InputNumber" desc="通过鼠标或键盘,输入范围内的数值。">
1666
1767
  #### API
1667
1768
 
1668
- | 属性名 | 描述 | 类型 | 默认值 |
1669
- |--------|--------|--------|--------|
1670
- | conent | 显示的内容 | string | "" |
1671
-
1672
- <AntdApiRef url="https://ant.design/components/message-cn/#api"></AntdApiRef>
1769
+ <AntdApiRef url="https://ant.design/components/input-number-cn/#api"></AntdApiRef>
1673
1770
 
1674
1771
 
1675
1772
  ## antd API
1676
1773
 
1677
1774
  通用属性参考:[通用属性](/docs/react/common-props)
1678
1775
 
1679
- 组件提供了一些静态方法,使用方式和参数如下:
1680
-
1681
-
1682
- - `message.success(content, [duration], onClose)`
1683
- - `message.error(content, [duration], onClose)`
1684
- - `message.info(content, [duration], onClose)`
1685
- - `message.warning(content, [duration], onClose)`
1686
- - `message.loading(content, [duration], onClose)`
1687
-
1688
- | 参数 | 说明 | 类型 | 默认值 |
1689
- |--------|--------|--------|--------|
1690
- | content | 提示内容 | ReactNode \| config | - |
1691
- | duration | 自动关闭的延时,单位秒。设为 0 时不自动关闭 | number | 3 |
1692
- | onClose | 关闭时触发的回调函数 | function | - |
1776
+ | 参数 | 说明 | 类型 | 默认值 | 版本 |
1777
+ |--------|--------|--------|--------|--------|
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 |
1693
1806
 
1694
1807
 
1695
- 组件同时提供 promise 接口。
1808
+ ## Ref
1696
1809
 
1810
+ | 名称 | 说明 | 参数 | 版本 |
1811
+ |--------|--------|--------|--------|
1812
+ | blur() | 移除焦点 | - | |
1813
+ | focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 |
1814
+ | nativeElement | 获取原生 DOM 元素 | - | 5.17.3 |
1697
1815
 
1698
- - `message[level](content, [duration]).then(afterClose)`
1699
- - `message[level](content, [duration], onClose).then(afterClose)`
1700
1816
 
1701
- 其中 `message[level]` 是组件已经提供的静态方法。`then` 接口返回值是 Promise。
1702
1817
 
1703
- 也可以对象的形式传递参数:
1704
1818
 
1819
+ <DemoTitle title="Input" desc="通过鼠标或键盘输入内容,为表单提供输入字段的基础容器。。">
1820
+ #### API
1705
1821
 
1706
- - `message.open(config)`
1707
- - `message.success(config)`
1708
- - `message.error(config)`
1709
- - `message.info(config)`
1710
- - `message.warning(config)`
1711
- - `message.loading(config)`
1822
+ | 属性名 | 描述 | 类型 | 默认值 |
1823
+ |--------|--------|--------|--------|
1824
+ | shape | 形态 | 'default' \| 'round' | default 默认 |
1712
1825
 
1713
- `config` 对象属性如下:
1714
1826
 
1715
- | 参数 | 说明 | 类型 | 默认值 |
1716
- |--------|--------|--------|--------|
1717
- | className | 自定义 CSS class | string | - |
1718
- | content | 提示内容 | ReactNode | - |
1719
- | duration | 自动关闭的延时,单位秒。设为 0 时不自动关闭 | number | 3 |
1720
- | icon | 自定义图标 | ReactNode | - |
1721
- | key | 当前提示的唯一标志 | string \| number | - |
1722
- | style | 自定义内联样式 | | - |
1723
- | onClick | 点击 message 时触发的回调函数 | function | - |
1724
- | onClose | 关闭时触发的回调函数 | function | - |
1827
+ <AntdApiRef url="https://ant.design/components/input-cn/#api"></AntdApiRef>
1725
1828
 
1726
1829
 
1727
- ### 全局方法
1830
+ ## antd API
1728
1831
 
1729
- 还提供了全局配置和全局销毁方法:
1832
+ 通用属性参考:[通用属性](/docs/react/common-props)
1730
1833
 
1834
+ ### Input
1731
1835
 
1732
- - `message.config(options)`
1733
- - `message.destroy()`
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 |
1734
1859
 
1735
- 也可通过 `message.destroy(key)` 来关闭一条消息。
1736
1860
 
1737
- #### message.config
1861
+ 如果 `Input` 在 `Form.Item` 内,并且 `Form.Item` 设置了 `id` 属性,则 `value` `defaultValue` 和 `id` 属性会被自动设置。
1738
1862
 
1739
- 当你使用 `ConfigProvider` 进行全局化配置时,系统会默认自动开启 RTL 模式。(4.3.0+)当你想单独使用,可通过如下设置开启 RTL 模式。
1863
+ Input 的其他属性和 React 自带的 [input](https://reactjs.org/docs/dom-elements.html#all-supported-html-attributes) 一致。
1740
1864
 
1865
+ #### CountConfig
1741
1866
 
1742
- ```js
1743
- message.config({
1744
- top: 100,
1745
- duration: 2,
1746
- maxCount: 3,
1747
- rtl: true,
1748
- prefixCls: 'my-message',
1749
- });
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
+ }
1750
1879
  ```
1751
1880
 
1752
1881
 
1882
+ ### Input.TextArea
1883
+
1884
+ 同 Input 属性,外加:
1885
+
1753
1886
  | 参数 | 说明 | 类型 | 默认值 | 版本 |
1754
1887
  |--------|--------|--------|--------|--------|
1755
- | duration | 默认自动关闭延时,单位秒 | number | 3 | |
1756
- | getContainer | 配置渲染节点的输出位置,但依旧为全屏展示 | () => HTMLElement | () => document.body | |
1757
- | maxCount | 最大显示数,超过限制时,最早的消息会被自动关闭 | number | - | |
1758
- | prefixCls | 消息节点的 className 前缀 | string | ant-message | 4.5.0 |
1759
- | rtl | 是否开启 RTL 模式 | boolean | false | |
1760
- | top | 消息距离顶部的位置 | string \| number | 8 | |
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 |
1761
1891
 
1762
1892
 
1893
+ `Input.TextArea` 的其他属性和浏览器自带的 [textarea](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) 一致。
1763
1894
 
1895
+ ### Input.Search
1764
1896
 
1765
- <DemoTitle title="InputNumber" desc="通过鼠标或键盘,输入范围内的数值。">
1766
- #### API
1897
+ | 参数 | 说明 | 类型 | 默认值 |
1898
+ |--------|--------|--------|--------|
1899
+ | enterButton | 是否有确认按钮,可设为按钮文字。该属性会与 | ReactNode | false |
1900
+ | loading | 搜索 loading | boolean | false |
1901
+ | onSearch | 点击搜索图标、清除图标,或按下回车键时的回调 | function(value, event, { source: "input" \| "clear" }) | - |
1767
1902
 
1768
- <AntdApiRef url="https://ant.design/components/input-number-cn/#api"></AntdApiRef>
1769
1903
 
1904
+ 其余属性和 Input 一致。
1770
1905
 
1771
- ## antd API
1906
+ ### Input.Password
1772
1907
 
1773
- 通用属性参考:[通用属性](/docs/react/common-props)
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,则会在控制台抛出警告。
1774
1919
 
1775
1920
  | 参数 | 说明 | 类型 | 默认值 | 版本 |
1776
1921
  |--------|--------|--------|--------|--------|
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 |
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 |
1805
1934
 
1806
1935
 
1807
- ## Ref
1936
+ #### VisibilityToggle
1937
+
1938
+ | Property | Description | Type | Default | Version |
1939
+ |--------|--------|--------|--------|--------|
1940
+ | visible | 用于手动控制密码显隐 | boolean | false | 4.24 |
1941
+ | onVisibleChange | 显隐密码的回调 | (visible) => void | - | 4.24 |
1942
+
1943
+
1944
+ #### Input Methods
1808
1945
 
1809
1946
  | 名称 | 说明 | 参数 | 版本 |
1810
1947
  |--------|--------|--------|--------|
1811
- | blur() | 移除焦点 | - | |
1812
- | focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 |
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
 
@@ -1957,162 +2093,27 @@ type TransformAction =
1957
2093
  onZoomOut: () => void;
1958
2094
  onZoomIn: () => void;
1959
2095
  onReset: () => void; // 5.17.3 之后支持
1960
- onClose: () => void;
1961
- };
1962
- transform: TransformType,
1963
- current: number;
1964
- total: number;
1965
- image: ImgInfo
1966
- }
1967
- ```
1968
-
1969
-
1970
- ### ImgInfo
1971
-
1972
-
1973
- ```typescript
1974
- {
1975
- url: string;
1976
- alt: string;
1977
- width: string | number;
1978
- height: string | number;
1979
- }
1980
- ```
1981
-
1982
-
1983
-
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
2096
+ onClose: () => void;
2097
+ };
2098
+ transform: TransformType,
2099
+ current: number;
2100
+ total: number;
2101
+ image: ImgInfo
2102
+ }
2103
+ ```
2103
2104
 
2104
- | Property | Description | Type | Default | Version |
2105
- |--------|--------|--------|--------|--------|
2106
- | visible | 用于手动控制密码显隐 | boolean | false | 4.24 |
2107
- | onVisibleChange | 显隐密码的回调 | (visible) => void | - | 4.24 |
2108
2105
 
2106
+ ### ImgInfo
2109
2107
 
2110
- #### Input Methods
2111
2108
 
2112
- | 名称 | 说明 | 参数 | 版本 |
2113
- |--------|--------|--------|--------|
2114
- | blur | 取消焦点 | - | |
2115
- | focus | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | option - 4.10.0 |
2109
+ ```typescript
2110
+ {
2111
+ url: string;
2112
+ alt: string;
2113
+ width: string | number;
2114
+ height: string | number;
2115
+ }
2116
+ ```
2116
2117
 
2117
2118
 
2118
2119
 
@@ -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
 
@@ -4158,6 +4160,77 @@ npm install antd @agentscope-ai/icons @agentscope-ai/design --save
4158
4160
 
4159
4161
 
4160
4162
 
4163
+ # 使用
4164
+
4165
+ 如果您有自己的 iconfont 项目,可以将您的图标集成到 Spark Design 中,并通过简单的符号名称访问您的图标。
4166
+
4167
+
4168
+ ```tsx
4169
+ import {
4170
+ ConfigProvider,
4171
+ purpleTheme,
4172
+ Button,
4173
+ IconFont,
4174
+ IconButton,
4175
+ } from '@agentscope-ai/design';
4176
+ import { Flex } from 'antd';
4177
+ import zhCN from 'antd/locale/zh_CN';
4178
+ import { useState } from 'react';
4179
+
4180
+ const App = () => {
4181
+ const prefix = 'sps';
4182
+ const iconSymbol = 'spark-effciency-line';
4183
+ const iconfont = '//at.alicdn.com/t/a/font_4807885_ugexdeaoq7.js'; // 您可以从 https://www.iconfont.cn/ 获取
4184
+ return (
4185
+ <ConfigProvider
4186
+ {...purpleTheme}
4187
+ prefix={prefix}
4188
+ prefixCls={prefix}
4189
+ iconfont={iconfont}
4190
+ locale={zhCN}
4191
+ style={{
4192
+ width: '100%',
4193
+ height: '100%',
4194
+ }}
4195
+ >
4196
+ <Flex
4197
+ style={{
4198
+ width: '100%',
4199
+ height: '100%',
4200
+ backgroundColor: `var(--${prefix}-color-bg-base)`,
4201
+ }}
4202
+ justify="center"
4203
+ align="center"
4204
+ >
4205
+ <Flex vertical gap={16} style={{ width: '300px', padding: '12px 0' }}>
4206
+ <Flex gap={8}>
4207
+ <div style={{ width: '100px', lineHeight: '32px' }}>IconFont:</div>
4208
+ <IconFont type={iconSymbol} />
4209
+ </Flex>
4210
+ <Flex gap={8}>
4211
+ <div style={{ width: '100px', lineHeight: '32px' }}>Button:</div>
4212
+ <Button type="primary" iconType={iconSymbol}>
4213
+ 添加用户
4214
+ </Button>
4215
+ </Flex>
4216
+ <Flex gap={8}>
4217
+ <div style={{ width: '100px', lineHeight: '32px' }}>
4218
+ IconButton:
4219
+ </div>
4220
+ <IconButton iconType={iconSymbol}></IconButton>
4221
+ </Flex>
4222
+ </Flex>
4223
+ </Flex>
4224
+ </ConfigProvider>
4225
+ );
4226
+ };
4227
+
4228
+ export default App;
4229
+ ```
4230
+
4231
+
4232
+
4233
+
4161
4234
  # 从 Antd 迁移
4162
4235
 
4163
4236
  ## 📦 安装
@@ -4316,77 +4389,6 @@ export default App;
4316
4389
 
4317
4390
 
4318
4391
 
4319
- # 使用
4320
-
4321
- 如果您有自己的 iconfont 项目,可以将您的图标集成到 Spark Design 中,并通过简单的符号名称访问您的图标。
4322
-
4323
-
4324
- ```tsx
4325
- import {
4326
- ConfigProvider,
4327
- purpleTheme,
4328
- Button,
4329
- IconFont,
4330
- IconButton,
4331
- } from '@agentscope-ai/design';
4332
- import { Flex } from 'antd';
4333
- import zhCN from 'antd/locale/zh_CN';
4334
- import { useState } from 'react';
4335
-
4336
- const App = () => {
4337
- const prefix = 'sps';
4338
- const iconSymbol = 'spark-effciency-line';
4339
- const iconfont = '//at.alicdn.com/t/a/font_4807885_ugexdeaoq7.js'; // 您可以从 https://www.iconfont.cn/ 获取
4340
- return (
4341
- <ConfigProvider
4342
- {...purpleTheme}
4343
- prefix={prefix}
4344
- prefixCls={prefix}
4345
- iconfont={iconfont}
4346
- locale={zhCN}
4347
- style={{
4348
- width: '100%',
4349
- height: '100%',
4350
- }}
4351
- >
4352
- <Flex
4353
- style={{
4354
- width: '100%',
4355
- height: '100%',
4356
- backgroundColor: `var(--${prefix}-color-bg-base)`,
4357
- }}
4358
- justify="center"
4359
- align="center"
4360
- >
4361
- <Flex vertical gap={16} style={{ width: '300px', padding: '12px 0' }}>
4362
- <Flex gap={8}>
4363
- <div style={{ width: '100px', lineHeight: '32px' }}>IconFont:</div>
4364
- <IconFont type={iconSymbol} />
4365
- </Flex>
4366
- <Flex gap={8}>
4367
- <div style={{ width: '100px', lineHeight: '32px' }}>Button:</div>
4368
- <Button type="primary" iconType={iconSymbol}>
4369
- 添加用户
4370
- </Button>
4371
- </Flex>
4372
- <Flex gap={8}>
4373
- <div style={{ width: '100px', lineHeight: '32px' }}>
4374
- IconButton:
4375
- </div>
4376
- <IconButton iconType={iconSymbol}></IconButton>
4377
- </Flex>
4378
- </Flex>
4379
- </Flex>
4380
- </ConfigProvider>
4381
- );
4382
- };
4383
-
4384
- export default App;
4385
- ```
4386
-
4387
-
4388
-
4389
-
4390
4392
  # 使用
4391
4393
 
4392
4394
 
@@ -4543,7 +4545,7 @@ export default App;
4543
4545
  "borderRadiusXL": 12,
4544
4546
  "borderRadiusFull": 999,
4545
4547
  "wireframe": false,
4546
- "colorPrimaryBg": "#F2F0FF",
4548
+ "colorPrimaryBg": "rgba(97, 92, 237, 0.08)",
4547
4549
  "colorPrimaryBgHover": "#F2F0FF",
4548
4550
  "colorPrimaryBorder": "#E2DEFF",
4549
4551
  "colorPrimaryBorderHover": "#BCB5FF",
@@ -4598,7 +4600,9 @@ export default App;
4598
4600
  "colorLink": "#615CED",
4599
4601
  "boxShadow": "0px 4px 6px 0px rgba(0, 0, 0, 0.08)",
4600
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)",
4601
- "colorTextWhite": "#fff",
4603
+
4604
+ "colorTextWhite": "#ffffff",
4605
+ "colorTextOnPrimary": "#ffffff",
4602
4606
  "colorFillDisable": "#DBDAE7",
4603
4607
  "colorPurple": "#615CED",
4604
4608
  "colorPurpleHover": "#8080FF",
@@ -4700,7 +4704,9 @@ export default App;
4700
4704
  "colorLink": "#5551CC",
4701
4705
  "boxShadow": "0px 4px 6px 0px rgba(255, 255, 255, 0.08)",
4702
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)",
4703
- "colorTextWhite": "#fff",
4707
+
4708
+ "colorTextWhite": "#fff",
4709
+ "colorTextOnPrimary": "#fff",
4704
4710
  "colorFillDisable": "#8D8C98",
4705
4711
  "colorPurple": "#5551CC",
4706
4712
  "colorPurpleHover": "#8383F0",
@@ -4803,7 +4809,9 @@ export default App;
4803
4809
  "colorLink": "rgba(0, 77, 255, 1)",
4804
4810
  "boxShadow": "0px 4px 6px 0px rgba(0, 0, 0, 0.08)",
4805
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)",
4806
- "colorTextWhite": "rgba(255, 255, 255, 1)",
4812
+
4813
+ "colorTextWhite": "#ffffff",
4814
+ "colorTextOnPrimary": "#ffffff",
4807
4815
  "colorFillDisable": "rgba(232, 232, 235, 1)",
4808
4816
  "colorPurple": "rgba(97, 92, 237, 1)",
4809
4817
  "colorPurpleHover": "#8080FF",
@@ -4902,7 +4910,9 @@ export default App;
4902
4910
  "colorLink": "#4D7DFF",
4903
4911
  "boxShadow": "0px 4px 6px 0px rgba(255, 255, 255, 0.08)",
4904
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)",
4905
- "colorTextWhite": "#FFFFFF",
4913
+
4914
+ "colorTextWhite": "#ffffff",
4915
+ "colorTextOnPrimary": "#000000",
4906
4916
  "colorFillDisable": "#898989",
4907
4917
  "colorPurple": "#615CED",
4908
4918
  "colorPurpleHover": "#8383F0",