primer-breadcrumb

2.0.0 • Public • Published

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

Package Sidebar

Install

npm i primer-breadcrumb

Weekly Downloads

1,389

Version

2.0.0

License

MIT

Unpacked Size

6.61 kB

Total Files

8

Last publish

Collaborators

  • arelia
  • gracepark
  • jibrangarcia
  • andrialexandrou
  • jfuchs
  • githubbot
  • manuelpuyol
  • jonrohan
  • broccolini
  • primer-css
  • keithamus
  • colebemis
  • smockle
  • simurai
  • khiga8
  • dustin.greif
  • srt32