# @swim/navigation

> menus, tree views, nav bars, tab bars, and other user interface navigation components

Latest version **3.11.0-dev.20200517** (published 2020-05-17) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @swim/navigation
pnpm add @swim/navigation
yarn add @swim/navigation
bun add @swim/navigation
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.11.0-dev.20200517 |
| Published | 2020-05-17 |
| First published | 2020-05-17 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 23 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Chris Sachs |
| Maintainers | swim-iot, c9r, ctrinh, scottswim |

## Links

- npm: https://www.npmjs.com/package/@swim/navigation
- Repository: https://github.com/swimos/swim
- Issues: https://github.com/swimos/swim/issues
- npm.io page: https://npm.io/package/@swim/navigation

## Dependencies (23)

- [@swim/app](https://npm.io/package/@swim/app.md) 3.11.0-dev.20200517
- [@swim/uri](https://npm.io/package/@swim/uri.md) 3.11.0-dev.20200517
- [@swim/font](https://npm.io/package/@swim/font.md) 3.11.0-dev.20200517
- [@swim/math](https://npm.io/package/@swim/math.md) 3.11.0-dev.20200517
- [@swim/time](https://npm.io/package/@swim/time.md) 3.11.0-dev.20200517
- [@swim/util](https://npm.io/package/@swim/util.md) 3.11.0-dev.20200517
- [@swim/view](https://npm.io/package/@swim/view.md) 3.11.0-dev.20200517
- [@swim/angle](https://npm.io/package/@swim/angle.md) 3.11.0-dev.20200517
- [@swim/codec](https://npm.io/package/@swim/codec.md) 3.11.0-dev.20200517
- [@swim/color](https://npm.io/package/@swim/color.md) 3.11.0-dev.20200517
- [@swim/scale](https://npm.io/package/@swim/scale.md) 3.11.0-dev.20200517
- [@swim/style](https://npm.io/package/@swim/style.md) 3.11.0-dev.20200517
- [@swim/theme](https://npm.io/package/@swim/theme.md) 3.11.0-dev.20200517
- [@swim/length](https://npm.io/package/@swim/length.md) 3.11.0-dev.20200517
- [@swim/render](https://npm.io/package/@swim/render.md) 3.11.0-dev.20200517
- [@swim/shadow](https://npm.io/package/@swim/shadow.md) 3.11.0-dev.20200517
- [@swim/animate](https://npm.io/package/@swim/animate.md) 3.11.0-dev.20200517
- [@swim/gesture](https://npm.io/package/@swim/gesture.md) 3.11.0-dev.20200517
- [@swim/structure](https://npm.io/package/@swim/structure.md) 3.11.0-dev.20200517
- [@swim/transform](https://npm.io/package/@swim/transform.md) 3.11.0-dev.20200517
- [@swim/constraint](https://npm.io/package/@swim/constraint.md) 3.11.0-dev.20200517
- [@swim/transition](https://npm.io/package/@swim/transition.md) 3.11.0-dev.20200517
- [@swim/interpolate](https://npm.io/package/@swim/interpolate.md) 3.11.0-dev.20200517

## Recent versions

- 3.11.0-dev.20200517 (latest) — 2020-05-17
- 3.11.0-dev.20200619 (dev) — 2020-06-19

## README

# @swim/navigation

[![package](https://img.shields.io/npm/v/@swim/navigation.svg)](https://www.npmjs.com/package/@swim/navigation)
[![documentation](https://img.shields.io/badge/doc-TypeDoc-blue.svg)](https://docs.swimos.org/js/latest/modules/_swim_navigations.html)
[![chat](https://img.shields.io/badge/chat-Gitter-green.svg)](https://gitter.im/swimos/community)

<a href="https://www.swimos.org"><img src="https://docs.swimos.org/readme/marlin-blue.svg" align="left"></a>

**@swim/navigation** implements menus, tree views, nav bars, tab bars, and
other user interface navigation components.  **@swim/navigation** is part of
the [**@swim/ux**](https://github.com/swimos/swim/tree/master/swim-toolkit-js/swim-ux-js/@swim/ux) framework.

## Installation

### npm

For an npm-managed project, `npm install @swim/navigation` to make it a dependency.
TypeScript sources will be installed into `node_modules/@swim/navigation/main`.
Transpiled JavaScript and TypeScript definition files install into
`node_modules/@swim/navigation/lib/main`.  And a pre-built UMD script can
be found in `node_modules/@swim/navigation/dist/main/swim-navigation.js`.

### Browser

Browser applications can load `swim-ux.js`—which bundles the **@swim/navigation**
library—along with its `swim-core.js` and `swim-ui.js` dependencies, directly
from the SwimOS CDN.

```html
<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-core.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ux.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-core.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ux.min.js"></script>
```

Alternatively, the `swim-toolkit.js` script may be loaded, along with its
`swim-system.js` dependency, from the SwimOS CDN.  The `swim-toolkit.js`
script bundles **@swim/navigation** together with all other
[**@swim/toolkit**](https://github.com/swimos/swim/tree/master/swim-toolkit-js/@swim/toolkit)
frameworks.

```html
<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-toolkit.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-toolkit.min.js"></script>
```

## Usage

### ES6/TypeScript

**@swim/navigation** can be imported as an ES6 module from TypeScript and other
ES6-compatible environments.

```typescript
import * as navigation from "@swim/navigation";
```

### CommonJS/Node.js

**@swim/navigation** can also be used as a CommonJS module in Node.js applications.

```javascript
var navigation = require("@swim/navigation");
```

### Browser

When loaded by a web browser, the `swim-navigation.js` script adds all
**@swim/navigation** library exports to the global `swim` namespace.
The `swim-navigation.js` script requires that `swim-core.js` and `swim-ui.js`
have already been loaded.

The `swim-toolkit.js` script also adds all **@swim/navigation** library
exports to the global `swim` namespace, making it a drop-in replacement for
`swim-ui.js` and `swim-navigation.js` when additional **@swim/toolkit** frameworks
are needed.

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