@swim/navigation
@swim/navigation implements menus, tree views, nav bars, tab bars, and other user interface navigation components. @swim/navigation is part of the @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.
<!-- 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
frameworks.
<!-- 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.
import * as navigation from "@swim/navigation";CommonJS/Node.js
@swim/navigation can also be used as a CommonJS module in Node.js applications.
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.