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