@gov.au/breadcrumbs

Breadcrumbs help users understand where they are in the service and how they got there.

Stats

StarsIssuesVersionUpdatedCreatedSize
@gov.au/breadcrumbs
728923.0.64 months ago5 years agoMinified + gzip package size for @gov.au/breadcrumbs in KB

Readme

@gov.au/breadcrumbs

Breadcrumbs help users understand where they are in the service and how they got there.

Contents


Install

yarn add @gov.au/breadcrumbs
npm install @gov.au/breadcrumbs

ā¬† back to top


Usage

ā¬† back to top


React

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.

ā¬† back to top


Dependency graph

breadcrumbs
ā”œā”€ core
ā””ā”€ link-list
   ā”œā”€ core
   ā””ā”€ body
      ā””ā”€ core

ā¬† back to top


Tests

The visual test: https://auds.service.gov.au/packages/breadcrumbs/tests/site/

ā¬† back to top


Release History

  • v3.0.6 - Update core package dependency to use the latest version
  • v3.0.5 - Remove --save-dev flag from readme instructions
  • v3.0.4 - Removed unused Fragment React import
  • v3.0.3 - Removed uikit references
  • v3.0.2 - Update dependencies
  • v3.0.1 - Removing web pack dev server, updating dependencies
  • v3.0.0 - Updated dependency version of link-list, build scripts for Windows
  • v2.1.1 - Replace node-sass with sass
  • v2.1.0 - Support react router
  • v2.0.3 - Update dependencies
  • v2.0.2 - Changing homepage link
  • v2.0.1 - Fix dependencies
  • v2.0.0 - Change to focus colour and border/muted color mix
  • v1.0.0 - Moved to AU namespace, added new color themes and spacing
  • v0.3.1 - Fixed interdependency with link-list
  • v0.3.0 - Fixed react pipeline, background repeat
  • v0.2.0 - Added react component
  • v0.1.0 - šŸ’„ Initial version

ā¬† back to top


License

Copyright (c) Commonwealth of Australia. Licensed under MIT.

ā¬† back to top

};

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.