@swim/animate provides property-managing animator types that efficiently
tween values between discrete state changes. @swim/animate is part of the
@swim/ui
framework.
For an npm-managed project, npm install @swim/animate to make it a dependency.
TypeScript sources will be installed into node_modules/@swim/animate/main.
Transpiled JavaScript and TypeScript definition files install into
node_modules/@swim/animate/lib/main. And a pre-built UMD script can
be found in node_modules/@swim/animate/dist/main/swim-animate.js.
Alternatively, the standalone swim-system.js script may be loaded
from the Swim CDN, which bundles @swim/animate together with all other
@swim/system
libraries.
When loaded by a web browser, the swim-ui.js script adds all
@swim/animate 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/animate 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.
@swim/animate
@swim/animate provides property-managing animator types that efficiently tween values between discrete state changes. @swim/animate is part of the @swim/ui framework.
Installation
npm
For an npm-managed project,
npm install @swim/animateto make it a dependency. TypeScript sources will be installed intonode_modules/@swim/animate/main. Transpiled JavaScript and TypeScript definition files install intonode_modules/@swim/animate/lib/main. And a pre-built UMD script can be found innode_modules/@swim/animate/dist/main/swim-animate.js.Browser
Browser applications can load
swim-ui.js—which bundles the @swim/animate library—along with itsswim-core.jsdependency, 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.jsscript may be loaded from the Swim CDN, which bundles @swim/animate together with all other @swim/system libraries.<script src="https://cdn.swim.ai/js/latest/swim-system.js"></script>Usage
ES6/TypeScript
@swim/animate can be imported as an ES6 module from TypeScript and other ES6-compatible environments.
import * as animate from "@swim/animate";CommonJS/Node.js
@swim/animate can also be used as a CommonJS module in Node.js applications.
var animate = require("@swim/animate");Browser
When loaded by a web browser, the
swim-ui.jsscript adds all @swim/animate library exports to the globalswimnamespace. Theswim-ui.jsscript requires thatswim-core.jshas already been loaded.The
swim-system.jsscript also adds all @swim/animate library exports to the globalswimnamespace, making it a drop-in replacement for 'swim-core.js' andswim-ui.jswhen additional @swim/system libraries are needed.