@swim/ux implements a user interface toolkit for advanced real-time applications. @swim/ux provides popovers, drawers, menus, toolbars, controls, and other interactive application views and controllers. @swim/ux is a part of the broader @swim/toolkit framework.
The @swim/ux umbrella package depends on, and re-exports, the following component libraries:
- @swim/button (npm, doc) – button-like user interface controls.
- @swim/token (npm, doc) – attribute, action, and user input token views.
- @swim/grid (npm, doc) – tables, trees, lists, and other tabular views.
- @swim/window (npm, doc) – popovers, drawers, and other view surfaces.
- @swim/deck (npm, doc) – card stack navigation views.
For an npm-managed project,
npm install @swim/ux to make it a dependency.
TypeScript sources will be installed into
node_modules/@swim/ux/lib/main. And a pre-built UMD script, which
bundles all @swim/ux component libraries, can be found in
Browser applications can load
swim-ux.js, along with its
swim-ui.js dependencies, 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>
swim-toolkit.js script may be loaded, along with its
swim-system.js dependency, from the SwimOS CDN. The
script bundles @swim/ux together with all other
<!-- 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>
@swim/ux can be imported as an ES6 module from TypeScript and other
ES6-compatible environments. All component libraries are re-exported by
import * as swim from "@swim/ux";
@swim/ux can also be used with CommonJS-compatible module systems.
All component libraries are re-exported by the umbrella
var swim = require("@swim/ux");
When loaded by a web browser, the
swim-ux.js script adds all component
library exports to the global
swim namespace. The
swim-ui.js have already been loaded.
swim-toolkit.js script also adds all @swim/ux component library
exports to the global
swim namespace, making it a drop-in replacement
swim-ux.js when additional @swim/toolkit
frameworks are needed.