# Primer Navigation
[](https://www.npmjs.org/package/primer-navigation)
[](https://travis-ci.org/primer/primer)
> Primer comes with several navigation components. Some were designed with singular purposes, while others were design to be more flexible and appear quite frequently.
This repository is a module of the full [primer][primer] repository.
## Install
This repository is distributed with [npm][npm]. After [installing npm][install-npm], you can install `primer-navigation` with this command.
```
$ npm install --save primer-navigation
```
## Usage
The source files included are written in [Sass][sass] (`scss`) You can simply point your sass `include-path` at your `node_modules` directory and import it like this.
```scss
@import "primer-navigation/index.scss";
```
You can also import specific portions of the module by importing those partials from the `/lib/` folder. _Make sure you import any requirements along with the modules._
## Build
For a compiled **css** version of this module, a npm script is included that will output a css version to `build/build.css` The built css file is also included in the npm package.
```
$ npm run build
```
## Documentation
Primer comes with several navigation components. Some were designed with singular purposes, while others were design to be more flexible and appear quite frequently.
{:toc}
## Menu
The menu is a vertical list of navigational links. **A menu's width and placement must be set by you.** If you like, just use our grid columns as a parent. Otherwise, apply a custom `width`.
```html title="Menu"
```
There are a few subcomponents and add-ons that work well with the menu, including avatars, counters, and Octicons.
```html title="Menu with octicons, avatars and counters"
```
You can also add optional headings to a menu. Feel free to use nearly any semantic element with the `.menu-heading` class, including inline elements, headings, and more.
```html title="Menu with heading"
```
## Underline nav
Use `.UnderlineNav` to style navigation with a minimal underlined selected state, typically used for navigation placed at the top of the page. This component comes with variations to accommodate icons, containers and other content.
```html title="UnderlineNav"
```
Use `.UnderlineNav-actions` to place another element, such as a button, to the opposite side of the navigation items.
```html title="UnderlineNav-actions"
```
Use `.UnderlineNav--right` to right align the navigation.
```html title="UnderlineNav--right"
```
`.UnderlineNav--right` also works with when used with `.UnderlineNav-actions`.
```html title="UnderlineNav--right with actions"
```
`.Counters` and `.octicons` can be used with navigation items. Use `.UnderlineNav-octicon` to add color and hover styles.
```html title="UnderlineNav with Counter"
```
Use `.UnderlineNav--full` in combination with container styles and `.UnderlineNav-container` to make navigation fill the width of the container.
```html title="UnderlineNav--full"
```
## Tabnav
When you need to toggle between different views, consider using a tabnav. It'll given you a left-aligned horizontal row of... tabs!
```html title="tabnav"
```
Use `.float-right` to align additional elements in the `.tabnav`:
```html title="tabnav with buttons"
```
## Filter list
A vertical list of filters. Grey text on white background. Selecting a filter from the list will fill its background with blue and make the text white.
```html title="filter-list"
```
## Sub navigation
`.subnav` is navigation that is typically used when on a dashboard type interface with another set of navigation above it. This helps distinguish navigation hierarchy.
```html title="subnav"
```
You can have `subnav-search` in the subnav bar.
```html title="subnav-search"