primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-12-03 03:33:40 +03:00
Code Issues Projects Releases Wiki Activity
8396c64f44
css/modules/primer-breadcrumb
History
Shawn Allen 4264e821cb fix breadcrumb example links
2019-01-11 14:29:22 -08:00
..
lib update components to use em spacer variables: 2018-01-05 17:55:47 -05: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 update year in licenses and source headers to 2019 2019-01-04 10:38:46 -08:00
package.json Publish 2019-01-07 15:03:45 -08:00
README.md fix breadcrumb example links 2019-01-11 14:29:22 -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="https://github.com/business">Business</a></li>
    <li class="breadcrumb-item text-small"><a href="https://github.com/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