Browserify transform for Vue.js components, with scoped CSS and component hot-reloading.
This transform allows you to write your components in this format:
// app.vue
<style>
.red {
color: #f00;
}
</style>
<template>
<h1 class="red">{{msg}}</h1>
</template>
<script>
module.exports = {
data: function () {
return {
msg: 'Hello world!'
}
}
}
</script>You can also mix preprocessor languages in the component file:
// app.vue
<style lang="stylus">
.red
color #f00
</style>
<template lang="jade">
h1(class="red") {{msg}}
</template>
<script lang="coffee">
module.exports =
data: ->
msg: 'Hello world!'
</script>And you can import using the src attribute (note you'll have to save the vue file to trigger a rebuild since the imported file is not tracked by Browserify as a dependency):
<style lang="stylus" src="style.styl"></style>Under the hood, the transform will:
- extract the styles, compile them and insert them with the
insert-cssmodule. - extract the template, compile it and add it to your exported options.
You can require() other stuff in the <script> as usual. Note that for CSS-preprocessor @imports, the path should be relative to your project root directory.
npm install vueify --save-dev
browserify -t vueify -e src/main.js -o build/build.jsAnd this is all you need to do in your main entry file:
// main.js
var Vue = require('vue')
var App = require('./app.vue')
new Vue({
el: 'body',
components: {
app: App
}
})In your HTML:
<body>
<app></app>
<script src="build.js"></script>
</body>If you are using vueify in Node:
var fs = require("fs")
var browserify = require('browserify')
var vueify = require('vueify')
browserify('./entry.js')
.transform(vueify)
.bundle()
.pipe(fs.createWriteStream("bundle.js"))Vueify automatically transforms the JavaScript in your *.vue components using Babel. Write ES2015 today!
The default Babel (6) options used for Vue.js components are:
{
presets: ['es2015'],
plugins: ['transform-runtime']
}If you wish to override this, you can add a vue.config.js and configure the option for babel:
// vue.config.js
module.exports = {
babel: {
// enable stage 0 transforms.
// make sure to install babel-presets-stage-0
presets: ['es2015', 'stage-0'],
plugins: ['transform-runtime']
}
}You need to install the corresponding node modules to enable the compilation. e.g. to get stylus compiled in your Vue components, do npm install stylus --save-dev.
These are the built-in preprocessors:
- stylus
- less
- scss (via
node-sass) - jade
- coffee-script
- myth
Starting in 5.0.0, all CSS output via vueify will be autoprefixed by default. See config section below on customizing the options.
Vueify uses PostCSS for scoped CSS rewrite and autoprefixing. You can also provide your own PostCSS plugins! See config section below for an example.
Create a vue.config.js file at where your build command is run (usually the root level of your project):
module.exports = {
// configure a built-in compiler
sass: {
includePaths: [...]
},
// provide your own postcss plugins
postcss: [...],
// configure autoprefixer
autoprefixer: {
browsers: ['last 2 versions']
},
// register custom compilers
customCompilers: {
// for tags with lang="ts"
ts: function (content, cb) {
// compile some TypeScript...
cb(null, result)
}
}
}Example using custom PostCSS plugin:
var cssnext = require('cssnext')
module.exports = {
postcss: [cssnext()],
// disable autoprefixer since cssnext comes with it
autoprefixer: false
}Alternatively, if you are using vueify in Node and don't want to create a vue.config.js file:
var fs = require("fs")
var browserify = require('browserify')
var vueify = require('vueify')
// apply custom config
vueify.compiler.applyConfig({
// ...same as in vue.config.js
})
browserify('./entry.js')
.transform(vueify)
.bundle()
.pipe(fs.createWriteStream("bundle.js"))Experimental
When a <style> tag has the scoped attribute, its CSS will apply to elements of the current component only. This is similar to the style encapsulation found in Shadow DOM, but doesn't require any polyfills. It is achieved by transforming the following:
<style scoped>
.example {
color: red;
}
</style>
<template>
<div class="example">hi</div>
</template>Into the following:
<style>
.example[_v-1] {
color: red;
}
</style>
<template>
<div class="example" _v-1>hi</div>
</template>-
You can include both scoped and non-scoped styles in the same component.
-
A child component's root node will be affected by both the parent's scoped CSS and the child's scoped CSS.
-
Partials are not affected by scoped styles.
Experimental
To enable hot component reloading, you need to install the browserify-hmr plugin:
npm install browserify-hmr --save-dev
watchify -p browserify-hmr index.js -o bundle.jsA full setup example with hot reloading is available at vuejs/vueify-example.
The compiler API (originally vue-component-compiler) is also exposed:
var compiler = require('vueify').compiler
// filePath should be an absolute path, and is optional if
// the fileContent doesn't contain src imports
compiler.compile(fileContent, filePath, function (err, result) {
// result is a common js module string
})And here's a SublimeText package for enabling language highlighting/support in these embbeded code blocks.
For an example setup using most of the features mentioned above, see vuejs/vueify-example.
If you use Webpack, there's also vue-loader that does the same thing.
- Upgraded to Babel 6. This is a breaking change because the babel configuration is now different.
- Added
postcssoption for providing custom PostCSS plugins.
- New: CSS output is now autoprefixed by default.
- Changed: New config file format
- Support ES2015 by default.
- Added support for scoped CSS and component hot reloading.
-
Built-in lang for ES2015 has been renamed from
es6toes. -
estransforms now uses loose mode and optional runtime by default. This means in addition to installingbabel, you should also installbabel-runtime. -
Templates and CSS are now non-minified by default. To enable minification, run the build with
NODE_ENV=production. -
Options for built-in pre-processors can now be configured in
vue.config.js. -
vue-component-compilerhas been merged intovueify. It is now exposed asrequire('vueify').compiler.