You can check Vue-element demos at https://karol-f.github.io/vue-element/
npm install vue-element --saveimport vueElement from 'vue-element'
Vue.use(vueElement);If you are using Vue globally, just include vue-element.js and it will automatically install the Vue.element method.
<script src="path/to/vue-element.js"></script>####Optional polyfill For cross-browser compatibility (IE9+) use Custom Elements polyfill.
<script src="https://cdnjs.cloudflare.com/ajax/libs/document-register-element/1.3.0/document-register-element.js"></script>or
import 'document-register-element/build/document-register-element';
Vue-element is a tiny wrapper around Vue components. It provide seamless way to use it in HTML, plain JavaScript, Vue, React, Angular etc., using power of Custom Elements.
- Works with Vue 0.12.x, 1.x and 2.x
- Small - 2.5 kb min+gzip, optional polyfill - 5,1 kb min+gzip
It might be confusing for users to understand difference between Vue components, Custom Elements and it's use cases.
Why you might need Vue-element? Simply, for your Vue components user's convinience. All they would need to do is include your JavaScript file and then they can:
- include HTML tag (e.g.
<my-component><my-component />) in any time of document lifecycle. You can use your elements in e.g. SPA application just by including HTML tag - no Vue initialization or JavaScript usage is needed. Custom Elements will auto initialize when mounted into document. You can include them in e.g. Vue, Angular or React projects and browser will take care of detecting it and initialization - use simple API that allows for interacting with underlaying Vue instance by changing attributes, props or passing callback functions
- take advantage of features like lazy-loading, that allows for loading components on demand, only when user add them to document
- Simplicity - only
tag-nameand Vue componentobjectis needed forVue.element()usage - Compatibility - using optional polyfill we can support wide range of browsers, including IE9+, Android and IOS
- Full featured - you can use nesting, HMR, slots, lazy-loading, native Custom Elements callbacks.
- reactive props and HTML attributes
- automatic props casting (numbers, booleans) so they won't be available as strings but proper data types
- passing callback functions to props via JavaScript
- 'default' and 'named' slots are available, check demo for example
- Hot Module Replacement for seamless developer experience (Vue 2.x+)
- lazy-loading - you can download component after it's attached to document. Useful for e.g. UI library authors. Check demo for example
- detecting if detached callback is not invoked due to opening vue-element in modal - element is then detached and attached to DOM again. It would be undesirable to destroy it immediately
- Custom Elements v1 - compatible with latest specification. Vue-element will use native implementation if supported
Check demos site to see it in action.
For additional examples and detailed description check the demos page.
<widget-vue prop1="1" prop2="string" prop3="true"></widget-vue>Vue.element('widget-vue', {
props: [
'prop1',
'prop2',
'prop3'
],
data: {
message: 'Hello Vue!'
},
template: '<p>{{ message }}, {{ prop1 }}, {{prop2}}, {{prop3}}</p>'
});document.querySelector('widget-vue')[0].prop2 // get prop value
document.querySelector('widget-vue')[0].prop2 = 'another string' // set prop valueYou can also change <widget-vue> HTML attributes and changes will be instantly reflected.
 Firefox |
 Chrome |
 Safari |
 Opera |
 Android |
|---|---|---|---|---|
| behind --flag | 54+ | Technology Preview | 42+ | 55+ |
 IE / Edge |
Firefox |
Chrome |
Safari |
Opera |
 iOS |
Android |
|---|---|---|---|---|---|---|
| IE9+, Edge | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Additional, optional, third parameter to Vue.element() is options object. You can pass following methods.
'This' in callbacks points to Custom Element's DOM Node.
{
// 'constructorCallback' can be triggered multiple times when e.g. vue-router is used
constructorCallback() {
console.info('constructorCallback', this);
},
// element is mounted/inserted into document
connectedCallback() {
console.info('connectedCallback', this);
},
// element is removed from document
disconnectedCallback() {
console.warn('disconnectedCallback', this);
},
// one of element's attributes (Vue instance props) is changed
attributeChangedCallback(name, oldValue, value) {
console.info('attributeChangedCallback', name, oldValue, value);
},
// only needed when using lazy-loading - when 'props' are not accessible on Custom Element registration
props: [],
// you can set shadow root for element. Only works if native implementation is available.
shadow: false
}Callbacks are executed before lifecycle hooks from Vue component passed to Vue-element. It's better idea just to use Vue component lifecycle hooks (e.g. created, mounted, beforeDestroy).
Inside HTML tag of defined custom element, Vue-element will create:
- Proxy component for seamless Hot Module Replacement, using render function for performance (Vue 2.x+)
- Vue component passed to Vue-element
Custom Element HTML tag will expose API to interact with underlying Vue component - you can change HTML attributes or props, using JavaScript.
For advanced access, when exposed API is not enough, defined custom element will expose Vue instance via __vue_element__ prop.
console.info(document.querySelector('widget-vue').__vue_element__)- custom elements must contain a hyphen in its tag name. For example,
my-elementis valid, butmyelementis not - in dev mode Vue will display console warning about element not being registered. It's desirable behaviour as we want to use browser's Custom Elements registration
npm install
npm run dev
npm run build
This command will compile vue-element.js and docs files (handled by .gitignore) to dist folder. You have to manually copy it to docs folder.
Please take a note that npm run build will use config.build.assetsPublicPath, which is set to Github Pages path in config/index.js.