Browse Source

docs: update demo

point.halo 1 year ago
parent
commit
a16110a81f

+ 9 - 9
content/feedback/popconfirm/index.md

@@ -204,13 +204,13 @@ import { Button, Popconfirm, Space } from '@douyinfe/semi-ui';
 
 
 | 属性 | 说明                                                                                                                                        | 类型 | 默认值 | 版本 |
 | 属性 | 说明                                                                                                                                        | 类型 | 默认值 | 版本 |
 | --- |-------------------------------------------------------------------------------------------------------------------------------------------| --- | --- | --- |
 | --- |-------------------------------------------------------------------------------------------------------------------------------------------| --- | --- | --- |
-| arrowPointAtCenter | “小三角”是否指向元素中心,需要同时传入"showArrow=true"                                                                                                      | boolean | false | **0.34.0** |
+| arrowPointAtCenter | “小三角”是否指向元素中心,需要同时传入"showArrow=true"                                                                                                      | boolean | false | |
 | cancelText | 取消按钮文字                                                                                                                                    | string | "取消" |
 | cancelText | 取消按钮文字                                                                                                                                    | string | "取消" |
 | cancelButtonProps | 取消按钮的 props                                                                                                                               | object |  | **0.29.0** |
 | cancelButtonProps | 取消按钮的 props                                                                                                                               | object |  | **0.29.0** |
 | cancelType | 取消按钮类型                                                                                                                                    | string | "tertiary" |
 | cancelType | 取消按钮类型                                                                                                                                    | string | "tertiary" |
 | closeOnEsc | 在 trigger 聚焦时或在弹出层内聚焦元素上按 Esc 键是否关闭面板,受控时不生效                                                                                              | boolean | true | **2.8.0** |
 | closeOnEsc | 在 trigger 聚焦时或在弹出层内聚焦元素上按 Esc 键是否关闭面板,受控时不生效                                                                                              | boolean | true | **2.8.0** |
 | content | 显示的内容(函数类型,2.10.0 版本支持)                                                                                                                   | ReactNode\|({ initialFocusRef }) => ReactNode |  |
 | content | 显示的内容(函数类型,2.10.0 版本支持)                                                                                                                   | ReactNode\|({ initialFocusRef }) => ReactNode |  |
-| defaultVisible | 气泡框默认是否展示                                                                                                                                 | boolean |  | **0.19.0** |
+| defaultVisible | 气泡框默认是否展示                                                                                                                                 | boolean |  |  |
 | disabled | 点击 Popconfirm 子元素是否弹出气泡确认框                                                                                                                | boolean | false |
 | disabled | 点击 Popconfirm 子元素是否弹出气泡确认框                                                                                                                | boolean | false |
 | getPopupContainer | 指定父级 DOM,弹层将会渲染至该 DOM 中,自定义时容器需要设置 `position: relative` 这会改变浮层 DOM 树位置,但不会改变视图渲染位置。                                                                                   | Function():HTMLElement | () => document.body |
 | getPopupContainer | 指定父级 DOM,弹层将会渲染至该 DOM 中,自定义时容器需要设置 `position: relative` 这会改变浮层 DOM 树位置,但不会改变视图渲染位置。                                                                                   | Function():HTMLElement | () => document.body |
 | guardFocus | 当焦点处于弹出层内时,切换 Tab 是否让焦点在弹出层内循环                                                                                                            | boolean | true | **2.8.0** |
 | guardFocus | 当焦点处于弹出层内时,切换 Tab 是否让焦点在弹出层内循环                                                                                                            | boolean | true | **2.8.0** |
@@ -218,20 +218,20 @@ import { Button, Popconfirm, Space } from '@douyinfe/semi-ui';
 | motion | 下拉列表出现/隐藏时,是否有动画                                                                                                                          | boolean | true |
 | motion | 下拉列表出现/隐藏时,是否有动画                                                                                                                          | boolean | true |
 | okText | 确认按钮文字                                                                                                                                    | string | "确认" |
 | okText | 确认按钮文字                                                                                                                                    | string | "确认" |
 | okType | 确认按钮类型                                                                                                                                    | string | "primary" |
 | okType | 确认按钮类型                                                                                                                                    | string | "primary" |
