Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vue-styleguidist/vue-live
A component to demo components, inspired by react-live
https://github.com/vue-styleguidist/vue-live
demo documentation live preview react-live vuejs
Last synced: 6 days ago
JSON representation
A component to demo components, inspired by react-live
- Host: GitHub
- URL: https://github.com/vue-styleguidist/vue-live
- Owner: vue-styleguidist
- Created: 2019-04-27T23:53:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T08:12:08.000Z (about 1 month ago)
- Last Synced: 2025-01-10T20:03:04.904Z (13 days ago)
- Topics: demo, documentation, live, preview, react-live, vuejs
- Language: TypeScript
- Homepage: http://vue-live.surge.sh/
- Size: 3.44 MB
- Stars: 259
- Watchers: 4
- Forks: 24
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vue-live
A lightweight playground for live editing VueJs code in the browser
[](https://app.travis-ci.com/github/vue-styleguidist/vue-live)
[](https://www.npmjs.com/package/vue-live) [](https://www.npmjs.com/package/vue-live)
[](https://github.com/semantic-release/semantic-release)
---
## Usage
Install the dependency
```
npm install --save vue-live
```
The simplest way to render components is as a VueJs template:
```vue
handleError(e)"
/>
import { VueLive } from "vue-live";
// import the css separately for easier SSR
import "vue-live/lib/vue-live.esm.css";
import DatePicker from "vuejs-datepicker";
export default {
components: { VueLive },
data() {
return {
// make DatePicker available in template
DatePicker,
};
},
};
```
Check out the [demo](http://vue-live.surge.sh) for alternative syntaxes to write your showcases.
### Install for Vue 2.X
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
### `@error`
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
log('Error on first example', e)"
/>
```
### `@success`
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
### `code`
**Type** String
Specifies the initial code to be evaluated
```vue
```
### `layout`
**Type** vue component
Layout to be used for displaying the
Example
```vue
import layout from "./Layout.vue";
export default {
data() {
return { layout };
},
};
```
`layout.vue`
```vue
.my-vuelive {
border: 1px solid #ccc;
border-radius: 10px;
}
.my-vuelive-editor {
margin: 8px;
}
.my-vuelive-preview {
margin: 8px;
}
```
### `components`
**Type** Object:
- key: registration name
- value: VueJs component object
Register some components to be used in the vue-live instance.
Example
```vue
import DatePicker from "./DatePicker.vue";
export default {
data() {
return {
registeredComponents: {
DatePicker,
},
};
},
};
```
### `directives`
**Type** Object:
- key: registration name
- value: VueJs directive object
You can use this prop in the same fashion as `components` above.
### `requires`
**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
import DatePicker from "./DatePicker.vue";
export default {
data() {
return {
// lodash can be pre-packaged by the bundler
// so it can be required at runtime
preRequiredObjects: {
lodash: require("lodash"),
},
code: `
import _ from 'lodash'
const val = _.each({1,2,3}, (i, v) => {
return \`\${i} value \${v}\`
})
<li v-for="v in val">
v : {{v}}
</li>
`,
};
},
};
```
### `jsx`
**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
export default {
data() {
return {
code: `
const args = {
type: "button",
value: "update me"
};
export default {
render() {
return <input {...args} />;
}
};
`,
};
},
};
```
### `delay`
**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.
### `editorProps`
**Type** Object
Props passed directly to [vue-prism-editor](https://github.com/koca/vue-prism-editor) as a spread
### `dataScope`
**Type** Object
Data object that wil be merged with the output data of the preview.
Example
````vue
```vue
import DatePicker from "./DatePicker.vue";
export default {
data() {
return {
registeredComponents: {
DatePicker,
},
// Without this variable declaration,
// today will not have a value when entering the
// particularly useful when examples or only a template
dataScope: {
today: new Date(),
},
};
},
};
````
### `checkVariableAvailability`
**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.
### `squiggles`
**Type** Boolean default: `true`
Shows a red indicator when the parser errors with the code given.
## How to contribute
```sh
npm ci
```
### Compiles and hot-reloads for development
```sh
npm run start
```
### Compiles and minifies library for production using rollup
```sh
npm run build
```
### Run unit and e2e tests
```sh
npm run test:unit
npm run test:e2e
```
### Lints and fixes files
```sh
npm run lint
```