Visual Controller for Svelte (@peter.naydenov/visual-controller-for-svelte3)

NOTE: After version 2.0.2 the library works with Svelte 4. Product is not changed, just the dependency. If you need version 3 of Svelte, use version 2.0.1 of this library.

Tool for building a micro-frontends(MFE) based on Svelte components - Start multiple Svelte applications in the same HTML page and control them.

Install visual controller:

npm i @peter.naydenov/visual-controller-for-svelte

Initialization process:

// for es6 module projects:
import notice from '@peter.naydenov/notice' // event emitter by your personal choice.
import VisualController from '@peter.naydenov/visual-controller-for-svelte3'

// for commonjs projects:
const notice = require('@peter.naydenov/notice')
const VisualController = require('@peter.naydenov/visual-controller-for-svelte3')



let 
      eBus = notice ()
    , dependencies = { eBus }  // Provide everything that should be exposed to components 
    , html = new VisualController ( dependencies ) 
    ;
// Ready for use...

Let's show something on the screen:

// Let's have svelte component 'Hello' with prop 'greeting'

html.publish ( Hello, {greeting:'Hi'}, 'app' )
//arguments are: ( component, props, containerID )

Inside of the Components

Note: If your component should be displayed only, that section can be skipped.

All provided libraries during visualController initialization are available if you export variable with name dependencies. Export also setupUpdates if you need to manipulate component

let msg = 'Vite + Svelte'
export let dependencies, setupUpdates;
const { eBus } = dependencies

setupUpdates ({   // Provides to visualContoller method 'changeMessage' 
          changeMessage (update) {
                  msg = update
              }
    })

The external call will look like this:

html.getApp ( 'app' ).changeMessage ( 'New message content' )

Visual Controller Methods

  publish : 'Render svelte app in container. Associate app instance with the container.'
, getApp  : 'Returns app instance by container name'
, destroy : 'Destroy app by using container name '
, has     : 'Checks if app with specific "id" was published'

VisualController.publish ()

Publish a svelte app.

html.publish ( component, props, containerID )

• component: object. Svelte component
• props: object. Svelte components props
• containerID: string. Id of the container where svelte-app will live.
• returns: Promise