-| okButtonProps | 确认按钮的 props                                                                                                                               | object |  | **0.29.0** |
+| okButtonProps | 确认按钮的 props                                                                                                                               | object |  |  |
 | position | 方向,可选值:`top`,`topLeft`,`topRight`,`left`,`leftTop`,`leftBottom`,<br/>`right`,`rightTop`,`rightBottom`,`bottom`,`bottomLeft`,`bottomRight` | string | "bottomLeft" |
 | position | 方向,可选值:`top`,`topLeft`,`topRight`,`left`,`leftTop`,`leftBottom`,<br/>`right`,`rightTop`,`rightBottom`,`bottom`,`bottomLeft`,`bottomRight` | string | "bottomLeft" |
 | returnFocusOnClose | 按下 Esc 键后,焦点是否回到 trigger 上,只有设置 trigger 为 click 时生效                                                                                       | boolean | true | **2.8.0** |
 | returnFocusOnClose | 按下 Esc 键后,焦点是否回到 trigger 上,只有设置 trigger 为 click 时生效                                                                                       | boolean | true | **2.8.0** |
 | showArrow | 是否显示箭头三角形                                                                                                                                 | boolean | false |  |
 | showArrow | 是否显示箭头三角形                                                                                                                                 | boolean | false |  |
-| stopPropagation | 是否阻止弹层上的点击事件冒泡                                                                                                                            | boolean | true | **0.34.0** |
-| title | 显示的标题                                                                                                                                     | string\|ReactNode |  |
+| stopPropagation | 是否阻止弹层上的点击事件冒泡                                                                                                                            | boolean | true |  |
+| title | 显示的标题                                                                                                                                     | ReactNode |  |
 | trigger | 触发展示的时机,可选值:hover / focus / click / custom                                                                                                | string | 'click' |
 | trigger | 触发展示的时机,可选值:hover / focus / click / custom                                                                                                | string | 'click' |
-| visible | 气泡框是否展示的受控属性                                                                                                                              | boolean |  | **0.19.0** |
+| visible | 气泡框是否展示的受控属性                                                                                                                              | boolean |  |  |
 | zIndex | 浮层 z-index 值                                                                                                                              | number | 1030 |
 | zIndex | 浮层 z-index 值                                                                                                                              | number | 1030 |
 | onConfirm | 点击确认按钮回调                                                                                                                                  | Function(e) |  |
 | onConfirm | 点击确认按钮回调                                                                                                                                  | Function(e) |  |
 | onCancel | 点击取消按钮回调                                                                                                                                  | Function(e) |  |
 | onCancel | 点击取消按钮回调                                                                                                                                  | Function(e) |  |
-| onClickOutSide | 当弹出层处于展示状态,点击非 Children、非浮层内部区域时的回调                                                                                                       | Function(e) | **2.1.0** |
-| onEscKeyDown | 在 trigger 或弹出层按 Esc 键时调用                                                                                                                  | function(e:event) |  | **2.8.0** |
-| onVisibleChange | 气泡框切换显示隐藏的回调                                                                                                                              | Function(visible: boolean): void | () => {} | **0.19.0** |
+| onClickOutSide | 当弹出层处于展示状态,点击非 Children、非浮层内部区域时的回调                                                                                                       | Function(e) | |**2.1.0** |
+| onEscKeyDown | 在 trigger 或弹出层按 Esc 键时调用                                                                                                                  | Function(e:event) |  | **2.8.0** |
+| onVisibleChange | 气泡框切换显示隐藏的回调                                                                                                                              | Function(visible: boolean): void | () => {} | |
 
 
 ## Accessibility
 ## Accessibility
 
 

+ 2 - 2
content/feedback/skeleton/index-en-US.md

@@ -10,7 +10,7 @@ brief: A placeholder preview of content before the data loaded.
 
 
 ## Overview
 ## Overview
 
 
