Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update doc of SwipeAction ProgressBar ProgressCircle Popover Switch #6232

Merged
merged 4 commits into from
Jul 4, 2023
Merged

docs: update doc of SwipeAction ProgressBar ProgressCircle Popover Switch #6232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d3cc361
doc: update SwupeAction doc
1587315093 Jul 4, 2023
62f592e
doc: update ProgressBar ProgressCircle doc
1587315093 Jul 4, 2023
41ec988
doc: update Popover doc
1587315093 Jul 4, 2023
604b943
doc: update Switch doc
1587315093 Jul 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/components/popover/index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Navigation applicable to functions can only be evoked by the icons on the naviga

| Name | Description | Type | Default |
| --- | --- | --- | --- |
| children | The element that triggered the popover | `React.ReactElement` | - |
| children | The element that triggered the Popover | `React.ReactElement` | - |
| content | The content of the Popover | `React.ReactNode` | - |
| defaultVisible | Whether to show or hide by default | `boolean` | `false` |
| destroyOnHide | When hiding, whether to destroy the content of `tooltip` | `boolean` | `false` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/popover/index.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

| 属性 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| children | 触发 `popover` 的元素 | `React.ReactElement` | - |
| children | 触发 `Popover` 的元素 | `React.ReactElement` | - |
| content | 弹出内容 | `React.ReactNode` | - |
| defaultVisible | 默认是否显隐 | `boolean` | `false` |
| destroyOnHide | 隐藏时，是否销毁 `tooltip` 内容 | `boolean` | `false` |
Expand Down
2 changes: 1 addition & 1 deletion src/components/progress-bar/index.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| percent | 百分比 | `number` | `0` |
| percent | 进度条百分比 | `number` | `0` |
| rounded | 是否圆角 | `boolean` | `true` |
| text | 是否显示进度文字，支持自定义渲染内容 | `boolean \| ReactNode \| ((percent: number) => ReactNode)` | `false` |

Expand Down
8 changes: 4 additions & 4 deletions src/components/progress-circle/index.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@

### 属性

| 参数 | 说明 | 类型 | 默认值 |
| -------- | ---------- | ----------------- | ------ |
| children | 自定义信息 | `React.ReactNode` | - |
| percent | 百分比 | `number` | `0` |
| 参数 | 说明 | 类型 | 默认值 |
| -------- | ------------ | ----------------- | ------ |
| children | 自定义信息 | `React.ReactNode` | - |
| percent | 进度圈百分比 | `number` | `0` |

### CSS 变量

Expand Down
4 changes: 2 additions & 2 deletions src/components/swipe-action/index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ Swipe to reveal hidden function menus.
| closeOnAction | Whether to return to the position automatically when the operation button is clicked | `boolean` | `true` |
| closeOnTouchOutside | Whether to return to the position automatically when other areas is clicked | `boolean` | `true` |
| leftActions | List of operation buttons on the left | `Action[]` | `[]` |
| onAction | Triggered when operation button is clicked | `(action: Action, e: React.MouseEvent) => void` | - |
| rightActions | List of operation buttons on the right | `Action[]` | `[]` |
| onAction | Triggered when operation button is clicked | `(action: Action, e: React.MouseEvent) => void` | - |
| stopPropagation | Stop the propagation of some events. | `PropagationEvent[]` | `[]` |
| onActionsReveal | Triggered when the operation button appears completely | (side: 'left' \| 'right') => void | - |
| onActionsReveal | Triggered when the operation button appears completely | `(side: 'left' \| 'right') => void` | - |

### Action

Expand Down
4 changes: 2 additions & 2 deletions src/components/swipe-action/index.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
| closeOnAction | 是否在点击操作按钮时自动归位 | `boolean` | `true` |
| closeOnTouchOutside | 是否在点击其他区域时自动归位 | `boolean` | `true` |
| leftActions | 左侧的操作按钮列表 | `Action[]` | `[]` |
| onAction | 点击操作按钮时触发 | `(action: Action, e: React.MouseEvent) => void` | - |
| rightActions | 右侧的操作按钮列表 | `Action[]` | `[]` |
| onAction | 点击操作按钮时触发 | `(action: Action, e: React.MouseEvent) => void` | - |
| stopPropagation | 阻止某些事件的冒泡 | `PropagationEven[]` | `[]` |
| onActionsReveal | 按钮完全出现时触发 | (side: 'left' \| 'right') => void | - |
| onActionsReveal | 按钮完全出现时触发 | `(side: 'left' \| 'right') => void` | - |

### Action

Expand Down
2 changes: 1 addition & 1 deletion src/components/switch/index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ switch selector.

| Name | Description | Type | Default |
| --- | --- | --- | --- |
| beforeChange | Execute before change | `(val: boolean) => Promise<void>` | - |
| beforeChange（deprecated） | Execute before change （Deprecated, recommend using the onChange attribute.） | `(val: boolean) => Promise<void>` | - |
| checked | Specify whether it is currently opened | `boolean` | `false` |
| checkedText | Selected text | `ReactNode` | - |
| defaultChecked | Whether to open initially | `boolean` | `false` |
Expand Down