@swim/typeset implements canvas typesetting views, with animated text, layout, font, and style properties. @swim/typeset is part of the @swim/ui framework.
For an npm-managed project,
npm install @swim/typeset to make it a dependency.
TypeScript sources will be installed into
node_modules/@swim/typeset/lib/main. And a pre-built UMD script can
be found in
Browser applications can load
swim-ui.js—which bundles the @swim/typeset
library—along with its
swim-core.js dependency, directly 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>
Alternatively, the standalone
swim-system.js script may be loaded
from the swimOS CDN, which bundles @swim/typeset together with all other
<!-- 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>
@swim/typeset can be imported as an ES6 module from TypeScript and other ES6-compatible environments.
import * as typeset from "@swim/typeset";
@swim/typeset can also be used as a CommonJS module in Node.js applications.
var typeset = require("@swim/typeset");
When loaded by a web browser, the
swim-ui.js script adds all
@swim/typeset library exports to the global
swim namespace. The
swim-ui.js script requires that
swim-core.js has already been loaded.
swim-system.js script also adds all @swim/typeset library exports
to the global
swim namespace, making it a drop-in replacement for
swim-ui.js when additional @swim/system
libraries are needed.