--   `Avatar`: Avatar placeholder, by default uses Avatar medium sizing: `width: 48px`, `height: 48px`. Supports Avatar's size (after v1.0) and shape attributes (after v2.20)
+-   `Avatar`: Avatar placeholder, by default uses Avatar medium sizing: `width: 48px`, `height: 48px`. Supports Avatar's size and shape attributes (after v2.20)
 -   `Image`: Image placeholder, default size: `width: 100%`, `height: 100%`.
 -   `Image`: Image placeholder, default size: `width: 100%`, `height: 100%`.
 -   `Title`: Title placeholder, default size: `width: 100%`, `height: 24px`.
 -   `Title`: Title placeholder, default size: `width: 100%`, `height: 24px`.
 -   `Paragraph`: Content part placeholder, default size: `width: 100%`, `height: 16px`, `margin-bottom: 10px`.
 -   `Paragraph`: Content part placeholder, default size: `width: 100%`, `height: 16px`, `margin-bottom: 10px`.
@@ -391,7 +391,7 @@ import { Skeleton, Avatar } from '@douyinfe/semi-ui';
 | Property | Instructions | type | Default |
 | Property | Instructions | type | Default |
 | --- | --- | --- | --- |
 | --- | --- | --- | --- |
 | class Name | Class name | string | - |
 | class Name | Class name | string | - |
-| size | Size of the avatar, one of `extra-extra-small`, `extra-small`, `small`, `medium`, `large`, `extra-large`, **v>=1.0** | string | `medium` |
+| size | Size of the avatar, one of `extra-extra-small`, `extra-small`, `small`, `medium`, `large`, `extra-large` | string | `medium` |
 | style | Inline style | CSSProperties | - |
 | style | Inline style | CSSProperties | - |
 | shape | Shape of the avatar, one of `circle`, `square` | string | `circle` |
 | shape | Shape of the avatar, one of `circle`, `square` | string | `circle` |
 
 

+ 2 - 2
content/feedback/skeleton/index.md

@@ -9,7 +9,7 @@ brief: 在需要等待加载内容的位置提供的占位组件。
 
 
 ## 概述
 ## 概述
 
 
--   `Avatar`:占位头像,默认为圆形,默认尺寸:Avatar medium: `width: 48px`,`height: 48px`。支持 Avatar 的 size(v1.0后支持)、shape 属性 (v2.20后支持)
+-   `Avatar`:占位头像,默认为圆形,默认尺寸:Avatar medium: `width: 48px`,`height: 48px`。支持 Avatar 的 size、shape 属性 (v2.20后支持)
 -   `Image`:占位图像,默认尺寸:`width: 100%`,`height: 100%`。
 -   `Image`:占位图像,默认尺寸:`width: 100%`,`height: 100%`。
 -   `Title`:占位标题,默认尺寸:`width: 100%`, `height: 24px`。
 -   `Title`:占位标题,默认尺寸:`width: 100%`, `height: 24px`。
 -   `Paragraph`:占位内容部分,默认尺寸:`width: 100%`,`height: 16px`,`margin-bottom: 10px`。
 -   `Paragraph`:占位内容部分,默认尺寸:`width: 100%`,`height: 16px`,`margin-bottom: 10px`。
@@ -379,7 +379,7 @@ import { Skeleton, Avatar } from '@douyinfe/semi-ui';
 | 属性 | 说明 | 类型 | 默认值 |
 | 属性 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
 | --- | --- | --- | --- |
 | className | 类名 | string | - |
 | className | 类名 | string | - |
-| size | 设置头像的大小,支持 `extra-extra-small`, `extra-small`、`small`、`medium`、`large`、`extra-large` **v>=1.0** | string | `medium` |
+| size | 设置头像的大小,支持 `extra-extra-small`, `extra-small`、`small`、`medium`、`large`、`extra-large` | string | `medium` |
 | style | 样式 | CSSProperties | - |
 | style | 样式 | CSSProperties | - |
 | shape | 指定头像的形状,支持 `circle`、`square` | string | `circle` |
 | shape | 指定头像的形状,支持 `circle`、`square` | string | `circle` |
 
 

+ 2 - 4
content/show/empty/index-en-US.md

@@ -114,8 +114,6 @@ import { IllustrationSuccess, IllustrationSuccessDark } from '@douyinfe/semi-ill
 
 
 Currently the following illustrations are supported in `@douyinfe/semi-illustrations`.
 Currently the following illustrations are supported in `@douyinfe/semi-illustrations`.
 
 
