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