Flutter docs
Default skin

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

Basic Usage

The simplest use.

With Params

With route params.

Bread crumbs with drop down menu

Breadcrumbs support drop down menu.

Debug Routes

Origin routes debug.

With an Icon

The icon should be placed in front of the text. A bare from a third-party icon library (e.g. lucide, react-icons) stays vertically centred with, and spaced from, the text.

Configuring the Separator

The separator can be customized by setting the separator property: separator="".

Configuring the Separator Independently

Customize separator for each other.

Custom semantic dom styling

You can customize the semantic dom style of Breadcrumb by passing objects/functions through classNames and styles.

API

Breadcrumb, Breadcrumb.Item, Breadcrumb.Separator, and their props are exported from @ceebee/ui/client.

Breadcrumb

PropertyDescriptionTypeDefaultVersion
classNamesCustomize class for each semantic structure inside the component. Supports object or function.Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string>-6.0.0
dropdownIconCustom dropdown iconReactNode<DownOutlined />6.2.0
itemsThe routing stack information of router (>=5.3.0 recommended, use Breadcrumb.Item children for older versions)[ItemType\[\]](#itemtype)-5.3.0
itemRenderCustom item renderer, work with react-router, see example(route, params, routes, paths) => ReactNode-—
paramsRouting parametersobject-—
separatorCustom separatorReactNode/—
stylesCustomize 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

PropertyDescriptionTypeDefaultVersion
classNameThe additional css classstring-—
dropdownPropsThe dropdown propsDropdown-—
hrefTarget of hyperlink. Can not work with pathstring-—
pathConnected path. Each path will connect with prev one. Can not work with hrefstring-—
menuThe menu propsMenuProps-4.24.0
onClickSet the handler to handle click event(e:MouseEvent) => void-—
titleitem nameReactNode-5.3.0

SeparatorType

PropertyDescriptionTypeDefaultVersion
typeMark as separatorseparator—5.3.0
separatorCustom separatorReactNode/5.3.0