Options
All
  • Public
  • Public/Protected
  • All
Menu

Library @swim/theme

@swim/theme

package documentation chat

@swim/theme implements semantic looks and feels for mood-aware UX components. A mood-aware UX component is a UI view that morphs its appearance to reflect the status of the outer application. @swim/theme is part of the @swim/ui framework.

Installation

npm

For an npm-managed project, npm install @swim/theme to make it a dependency. TypeScript sources will be installed into node_modules/@swim/theme/main. Transpiled JavaScript and TypeScript definition files install into node_modules/@swim/theme/lib/main. And a pre-built UMD script can be found in node_modules/@swim/theme/dist/main/swim-theme.js.

Browser

Browser applications can load swim-ui.js—which bundles the @swim/theme 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/theme 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/theme can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

import * as theme from "@swim/theme";

CommonJS/Node.js

@swim/theme can also be used as a CommonJS module in Node.js applications.

var theme = require("@swim/theme");

Browser

When loaded by a web browser, the swim-ui.js script adds all @swim/theme 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/theme library exports to the global swim namespace, making it a drop-in replacement for swim-ui.js and swim-theme.js when additional @swim/toolkit frameworks are needed.

Index

Type aliases

AnyFeelVector

AnyFeelVector: FeelVector | FeelVectorArray

AnyLookVector

AnyLookVector<T>: LookVector<T> | LookVectorArray<T>

Type parameters

  • T

AnyMoodVector

AnyMoodVector<M>: MoodVector<M> | MoodVectorArray<M>

Type parameters

FeelVectorArray

FeelVectorArray: ReadonlyArray<[Look<unknown>, unknown]>

FeelVectorUpdates

FeelVectorUpdates: ReadonlyArray<[Look<unknown>, unknown | undefined]>

LookVectorArray

LookVectorArray<T>: ReadonlyArray<[Feel, T]>

Type parameters

  • T

LookVectorUpdates

LookVectorUpdates<T>: ReadonlyArray<[Feel, T | undefined]>

Type parameters

  • T

MoodVectorArray

MoodVectorArray<M>: ReadonlyArray<[M, number]>

Type parameters

MoodVectorUpdates

MoodVectorUpdates<M>: ReadonlyArray<[M, number | undefined]>

Type parameters

Variables

Mood

Mood: { alert: MoodVector<Feel>; ambient: MoodVector<Feel>; contrasted: MoodVector<Feel>; covered: MoodVector<Feel>; darker: MoodVector<Feel>; default: MoodVector<Feel>; disabled: MoodVector<Feel>; embossed: MoodVector<Feel>; floating: MoodVector<Feel>; hovering: MoodVector<Feel>; inactive: MoodVector<Feel>; lighter: MoodVector<Feel>; navigating: MoodVector<Feel>; nested: MoodVector<Feel>; primary: MoodVector<Feel>; raised: MoodVector<Feel>; secondary: MoodVector<Feel>; selected: MoodVector<Feel>; translucent: MoodVector<Feel>; transparent: MoodVector<Feel>; warning: MoodVector<Feel> }

Type declaration

Const Theme

Theme: { dark: ThemeMatrix; light: ThemeMatrix }

Type declaration

Generated using TypeDoc