Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
main
.gitignore
.npmignore
README.md
package.json
rollup.config.js
tsconfig.json

README.md

@swim/ux

package documentation chat

@swim/ux implements seamlessly animated user interface widgets, including gauges, pie charts, line, area, and bubble charts, and geospatial map overlays. These fully encapsulated widgets can be embedded into any web application framework, or directly into any web page. @swim/ux is a part of the broader @swim/system framework.

Framework

The @swim/ux umbrella package depends on, and re-exports, the following component libraries:

  • @swim/gauge (npm, doc) – multi-dial, fully animatable, canvas rendered gauge widget.
  • @swim/pie (npm, doc) – multi-slice, fully animatable, canvas rendered pie chart widget.
  • @swim/chart (npm, doc) – multi-plot, fully animatable, canvas rendered chart widget, suppporting line, area, and bubble graphs, with customizeable axes, and kinematic multitouch scale gestures for panning and zooming with momentum.
  • @swim/map (npm, doc) – canvas views for efficiently rendering geospatially located map overlays, including fully animatable views for lines, circles, and polygons.
  • @swim/mapbox (npm, doc) – support for overlaying @swim/map views on Mapbox maps.

@swim/ux builds on the @swim/core and @swim/ui frameworks; it has no additional required dependencies.

Installation

npm

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

Browser

Browser applications can load swim-ux.js, along with its swim-core.js and 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>

Alternatively, the standalone swim-system.js script may be loaded from the swimOS CDN, which bundles @swim/ux together with all other @swim/system frameworks.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>

Usage

ES6/TypeScript

@swim/ux can be imported as an ES6 module from TypeScript and other ES6-compatible environments. All component libraries are re-exported by the umbrella @swim/ux module.

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

CommonJS

@swim/ux can also be used with CommonJS-compatible module systems. All component libraries are re-exported by the umbrella @swim/ux module.

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

Browser

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

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

You can’t perform that action at this time.