Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
lib
.npmignore
LICENSE
README.md
index.scss
package-lock.json
package.json
stories.js

README.md

Primer Breadcrumb Navigation

npm version Build Status

Breadcrumb navigation for GitHub's pages with parents / grandparents.

This repository is a module of the full primer repository.

Documentation

Breadcrumbs are used to show taxonomical context on pages that are many levels deep in a site’s hierarchy. Breadcrumbs show and link to parent, grandparent, and sometimes great-grandparent pages. Breadcrumbs are most appropriate on pages that:

  • Are many levels deep on a site
  • Do not have a section-level navigation
  • May need the ability to quickly go back to the previous (parent) page

Usage

<nav aria-label="Breadcrumb">
  <ol>
    <li class="breadcrumb-item text-small"><a href="/business">Business</a></li>
    <li class="breadcrumb-item text-small"><a href="/business/customers">Customers</a></li>
    <li class="breadcrumb-item breadcrumb-item-selected text-small text-gray" aria-current="page">MailChimp</li>
  </ol>
</nav>

License

MIT © GitHub