@swim/ui implements a user interface toolkit for pervasively real-time applications. A unified view hierarchy, with builtin procedural styling and animation, makes it easy for @swim/ui components to uniformly style, animate, and render mixed HTML, SVG, Canvas, and WebGL components. @swim/ui is a part of the @swim/toolkit framework.
The @swim/ui umbrella package depends on, and re-exports, the following component libraries:
@swim/ui builds on the @swim/core framework; it has no additional dependencies.
For an npm-managed project,
npm install @swim/ui to make it a dependency.
TypeScript sources will be installed into
node_modules/@swim/ui/lib/main. And a pre-built UMD script, which
bundles all @swim/ui component libraries, can be found in
Browser applications can load
swim-ui.js, along with its
dependency, 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> <!-- 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>
swim-toolkit.js script may be loaded, along with its
swim-system.js dependency, from the SwimOS CDN. The
script bundles @swim/ui 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/ui 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/ui";
@swim/ui can also be used with CommonJS-compatible module systems.
All component libraries are re-exported by the umbrella
var swim = require("@swim/ui");
When loaded by a web browser, the
swim-ui.js script adds all component
library exports to the global
swim namespace. The
swim-core.js has already been loaded.
swim-toolkit.js script also adds all @swim/ui component library
exports to the global
swim namespace, making it a drop-in replacement
swim-ui.js when additional @swim/toolkit frameworks are needed.
Generated using TypeDoc