@swim/webapp
    TypeScript icon, indicating that this package has built-in type declarations

    3.10.2 • Public • Published

    @swim/webapp

    package documentation chat

    @swim/webapp implements a lightweight web application loader that dynamically instantiates views and controllers declared by swim- HTML attributes. @swim/webapp is part of the @swim/web framework.

    Installation

    npm

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

    Browser

    Browser applications can load swim-web.js—which bundles the @swim/webapp library—along with its swim-core.js and 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/webapp 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/webapp can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

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

    CommonJS/Node.js

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

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

    Browser

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

    Keywords

    none

    Install

    npm i @swim/webapp

    DownloadsWeekly Downloads

    8

    Version

    3.10.2

    License

    Apache-2.0

    Unpacked Size

    77.7 kB

    Total Files

    26

    Last publish

    Collaborators

    • avatar