-> As the illustration library is still under construction, please keep an eye on possible changes in the future.
-
 ```jsx live=true dir="column"
 ```jsx live=true dir="column"
 import React from 'react';
 import React from 'react';
 import { Empty } from '@douyinfe/semi-ui';
 import { Empty } from '@douyinfe/semi-ui';
@@ -184,13 +182,13 @@ import { IllustrationIdle, IllustrationIdleDark, IllustrationConstructionDark, I
 | Property | Description | Type | Default |
 | Property | Description | Type | Default |
 | --- | --- | --- | --- |
 | --- | --- | --- | --- |
 | className | class name | string |-|
 | className | class name | string |-|
-| darkModeImage | The placeholder image after the dark mode is turned on, in response to the change of the theme-mode property of document.body **v>=1.13.0** | ReactNode |-|
+| darkModeImage | The placeholder image after the dark mode is turned on, in response to the change of the theme-mode property of document.body | ReactNode |-|
 | description | Content description | ReactNode |-|
 | description | Content description | ReactNode |-|
 | image | Placeholder image | ReactNode \| { id?: string; viewBox?: string; url?: string;} |-|
 | image | Placeholder image | ReactNode \| { id?: string; viewBox?: string; url?: string;} |-|
 | imageStyle | Placeholder image style | CSSProperties |-|
 | imageStyle | Placeholder image style | CSSProperties |-|
 | layout | Layout mode, support `vertical`, `horizontal` | string | `vertical` |
 | layout | Layout mode, support `vertical`, `horizontal` | string | `vertical` |
 | style | Style name | CSSProperties |-|
 | style | Style name | CSSProperties |-|
-| title | Title **v>=1.0.0** | ReactNode |-|
+| title | Title | ReactNode |-|
 
 
 ## Accessibility
 ## Accessibility
 
 

+ 2 - 4
content/show/empty/index.md

@@ -113,8 +113,6 @@ import { IllustrationSuccess, IllustrationSuccessDark } from '@douyinfe/semi-ill
 
 
 目前 `@douyinfe/semi-illustrations` 中支持以下插画。
 目前 `@douyinfe/semi-illustrations` 中支持以下插画。
 
 
-> 由于插画库还在建设中,请随时留意后续可能发生的改变。
-
 ```jsx live=true dir="column"
 ```jsx live=true dir="column"
 import React from 'react';
 import React from 'react';
 import { Empty } from '@douyinfe/semi-ui';
 import { Empty } from '@douyinfe/semi-ui';
@@ -187,13 +185,13 @@ import { IllustrationIdle, IllustrationIdleDark, IllustrationConstructionDark, I
 | 属性 | 说明 | 类型 | 默认值 |
 | 属性 | 说明 | 类型 | 默认值 |
 | --- | --- | --- | --- |
 | --- | --- | --- | --- |
 | className | 类名 | string | - |
 | className | 类名 | string | - |
-| darkModeImage | 暗色模式开启后的占位图,响应 document.body 的 theme-mode 属性变化 **v>=1.13.0** | ReactNode | - |
+| darkModeImage | 暗色模式开启后的占位图,响应 document.body 的 theme-mode 属性变化 | ReactNode | - |
 | description | 内容描述 | ReactNode | - |
 | description | 内容描述 | ReactNode | - |
 | image | 占位图 | ReactNode \| { id?: string; viewBox?: string; url?: string;} | - |
 | image | 占位图 | ReactNode \| { id?: string; viewBox?: string; url?: string;} | - |
 | imageStyle | 占位图样式 | CSSProperties | - |
 | imageStyle | 占位图样式 | CSSProperties | - |
 | layout | 布局方式,支持 `vertical`, `horizontal` | string | `vertical` |
 | layout | 布局方式,支持 `vertical`, `horizontal` | string | `vertical` |
 | style | 样式名 | CSSProperties | - |
 | style | 样式名 | CSSProperties | - |
-| title | 标题 **v>=1.0.0** | ReactNode | - |
+| title | 标题 | ReactNode | - |
 
 
 ## Accessibility
 ## Accessibility