Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @swim/transform

@swim/transform

package documentation chat

@swim/transform implements CSS and SVG compatible transform types with unit-aware algebraic operators and parsers. @swim/transform is part of the @swim/ui framework.

Installation

npm

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

Browser

Browser applications can load swim-ui.js—which bundles the @swim/transform library—along with its swim-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/transform together with all other @swim/system libraries.

<script src="https://cdn.swim.ai/js/latest/swim-system.js"></script>

Usage

ES6/TypeScript

@swim/transform can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

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

CommonJS/Node.js

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

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

Browser

When loaded by a web browser, the swim-ui.js script adds all @swim/transform 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/transform 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.

Index

Type aliases

AnyTransform

AnyTransform: Transform | string