Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
main
.gitignore
.npmignore
README.md
package.json
rollup.config.js
tsconfig.json

README.md

@swim/render

package documentation chat

@swim/render provides renderable graphic types for SVG/Canvas-compatible path drawing contexts, and Canvas-compatible rendering contexts. @swim/render is part of the @swim/ui framework.

Installation

npm

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

Browser

Browser applications can load swim-ui.js—which bundles the @swim/render 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 standalone swim-system.js script may be loaded from the swimOS CDN, which bundles @swim/render together with all other @swim/system libraries.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>

Usage

ES6/TypeScript

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

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

CommonJS/Node.js

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

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

Browser

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