Play and demonstrate your Vue components, inspired by react-storybook.
The only thing you need to install is vue-play-cli:
$ npm install -g vue-play-cli
Then, let's play with your Button component, create a play.js in the root directory of your project (anywhere else is ok):
// you don't need to install vue-play!
import {play} from 'vue-play'
// import the button you wanna play
import MyButton from './components/MyButton.vue'
play({
Button: {
'with text'(h) {
// in the component
// you can use this.$log and this.$clear to debug
return <MyButton on-click={() => this.$log('hi')}>Hello Play!</MyButton>
},
'with rounded border'(h) {
return <MyButton rounded={true}>I'm rouned!</MyButton>
},
'with example code': {
// if you want to let people know how to use the component
// you can pass some code example here
example: '<my-button>text</my-button>',
// or use a readme instead
// you can import xxx.md to use it here
// you can have both example field and readme field, it's up to you
readme: '<html code/>',
render(h) {
return <MyButton>text</MyButton>
}
},
'without jsx': '<button>i prefer template syntax</button>'
}
})
Run the play script with command vue-play, and see it in action! (code)
$ ~/my-button-component vue-play
> play at http://localhost:5000
Share the play spot with your team mates!
# bundled into ./play-dist
$ vue-play -p
# for example, deploy to gh-pages
$ gh-pages -d ./play-dist
How do I write play script so that my component can call a method or update a state? Well, you can simply:
// pass a component object
play({
Button: {
'with text': {
data() {
return {/* ... */}
},
methods: {
handleClick() {/* ... */}
},
render(h) {
return <MyButton on-click={this.handleClick}>text</MyButton>
}
}
}
})
In most cases you only need to update babel, postcss or loaders, so here's the API for that:
// play.config.js
module.exports = {
// all the cli options can be defined here and:
browsers: [], // autoprefixer browsers
babel: {}, // override babel options
postcss: [], // or function, override postcss options
loaders: [], // append to current loaders
}
Run vue-play -c will auto load this file, and -c /path/to/custom/file to change location.
Check out the default webpack config, in brief, you can play with:
babel: es2015 stage-2
postcss: postcss-nested postcsss-simple-vars
image and fonts: file-loader
Provide your own webpack.config.js and pass the path to it in --webpack-config option. In this way you will need to install loaders and plugins you used in your project, since the default config was totally overridden.
| package | version |
|---|---|
| vue-play |  |
| vue-play-cli |  |
# link vue-play in vue-play-cli
$ cd vue-play
$ npm link
$ cd packages/vue-play-cli
$ npm link vue-play
$ npm link
# build vue-play
$ npm run build
# run example play script
$ vue-play example.js
FAQs
Play with your vue components.
The npm package vue-play receives a total of 0 weekly downloads. As such, vue-play popularity was classified as not popular.
We found that vue-play demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.