Search code examples
vue.jsvis.js

How do I update props on a manually mounted vue component?


Question: Is there any way to update the props of a manually mounted vue component/instance that is created like this? I'm passing in an object called item as the component's data prop.

let ComponentClass = Vue.extend(MyComponent);

let instance = new ComponentClass({
    propsData: { data: item }
});

// mount it
instance.$mount();

Why

I have a non vue 3rd party library that renders content on a timeline (vis.js). Because the rest of my app is written in vue I'm attempting to use vue components for the content on the timeline itself.

I've managed to render components on the timeline by creating and mounting them manually in vis.js's template function like so.

template: function(item, element, data) {

    // create a class from the component that was passed in with the item
    let ComponentClass = Vue.extend(item.component);

    // create a new vue instance from that component and pass the item in as a prop
    let instance = new ComponentClass({
        propsData: { data: item },
        parent: vm
    });

    // mount it
    instance.$mount();

    return instance.$el;
}

item.component is a vue component that accepts a data prop.

I am able to create and mount the vue component this way, however when item changes I need to update the data prop on the component.


Solution

  • If you define an object outside of Vue and then use it in the data for a Vue instance, it will be made reactive. In the example below, I use dataObj that way. Although I follow the convention of using a data function, it returns a pre-defined object (and would work exactly the same way if I'd used data: dataObj).

    After I mount the instance, I update dataObj.data, and you can see that the component updates to reflect the new value.

    const ComponentClass = Vue.extend({
      template: '<div>Hi {{data}}</div>'
    });
    
    const dataObj = {
      data: 'something'
    }
    
    let instance = new ComponentClass({
      data() {
        return dataObj;
      }
    });
    
    // mount it
    instance.$mount();
    document.getElementById('target').appendChild(instance.$el);
    
    setTimeout(() => {
      dataObj.data = 'another thing';
    }, 1500);
    <script src="https://unpkg.com/vue@latest/dist/vue.js"></script>
    <div id="target">
    </div>