From cef58664e8966ef1da775f3b9777ed8ef496e83a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=91=E9=9B=A8?= Date: Tue, 11 Apr 2023 10:25:24 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9Ddoc:=20add=20design=20token=20=20ta?= =?UTF-8?q?ble=20(#41717)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * ✨feat: add token * 📝doc: update lint * 📝doc: update doc --- components/app/index.en-US.md | 4 ++++ components/app/index.zh-CN.md | 4 ++++ components/auto-complete/index.en-US.md | 4 ++++ components/auto-complete/index.zh-CN.md | 4 ++++ components/avatar/index.en-US.md | 4 ++++ components/avatar/index.zh-CN.md | 4 ++++ components/badge/index.en-US.md | 4 ++++ components/badge/index.zh-CN.md | 4 ++++ components/calendar/index.en-US.md | 4 ++++ components/calendar/index.zh-CN.md | 4 ++++ components/card/index.en-US.md | 4 ++++ components/card/index.zh-CN.md | 4 ++++ components/carousel/index.en-US.md | 4 ++++ components/carousel/index.zh-CN.md | 4 ++++ components/cascader/index.en-US.md | 4 ++++ components/cascader/index.zh-CN.md | 4 ++++ components/checkbox/index.en-US.md | 4 ++++ components/checkbox/index.zh-CN.md | 4 ++++ components/collapse/index.en-US.md | 4 ++++ components/collapse/index.zh-CN.md | 4 ++++ components/date-picker/index.en-US.md | 4 ++++ components/date-picker/index.zh-CN.md | 4 ++++ components/descriptions/index.en-US.md | 4 ++++ components/descriptions/index.zh-CN.md | 4 ++++ components/drawer/index.en-US.md | 4 ++++ components/drawer/index.zh-CN.md | 4 ++++ components/empty/index.en-US.md | 4 ++++ components/empty/index.zh-CN.md | 4 ++++ components/float-button/index.en-US.md | 4 ++++ components/float-button/index.zh-CN.md | 4 ++++ components/form/index.en-US.md | 4 ++++ components/form/index.zh-CN.md | 4 ++++ components/grid/index.en-US.md | 4 ++++ components/grid/index.zh-CN.md | 4 ++++ components/icon/index.en-US.md | 4 ++++ components/icon/index.zh-CN.md | 4 ++++ components/image/index.en-US.md | 4 ++++ components/image/index.zh-CN.md | 4 ++++ components/input-number/index.en-US.md | 4 ++++ components/input-number/index.zh-CN.md | 4 ++++ components/list/index.en-US.md | 4 ++++ components/list/index.zh-CN.md | 4 ++++ components/mentions/index.en-US.md | 4 ++++ components/mentions/index.zh-CN.md | 4 ++++ components/message/index.en-US.md | 4 ++++ components/message/index.zh-CN.md | 4 ++++ components/modal/index.en-US.md | 4 ++++ components/modal/index.zh-CN.md | 4 ++++ components/notification/index.en-US.md | 4 ++++ components/notification/index.zh-CN.md | 4 ++++ components/popconfirm/index.en-US.md | 4 ++++ components/popconfirm/index.zh-CN.md | 4 ++++ components/popover/index.en-US.md | 4 ++++ components/popover/index.zh-CN.md | 4 ++++ components/progress/index.en-US.md | 4 ++++ components/progress/index.zh-CN.md | 4 ++++ components/qrcode/index.en-US.md | 4 ++++ components/qrcode/index.zh-CN.md | 4 ++++ components/radio/index.en-US.md | 4 ++++ components/radio/index.zh-CN.md | 4 ++++ components/rate/index.en-US.md | 4 ++++ components/rate/index.zh-CN.md | 4 ++++ components/result/index.en-US.md | 4 ++++ components/result/index.zh-CN.md | 4 ++++ components/segmented/index.en-US.md | 4 ++++ components/segmented/index.zh-CN.md | 4 ++++ components/skeleton/index.en-US.md | 4 ++++ components/skeleton/index.zh-CN.md | 4 ++++ components/slider/index.en-US.md | 4 ++++ components/slider/index.zh-CN.md | 4 ++++ components/space/index.en-US.md | 4 ++++ components/space/index.zh-CN.md | 4 ++++ components/spin/index.en-US.md | 4 ++++ components/spin/index.zh-CN.md | 4 ++++ components/statistic/index.en-US.md | 4 ++++ components/statistic/index.zh-CN.md | 4 ++++ components/switch/index.en-US.md | 4 ++++ components/switch/index.zh-CN.md | 4 ++++ components/table/index.en-US.md | 4 ++++ components/table/index.zh-CN.md | 4 ++++ components/tabs/index.en-US.md | 4 ++++ components/tabs/index.zh-CN.md | 4 ++++ components/tag/index.en-US.md | 4 ++++ components/tag/index.zh-CN.md | 4 ++++ components/time-picker/index.en-US.md | 4 ++++ components/time-picker/index.zh-CN.md | 4 ++++ components/timeline/index.en-US.md | 4 ++++ components/timeline/index.zh-CN.md | 4 ++++ components/tooltip/index.en-US.md | 4 ++++ components/tooltip/index.zh-CN.md | 4 ++++ components/tour/index.en-US.md | 4 ++++ components/tour/index.zh-CN.md | 4 ++++ components/transfer/index.en-US.md | 4 ++++ components/transfer/index.zh-CN.md | 4 ++++ components/tree-select/index.en-US.md | 4 ++++ components/tree-select/index.zh-CN.md | 4 ++++ components/tree/index.en-US.md | 4 ++++ components/tree/index.zh-CN.md | 4 ++++ components/upload/index.en-US.md | 4 ++++ components/upload/index.zh-CN.md | 4 ++++ components/watermark/index.en-US.md | 4 ++++ components/watermark/index.zh-CN.md | 4 ++++ 102 files changed, 408 insertions(+) diff --git a/components/app/index.en-US.md b/components/app/index.en-US.md index 45d9003bb1..d6804f75e8 100644 --- a/components/app/index.en-US.md +++ b/components/app/index.en-US.md @@ -126,3 +126,7 @@ export default () => { | --- | --- | --- | --- | --- | | message | Global config for Message | [MessageConfig](/components/message/#messageconfig) | - | 5.3.0 | | notification | Global config for Notification | [NotificationConfig](/components/notification/#notificationconfig) | - | 5.3.0 | + +## Design Token + + diff --git a/components/app/index.zh-CN.md b/components/app/index.zh-CN.md index 61741724d9..97793b5d1e 100644 --- a/components/app/index.zh-CN.md +++ b/components/app/index.zh-CN.md @@ -128,3 +128,7 @@ export default () => { | --- | --- | --- | --- | --- | | message | App 内 Message 的全局配置 | [MessageConfig](/components/message-cn/#messageconfig) | - | 5.3.0 | | notification | App 内 Notification 的全局配置 | [NotificationConfig](/components/notification-cn/#notificationconfig) | - | 5.3.0 | + +## Design Token + + diff --git a/components/auto-complete/index.en-US.md b/components/auto-complete/index.en-US.md index 0460972288..0626e6585f 100644 --- a/components/auto-complete/index.en-US.md +++ b/components/auto-complete/index.en-US.md @@ -72,6 +72,10 @@ The differences with Select are: | blur() | Remove focus | | | focus() | Get focus | | +## Design Token + + + ## FAQ ### Why doesn't the text composition system work well with onSearch in controlled mode? diff --git a/components/auto-complete/index.zh-CN.md b/components/auto-complete/index.zh-CN.md index bdbb05a66f..cca99d6d62 100644 --- a/components/auto-complete/index.zh-CN.md +++ b/components/auto-complete/index.zh-CN.md @@ -74,6 +74,10 @@ demo: | blur() | 移除焦点 | | | focus() | 获取焦点 | | +## Design Token + + + ## FAQ ### 为何受控状态下使用 onSearch 无法输入中文？ diff --git a/components/avatar/index.en-US.md b/components/avatar/index.en-US.md index ba28a9884f..6c20f7b7bd 100644 --- a/components/avatar/index.en-US.md +++ b/components/avatar/index.en-US.md @@ -52,3 +52,7 @@ Avatars can be used to represent people or objects. It supports images, `Icon`s, | maxPopoverTrigger | Set the trigger of excess avatar Popover | `hover` \| `focus` \| `click` | `hover` | 4.17.0 | | maxStyle | The style of excess avatar style | CSSProperties | - | | | size | The size of the avatar | number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...} | `default` | 4.8.0 | + +## Design Token + + diff --git a/components/avatar/index.zh-CN.md b/components/avatar/index.zh-CN.md index b50531c87b..b6bccedbf3 100644 --- a/components/avatar/index.zh-CN.md +++ b/components/avatar/index.zh-CN.md @@ -57,3 +57,7 @@ group: | maxPopoverTrigger | 设置多余头像 Popover 的触发方式 | `hover` \| `focus` \| `click` | `hover` | 4.17.0 | | maxStyle | 多余头像样式 | CSSProperties | - | | | size | 设置头像的大小 | number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...} | `default` | 4.8.0 | + +## Design Token + + diff --git a/components/badge/index.en-US.md b/components/badge/index.en-US.md index a4c8183f6d..6266ea32bd 100644 --- a/components/badge/index.en-US.md +++ b/components/badge/index.en-US.md @@ -57,3 +57,7 @@ Badge normally appears in proximity to notifications or user avatars with eye-ca | color | Customize Ribbon color | string | - | | | placement | The placement of the Ribbon, `start` and `end` follow text direction (RTL or LTR) | `start` \| `end` | `end` | | | text | Content inside the Ribbon | ReactNode | - | | + +## Design Token + + diff --git a/components/badge/index.zh-CN.md b/components/badge/index.zh-CN.md index 63758ab81b..9a2e80c70e 100644 --- a/components/badge/index.zh-CN.md +++ b/components/badge/index.zh-CN.md @@ -58,3 +58,7 @@ group: 数据展示 | color | 自定义缎带的颜色 | string | - | | | placement | 缎带的位置，`start` 和 `end` 随文字方向（RTL 或 LTR）变动 | `start` \| `end` | `end` | | | text | 缎带中填入的内容 | ReactNode | - | | + +## Design Token + + diff --git a/components/calendar/index.en-US.md b/components/calendar/index.en-US.md index 5eed518af9..5a534c9c00 100644 --- a/components/calendar/index.en-US.md +++ b/components/calendar/index.en-US.md @@ -57,6 +57,10 @@ When data is in the form of dates, such as schedules, timetables, prices calenda | onPanelChange | Callback for when panel changes | function(date: Dayjs, mode: string) | - | | | onSelect | Callback for when a date is selected | function(date: Dayjs） | - | | +## Design Token + + + ## FAQ ### How to use Calendar with customize date library? diff --git a/components/calendar/index.zh-CN.md b/components/calendar/index.zh-CN.md index 83e78a1041..56039fdb92 100644 --- a/components/calendar/index.zh-CN.md +++ b/components/calendar/index.zh-CN.md @@ -62,6 +62,10 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*-p-wQLik200AAA | onPanelChange | 日期面板变化回调 | function(date: Dayjs, mode: string) | - | | | onSelect | 点击选择日期回调 | function(date: Dayjs） | - | | +## Design Token + + + ## FAQ ### 如何在 Calendar 中使用自定义日期库 diff --git a/components/card/index.en-US.md b/components/card/index.en-US.md index 8269dfb221..2caa878973 100644 --- a/components/card/index.en-US.md +++ b/components/card/index.en-US.md @@ -71,3 +71,7 @@ A card can be used to display content related to a single subject. The content c | description | Description content | ReactNode | - | | | style | The style object of container | CSSProperties | - | | | title | Title content | ReactNode | - | | + +## Design Token + + diff --git a/components/card/index.zh-CN.md b/components/card/index.zh-CN.md index 9d9f1d1815..fa8712fd78 100644 --- a/components/card/index.zh-CN.md +++ b/components/card/index.zh-CN.md @@ -72,3 +72,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*a-8zR6rrupgAAA | description | 描述内容 | ReactNode | - | | | style | 定义容器类名的样式 | CSSProperties | - | | | title | 标题内容 | ReactNode | - | | + +## Design Token + + diff --git a/components/carousel/index.en-US.md b/components/carousel/index.en-US.md index 2bbbacf77c..658961e14f 100644 --- a/components/carousel/index.en-US.md +++ b/components/carousel/index.en-US.md @@ -46,6 +46,10 @@ A carousel component. Scales with its container. Find more APIs in react-slick [documentation](https://react-slick.neostack.com/docs/api). +## Design Token + + + ## FAQ ### How to add custom arrows? diff --git a/components/carousel/index.zh-CN.md b/components/carousel/index.zh-CN.md index bda815398d..20fec2cda5 100644 --- a/components/carousel/index.zh-CN.md +++ b/components/carousel/index.zh-CN.md @@ -47,6 +47,10 @@ demo: 更多 API 可参考： +## Design Token + + + ## FAQ ### 如何自定义箭头？ diff --git a/components/cascader/index.en-US.md b/components/cascader/index.en-US.md index 84e9121216..5ed48ca1c5 100644 --- a/components/cascader/index.en-US.md +++ b/components/cascader/index.en-US.md @@ -117,3 +117,7 @@ interface Option { | ------- | ------------ | ------- | | blur() | Remove focus | | | focus() | Get focus | | + +## Design Token + + diff --git a/components/cascader/index.zh-CN.md b/components/cascader/index.zh-CN.md index 7aa272edca..1bc266e11c 100644 --- a/components/cascader/index.zh-CN.md +++ b/components/cascader/index.zh-CN.md @@ -120,3 +120,7 @@ interface Option { | focus() | 获取焦点 | | > 注意，如果需要获得中国省市区数据，可以参考 [china-division](https://gist.github.com/afc163/7582f35654fd03d5be7009444345ea17)。 + +## Design Token + + diff --git a/components/checkbox/index.en-US.md b/components/checkbox/index.en-US.md index 7a4efcb518..22dbe06343 100644 --- a/components/checkbox/index.en-US.md +++ b/components/checkbox/index.en-US.md @@ -69,3 +69,7 @@ interface Option { | ------- | ------------ | ------- | | blur() | Remove focus | | | focus() | Get focus | | + +## Design Token + + diff --git a/components/checkbox/index.zh-CN.md b/components/checkbox/index.zh-CN.md index 3c3e54722e..fdd9276555 100644 --- a/components/checkbox/index.zh-CN.md +++ b/components/checkbox/index.zh-CN.md @@ -70,3 +70,7 @@ interface Option { | ------- | -------- | ---- | | blur() | 移除焦点 | | | focus() | 获取焦点 | | + +## Design Token + + diff --git a/components/collapse/index.en-US.md b/components/collapse/index.en-US.md index d5cfd14f35..4d7413f3eb 100644 --- a/components/collapse/index.en-US.md +++ b/components/collapse/index.en-US.md @@ -55,3 +55,7 @@ A content area which can be collapsed and expanded. | header | Title of the panel | ReactNode | - | | | key | Unique key identifying the panel from among its siblings | string \| number | - | | | showArrow | If false, panel will not show arrow icon. If false, collapsible can't be set as icon | boolean | true | | + +## Design Token + + diff --git a/components/collapse/index.zh-CN.md b/components/collapse/index.zh-CN.md index 1c258b183a..fe34d6bb32 100644 --- a/components/collapse/index.zh-CN.md +++ b/components/collapse/index.zh-CN.md @@ -56,3 +56,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*sir-TK0HkWcAAA | header | 面板头内容 | ReactNode | - | | | key | 对应 activeKey | string \| number | - | | | showArrow | 是否展示当前面板上的箭头（为 false 时，collapsible 不能置为 icon） | boolean | true | | + +## Design Token + + diff --git a/components/date-picker/index.en-US.md b/components/date-picker/index.en-US.md index 57374b060c..5ec9c7af69 100644 --- a/components/date-picker/index.en-US.md +++ b/components/date-picker/index.en-US.md @@ -212,6 +212,10 @@ type GenericFn = (value: Dayjs) => string; export type FormatType = Generic | GenericFn | Array; ``` +## Design Token + + + ## FAQ ### When set mode to DatePicker/RangePicker, cannot select year or month anymore? diff --git a/components/date-picker/index.zh-CN.md b/components/date-picker/index.zh-CN.md index fb4f05e2bc..99a23bf717 100644 --- a/components/date-picker/index.zh-CN.md +++ b/components/date-picker/index.zh-CN.md @@ -213,6 +213,10 @@ type GenericFn = (value: Dayjs) => string; export type FormatType = Generic | GenericFn | Array; ``` +## Design Token + + + ## FAQ ### 当我指定了 DatePicker/RangePicker 的 mode 属性后，点击后无法选择年份/月份？ diff --git a/components/descriptions/index.en-US.md b/components/descriptions/index.en-US.md index 2820c76388..59bed2fde7 100644 --- a/components/descriptions/index.en-US.md +++ b/components/descriptions/index.en-US.md @@ -50,3 +50,7 @@ Commonly displayed on the details page. | span | The number of columns included | number | 1 | | > The number of span Description.Item. Span={2} takes up the width of two DescriptionItems. When both `style` and `labelStyle`(or `contentStyle`) configured, both of them will work. And next one will overwrite first when conflict. + +## Design Token + + diff --git a/components/descriptions/index.zh-CN.md b/components/descriptions/index.zh-CN.md index 9a14ef2702..95d0919624 100644 --- a/components/descriptions/index.zh-CN.md +++ b/components/descriptions/index.zh-CN.md @@ -51,3 +51,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*d27AQJrowGAAAA | span | 包含列的数量 | number | 1 | | > span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。当同时配置 `style` 和 `labelStyle`（或 `contentStyle`）时，两者会同时作用。样式冲突时，后者会覆盖前者。 + +## Design Token + + diff --git a/components/drawer/index.en-US.md b/components/drawer/index.en-US.md index a7c311dd97..5244fc234c 100644 --- a/components/drawer/index.en-US.md +++ b/components/drawer/index.en-US.md @@ -71,3 +71,7 @@ A Drawer is a panel that is typically overlaid on top of a page and slides in fr | width | Width of the Drawer dialog | string \| number | 378 | | | zIndex | The `z-index` of the Drawer | number | 1000 | | | onClose | Specify a callback that will be called when a user clicks mask, close button or Cancel button | function(e) | - | | + +## Design Token + + diff --git a/components/drawer/index.zh-CN.md b/components/drawer/index.zh-CN.md index f2d78f3642..664984968f 100644 --- a/components/drawer/index.zh-CN.md +++ b/components/drawer/index.zh-CN.md @@ -70,3 +70,7 @@ demo: | width | 宽度 | string \| number | 378 | | | zIndex | 设置 Drawer 的 `z-index` | number | 1000 | | | onClose | 点击遮罩层或左上角叉或取消按钮的回调 | function(e) | - | | + +## Design Token + + diff --git a/components/empty/index.en-US.md b/components/empty/index.en-US.md index 5b7c2bad4e..32135d4ec7 100644 --- a/components/empty/index.en-US.md +++ b/components/empty/index.en-US.md @@ -62,3 +62,7 @@ Empty state placeholder. background-image: url("https://user-images.githubusercontent.com/507615/54591670-ac0a0180-4a65-11e9-846c-e55ffce0fe7b.png"); } + +## Design Token + + diff --git a/components/empty/index.zh-CN.md b/components/empty/index.zh-CN.md index f8b368ab37..68c774c0ce 100644 --- a/components/empty/index.zh-CN.md +++ b/components/empty/index.zh-CN.md @@ -63,3 +63,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*obM7S5lIxeMAAA background-image: url("https://user-images.githubusercontent.com/507615/54591670-ac0a0180-4a65-11e9-846c-e55ffce0fe7b.png"); } + +## Design Token + + diff --git a/components/float-button/index.en-US.md b/components/float-button/index.en-US.md index 4ae5d751cd..9ac546a7bb 100644 --- a/components/float-button/index.en-US.md +++ b/components/float-button/index.en-US.md @@ -65,3 +65,7 @@ FloatButton. Available since `5.0.0`. | target | Specifies the scrollable area dom node | () => HTMLElement | () => window | | | visibilityHeight | The BackTop button will not show until the scroll height reaches this value | number | 400 | | | onClick | A callback function, which can be executed when you click the button | () => void | - | | + +## Design Token + + diff --git a/components/float-button/index.zh-CN.md b/components/float-button/index.zh-CN.md index 0cf822ac60..dfa41a178d 100644 --- a/components/float-button/index.zh-CN.md +++ b/components/float-button/index.zh-CN.md @@ -66,3 +66,7 @@ demo: | target | 设置需要监听其滚动事件的元素 | () => HTMLElement | () => window | | | visibilityHeight | 滚动高度达到此参数值才出现 BackTop | number | 400 | | | onClick | 点击按钮的回调函数 | () => void | - | | + +## Design Token + + diff --git a/components/form/index.en-US.md b/components/form/index.en-US.md index 01805546f2..fcff39f98e 100644 --- a/components/form/index.en-US.md +++ b/components/form/index.en-US.md @@ -481,6 +481,10 @@ type Rule = RuleConfig | ((form: FormInstance) => RuleConfig); | form | Form instance | FormInstance | Current form in context | 5.4.0 | | preserve | Whether to watch the field which has no matched `Form.Item` | boolean | false | 5.4.0 | +## Design Token + + + ## FAQ ### Custom validator not working diff --git a/components/form/index.zh-CN.md b/components/form/index.zh-CN.md index 96eab72387..3950f457a5 100644 --- a/components/form/index.zh-CN.md +++ b/components/form/index.zh-CN.md @@ -480,6 +480,10 @@ type Rule = RuleConfig | ((form: FormInstance) => RuleConfig); | form | 指定 Form 实例 | FormInstance | 当前 context 中的 Form | 5.4.0 | | preserve | 是否监视没有对应的 `Form.Item` 的字段 | boolean | false | 5.4.0 | +## Design Token + + + ## FAQ ### 自定义 validator 没有效果 diff --git a/components/grid/index.en-US.md b/components/grid/index.en-US.md index 7c7dc93fe2..96fcc9c0e7 100644 --- a/components/grid/index.en-US.md +++ b/components/grid/index.en-US.md @@ -85,3 +85,7 @@ If the Ant Design grid layout component does not meet your needs, you can use th You can modify the breakpoints values using by modifying `screen[XS|SM|MD|LG|XL|XXL]` with [theme customization](/docs/react/customize-theme) (since 5.1.0, [sandbox demo](https://codesandbox.io/s/antd-reproduction-template-forked-dlq3r9?file=/index.js)). The breakpoints of responsive grid follow [BootStrap 4 media queries rules](https://getbootstrap.com/docs/4.0/layout/overview/#responsive-breakpoints) (not including `occasionally part`). + +## Design Token + + diff --git a/components/grid/index.zh-CN.md b/components/grid/index.zh-CN.md index 6a707a4bd6..04c010bb70 100644 --- a/components/grid/index.zh-CN.md +++ b/components/grid/index.zh-CN.md @@ -84,3 +84,7 @@ Ant Design 的布局组件若不能满足你的需求，你也可以直接使用 您可以使用 [主题定制](/docs/react/customize-theme-cn) 修改 `screen[XS|SM|MD|LG|XL|XXL]` 来修改断点值（自 5.1.0 起，[codesandbox demo](https://codesandbox.io/s/antd-reproduction-template-forked-dlq3r9?file=/index.js)）。 响应式栅格的断点扩展自 [BootStrap 4 的规则](https://getbootstrap.com/docs/4.0/layout/overview/#responsive-breakpoints)（不包含链接里 `occasionally` 的部分)。 + +## Design Token + + diff --git a/components/icon/index.en-US.md b/components/icon/index.en-US.md index ac401e8a65..c5eb8eba3a 100644 --- a/components/icon/index.en-US.md +++ b/components/icon/index.en-US.md @@ -177,3 +177,7 @@ The following properties are available for the component: | height | The height of the `svg` element | string \| number | `1em` | | | style | The computed style of the `svg` element | CSSProperties | - | | | width | The width of the `svg` element | string \| number | `1em` | | + +## Design Token + + diff --git a/components/icon/index.zh-CN.md b/components/icon/index.zh-CN.md index aa016628c6..09d0f3cffc 100644 --- a/components/icon/index.zh-CN.md +++ b/components/icon/index.zh-CN.md @@ -172,3 +172,7 @@ ReactDOM.createRoot(mountNode).render(); | height | `svg` 元素高度 | string \| number | `1em` | | | style | 计算后的 `svg` 元素样式 | CSSProperties | - | | | width | `svg` 元素宽度 | string \| number | `1em` | | + +## Design Token + + diff --git a/components/image/index.en-US.md b/components/image/index.en-US.md index 2aa623cc39..1b465d5057 100644 --- a/components/image/index.en-US.md +++ b/components/image/index.en-US.md @@ -60,3 +60,7 @@ Previewable image. ``` Other attributes [<img>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#Attributes) + +## Design Token + + diff --git a/components/image/index.zh-CN.md b/components/image/index.zh-CN.md index 7ab579f0b7..c5324fccb5 100644 --- a/components/image/index.zh-CN.md +++ b/components/image/index.zh-CN.md @@ -62,3 +62,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*LVQ3R5JjjJEAAA ``` 其他属性见 [<img>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#Attributes) + +## Design Token + + diff --git a/components/input-number/index.en-US.md b/components/input-number/index.en-US.md index 483f389296..c62e0572c6 100644 --- a/components/input-number/index.en-US.md +++ b/components/input-number/index.en-US.md @@ -68,6 +68,10 @@ When a numeric value needs to be provided. | blur() | Remove focus | | focus() | Get focus | +## Design Token + + + ## Notes Per issues [#21158](https://github.com/ant-design/ant-design/issues/21158), [#17344](https://github.com/ant-design/ant-design/issues/17344), [#9421](https://github.com/ant-design/ant-design/issues/9421), and [documentation about inputs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/number#Using_number_inputs), it appears this community does not support native inclusion of the `type="number"` in the `` attributes, so please feel free to include it as needed, and be aware that it is heavily suggested that server side validation be utilized, as client side validation can be edited by power users. diff --git a/components/input-number/index.zh-CN.md b/components/input-number/index.zh-CN.md index 132108f0c9..ce37f7348d 100644 --- a/components/input-number/index.zh-CN.md +++ b/components/input-number/index.zh-CN.md @@ -71,6 +71,10 @@ demo: | blur() | 移除焦点 | | focus() | 获取焦点 | +## Design Token + + + ## FAQ ### 为何受控模式下，`value` 可以超出 `min` 和 `max` 范围？ diff --git a/components/list/index.en-US.md b/components/list/index.en-US.md index 603ff9c479..24fed351a6 100644 --- a/components/list/index.en-US.md +++ b/components/list/index.en-US.md @@ -85,3 +85,7 @@ More about pagination, please check [`Pagination`](/components/pagination/). | avatar | The avatar of list item | ReactNode | - | | | description | The description of list item | ReactNode | - | | | title | The title of list item | ReactNode | - | | + +## Design Token + + diff --git a/components/list/index.zh-CN.md b/components/list/index.zh-CN.md index eeacef28ae..41b2d3ee20 100644 --- a/components/list/index.zh-CN.md +++ b/components/list/index.zh-CN.md @@ -88,3 +88,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*tBzwQ7raKX8AAA | avatar | 列表元素的图标 | ReactNode | - | | | description | 列表元素的描述内容 | ReactNode | - | | | title | 列表元素的标题 | ReactNode | - | | + +## Design Token + + diff --git a/components/mentions/index.en-US.md b/components/mentions/index.en-US.md index 76d4c48fe1..743cc18956 100644 --- a/components/mentions/index.en-US.md +++ b/components/mentions/index.en-US.md @@ -87,3 +87,7 @@ return ( | disabled | Optional | boolean | - | | className | className | string | - | | style | The style of the option | React.CSSProperties | - | + +## Design Token + + diff --git a/components/mentions/index.zh-CN.md b/components/mentions/index.zh-CN.md index 44717e0fe1..2903a61173 100644 --- a/components/mentions/index.zh-CN.md +++ b/components/mentions/index.zh-CN.md @@ -88,3 +88,7 @@ return ( | disabled | 是否可选 | boolean | - | | className | css 类名 | string | - | | style | 选项样式 | React.CSSProperties | - | + +## Design Token + + diff --git a/components/message/index.en-US.md b/components/message/index.en-US.md index fa7c065964..1da63806d2 100644 --- a/components/message/index.en-US.md +++ b/components/message/index.en-US.md @@ -108,6 +108,10 @@ message.config({ | rtl | Whether to enable RTL mode | boolean | false | | | top | Distance from top | number | 8 | | +## Design Token + + + ## FAQ ### Why I can not access context, redux, ConfigProvider `locale/prefixCls/theme` in message? diff --git a/components/message/index.zh-CN.md b/components/message/index.zh-CN.md index 91d2b23a2d..5ec819e2ab 100644 --- a/components/message/index.zh-CN.md +++ b/components/message/index.zh-CN.md @@ -109,6 +109,10 @@ message.config({ | rtl | 是否开启 RTL 模式 | boolean | false | | | top | 消息距离顶部的位置 | number | 8 | | +## Design Token + + + ## FAQ ### 为什么 message 不能获取 context、redux 的内容和 ConfigProvider 的 `locale/prefixCls/theme` 等配置？ diff --git a/components/modal/index.en-US.md b/components/modal/index.en-US.md index f763b9edac..ba3bdb5ef7 100644 --- a/components/modal/index.en-US.md +++ b/components/modal/index.en-US.md @@ -168,6 +168,10 @@ React.useEffect(() => { return
{contextHolder}
; ``` +## Design Token + + + ## FAQ ### Why content not update when Modal closed? diff --git a/components/modal/index.zh-CN.md b/components/modal/index.zh-CN.md index f73419dfa2..828f0eaa54 100644 --- a/components/modal/index.zh-CN.md +++ b/components/modal/index.zh-CN.md @@ -169,6 +169,10 @@ React.useEffect(() => { return
{contextHolder}
; ``` +## Design Token + + + ## FAQ ### 为什么 Modal 关闭时，内容不会更新？ diff --git a/components/notification/index.en-US.md b/components/notification/index.en-US.md index c88c7a6de0..f10d40b517 100644 --- a/components/notification/index.en-US.md +++ b/components/notification/index.en-US.md @@ -95,6 +95,10 @@ notification.config({ | top | Distance from the top of the viewport, when `placement` is `topRight` or `topLeft` (unit: pixels) | number | 24 | | | maxCount | Max Notification show, drop oldest if exceed limit | number | - | 4.17.0 | +## Design Token + + + ## FAQ ### Why I can not access context, redux, ConfigProvider `locale/prefixCls/theme` in notification? diff --git a/components/notification/index.zh-CN.md b/components/notification/index.zh-CN.md index eb9705138f..5b1d2cfce0 100644 --- a/components/notification/index.zh-CN.md +++ b/components/notification/index.zh-CN.md @@ -96,6 +96,10 @@ notification.config({ | top | 消息从顶部弹出时，距离顶部的位置，单位像素 | number | 24 | | | maxCount | 最大显示数, 超过限制时，最早的消息会被自动关闭 | number | - | 4.17.0 | +## Design Token + + + ## FAQ ### 为什么 notification 不能获取 context、redux 的内容和 ConfigProvider 的 `locale/prefixCls/theme` 等配置？ diff --git a/components/popconfirm/index.en-US.md b/components/popconfirm/index.en-US.md index 41cff81277..7deb3dc4ab 100644 --- a/components/popconfirm/index.en-US.md +++ b/components/popconfirm/index.en-US.md @@ -48,6 +48,10 @@ The difference with the `confirm` modal dialog is that it's more lightweight tha Consult [Tooltip's documentation](/components/tooltip/#api) to find more APIs. +## Design Token + + + ## Note Please ensure that the child node of `Popconfirm` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events. diff --git a/components/popconfirm/index.zh-CN.md b/components/popconfirm/index.zh-CN.md index f12b13f1e7..a1d66956f3 100644 --- a/components/popconfirm/index.zh-CN.md +++ b/components/popconfirm/index.zh-CN.md @@ -49,6 +49,10 @@ demo: 更多属性请参考 [Tooltip](/components/tooltip-cn/#api)。 +## Design Token + + + ## 注意 请确保 `Popconfirm` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。 diff --git a/components/popover/index.en-US.md b/components/popover/index.en-US.md index 3305dd531f..f7f6d2b8bb 100644 --- a/components/popover/index.en-US.md +++ b/components/popover/index.en-US.md @@ -40,3 +40,7 @@ Consult [Tooltip's documentation](/components/tooltip/#api) to find more APIs. ## Note Please ensure that the child node of `Popover` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events. + +## Design Token + + diff --git a/components/popover/index.zh-CN.md b/components/popover/index.zh-CN.md index d30a50a0c5..9db7598bac 100644 --- a/components/popover/index.zh-CN.md +++ b/components/popover/index.zh-CN.md @@ -41,3 +41,7 @@ demo: ## 注意 请确保 `Popover` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。 + +## Design Token + + diff --git a/components/progress/index.en-US.md b/components/progress/index.en-US.md index 94af02bc03..c5e6ded3ef 100644 --- a/components/progress/index.en-US.md +++ b/components/progress/index.en-US.md @@ -73,3 +73,7 @@ Properties that shared by all types. | gapDegree | The gap degree of half circle, 0 ~ 295 | number | 75 | | gapPosition | The gap position, options: `top` `bottom` `left` `right` | string | `bottom` | | strokeWidth | To set the width of the dashboard progress, unit: percentage of the canvas width | number | 6 | + +## Design Token + + diff --git a/components/progress/index.zh-CN.md b/components/progress/index.zh-CN.md index fdede7fc00..43a803350a 100644 --- a/components/progress/index.zh-CN.md +++ b/components/progress/index.zh-CN.md @@ -74,3 +74,7 @@ demo: | gapDegree | 仪表盘进度条缺口角度，可取值 0 ~ 295 | number | 75 | - | | gapPosition | 仪表盘进度条缺口位置 | `top` \| `bottom` \| `left` \| `right` | `bottom` | - | | strokeWidth | 仪表盘进度条线的宽度，单位是进度条画布宽度的百分比 | number | 6 | - | + +## Design Token + + diff --git a/components/qrcode/index.en-US.md b/components/qrcode/index.en-US.md index 507b71eb89..df0ea865c2 100644 --- a/components/qrcode/index.en-US.md +++ b/components/qrcode/index.en-US.md @@ -46,6 +46,10 @@ Used when the text needs to be converted into a QR Code. | status | QRCode status | `active \| expired \| loading ` | `active` | | onRefresh | callback | `() => void` | - | +## Design Token + + + ## FAQ ### About QRCode ErrorLevel diff --git a/components/qrcode/index.zh-CN.md b/components/qrcode/index.zh-CN.md index 67b8a67951..b3be383baf 100644 --- a/components/qrcode/index.zh-CN.md +++ b/components/qrcode/index.zh-CN.md @@ -47,6 +47,10 @@ group: | status | 二维码状态 | `active \| expired \| loading ` | `active` | | onRefresh | 点击"点击刷新"的回调 | `() => void` | - | +## Design Token + + + ## FAQ ### 关于二维码纠错等级 diff --git a/components/radio/index.en-US.md b/components/radio/index.en-US.md index c9953c0bec..a6585f118f 100644 --- a/components/radio/index.en-US.md +++ b/components/radio/index.en-US.md @@ -67,3 +67,7 @@ Radio group can wrap a group of `Radio`。 | ------- | ------------ | | blur() | Remove focus | | focus() | Get focus | + +## Design Token + + diff --git a/components/radio/index.zh-CN.md b/components/radio/index.zh-CN.md index 5a4dfa1ded..f3ef2f90d6 100644 --- a/components/radio/index.zh-CN.md +++ b/components/radio/index.zh-CN.md @@ -70,3 +70,7 @@ demo: | ------- | -------- | | blur() | 移除焦点 | | focus() | 获取焦点 | + +## Design Token + + diff --git a/components/rate/index.en-US.md b/components/rate/index.en-US.md index f2e7df59fc..aa492f6a76 100644 --- a/components/rate/index.en-US.md +++ b/components/rate/index.en-US.md @@ -53,3 +53,7 @@ Rate component. | ------- | ------------ | | blur() | Remove focus | | focus() | Get focus | + +## Design Token + + diff --git a/components/rate/index.zh-CN.md b/components/rate/index.zh-CN.md index 8489c97f09..2912314790 100644 --- a/components/rate/index.zh-CN.md +++ b/components/rate/index.zh-CN.md @@ -54,3 +54,7 @@ demo: | ------- | -------- | | blur() | 移除焦点 | | focus() | 获取焦点 | + +## Design Token + + diff --git a/components/result/index.en-US.md b/components/result/index.en-US.md index 5d0c9395fd..034f7d1bca 100644 --- a/components/result/index.en-US.md +++ b/components/result/index.en-US.md @@ -33,3 +33,7 @@ Use when important operations need to inform the user to process the results and | status | Result status, decide icons and colors | `success` \| `error` \| `info` \| `warning` \| `404` \| `403` \| `500` | `info` | | subTitle | The subTitle | ReactNode | - | | title | The title | ReactNode | - | + +## Design Token + + diff --git a/components/result/index.zh-CN.md b/components/result/index.zh-CN.md index 77fc602a03..f86ea7bee2 100644 --- a/components/result/index.zh-CN.md +++ b/components/result/index.zh-CN.md @@ -34,3 +34,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*-0kxQrbHx2kAAA | status | 结果的状态，决定图标和颜色 | `success` \| `error` \| `info` \| `warning` \| `404` \| `403` \| `500` | `info` | | subTitle | subTitle 文字 | ReactNode | - | | title | title 文字 | ReactNode | - | + +## Design Token + + diff --git a/components/segmented/index.en-US.md b/components/segmented/index.en-US.md index 28c42791b8..c17801ee59 100644 --- a/components/segmented/index.en-US.md +++ b/components/segmented/index.en-US.md @@ -43,3 +43,7 @@ Segmented Controls. This component is available since `antd@4.20.0`. | options | Set children optional | string\[] \| number\[] \| Array<{ label: ReactNode value: string icon? ReactNode disabled?: boolean className?: string }> | [] | | | size | The size of the Segmented. | `large` \| `middle` \| `small` | `middle` | | | value | Currently selected value | string \| number | | | + +## Design Token + + diff --git a/components/segmented/index.zh-CN.md b/components/segmented/index.zh-CN.md index 67d9cc97c9..80ffad3723 100644 --- a/components/segmented/index.zh-CN.md +++ b/components/segmented/index.zh-CN.md @@ -46,3 +46,7 @@ demo: | options | 数据化配置选项内容 | string\[] \| number\[] \| Array<{ label: ReactNode value: string icon? ReactNode disabled?: boolean className?: string }> | [] | | | size | 控件尺寸 | `large` \| `middle` \| `small` | `middle` | | | value | 当前选中的值 | string \| number | | | + +## Design Token + + diff --git a/components/skeleton/index.en-US.md b/components/skeleton/index.en-US.md index 88fa0c93a6..b3a6c59c41 100644 --- a/components/skeleton/index.en-US.md +++ b/components/skeleton/index.en-US.md @@ -74,3 +74,7 @@ Provide a placeholder while you wait for content to load, or to visualize conten | -------- | --------------------- | ------------------------------- | ------- | | active | Show animation effect | boolean | false | | size | Set the size of input | `large` \| `small` \| `default` | - | + +## Design Token + + diff --git a/components/skeleton/index.zh-CN.md b/components/skeleton/index.zh-CN.md index b1a7d6609b..35e67be85b 100644 --- a/components/skeleton/index.zh-CN.md +++ b/components/skeleton/index.zh-CN.md @@ -75,3 +75,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*VcjGQLSrYdcAAA | ------ | ---------------- | ------------------------------- | ------ | | active | 是否展示动画效果 | boolean | false | | size | 设置输入框的大小 | `large` \| `small` \| `default` | - | + +## Design Token + + diff --git a/components/slider/index.en-US.md b/components/slider/index.en-US.md index 97ffbf00b6..fe21190220 100644 --- a/components/slider/index.en-US.md +++ b/components/slider/index.en-US.md @@ -74,3 +74,7 @@ To input a value in a range. | ------- | ------------ | ------- | | blur() | Remove focus | | | focus() | Get focus | | + +## Design Token + + diff --git a/components/slider/index.zh-CN.md b/components/slider/index.zh-CN.md index 1305f2c987..ebb285619a 100644 --- a/components/slider/index.zh-CN.md +++ b/components/slider/index.zh-CN.md @@ -72,3 +72,7 @@ demo: | ------- | -------- | ---- | | blur() | 移除焦点 | | | focus() | 获取焦点 | | + +## Design Token + + diff --git a/components/space/index.en-US.md b/components/space/index.en-US.md index 7ccc741c69..4841a3d877 100644 --- a/components/space/index.en-US.md +++ b/components/space/index.en-US.md @@ -63,3 +63,7 @@ Use Space.Compact when child form components are compactly connected and the bor | block | Option to fit width to its parent\'s width | boolean | false | 4.24.0 | | direction | Set direction of layout | `vertical` \| `horizontal` | `horizontal` | 4.24.0 | | size | Set child component size | `large` \| `middle` \| `small` | `middle` | 4.24.0 | + +## Design Token + + diff --git a/components/space/index.zh-CN.md b/components/space/index.zh-CN.md index 2a6a8733fd..c0640cd5a1 100644 --- a/components/space/index.zh-CN.md +++ b/components/space/index.zh-CN.md @@ -71,3 +71,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*37T2R6O9oi0AAA | block | 将宽度调整为父元素宽度的选项 | boolean | false | 4.24.0 | | direction | 指定排列方向 | `vertical` \| `horizontal` | `horizontal` | 4.24.0 | | size | 子组件大小 | `large` \| `middle` \| `small` | `middle` | 4.24.0 | + +## Design Token + + diff --git a/components/spin/index.en-US.md b/components/spin/index.en-US.md index 4f284682df..3c1692ad7a 100644 --- a/components/spin/index.en-US.md +++ b/components/spin/index.en-US.md @@ -41,3 +41,7 @@ When part of the page is waiting for asynchronous data or during a rendering pro - `Spin.setDefaultIndicator(indicator: ReactNode)` You can define default spin element globally. + +## Design Token + + diff --git a/components/spin/index.zh-CN.md b/components/spin/index.zh-CN.md index 2f0cac78f9..f5d66656a1 100644 --- a/components/spin/index.zh-CN.md +++ b/components/spin/index.zh-CN.md @@ -42,3 +42,7 @@ demo: - `Spin.setDefaultIndicator(indicator: ReactNode)` 你可以自定义全局默认 Spin 的元素。 + +## Design Token + + diff --git a/components/statistic/index.en-US.md b/components/statistic/index.en-US.md index 1c95c17112..48cbb2526c 100644 --- a/components/statistic/index.en-US.md +++ b/components/statistic/index.en-US.md @@ -53,3 +53,7 @@ Display statistic number. | valueStyle | Set value section style | CSSProperties | - | | | onFinish | Trigger when time's up | () => void | - | | | onChange | Trigger when time's changing | (value: number) => void | - | 4.16.0 | + +## Design Token + + diff --git a/components/statistic/index.zh-CN.md b/components/statistic/index.zh-CN.md index 2d33b49176..30b0b14fa6 100644 --- a/components/statistic/index.zh-CN.md +++ b/components/statistic/index.zh-CN.md @@ -54,3 +54,7 @@ demo: | valueStyle | 设置数值区域的样式 | CSSProperties | - | | | onFinish | 倒计时完成时触发 | () => void | - | | | onChange | 倒计时时间变化时触发 | (value: number) => void | - | 4.16.0 | + +## Design Token + + diff --git a/components/switch/index.en-US.md b/components/switch/index.en-US.md index 9482313fda..c5b4f4b475 100644 --- a/components/switch/index.en-US.md +++ b/components/switch/index.en-US.md @@ -46,3 +46,7 @@ Switching Selector. | ------- | ------------ | | blur() | Remove focus | | focus() | Get focus | + +## Design Token + + diff --git a/components/switch/index.zh-CN.md b/components/switch/index.zh-CN.md index 20b675f674..98a14bdb90 100644 --- a/components/switch/index.zh-CN.md +++ b/components/switch/index.zh-CN.md @@ -47,3 +47,7 @@ demo: | ------- | -------- | | blur() | 移除焦点 | | focus() | 获取焦点 | + +## Design Token + + diff --git a/components/table/index.en-US.md b/components/table/index.en-US.md index 1325ca9f85..7ec499ac21 100644 --- a/components/table/index.en-US.md +++ b/components/table/index.en-US.md @@ -322,6 +322,10 @@ export default Demo; Here is the [CodeSandbox for TypeScript](https://codesandbox.io/s/serene-platform-0jo5t). +## Design Token + + + ## Note According to the [React documentation](https://facebook.github.io/react/docs/lists-and-keys.html#keys), every child in an array should be assigned a unique key. The values inside the Table's `dataSource` and `columns` should follow this rule. By default, `dataSource[i].key` will be treated as the key value for `dataSource`. diff --git a/components/table/index.zh-CN.md b/components/table/index.zh-CN.md index 6ba3d4fc53..b52987da8c 100644 --- a/components/table/index.zh-CN.md +++ b/components/table/index.zh-CN.md @@ -325,6 +325,10 @@ export default Demo; TypeScript 里使用 Table 的 [CodeSandbox 实例](https://codesandbox.io/s/serene-platform-0jo5t)。 +## Design Token + + + ## 注意 按照 [React 的规范](https://zh-hans.reactjs.org/docs/lists-and-keys.html#keys)，所有的数组组件必须绑定 `key`。在 Table 中，`dataSource` 和 `columns` 里的数据值都需要指定 `key` 值。对于 `dataSource` 默认将每列数据的 `key` 属性作为唯一的标识。 diff --git a/components/tabs/index.en-US.md b/components/tabs/index.en-US.md index 6659318e2d..f73d7756fb 100644 --- a/components/tabs/index.en-US.md +++ b/components/tabs/index.en-US.md @@ -77,3 +77,7 @@ More option at [rc-tabs tabs](https://github.com/react-component/tabs#tabs) | key | TabPane's key | string | - | | label | TabPane's head display text | ReactNode | - | | children | TabPane's head display content | ReactNode | - | + +## Design Token + + diff --git a/components/tabs/index.zh-CN.md b/components/tabs/index.zh-CN.md index dfeb977c6b..040edd41f5 100644 --- a/components/tabs/index.zh-CN.md +++ b/components/tabs/index.zh-CN.md @@ -79,3 +79,7 @@ Ant Design 依次提供了三级选项卡，分别用于不同的场景。 | key | 对应 activeKey | string | - | | label | 选项卡头显示文字 | ReactNode | - | | children | 选项卡头显示内容 | ReactNode | - | + +## Design Token + + diff --git a/components/tag/index.en-US.md b/components/tag/index.en-US.md index 1e9244f88b..308558e6a4 100644 --- a/components/tag/index.en-US.md +++ b/components/tag/index.en-US.md @@ -50,3 +50,7 @@ Tag for categorizing or markup. | -------- | ----------------------------------------------- | ----------------- | ------- | | checked | Checked status of Tag | boolean | false | | onChange | Callback executed when Tag is checked/unchecked | (checked) => void | - | + +## Design Token + + diff --git a/components/tag/index.zh-CN.md b/components/tag/index.zh-CN.md index 235a364c3e..00ae969f0c 100644 --- a/components/tag/index.zh-CN.md +++ b/components/tag/index.zh-CN.md @@ -50,3 +50,7 @@ demo: | -------- | -------------------- | ----------------- | ------ | | checked | 设置标签的选中状态 | boolean | false | | onChange | 点击标签时触发的回调 | (checked) => void | - | + +## Design Token + + diff --git a/components/time-picker/index.en-US.md b/components/time-picker/index.en-US.md index f2c73911e7..aafdefe36a 100644 --- a/components/time-picker/index.en-US.md +++ b/components/time-picker/index.en-US.md @@ -118,6 +118,10 @@ type RangeDisabledTime = ( }; ``` +## Design Token + + + ## FAQ - [How to use TimePicker with customize date library like dayjs](/docs/react/use-custom-date-library#timepicker) diff --git a/components/time-picker/index.zh-CN.md b/components/time-picker/index.zh-CN.md index 21d5d378b3..47d80fcc27 100644 --- a/components/time-picker/index.zh-CN.md +++ b/components/time-picker/index.zh-CN.md @@ -117,6 +117,10 @@ type RangeDisabledTime = ( }; ``` +## Design Token + + + ## FAQ - [如何在 TimePicker 中使用自定义日期库（如 Moment.js ）](/docs/react/use-custom-date-library#timepicker) diff --git a/components/timeline/index.en-US.md b/components/timeline/index.en-US.md index dcfb65d813..1abbe96282 100644 --- a/components/timeline/index.en-US.md +++ b/components/timeline/index.en-US.md @@ -65,3 +65,7 @@ Node of timeline. | label | Set the label | ReactNode | - | | children | Set the content | ReactNode | - | | position | Customize node position | `left` \| `right` | - | + +## Design Token + + diff --git a/components/timeline/index.zh-CN.md b/components/timeline/index.zh-CN.md index a3b6871c4f..982157f471 100644 --- a/components/timeline/index.zh-CN.md +++ b/components/timeline/index.zh-CN.md @@ -66,3 +66,7 @@ return ( | label | 设置标签 | ReactNode | - | | children | 设置内容 | ReactNode | - | | position | 自定义节点位置 | `left` \| `right` | - | + +## Design Token + + diff --git a/components/tooltip/index.en-US.md b/components/tooltip/index.en-US.md index f01a0b2c31..7eecd38d48 100644 --- a/components/tooltip/index.en-US.md +++ b/components/tooltip/index.en-US.md @@ -58,6 +58,10 @@ The following APIs are shared by Tooltip, Popconfirm, Popover. | zIndex | Config `z-index` of Tooltip | number | - | | | onOpenChange | Callback executed when visibility of the tooltip card is changed | (open: boolean) => void | - | 4.23.0 | +## Design Token + + + ## Note Please ensure that the child node of `Tooltip` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events. diff --git a/components/tooltip/index.zh-CN.md b/components/tooltip/index.zh-CN.md index c0920bb97a..3966479329 100644 --- a/components/tooltip/index.zh-CN.md +++ b/components/tooltip/index.zh-CN.md @@ -60,6 +60,10 @@ demo: | zIndex | 设置 Tooltip 的 `z-index` | number | - | | | onOpenChange | 显示隐藏的回调 | (open: boolean) => void | - | 4.23.0 | +## Design Token + + + ## 注意 请确保 `Tooltip` 的子元素能接受 `onMouseEnter`、`onMouseLeave`、`onFocus`、`onClick` 事件。 diff --git a/components/tour/index.en-US.md b/components/tour/index.en-US.md index 457fa1f195..9830781c3f 100644 --- a/components/tour/index.en-US.md +++ b/components/tour/index.en-US.md @@ -58,3 +58,7 @@ Use when you want to guide users through a product. | nextButtonProps | Properties of the Next button | `{ children: ReactNode; onClick: Function }` | - | | | prevButtonProps | Properties of the previous button | `{ children: ReactNode; onClick: Function }` | - | | | scrollIntoViewOptions | support pass custom scrollIntoView options, the default follows the `scrollIntoViewOptions` property of Tour | `boolean \| ScrollIntoViewOptions` | `true` | 5.2.0 | + +## Design Token + + diff --git a/components/tour/index.zh-CN.md b/components/tour/index.zh-CN.md index ebfceab064..87c352c5c0 100644 --- a/components/tour/index.zh-CN.md +++ b/components/tour/index.zh-CN.md @@ -60,3 +60,7 @@ demo: | nextButtonProps | 下一步按钮的属性 | `{ children: ReactNode; onClick: Function }` | - | | | prevButtonProps | 上一步按钮的属性 | `{ children: ReactNode; onClick: Function }` | - | | | scrollIntoViewOptions | 是否支持当前元素滚动到视窗内，也可传入配置指定滚动视窗的相关参数，默认跟随 Tour 的 `scrollIntoViewOptions` 属性 | `boolean \| ScrollIntoViewOptions` | `true` | 5.2.0 | + +## Design Token + + diff --git a/components/transfer/index.en-US.md b/components/transfer/index.en-US.md index 7d26e17fc8..5d127337ec 100644 --- a/components/transfer/index.en-US.md +++ b/components/transfer/index.en-US.md @@ -90,6 +90,10 @@ If there's no `key` in your data, you should use `rowKey` to specify the key tha return record.uid} />; ``` +## Design Token + + + ## FAQ ### How to support fetch and present data from a remote server in Transfer column. diff --git a/components/transfer/index.zh-CN.md b/components/transfer/index.zh-CN.md index 2d293787f4..f75cb533b6 100644 --- a/components/transfer/index.zh-CN.md +++ b/components/transfer/index.zh-CN.md @@ -93,6 +93,10 @@ Transfer 支持接收 `children` 自定义渲染列表，并返回以下参数 return record.uid} />; ``` +## Design Token + + + ## FAQ ### 怎样让 Transfer 穿梭框列表支持异步数据加载 diff --git a/components/tree-select/index.en-US.md b/components/tree-select/index.en-US.md index 11e7a7443e..fd39368c91 100644 --- a/components/tree-select/index.en-US.md +++ b/components/tree-select/index.en-US.md @@ -108,6 +108,10 @@ Tree selection control. | title | Content showed on the treeNodes | ReactNode | `---` | | | value | Will be treated as `treeNodeFilterProp` by default, should be unique in the tree | string | - | | +## Design Token + + + ## FAQ ### How to get parent node in onChange? diff --git a/components/tree-select/index.zh-CN.md b/components/tree-select/index.zh-CN.md index df4c5df5a0..1e15c803f0 100644 --- a/components/tree-select/index.zh-CN.md +++ b/components/tree-select/index.zh-CN.md @@ -109,6 +109,10 @@ demo: | title | 树节点显示的内容 | ReactNode | `---` | | | value | 默认根据此属性值进行筛选（其值在整个树范围内唯一） | string | - | | +## Design Token + + + ## FAQ ### onChange 时如何获得父节点信息？ diff --git a/components/tree/index.en-US.md b/components/tree/index.en-US.md index 4a708467bc..cce32867fe 100644 --- a/components/tree/index.en-US.md +++ b/components/tree/index.en-US.md @@ -123,6 +123,10 @@ Before `3.4.0`: The number of treeNodes can be very large, but when `checkable=t | --- | --- | | scrollTo({ key: string \| number; align?: 'top' \| 'bottom' \| 'auto'; offset?: number }) | Scroll to key item in virtual scroll | +## Design Token + + + ## FAQ ### How to hide file icon when use showLine? diff --git a/components/tree/index.zh-CN.md b/components/tree/index.zh-CN.md index b59fc8ec09..6f6f919f76 100644 --- a/components/tree/index.zh-CN.md +++ b/components/tree/index.zh-CN.md @@ -125,6 +125,10 @@ demo: | --- | --- | | scrollTo({ key: string \| number; align?: 'top' \| 'bottom' \| 'auto'; offset?: number }) | 虚拟滚动下，滚动到指定 key 条目 | +## Design Token + + + ## FAQ ### 在 showLine 时，如何隐藏子节点图标？ diff --git a/components/upload/index.en-US.md b/components/upload/index.en-US.md index 3701fb5ab8..f66046331b 100644 --- a/components/upload/index.en-US.md +++ b/components/upload/index.en-US.md @@ -120,6 +120,10 @@ When uploading state change, it returns: 3. `event` response from server, including uploading progress, supported by advanced browsers. +## Design Token + + + ## FAQ ### How do I implement upload server side? diff --git a/components/upload/index.zh-CN.md b/components/upload/index.zh-CN.md index 260b50904e..5c523b36fb 100644 --- a/components/upload/index.zh-CN.md +++ b/components/upload/index.zh-CN.md @@ -120,6 +120,10 @@ demo: 3. `event` 上传中的服务端响应内容，包含了上传进度等信息，高级浏览器支持。 +## Design Token + + + ## FAQ ### 服务端如何实现？ diff --git a/components/watermark/index.en-US.md b/components/watermark/index.en-US.md index f2ff507763..59aceaa478 100644 --- a/components/watermark/index.en-US.md +++ b/components/watermark/index.en-US.md @@ -50,6 +50,10 @@ Add specific text or patterns to the page. | fontFamily | font family | string | sans-serif | | | fontStyle | font style | `none` \| `normal` \| `italic` \| `oblique` | normal | | +## Design Token + + + ## FAQ ### Handle abnormal image watermarks diff --git a/components/watermark/index.zh-CN.md b/components/watermark/index.zh-CN.md index 5b2e05fbf6..78f3c06012 100644 --- a/components/watermark/index.zh-CN.md +++ b/components/watermark/index.zh-CN.md @@ -51,6 +51,10 @@ demo: | fontFamily | 字体类型 | string | sans-serif | | | fontStyle | 字体样式 | `none` \| `normal` \| `italic` \| `oblique` | normal | | +## Design Token + + + ## FAQ ### 处理异常图片水印