@swim/deck

@swim/deck

@swim/deck implements card stack navigation views. @swim/deck is part of the @swim/ux framework.

Installation

npm

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

Browser

Browser applications can load swim-ux.js—which bundles the @swim/deck 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/deck 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/deck can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

import * as deck from "@swim/deck";

CommonJS/Node.js

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

var deck = require("@swim/deck");

Browser

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

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