Breadcrumbs

Breadcrumbs are a navigation system used to show a user's location in a site or app.

Installation

Package installation information
Installyarn add @atlaskit/breadcrumbs
SourceBitbucket.org, (opens new window)
npm@atlaskit/breadcrumbs, (opens new window)
Bundleunpkg.com, (opens new window)

Props

analyticsContext

Description

Additional information to be included in the context of analytics events.

Type{ [x: string]: any; }

children

Description

The items to be included inside the Breadcrumbs wrapper.

Typestring | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal

createAnalyticsEvent

Description

You should not be accessing this prop under any circumstances. It is provided by @atlaskit/analytics-next and integrated in the component

Type(payload: AnalyticsEventPayload) => UIAnalyticsEvent

defaultExpanded

Deprecated
Description

Controls whether the legacy collapsed breadcrumbs start expanded.

{@link https://hello.atlassian.net/browse/ENGHEALTH-58821 Internal documentation for deprecation (no external access)} Only used by the legacy breadcrumbs collapse behavior. The refreshed breadcrumbs collapse responsively and ignore this prop.

Typeboolean

ellipsisLabel

Description

Text to be used as an accessible label for the ellipsis button that reveals collapsed breadcrumb items in a popup.

Typestring

isExpanded

Deprecated
Description

Override collapsing of the nav when there are more than the maximum number of items.

{@link https://hello.atlassian.net/browse/ENGHEALTH-58821 Internal documentation for deprecation (no external access)} Only used by the legacy breadcrumbs collapse behavior. The refreshed breadcrumbs collapse responsively and ignore this prop.

Typeboolean

itemsAfterCollapse

Deprecated
Description

If max items is exceeded, the number of items to show after the ellipsis.

{@link https://hello.atlassian.net/browse/ENGHEALTH-58821 Internal documentation for deprecation (no external access)} Only used by the legacy breadcrumbs collapse behavior. The refreshed breadcrumbs automatically choose which items to collapse and ignore this prop.

Typenumber

itemsBeforeCollapse

Deprecated
Description

If max items is exceeded, the number of items to show before the ellipsis.

{@link https://hello.atlassian.net/browse/ENGHEALTH-58821 Internal documentation for deprecation (no external access)} Only used by the legacy breadcrumbs collapse behavior. The refreshed breadcrumbs automatically choose which items to collapse and ignore this prop.

Typenumber

label

Description

Text to be used as label of navigation region that wraps the breadcrumbs.

Typestring

maxItems

Deprecated
Description

Set the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first and last will be shown, with an ellipsis in between.

{@link https://hello.atlassian.net/browse/ENGHEALTH-58821 Internal documentation for deprecation (no external access)} Only used by the legacy breadcrumbs collapse behavior. The refreshed breadcrumbs collapse based on available space and ignore this prop.

Typenumber

onExpand

Deprecated
Description

A function to be called when you are in the collapsed view and click the ellipsis.

{@link https://hello.atlassian.net/browse/ENGHEALTH-58821 Internal documentation for deprecation (no external access)} Only used by the legacy breadcrumbs collapse behavior. The refreshed breadcrumbs manage collapse responsively and ignore this prop.

Type(event: MouseEvent<Element, globalThis.MouseEvent>, analyticsEvent: UIAnalyticsEvent) => void

ref

Description
No description.
Type((instance: any) => void) | RefObject<any>

size

Description

The size variant of the breadcrumbs. Use 'small' for a compact presentation with smaller text (font.body.small) and smaller icons.

Default'medium'
Type"medium" | "small"

testId

Description

A testId prop is provided for specified elements, which is a unique string that appears as a data attribute data-testid in the rendered code, serving as a hook for automated tests.

Typestring
Was this page helpful?
We use this feedback to improve our documentation.
© 2026 AtlassianTrademark, (opens new window)Privacy, (opens new window)License