primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-11-28 13:12:16 +03:00
Code Issues Projects Releases Wiki Activity
1440c5b691
css/modules/primer-breadcrumb/README.md
Jon Rohan a830f2c7ac Changing shields.io url to https
2017-11-15 10:08:26 -08:00

1.6 KiB
Raw Blame History

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