PageNav
The top bar of a page, with the sidebar toggle, breadcrumb and page actions.
Automations / Nightly dependency bump
<template> <PageNav :breadcrumb="[{ label: 'Automations', to: '/automations' }, { label: 'Nightly dependency bump' }]" /></template>Props
| Name | Type | Default |
|---|---|---|
| breadcrumb | BreadcrumbItem[] | - |
| toggle | boolean | true |
Slots
| Name | Description |
|---|---|
| actions | Right-aligned content (page actions, search/help controls). Renders nothing when unset. |
Guidelines
Do
- Render this as the top of every page - it's the one nav bar every page in the product shares, not a per-page bespoke header.
- Pass a full path (
[{ label: 'Automations', to: '/automations' }, { label: 'Nightly dependency bump' }]) for a page reached by drilling into a hierarchy - the real pattern behind this package's ownBreadcrumbcomponent. - Pass a single-item array (
[{ label: 'Settings' }]) for a plain, single-level page with no real path to show - there's no separate "just a title" prop, a one-crumb breadcrumb is that case.
- Put the page's controls in
#actions- it renders nothing by default. Inapps/frontend, useAppPageNav, which fills it with the app's search/help controls. - Pass
:toggle="false"when the page isn't inside aUDashboardGroup- otherwise the sidebar toggle renders but does nothing when clicked.
Don't
- Don't reach for this over
PageHeaderwhen the page has no path to show at all and no action row -PageHeaderalready covers a plain title + description + primary action. - Don't add placeholder search/help buttons with no behavior - the app's working ones come from
AppPageNav.