Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


package documentation chat

@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/main. Transpiled JavaScript and TypeScript definition files install into node_modules/@swim/typeset/lib/main. And a pre-built UMD script can be found in node_modules/@swim/typeset/dist/main/swim-typeset.js.


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=""></script>
<script src=""></script>

<!-- Production -->
<script src=""></script>
<script src=""></script>

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

<!-- Development -->
<script src=""></script>

<!-- Production -->
<script src=""></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.

The swim-system.js script also adds all @swim/typeset library exports to the global swim namespace, making it a drop-in replacement for 'swim-core.js' and swim-ui.js when additional @swim/system libraries are needed.

You can’t perform that action at this time.