@swim/website provides minimalist components that implement common dynamic website behaviors. @swim/website is part of the @swim/web framework.
For an npm-managed project,
npm install @swim/website to make it a dependency.
TypeScript sources will be installed into
node_modules/@swim/website/lib/main. And a pre-built UMD script can
be found in
Browser applications can load
swim-web.js—which bundles the @swim/website
library—along with its
swim-ui.js dependencies, 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> <script src="https://cdn.swimos.org/js/latest/swim-web.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> <script src="https://cdn.swimos.org/js/latest/swim-web.min.js"></script>
Alternatively, the standalone
swim-system.js script may be loaded
from the SwimOS CDN, which bundles @swim/website together with all other
<!-- 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>
@swim/website can be imported as an ES6 module from TypeScript and other ES6-compatible environments.
import * as website from "@swim/website";
@swim/website can also be used as a CommonJS module in Node.js applications.
var website = require("@swim/website");
When loaded by a web browser, the
swim-web.js script adds all
@swim/website library exports to the global
swim-web.js script requires that
have already been loaded.
swim-system.js script also adds all @swim/website library exports
to the global
swim namespace, making it a drop-in replacement for
swim-web.js when additional
@swim/system libraries are needed.