Skip to content

Commit

Permalink
feat: 文档补充 (#329)
Browse files Browse the repository at this point in the history
  • Loading branch information
yx376642000 committed Jan 25, 2024
1 parent fd8285b commit 7a7940e
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 15 deletions.
1 change: 1 addition & 0 deletions packages/quarkd/src/tab/doc-react.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ In sticky mode, the nav-item will be fixed to top when scroll to top.
| dark | Whether to use dark mode | `boolean` | `false` |
| offsettop | Sticky offset top , supports vm | `string` | `0vw` |
| linewidth | Width of tab line | `string` | `40px` |
| shrink | Whether to shrink the the tabs to the left | `boolean` | `false` |
| onChange | change callback | `(e: {detail: { name: string,label: number }}) => void` | - |

### TabContent props
Expand Down
18 changes: 10 additions & 8 deletions packages/quarkd/src/tab/doc-react.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,16 @@ nav-item 在滚动时固定在屏幕上方

### Tabs props

| 方法名 | 说明 | 类型 | 默认值 |
| --------- | ----------------------------------------------- | -------------------------------------------------------- | ------- |
| activekey | 当前激活的 tab,对应到 `TabContent` 中的 `name` | `string` | - |
| sticky | 是否吸顶 | `boolean` | `false` |
| dark | 深色模式 | `boolean` | `false` |
| offsettop | 吸顶时与顶部的距离(单位: vw) | `string` | `0vw` |
| linewidth | 下划线宽 | string | `40px` |
| onChange | change 回调函数 | `(e: {detail: { name: string,label: number }}) => void` | - |
| 方法名 | 说明 | 类型 | 默认值 |
| --------- | ----------------------------------------------- | --------- | ------- |
| activekey | 当前激活的 tab,对应到 `TabContent` 中的 `name` | `string` | - |
| sticky | 是否吸顶 | `boolean` | `false` |
| dark | 深色模式 | `boolean` | `false` |
| offsettop | 吸顶时与顶部的距离(单位: vw) | `string` | `0vw` |
| linewidth | 下划线宽 | string | `40px` |
| shrink | 是否开启左侧收缩布局 | `boolean` | `false` |

| onChange | change 回调函数 | `(e: {detail: { name: string,label: number }}) => void` | - |

### TabContent props

Expand Down
1 change: 1 addition & 0 deletions packages/quarkd/src/tab/doc.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ In sticky mode, the nav-item will be fixed to top when scroll to top.
| dark | Whether to use dark mode | `boolean` | `false` |
| offsettop | Sticky offset top , supports vm | `string` | `0vw` |
| linewidth | Width of tab line | `string` | `40px` |
| shrink | Whether to shrink the the tabs to the left | `boolean` | `false` |

### Quark-tab-content props

Expand Down
15 changes: 8 additions & 7 deletions packages/quarkd/src/tab/doc.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,14 @@ nav-item 在滚动时固定在屏幕上方

### Quark-tabs props

| 方法名 | 说明 | 类型 | 默认值 |
| --------- | ------------------------------------------------------ | ---------- | ------- |
| activekey | 当前激活的 tab,对应到 `quark-tab-content` 中的 `name` | `string` ||
| sticky | 是否吸顶 | `boolean ` | `false` |
| dark | 深色模式 | `boolean ` | `false` |
| offsettop | 吸顶时与顶部的距离(单位: vw) | `string ` | `0vw` |
| linewidth | 下划线宽 | `string ` | `40px` |
| 方法名 | 说明 | 类型 | 默认值 |
| --------- | ------------------------------------------------------ | --------- | ------- |
| activekey | 当前激活的 tab,对应到 `quark-tab-content` 中的 `name` | `string` ||
| sticky | 是否吸顶 | `boolean` | `false` |
| dark | 深色模式 | `boolean` | `false` |
| offsettop | 吸顶时与顶部的距离(单位: vw) | `string` | `0vw` |
| linewidth | 下划线宽 | `string` | `40px` |
| shrink | 是否开启左侧收缩布局 | `boolean` | `false` |

### Quark-tab-content props

Expand Down

0 comments on commit 7a7940e

Please sign in to comment.