primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-12-20 12:42:07 +03:00
Code Issues Projects Releases Wiki Activity
6e725f0778
css/modules/primer-breadcrumb
History
Shawn Allen aab31b5dea Merge branch 'dev' into stories-from-markdown
2017-09-15 14:59:05 -07:00
..
lib Updating 4px spacer values to use the sass variables 2017-07-17 13:13:24 -07:00
.npmignore rename packages directory to modules 2017-06-29 12:49:16 -07:00
index.scss Moving primer-breadcrumbs to core 2017-09-06 12:13:00 -07:00
LICENSE update copyright year to 2017 2017-08-31 09:52:28 -07:00
package.json Merge branch 'dev' into primer-breadcrumbs-core 2017-09-14 12:41:47 -07:00
README.md Merge branch 'dev' into stories-from-markdown 2017-09-15 14:59:05 -07:00
stories.js whitespace 2017-09-13 00:53:01 -07:00

README.md

Primer CSS Breadcrumb Navigation

npm version Build Status

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

This repository is a module of the full primer-css 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