Breadcrumb
Displays the current location within a hierarchy.
When to use
Use Breadcrumb when the product has more than two hierarchy levels and users may need to move upward.
Examples
API
Breadcrumb, Breadcrumb.Item, Breadcrumb.Separator, and their props are exported from @ceebee/ui/client.
Breadcrumb
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
classNames | Customize class for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string> | - | 6.0.0 |
dropdownIcon | Custom dropdown icon | ReactNode | <DownOutlined /> | 6.2.0 |
items | The routing stack information of router (>=5.3.0 recommended, use Breadcrumb.Item children for older versions) | [ItemType\[\]](#itemtype) | - | 5.3.0 |
itemRender | Custom item renderer, work with react-router, see example | (route, params, routes, paths) => ReactNode | - | — |
params | Routing parameters | object | - | — |
separator | Custom separator | ReactNode | / | — |
styles | Customize inline style for each semantic structure inside the component. Supports object or function. | Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties> | - | 6.0.0 |
RouteItemType
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
className | The additional css class | string | - | — |
dropdownProps | The dropdown props | Dropdown | - | — |
href | Target of hyperlink. Can not work with path | string | - | — |
path | Connected path. Each path will connect with prev one. Can not work with href | string | - | — |
menu | The menu props | MenuProps | - | 4.24.0 |
onClick | Set the handler to handle click event | (e:MouseEvent) => void | - | — |
title | item name | ReactNode | - | 5.3.0 |
SeparatorType
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
type | Mark as separator | separator | — | 5.3.0 |
separator | Custom separator | ReactNode | / | 5.3.0 |