|
1 | | -# Vue.element plugin |
| 1 | +# Deprecated |
2 | 2 |
|
3 | | -Register a real Custom Element using Vue.js. |
4 | | - |
5 | | -## Requirements |
6 | | - |
7 | | -- Does not work with Vue 2.0 yet |
8 | | -- Only works with Vue ^0.11.0 |
9 | | -- The browser must support the Custom Element API (currently Chrome only), or you need to include the [Web Components polyfill](https://github.com/webcomponents/webcomponentsjs). |
10 | | - |
11 | | -## Installation |
12 | | - |
13 | | -Available through npm, Component, Duo or Bower. |
14 | | - |
15 | | -### Direct include |
16 | | - |
17 | | -If you are using Vue globally, just include `vue-element.js` and it will automatically install the `Vue.element` method. |
18 | | - |
19 | | -### CommonJS |
20 | | - |
21 | | -``` js |
22 | | -Vue.use(require('vue-element')) // installed |
23 | | -Vue.element('my-element', { /* ... */ }) |
24 | | -``` |
25 | | - |
26 | | -## Usage |
27 | | - |
28 | | -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: |
29 | | - |
30 | | -- Nested Vue custom elements are not supported - it is recommended to use Vue's own component system inside a custom element; The custom element interface is intended for inter-op with other libraries (e.g. Polymer). |
31 | | - |
32 | | -- 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. |
33 | | - |
34 | | -- Real custom elements **must** contain a hyphen in its tag name. For example, `my-element` is valid, but `myelement` is not. |
35 | | - |
36 | | -- You can expose attributes with Vue's `props` (0.12) or `paramAttributes` (0.11) option, but you can only pass in literal values (no dynamic bindings). See the example folder to see it in action. |
37 | | - |
38 | | -- By default the element does not use Shadow DOM. If you want to enable Shadow DOM encapsulation, pass in `shadow: true` in your component options. |
39 | | - |
40 | | -## License |
41 | | - |
42 | | -[MIT](http://opensource.org/licenses/MIT) |
| 3 | +See [karol-f/vue-element](https://github.com/karol-f/vue-element) instead. |
0 commit comments