vue-live

A lightweight playground for live editing VueJs code in the browser

 

---

Usage

Install the dependency

``
npm install --save vue-live
`

The simplest way to render components is as a VueJs template:

`vue



`

Check out the demo for alternative syntaxes to write your showcases.

$3

The default version at @latest is for vue 3 and up.

To install the version for vue 2, use the following:

`
npm install --save vue-live@1
`

Events

$3

When the template compilation or the script evaluation fail, errors are returned in this box. Hooking on these errors will not prevent them from displaying on the preview panel but will allow you to provide more info to your users about how to fix what they see.

`vue

`

$3

When the template compilation and the script evaluation succeed, the @success event is emitted. If you provided extra info to your user about previous errors, you can use this event to clear the error message.

`vue

`

Props

$3

Type String

Specifies the initial code to be evaluated

`vue

`

$3

Type vue component

Layout to be used for displaying the

Example

`vue


`

layout.vue

`vue


`

$3

Type Object:

- key: registration name
- value: VueJs component object

Register some components to be used in the vue-live instance.

Example

`vue


`

$3

Type Object:

- key: registration name
- value: VueJs directive object

You can use this prop in the same fashion as components above.

$3

Type Object:

- key: query in the require/import statement
- value: value returned by an es5 reauire statement

To allow require statements on a code evaluated in the browser, we have to pre-package all dependencies. This allows bundlers to know in advance what external dependencies will be allowed in the code.

Example

`vue


`

$3

Type Boolean

JSX does not always play nice with vue templates. If you want to expose vue templates, leave this option off. If you plan on using render functions with JSX, you will have to turn this option on.

Example

`vue


`

$3

Type Number

Time between a change in the code and its effect in the preview.

> Note If a change happens before the prview has changed, the timer is reset.

$3

Type Object

Props passed directly to vue-prism-editor as a spread

$3

Type Object

Data object that wil be merged with the output data of the preview.

Example

``vue
`vue


``

$3

Type Boolean

Makes sure that every variable in the template actually exists when the user starts editing.

Throws an error in te preview field when the variable dont exist.

$3

Type Boolean default: true

Shows a red indicator when the parser errors with the code given.

How to contribute

`sh
npm ci
`

$3

`sh
npm run start
`

$3

`sh
npm run build
`

$3

`sh
npm run test:unit
npm run test:e2e
`

$3

`sh
npm run lint
``