Skip to content

Commit

Permalink
chore: doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@DaiQiangReal
DaiQiangReal committed Jun 17, 2024
1 parent f8d8fa6 commit 85967ed
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 28 deletions.
29 changes: 15 additions & 14 deletions content/navigation/breadcrumb/index-en-US.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -297,20 +297,21 @@ import { IconHome, IconArticle } from '@douyinfe/semi-icons';

### Breadcrumb

| Properties | Instructions | type | Default | version |
| ---------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------- | --------- | ------- |
| autoCollapse | Toggle whether to auto collapse when exceed maxItemCount | boolean | true | 1.9.0 |
| className | Class name | string | - | |
| compact | Compact sizing | boolean | true | |
| maxItemCount | Set the number of item when reached to collapse | number | 4 | 1.9.0 |
|moreType|...area rendering type，one of 'default'、'popover'|string|'default'|1.27.0|
| renderItem | Custom function, used with routes | (Route: [Route](#Route)) => React Node | - | 0.27.0 |
|renderMore|Custom ... area rendering|(restItem: ReactNode[]) => ReactNode|-|1.27.0|
| routes | Routing information, an array of route objects or strings, format reference: [Route](#Route) | Array<[Route](#Route) \| string\> | - | |
| separator | Customized delimiter | string | ReactNode | '/' | |
| showTooltip | Toggle whether to show tooltip if text overflowed. If passed in as an object: width, overflowed width; ellipsisPos, ways of truncation; opts, passed directly to Tooltip component | boolean \| showToolTipProps | {width: 150, ellipsisPos: 'end', opts: { autoAdjustOverflow: true, position: "bottomLeft" }} | 0.34.0 |
| style | Inline style | CSSProperties | - | |
| onClick | Click event | (item: [Route](#Route), e: Event) => void| - | 0.27.0 |
| Properties | Instructions | type | Default | version |
| ---------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------------------------------------------- | --------- | ------- |
| activeIndex| Controlled use, currently selected navigation index | - | 2.61.0 |
| autoCollapse | Toggle whether to auto collapse when exceed maxItemCount | boolean | true | 1.9.0 |
| className | Class name | string | - | |
| compact | Compact sizing | boolean | true | |
| maxItemCount | Set the number of item when reached to collapse | number | 4 | 1.9.0 |
|moreType| ...area rendering type，one of 'default'、'popover' |string|'default'|1.27.0|
| renderItem | Custom function, used with routes | (Route: [Route](#Route)) => React Node | - | 0.27.0 |
|renderMore| Custom ... area rendering |(restItem: ReactNode[]) => ReactNode|-|1.27.0|
| routes | Routing information, an array of route objects or strings, format reference: [Route](#Route) | Array<[Route](#Route) \| string\> | - | |
| separator | Customized delimiter | string | ReactNode | '/' | |
| showTooltip | Toggle whether to show tooltip if text overflowed. If passed in as an object: width, overflowed width; ellipsisPos, ways of truncation; opts, passed directly to Tooltip component | boolean \| showToolTipProps | {width: 150, ellipsisPos: 'end', opts: { autoAdjustOverflow: true, position: "bottomLeft" }} | 0.34.0 |
| style | Inline style | CSSProperties | - | |
| onClick | Click event | (item: [Route](#Route), e: Event) => void| - | 0.27.0 |

### Breadcrumb.Item

Expand Down
29 changes: 15 additions & 14 deletions content/navigation/breadcrumb/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -300,20 +300,21 @@ import { IconHome, IconArticle } from '@douyinfe/semi-icons';

### Breadcrumb

| 属性 | 说明 | 类型 | 默认值 | 版本 |
| ---------- | ----------------------------------------------------------------------------------------- | ------------------------------------------ | ------ | ------ |
| autoCollapse | 是否超出maxItemCount后自动折叠 | boolean | true | 1.9.0 |
| className | 类名 | string | - | |
| compact | 显示尺寸，是否紧凑 | boolean | true | |
| maxItemCount | 超出多少个进行自动折叠 | number | 4 | 1.9.0 |
|moreType|内置的...区域的渲染类型，可选值为 'default'、'popover'|string|'default'|1.27.0|
| renderItem | 自定义链接函数，配合 routes 使用 | (Route: [Route](#Route)) => ReactNode | - | 0.27.0 |
| renderMore|自定义...区域的渲染|(restItem: ReactNode[]) => ReactNode|-|1.27.0|
| routes | router 的路由信息，由路由对象或字符串组成的数组，路由对象格式参考: [Route](#Route) | Array<[Route](#Route) \| string\> | - | |
| separator | 自定义的分隔符 | ReactNode | '/' | |
| showTooltip | 是否展示 Tooltip 及相关配置: width，溢出宽度； ellipsisPos，截断方式，从中间/末尾截断； opts，透传给Tooltip的属性 | boolean \| showToolTipProps | {width: 150, ellipsisPos: 'end', opts: { autoAdjustOverflow: true, position: "bottomLeft" }} | 0.34.0 |
| style | 内联样式 | CSSProperties | - | |
| onClick | 单击事件 | (item: [Route](#Route) , e: Event) => void | - | 0.27.0 |
| 属性 | 说明 | 类型 | 默认值 | 版本 |
| ---------- |---------------------------------------------------------------------------------------------------------| ------------------------------------------ | ------ | ------ |
| activeIndex| 受控使用，当前选择的导航序号 | - | 2.61.0 |
| autoCollapse | 是否超出maxItemCount后自动折叠 | boolean | true | 1.9.0 |
| className | 类名 | string | - | |
| compact | 显示尺寸，是否紧凑 | boolean | true | |
| maxItemCount | 超出多少个进行自动折叠 | number | 4 | 1.9.0 |
|moreType| 内置的...区域的渲染类型，可选值为 'default'、'popover' |string|'default'|1.27.0|
| renderItem | 自定义链接函数，配合 routes 使用 | (Route: [Route](#Route)) => ReactNode | - | 0.27.0 |
| renderMore| 自定义...区域的渲染 |(restItem: ReactNode[]) => ReactNode|-|1.27.0|
| routes | router 的路由信息，由路由对象或字符串组成的数组，路由对象格式参考: [Route](#Route) | Array<[Route](#Route) \| string\> | - | |
| separator | 自定义的分隔符 | ReactNode | '/' | |
| showTooltip | 是否展示 Tooltip 及相关配置: width，溢出宽度； ellipsisPos，截断方式，从中间/末尾截断； opts，透传给Tooltip的属性 | boolean \| showToolTipProps | {width: 150, ellipsisPos: 'end', opts: { autoAdjustOverflow: true, position: "bottomLeft" }} | 0.34.0 |
| style | 内联样式 | CSSProperties | - | |
| onClick | 单击事件 | (item: [Route](#Route) , e: Event) => void | - | 0.27.0 |

### Breadcrumb.Item

Expand Down

0 comments on commit 85967ed

Please sign in to comment.