@swim/ux v3.11.1
@swim/ux
@swim/ux implements a user interface framework 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.
Framework
The @swim/ux umbrella package depends on, and re-exports, the following component libraries:
- @swim/theme (npm, doc) – semantic looks and feels for mood-aware UX components.
- @swim/app (npm, doc) – application model for coordinating window-level components, such as popovers and drawers.
- @swim/controls (npm, doc) – buttons, switches, sliders, and other user interface controls.
- @swim/navigation (npm, doc) – menus, tree views, nav bars, tab bars, and other user interface navigation components.
@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 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/ux 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/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-toolkit.js
script also adds all @swim/ux component library
exports to the global swim
namespace, making it a drop-in replacement
for swim-ui.js
and swim-ux.js
when additional @swim/toolkit
frameworks are needed.
1 month ago
1 month ago
8 months ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago