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

Commit 5de8054

Browse files
committed
readme
1 parent 9d629ed commit 5de8054

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,12 @@ Vue.element('my-element', { /* ... */ })
2626

2727
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:
2828

29+
- 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).
30+
2931
- 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.
3032

31-
- You can expose attributes with Vue's `props` (0.12) or `paramAttributes` (0.11) option. See the example folder to see it in action.
33+
- Real custom elements **must** contain a hyphen in its tag name. For example, `my-element` is valid, but `myelement` is not.
34+
35+
- 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.
3236

3337
- 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.

0 commit comments

Comments
 (0)