Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace @swim/font

@swim/font

package documentation chat

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

Browser

Browser applications can load swim-ui.js—which bundles the @swim/font 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 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/font 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/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 global swim namespace. The swim-ui.js script requires that swim-core.js has already been loaded.

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

Index

Type aliases

AnyFont

AnyFont: Font | FontInit | string

AnyFontSize

AnyFontSize: AnyLength | FontSize

AnyLineHeight

AnyLineHeight: AnyLength | LineHeight

FontFamily

FontFamily: string | GenericFamily

FontSize

FontSize: 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"

LineHeight

LineHeight: Length | "normal"

Object literals

Const FontFamily

FontFamily: object

format

fromValue

Const FontSize

FontSize: object

fromAny

fromValue

Const LineHeight

LineHeight: object

fromAny

fromValue