Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add warning to custom-directives #2850

Merged
merged 2 commits into from
May 3, 2024
Merged

docs: add warning to custom-directives #2850

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b7c9b3
docs: add warning to custom-directives
xiaodong2008 May 2, 2024
fa6b5e7
Update src/guide/reusability/custom-directives.md
NataliaTepluhina May 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/guide/reusability/custom-directives.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,11 @@ app.directive('demo', (el, binding) => {

## Usage on Components {#usage-on-components}

:::warning Not recommended
Using custom directives on components is not recommended, unexpected behaviour may occur when a component has multiple root nodes.
:::


When used on components, custom directives will always apply to a component's root node, similar to [Fallthrough Attributes](/guide/components/attrs).

```vue-html
Expand All @@ -224,4 +229,4 @@ When used on components, custom directives will always apply to a component's ro
</div>
```

Note that components can potentially have more than one root node. When applied to a multi-root component, a directive will be ignored and a warning will be thrown. Unlike attributes, directives can't be passed to a different element with `v-bind="$attrs"`. In general, it is **not** recommended to use custom directives on components.
Note that components can potentially have more than one root node. When applied to a multi-root component, a directive will be ignored and a warning will be thrown. Unlike attributes, directives can't be passed to a different element with `v-bind="$attrs"`.