ether/craft-vue

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

A helper module for building Craft CMS plugins with Vue components

dev-master 2018-10-04 22:22 UTC

This package is auto-updated.

Last update: 2021-12-05 12:42:21 UTC


README

A helper module for building Craft CMS plugins with Vue components.

This supports all major browsers except IE11.

Installation

composer require ether/craft-vue

Usage

First, register the module wherever you are rendering your Vue components:

class Field extends \craft\base\Field
{

    public function getInputHtml ()
    {
        \ether\craftvue\CraftVue::register();
        
        // ...
    }

}

Then in your JS register your component (this should be a JS file imported by an asset bundle):

Craft.booting(Vue => {
    Vue.component('my-component', require('../vue/MyComponent.vue'));
});

You can import your component however you want, but if you use .vue files be sure to compile them beforehand. Craft.booting supports returned Promises, and await / async syntax.

It's now possible to use <my-component></my-component> anywhere in the #main div.

Note: If you're developing, remember to set 'useCompressedJs' => false to use Vue in development mode.

Future Features

  • CLI for creating boilerplate for compatible Vue components with hot-reloading and other fun stuff (something like ./craft vue/create [name], perhaps using Laravel Mix).