The @swim/toolkit umbrella framework provides a set of frameworks for building pervasively real-time user interface applications. @swim/toolkit incorporates the @swim/ui real-time user interface toolkit, the @swim/ux real-time application framework, the @swim/vis real-time visualizations framework, and the @swim/maps real-time maps framework.
The Swim Toolkit umbrella framework builds on the Swim Core framework, and provides the following top-level libraries:
The Swim UI framework implements a user interface framework 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 consists of the following component libraries:
The Swim UX framework 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 consists of the following component libraries:
The Swim Visualizations framework implements seamlessly animated diagram widgets, including gauges, pie charts, and line, area, and bubble charts. Swim Visualizations consists of the following component libraries:
The Swim Maps framework implements real-time geospatial map overlays, with support for Mapbox, Google, and Esri maps. Swim Maps consists of the following component libraries:
For an npm-managed project,
npm install @swim/toolkit to make it a dependency.
TypeScript sources will be installed into
node_modules/@swim/toolkit/lib/main. And a pre-built UMD script, which
bundles all @swim/toolkit child frameworks, can be found in
Browser applications can load
swim-toolkit.js, along with its
dependency, from the SwimOS CDN. The
swim-toolkit.js bundle supersedes
need not be loaded when using
<!-- 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/toolkit can be imported as an ES6 module from TypeScript and other
ES6-compatible environments. All child framework libraries are re-exported
by the umbrella
import * as swim from "@swim/toolkit";
@swim/toolkit can also be used with CommonJS-compatible module systems.
All component libraries are re-exported by the umbrella
var swim = require("@swim/toolkit");
When loaded by a web browser, the
swim-toolkit.js script adds all child
framework exports to the global
swim namespace. The
requires that either
swim-system.js has already been loaded.
Generated using TypeDoc