@gov.au/breadcrumbs
Advanced tools
Breadcrumbs help users understand where they are in the service and how they got there.
Breadcrumbs help users understand where they are in the service and how they got there.
yarn add @gov.au/breadcrumbs
npm install @gov.au/breadcrumbs --save-dev
Usage:
import AUbreadcrumbs from './breadcrumbs.js';
<AUbreadcrumbs label="Breadcrumb for this page" items={[
{
link: 'breadcrumb/one/',
text: 'breadcrumb 1',
},
{
link: 'breadcrumb/two/',
text: 'breadcrumb 2',
li: {
className: 'li-wrapping-class',
},
},
{
text: 'breadcrumb 3',
},
]} />
All props:
<AUbreadcrumbs
label="The aria-label" {/* Provide the aria label is a must */}
dark={ false } {/* A dark variation of the component */}
linkComponent="a" {/* The component used for the link, optional */}
items={[ {/* An array of all breadcrumbs */}
{
link: 'breadcrumb/one/', {/* The link of the breadcrumb, optional */}
text: 'breadcrumb 1', {/* The text of the breadcrumb */}
li: {}, {/* An object that will be spread onto the <li> tag, optional */}
},
]},
/>
(💡 additional props are spread onto the component)
For more details have a look at the usage example.
breadcrumbs
├─ core
└─ link-list
├─ core
└─ body
└─ core
The visual test: https://uikit.service.gov.au/packages/breadcrumbs/tests/site/
Copyright (c) Commonwealth of Australia. Licensed under MIT.
FAQs
Breadcrumbs help users understand where they are in the service and how they got there.
The npm package @gov.au/breadcrumbs receives a total of 12 weekly downloads. As such, @gov.au/breadcrumbs popularity was classified as not popular.
We found that @gov.au/breadcrumbs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.