Type aliases
FontSize
Font
Size: Length | "large" | "larger" | "medium" | "small" | "smaller" | "x-large" | "x-small" | "xx-large" | "xx-small"
FontStretch
FontStretch: "normal" | "ultra-condensed" | "extra-condensed" | "semi-condensed" | "condensed" | "expanded" | "semi-expanded" | "extra-expanded" | "ultra-expanded"
FontStyle
FontStyle: "normal" | "italic" | "oblique"
FontVariant
FontVariant: "normal" | "small-caps"
FontWeight
FontWeight: "normal" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | "bold" | "bolder" | "lighter"
GenericFamily
GenericFamily: "serif" | "sans-serif" | "cursive" | "fantasy" | "monospace" | "system-ui" | "emoji" | "math" | "fangsong"
@swim/font
@swim/font implements CSS font property types and parsers. @swim/font is part of the @swim/ui framework.
Installation
npm
For an npm-managed project,
npm install @swim/font
to make it a dependency. TypeScript sources will be installed intonode_modules/@swim/font/main
. Transpiled JavaScript and TypeScript definition files install intonode_modules/@swim/font/lib/main
. And a pre-built UMD script can be found innode_modules/@swim/font/dist/main/swim-font.js
.Browser
Browser applications can load
swim-ui.js
—which bundles the @swim/font library—along with itsswim-core.js
dependency, directly from the Swim CDN.<script src="https://cdn.swim.ai/js/latest/swim-core.js"></script> <script src="https://cdn.swim.ai/js/latest/swim-ui.js"></script>
Alternatively, the standalone
swim-system.js
script may be loaded from the Swim CDN, which bundles @swim/font together with all other @swim/system libraries.<script src="https://cdn.swim.ai/js/latest/swim-system.js"></script>
Usage
ES6/TypeScript
@swim/font can be imported as an ES6 module from TypeScript and other ES6-compatible environments.
import * as font from "@swim/font";
CommonJS/Node.js
@swim/font can also be used as a CommonJS module in Node.js applications.
var font = require("@swim/font");
Browser
When loaded by a web browser, the
swim-ui.js
script adds all @swim/font library exports to the globalswim
namespace. Theswim-ui.js
script requires thatswim-core.js
has already been loaded.The
swim-system.js
script also adds all @swim/font library exports to the globalswim
namespace, making it a drop-in replacement for 'swim-core.js' andswim-ui.js
when additional @swim/system libraries are needed.