Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/peternaydenov/visual-controller-for-svelte3

visual controller for svelte3
https://github.com/peternaydenov/visual-controller-for-svelte3

Last synced: 23 days ago
JSON representation

visual controller for svelte3

Awesome Lists containing this project

README 

        
# 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.*



![version](https://img.shields.io/github/package-json/v/peterNaydenov/visual-controller-for-svelte3)

![license](https://img.shields.io/github/license/peterNaydenov/visual-controller-for-svelte3)



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:

```js

// 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:

```js

// 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 



```js



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:



```js

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

```



## Visual Controller Methods

```js

  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.

```js

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*. Update methods library if defined. Else will return a empty object;



Example:

```js

 let html = new VisualController ();

 html.publish ( Hi, { greeting: 'hi'}, 'app' )

```



Render component 'Hi' with prop 'greeting' and render it in html element with id "app".



### VisualController.getApp ()

Returns the library of functions provided from method `setupUpdates`. If svelte-app never called `setupUpdates`, result will be an empty object.



```js

 let controls = html.getApp ( containerID )

```

- **containerID**: *string*. Id of the container.



Example:

```js

let 

      id = 'videoControls'

    , controls = html.getApp ( id )

    ;

    // if app with 'id' doesn't exist -> returns false, 

    // if app exists and 'setupUpdates' was not used -> returns {}

    // in our case -> returns { changeMessage:f }

if ( !controls )   console.error ( `App for id:"${id}" is not available` )

else {

        if ( controls.changeMessage )   controls.changeMessage ('new title') 

   }

```

If visual controller(html) has a svelte app associated with this name will return it. Otherwise will return **false**.



### VisualController.destroy ()

Will destroy svelte app associated with this container name and container will become empty. Function will return 'true' on success and 'false' on failure. 

Function will not delete content of provided container if there is no svelte app associated with it.



```js

html.destroy ( containerID )

```

- **containerID**: *string*. Id name.



### Extra



Visual Controller has versions for few other front-end frameworks:

- [React](https://github.com/PeterNaydenov/visual-controller-for-react) 

- [Vue 3](https://github.com/PeterNaydenov/visual-controller-for-vue3)

- [Vue 2](https://github.com/PeterNaydenov/visual-controller-for-vue)



## Links



- [History of changes](https://github.com/PeterNaydenov/visual-controller-for-svelte3/blob/master/Changelog.md)

- [License](https://github.com/PeterNaydenov/visual-controller-for-svelte3/blob/master/LICENSE)



## Credits

'visual-controller-for-svelte3' is created and supported by Peter Naydenov



## License



'visual-controller-for-svelte3' is released under the [MIT license](https://github.com/PeterNaydenov/visual-controller-for-svelte3/blob/master/LICENSE)