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>
export default {
data () {
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:
<style lang="stylus" src="style.styl"></style>
Under the hood, the transform will:
insert-css module.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. Starting in 7.0.0, @import in LESS, SASS and Stylus files can be either relative to your build tool root working directory, or to the file being edited.
npm install vueify --save-dev
browserify -t vueify -e src/main.js -o build/build.js
If you are using npm 3+, it no longer auto install the peer dependencies. So you will also have to do:
npm install\
vueify-insert-css vue-hot-reload-api\
babel-core babel-preset-es2015\
babel-plugin-transform-runtime babel-runtime@5\
--save-dev
And 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 .babelrc file at the root of your project:
{
"presets": ["es2015", "stage-2"],
"plugins": ["transform-runtime"]
}
You can also configure babel with the babel field in vue.config.js, which will take the highest priority.
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:
node-sass)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']
},
// configure html minification in production mode
// see https://github.com/kangax/html-minifier#options-quick-reference
htmlMinifier: {
// ...
},
// register custom compilers
customCompilers: {
// for tags with lang="ts"
ts: function (content, cb, compiler, filePath) {
// content: content extracted from lang="ts" blocks
// cb: the callback to call when you're done compiling
// compiler: the vueify compiler instance
// filePath: the path for the file being compiled
//
// compile some TypeScript... and when you're done:
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.js
A 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
compiler.compile(fileContent, filePath, function (err, result) {
// result is a common js module string
})
Currently there are syntax highlighting support for Sublime Text, Atom, Vim, Visual Studio Code and Brackets. Contributions for other editors/IDEs are highly appreciated! If you are not using any pre-processors in Vue components, you can also get by by treating *.vue files as HTML in your editor.
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.
htmlMinifier option in config that allows configuration of HTML minification in production mode.type attribute for <input type="text">..babelrc over default options.babel-core is now a peer dependency.Added relative @import path support and import dependency tracking for LESS, SASS & Stylus. Now you can @import files using relative paths to the file being edited, and editing these imported files will also trigger watchify rebuild.
Removed built-in compiler for myth. Prefer using PostCSS + CSSNext.
postcss option for providing custom PostCSS plugins.Built-in lang for ES2015 has been renamed from es6 to es.
es transforms now uses loose mode and optional runtime by default. This means in addition to installing babel, you should also install babel-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-compiler has been merged into vueify. It is now exposed as require('vueify').compiler.
FAQs
Vue component transform for Browserify
The npm package vueify receives a total of 0 weekly downloads. As such, vueify popularity was classified as not popular.
We found that vueify 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
CISOs are racing to adopt AI for cybersecurity, but hurdles in budgets and governance may leave some falling behind in the fight against cyber threats.
Research
Security News
Socket researchers uncovered a backdoored typosquat of BoltDB in the Go ecosystem, exploiting Go Module Proxy caching to persist undetected for years.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.