#Javascript API

Webswing provides an NPM module for easier integration of Webswing to javascript/typescript projects. This allows easier integration of Webswing into the existing web project. The module provides typescript declarations.

Requirements: This module works with Webswing 22.2 and newer.

#Installation

npm install webswing-api

#Basic Usage

import { getWebswingApi } from 'webswing-api'

getWebswingApi("http://localhost:8080/webswing-demo").then((api) => {
    const instance = api.bootstrap(document.getElementById('#rootElement'))
    instance.start()
})

ThegetWebswingApi is an async functions that is responsible for loading the actuall Webswing JS client from the Webswing server identified by the connectionUrl parameter. When the JS client is loaded API object is returned, which can be used to bootstrap the Webswing view to a DOM element passed in the first argument.

#Usage with Customization and Options

import { getWebswingApi } from 'webswing-api'

const connectionUrl = "http://localhost:8080/webswing-demo"

getWebswingApi(connectionUrl, i18n).then((api) => {
    const instance = api.bootstrap(document.getElementById('#rootElement'), {
            //here define basic bootstrap options like:
            autoStart: false,
            args: 'customArgs sent to Swing app',
            onReady: () => { instance.start()},
            onStart: () => {// ...}
        },
        (injector) => {
            // here define more advanced customizations of Webswing JS client behavior like dialog contents: 
            injector.services.dialog.content.startingDialog.content = `<p>MyApp is being started</p>`
            injector.services.dialog.content.initializingDialog.content = `<p>MyApp is being initialized</p>`
        }
    )
}).catch((e) => {
    console.error(e)
    // ...
})

The getWebswingApi function allows to pass in custom translations logic and with the bootstrap function you can modify the bootstrap options and also define advanced customizations of the Webswing client behavior.

#Custom i18n

You can reuse the i18n framework from your project by passing custom translate logic as second parameter of getWebswingApi function. Otherwise will be loaded from server. The translation logic is expecting object with this interface:

interface ITranslations {
    translate: (key: string, vars?: any) => string;
    getLocale: () => string;
}

#Bootstrap Options

These options can be modified in the bootstrap function's second parameter.

Other javascript bootstrap options can be configured in Admin Console -> application web configuration -> Javascript Bootstrap Options. Some of the bootstrap options can be still overridden in custom index.html in bootstrap options.

#Webswing Instance API Reference

api.bootstrap will return an instance of webswing object with a set of functions. Check the reference below.