@peter.naydenov/visual-controller-for-vue3

Visual Controller for Vue 3

Install visual controller:

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

Initialization process:

import { createApp } from 'vue'
import mitt from 'mitt'
import VisualController from '@peter.naydenov/visual-controller-for-vue3'

let 
      eBus = mitt ()
    , html = new VisualController ({eBus,createApp})
    ;
// Ready for use...

Let's show something on the screen:

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

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

Visual Controller Methods

  publish : 'Render vue app in container. Associate app instance with the container.'
, getApp  : 'Returns app instance by container name'
, destroy : 'Destroy app by using container name '

VisualController.publish ()

Publish vue app.

html.publish ( component, props, containerID )

• component: object. Vue component
• props: object. Vue components props
• containerID: string. Id of the container where vue-app will live.

Example:

 import mitt from 'mitt
 import { createApp } from 'vue'

 let 
      eBus = mitt ()
    , html = new VisualController ({eBus, createApp})
    ;

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

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

VisualController.getApp ()

Returns vue-app associated with a container. Provides access to the methods of parent vue-app component.

 let controls = html.getApp ( containerID )

• containerID: string. Id of the container.

Example:

let 
      id = 'videoControls'
    , controls = html.getApp ( id )
    ;
if ( controls )   controls.pushPlay () // use methods of the component
else { // component is not available
       console.error ( `App for id:"${id}" is not available` )
   }

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

VisualController.destroy ()

Will destroy vue 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 vue app associated with it.

html.destroy ( containerID )

• containerID: string. Id name.

Other details and requirements

• Every component receive at least one props: [ 'eBus' ]. Use eBus to provide screen-events back to the software.
• Support for Autonomous Custom Elements ( after v.1.1.0 ). Add a prop named isCustomElement. Should be a function.

let isCustomElement = tag => tag === 'plastic-button';   // Will ignore tags 'plastic-button' during vue- render process. 

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

//custom elements for AWS Amplify service will look like
let amplfiyCustom = tag => tag.startsWith ( 'amplify-' )
html.publish ( Hi, {greeting:'hi', isCustomElement: amplifyCustom}, 'app' )

Release History

1.1.0 ( 2021-04-25)

• [x] Support for Autonomous Custom Elements

1.0.2 (2021-03-15)

• [x] Fix: Only one load per component;