primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-12-19 20:21:38 +03:00
Code Issues Projects Releases Wiki Activity
a09c6573bb
css/modules/primer-breadcrumb
History
Jon Rohan 9af6e71e43 Updating breadcrumb item to use negative em
2017-12-18 15:34:40 -08:00
..
lib Updating breadcrumb item to use negative em 2017-12-18 15:34:40 -08:00
.npmignore rename packages directory to modules 2017-06-29 12:49:16 -07:00
index.scss Moving primer-breadcrumbs to core 2017-10-24 20:55:17 -07:00
LICENSE Revert "Merge branch 'dev' into master" 2017-09-20 21:21:19 -07:00
package.json Publish 2017-12-18 11:41:05 -08:00
README.md Changing shields.io url to https 2017-11-15 10:08:26 -08:00
stories.js Revert "Merge branch 'dev' into master" 2017-09-20 21:21:19 -07:00

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