Piral Vue ·

This is a plugin that only has a peer dependency to vue. What piral-vue brings to the table is a set of Pilet API extensions that can be used with piral or piral-core.

The set includes a Vue@2 converter for any component registration, as well as a fromVue shortcut and a VueExtension component.

By default, these API extensions are not integrated in piral, so you'd need to add them to your Piral instance.

Documentation

The following functions are brought to the Pilet API.

fromVue()

Transforms a standard Vue@2 component into a component that can be used in Piral, essentially wrapping it with a reference to the corresponding converter.

VueExtension

The extension slot component to be used in Vue@2 components. This is not really needed, as it is made available automatically via a Vue@2 custom element named extension-component.

Usage

::: summary: For pilet authors

You can use the fromVue function from the Pilet API to convert your Vue@2 components to components usable by your Piral instance.

Example use:

import { PiletApi } from '<name-of-piral-instance>';
import VuePage from './Page.vue';

export function setup(piral: PiletApi) {
  piral.registerPage('/sample', piral.fromVue(VuePage));
}

Within Vue@2 components the Piral Vue@2 extension component can be used by referring to extension-component, e.g.,

<extension-component name="name-of-extension"></extension-component>

Alternatively, if piral-vue has not been added to the Piral instance you can install and use the package also from a pilet directly.

import { PiletApi } from '<name-of-piral-instance>';
import { fromVue } from 'piral-vue/convert';
import VuePage from './Page.vue';

export function setup(piral: PiletApi) {
  piral.registerPage('/sample', fromVue(VuePage));
}

:::

::: summary: For Piral instance developers

Using Vue with Piral is as simple as installing piral-vue and vue.

import { createVueApi } from 'piral-vue';

The integration looks like:

const instance = createInstance({
  // important part
  plugins: [createVueApi()],
  // ...
});

The vue package should be shared with the pilets via the package.json:

{
  "pilets": {
    "externals": [
      "vue"
    ]
  }
}

:::

License

Piral is released using the MIT license. For more information see the license file.