# eleventy-navigation-bootstrap

> Filter for the @11ty/eleventy-navigation plugin to support the bootstrap dropdown navigation.

Latest version **0.1.2** (published 2020-02-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install eleventy-navigation-bootstrap
pnpm add eleventy-navigation-bootstrap
yarn add eleventy-navigation-bootstrap
bun add eleventy-navigation-bootstrap
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2020-02-01 |
| First published | 2020-01-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Philipp Müller |
| Maintainers | muellerphilipp |
| Keywords | eleventy, eleventy-navigation |

## Links

- npm: https://www.npmjs.com/package/eleventy-navigation-bootstrap
- Repository: https://gitlab.com/muellerphilipp/eleventy-navigation-bootstrap
- Homepage: https://gitlab.com/muellerphilipp/eleventy-navigation-bootstrap#readme
- Issues: https://gitlab.com/muellerphilipp/eleventy-navigation-bootstrap/issues
- npm.io page: https://npm.io/package/eleventy-navigation-bootstrap

## Dependencies (1)

- [@11ty/eleventy](https://npm.io/package/@11ty/eleventy.md) ^0.10.0

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 0.1.2 (latest) — 2020-02-01
- 0.1.1 — 2020-01-29
- 0.1.0 — 2020-01-29

## README

# eleventy-navigation-bootstrap

Filter for the @11ty/eleventy-navigation plugin to support the bootstrap dropdown navigation.

## Usage

Install via npm:

```bash
npm install --save-dev eleventy-navigation-bootstrap
```

Add this Nunjucks filter to your [.eleventy.js](https://www.11ty.dev/docs/config/) file:

```javascript
  const toBootstrapNav = require('eleventy-navigation-bootstrap')
  eleventyConfig.addNunjucksFilter('bootstrapNav', toBootstrapNav)
```


Pipe the [@11ty/eleventy-navigation](https://github.com/11ty/eleventy-navigation) output to this filter like so:

```nunjucks
{{ collections.all | eleventyNavigation | bootstrapNav | safe }}
```

## Options

You can pass additional options:

```nunjucks
{{ collections.all | eleventyNavigation | bootstrapNav({
    listClass: "nav nav-pills justify-content-center", listChildItemClass: "dropdown-menu shadow", activeKey: eleventyNavigation.key
  }) | safe }}
```

Available options are:

Option | Type | Effect
--- | --- | ---
`listElement` | string  | `HTML` tag of the navigation list
`listClass` | string  | Class for the navigation list
`listItemElement` | string  | `HTML` tag for one navigation entry
`listItemClass` | string  | Class for one navigation entry
`listItemLinkClass` | string  | Class for the link of a navigation entry
`listItemHasChildrenClass` | string | Class for a navigation entry that has child entries
`listItemHasChildrenLinkClass` | string | Class for the link of a navigation entry that has child entries
`listChildItemClass` | string | Class for a navigation entry that is child to another entry
`listChildItemLinkClass` | string | Class for the link of a navigation entry that is child to another entry
`activeKey` | string  | Current page (provide this if you want to highlight the currently displayed page)
`activeListItemClass` | string  | Class of the navigation entry that corresponds to the current page
`listDoorpageDivider` | string | Divider between the door page and the child entries of a parent page

---
_Source: https://npm.io/package/eleventy-navigation-bootstrap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._