Skip to content
This repository was archived by the owner on Jan 18, 2022. It is now read-only.

vuejs/vue-element

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vue.element plugin

Register a real Custom Element using Vue.js.

Requirements

  • Only works with Vue ^0.11.0
  • The browser must support the Custom Element API (currently Chrome only), or you need to include Polymer's platform.js polyfill.

Installation

Available through npm, Component, Duo or Bower.

Direct include

If you are using Vue globally, just include vue-element.js and it will automatically install the Vue.element method.

CommonJS

Vue.use(require('vue-element')) // installed
Vue.element('my-element', { /* ... */ })

Usage

Usage is the same as Vue.component() - you pass in exactly the same options as if you are defining a Vue component. A few things to note:

  • You don't need to manually instantiate a root level Vue instance. Custom Elements get auto-promoted when document.registerElement is called. You can also freely define the element before or after the markup.

  • You can expose attributes with Vue's paramAttributes option. See the example folder to see it in action.

  • This plugin uses only the Custom Elements API - it does not provide Shadow DOM encapsulation.

About

register a custom element with Vue.js.

Resources

License

Stars

Watchers

Forks

Packages

No packages published