You're browsing the documentation for v2.x and earlier. For v3.x, click here.
This page assumes you've already read the Components Basics. Read that first if you are new to components.
- Vue.js has an amazing feature called Slots that's modeled after the current Web Components spec draft. If a component is using slots then we can fill whatever content we want in those slots. This way the component can deal with all the logic and let the component's user provide the view part of it.
- Vue.js implements the content distribution API using the slot element. It has some similarities to the children API of React.js. So slots help us to distribute our content in other components.
- Vue.js Scoped Slots Published July 17, 2019 By Richard Bagshaw - Edit page on Github Written by Richard Bagshaw a php, javascript, vue and react freelancer who lives and works in Nottingham, UK. Follow me on Twitter.
In 2.6.0, we introduced a new unified syntax (the v-slot directive) for named and scoped slots. It replaces the slot and slot-scope attributes, which are now deprecated, but have not been removed and are still documented here. The rationale for introducing the new syntax is described in this RFC.
Vue implements a content distribution API inspired by the Web Components spec draft(opens new window), using the slotelement to serve as distribution outlets for content. This allows you to compose components like this.
Slot Content
Vue implements a content distribution API inspired by the Web Components spec draft, using the element to serve as distribution outlets for content.
This allows you to compose components like this:
Then in the template for , you might have:
When the component renders, will be replaced by 'Your Profile'. Slots can contain any template code, including HTML:
Or even other components:
If ‘s template did not contain a element, any content provided between its opening and closing tag would be discarded.
Compilation Scope
When you want to use data inside a slot, such as in:
That slot has access to the same instance properties (i.e. the same 'scope') as the rest of the template. The slot does not have access to ‘s scope. For example, trying to access url would not work:
As a rule, remember that:
Everything in the parent template is compiled in parent scope; everything in the child template is compiled in the child scope.
Fallback Content
There are cases when it's useful to specify fallback (i.e. default) content for a slot, to be rendered only when no content is provided. For example, in a component:
We might want the text 'Submit' to be rendered inside the most of the time. To make 'Submit' the fallback content, we can place it in between the tags:
Now when we use in a parent component, providing no content for the slot:
will render the fallback content, 'Submit':
But if we provide content:
Then the provided content will be rendered instead:
Named Slots
Updated in 2.6.0+. See here for the deprecated syntax using the slot attribute.
There are times when it's useful to have multiple slots. For example, in a component with the following template:
For these cases, the element has a special attribute, name, which can be used to define additional slots:
A outlet without name implicitly has the name 'default'.
To provide content to named slots, we can use the v-slot directive on a , providing the name of the slot as v-slot‘s argument:
Vue.js Slot Activator
Now everything inside the elements will be passed to the corresponding slots. Any content not wrapped in a using v-slot is assumed to be for the default slot.
However, you can still wrap default slot content in a if you wish to be explicit:
Either way, the rendered HTML will be:
Note that v-slot can only be added to a (with one exception), unlike the deprecated slot attribute.
Scoped Slots
Updated in 2.6.0+. See here for the deprecated syntax using the slot-scope attribute.
Sometimes, it's useful for slot content to have access to data only available in the child component. For example, imagine a component with the following template:
We might want to replace this fallback content to display the user's first name, instead of last, like this:
That won't work, however, because only the component has access to the user and the content we're providing is rendered in the parent.
To make user available to the slot content in the parent, we can bind user as an attribute to the element:
Attributes bound to a element are called slot props. Now, in the parent scope, we can use v-slot with a value to define a name for the slot props we've been provided:
In this example, we've chosen to name the object containing all our slot props slotProps, but you can use any name you like.
Abbreviated Syntax for Lone Default Slots
In cases like above, when only the default slot is provided content, the component's tags can be used as the slot's template. This allows us to use v-slot directly on the component:
This can be shortened even further. Just as non-specified content is assumed to be for the default slot, v-slot without an argument is assumed to refer to the default slot:
Note that the abbreviated syntax for default slot cannot be mixed with named slots, as it would lead to scope ambiguity:
Whenever there are multiple slots, use the full based syntax for all slots:
Destructuring Slot Props
Internally, scoped slots work by wrapping your slot content in a function passed a single argument:
That means the value of v-slot can actually accept any valid JavaScript expression that can appear in the argument position of a function definition. So in supported environments (single-file components or modern browsers), you can also use ES2015 destructuring to pull out specific slot props, like so:
This can make the template much cleaner, especially when the slot provides many props. It also opens other possibilities, such as renaming props, e.g. user to person:
You can even define fallbacks, to be used in case a slot prop is undefined:
Dynamic Slot Names
New in 2.6.0+
Dynamic directive arguments also work on v-slot, allowing the definition of dynamic slot names:
Named Slots Shorthand
New in 2.6.0+
Similar to v-on and v-bind, v-slot also has a shorthand, replacing everything before the argument (v-slot:) with the special symbol #. For example, v-slot:header can be rewritten as #header:
However, just as with other directives, the shorthand is only available when an argument is provided. That means the following syntax is invalid:
Instead, you must always specify the name of the slot if you wish to use the shorthand:
Slot In Vue Js
Other Examples
Slot props allow us to turn slots into reusable templates that can render different content based on input props. This is most useful when you are designing a reusable component that encapsulates data logic while allowing the consuming parent component to customize part of its layout.
For example, we are implementing a component that contains the layout and filtering logic for a list:
Instead of hard-coding the content for each todo, we can let the parent component take control by making every todo a slot, then binding todo as a slot prop:
Now when we use the component, we can optionally define an alternative for todo items, but with access to data from the child:
However, even this barely scratches the surface of what scoped slots are capable of. For real-life, powerful examples of scoped slot usage, we recommend browsing libraries such as Vue Virtual Scroller, Vue Promised, and Portal Vue.
Deprecated Syntax
The v-slot directive was introduced in Vue 2.6.0, offering an improved, alternative API to the still-supported slot and slot-scope attributes. The full rationale for introducing v-slot is described in this RFC. The slot and slot-scope attributes will continue to be supported in all future 2.x releases, but are officially deprecated and will eventually be removed in Vue 3.
Named Slots with the slot Attribute
Deprecated in 2.6.0+. See here for the new, recommended syntax.
To pass content to named slots from the parent, use the special slot attribute on (using the component described here as example):
Or, the slot attribute can also be used directly on a normal element:
There can still be one unnamed slot, which is the default slot that serves as a catch-all for any unmatched content. In both examples above, the rendered HTML would be:
Scoped Slots with the slot-scope Attribute
Deprecated in 2.6.0+. See here for the new, recommended syntax.
To receive props passed to a slot, the parent component can use with the slot-scope attribute (using the described here as example):
Here, slot-scope declares the received props object as the slotProps variable, and makes it available inside the scope. You can name slotProps anything you like similar to naming function arguments in JavaScript.
Here slot='default' can be omitted as it is implied:
The slot-scope attribute can also be used directly on a non- element (including components):
The value of slot-scope can accept any valid JavaScript expression that can appear in the argument position of a function definition. This means in supported environments (single-file components or modern browsers) you can also use ES2015 destructuring in the expression, like so:
Using the described here as an example, here's the equivalent usage using slot-scope:
Vue Jsx Slot Props
A component can be 100% responsible for generating its output, like in this case:
or it can also let the parent component inject any kind of content into it, using slots.
What is a slot? It's a space in your component output that is reserved, waiting to be filled.
You define a slot by putting in a component template:
When using this component, any content added between the opening and closing tag will be added inside the slot placeholder:
If you put any content side the tags, that serves as the default content in case nothing is passed in.
A complicated component layout might require a better way to organize content, with multiple slots as well.
This is why Vue offers us named slots.
Named slots
If ‘s template did not contain a element, any content provided between its opening and closing tag would be discarded.
Compilation Scope
When you want to use data inside a slot, such as in:
That slot has access to the same instance properties (i.e. the same 'scope') as the rest of the template. The slot does not have access to ‘s scope. For example, trying to access url would not work:
As a rule, remember that:
Everything in the parent template is compiled in parent scope; everything in the child template is compiled in the child scope.
Fallback Content
There are cases when it's useful to specify fallback (i.e. default) content for a slot, to be rendered only when no content is provided. For example, in a component:
We might want the text 'Submit' to be rendered inside the most of the time. To make 'Submit' the fallback content, we can place it in between the tags:
Now when we use in a parent component, providing no content for the slot:
will render the fallback content, 'Submit':
But if we provide content:
Then the provided content will be rendered instead:
Named Slots
Updated in 2.6.0+. See here for the deprecated syntax using the slot attribute.
There are times when it's useful to have multiple slots. For example, in a component with the following template:
For these cases, the element has a special attribute, name, which can be used to define additional slots:
A outlet without name implicitly has the name 'default'.
To provide content to named slots, we can use the v-slot directive on a , providing the name of the slot as v-slot‘s argument:
Vue.js Slot Activator
Now everything inside the elements will be passed to the corresponding slots. Any content not wrapped in a using v-slot is assumed to be for the default slot.
However, you can still wrap default slot content in a if you wish to be explicit:
Either way, the rendered HTML will be:
Note that v-slot can only be added to a (with one exception), unlike the deprecated slot attribute.
Scoped Slots
Updated in 2.6.0+. See here for the deprecated syntax using the slot-scope attribute.
Sometimes, it's useful for slot content to have access to data only available in the child component. For example, imagine a component with the following template:
We might want to replace this fallback content to display the user's first name, instead of last, like this:
That won't work, however, because only the component has access to the user and the content we're providing is rendered in the parent.
To make user available to the slot content in the parent, we can bind user as an attribute to the element:
Attributes bound to a element are called slot props. Now, in the parent scope, we can use v-slot with a value to define a name for the slot props we've been provided:
In this example, we've chosen to name the object containing all our slot props slotProps, but you can use any name you like.
Abbreviated Syntax for Lone Default Slots
In cases like above, when only the default slot is provided content, the component's tags can be used as the slot's template. This allows us to use v-slot directly on the component:
This can be shortened even further. Just as non-specified content is assumed to be for the default slot, v-slot without an argument is assumed to refer to the default slot:
Note that the abbreviated syntax for default slot cannot be mixed with named slots, as it would lead to scope ambiguity:
Whenever there are multiple slots, use the full based syntax for all slots:
Destructuring Slot Props
Internally, scoped slots work by wrapping your slot content in a function passed a single argument:
That means the value of v-slot can actually accept any valid JavaScript expression that can appear in the argument position of a function definition. So in supported environments (single-file components or modern browsers), you can also use ES2015 destructuring to pull out specific slot props, like so:
This can make the template much cleaner, especially when the slot provides many props. It also opens other possibilities, such as renaming props, e.g. user to person:
You can even define fallbacks, to be used in case a slot prop is undefined:
Dynamic Slot Names
New in 2.6.0+
Dynamic directive arguments also work on v-slot, allowing the definition of dynamic slot names:
Named Slots Shorthand
New in 2.6.0+
Similar to v-on and v-bind, v-slot also has a shorthand, replacing everything before the argument (v-slot:) with the special symbol #. For example, v-slot:header can be rewritten as #header:
However, just as with other directives, the shorthand is only available when an argument is provided. That means the following syntax is invalid:
Instead, you must always specify the name of the slot if you wish to use the shorthand:
Slot In Vue Js
Other Examples
Slot props allow us to turn slots into reusable templates that can render different content based on input props. This is most useful when you are designing a reusable component that encapsulates data logic while allowing the consuming parent component to customize part of its layout.
For example, we are implementing a component that contains the layout and filtering logic for a list:
Instead of hard-coding the content for each todo, we can let the parent component take control by making every todo a slot, then binding todo as a slot prop:
Now when we use the component, we can optionally define an alternative for todo items, but with access to data from the child:
However, even this barely scratches the surface of what scoped slots are capable of. For real-life, powerful examples of scoped slot usage, we recommend browsing libraries such as Vue Virtual Scroller, Vue Promised, and Portal Vue.
Deprecated Syntax
The v-slot directive was introduced in Vue 2.6.0, offering an improved, alternative API to the still-supported slot and slot-scope attributes. The full rationale for introducing v-slot is described in this RFC. The slot and slot-scope attributes will continue to be supported in all future 2.x releases, but are officially deprecated and will eventually be removed in Vue 3.
Named Slots with the slot Attribute
Deprecated in 2.6.0+. See here for the new, recommended syntax.
To pass content to named slots from the parent, use the special slot attribute on (using the component described here as example):
Or, the slot attribute can also be used directly on a normal element:
There can still be one unnamed slot, which is the default slot that serves as a catch-all for any unmatched content. In both examples above, the rendered HTML would be:
Scoped Slots with the slot-scope Attribute
Deprecated in 2.6.0+. See here for the new, recommended syntax.
To receive props passed to a slot, the parent component can use with the slot-scope attribute (using the described here as example):
Here, slot-scope declares the received props object as the slotProps variable, and makes it available inside the scope. You can name slotProps anything you like similar to naming function arguments in JavaScript.
Here slot='default' can be omitted as it is implied:
The slot-scope attribute can also be used directly on a non- element (including components):
The value of slot-scope can accept any valid JavaScript expression that can appear in the argument position of a function definition. This means in supported environments (single-file components or modern browsers) you can also use ES2015 destructuring in the expression, like so:
Using the described here as an example, here's the equivalent usage using slot-scope:
Vue Jsx Slot Props
A component can be 100% responsible for generating its output, like in this case:
or it can also let the parent component inject any kind of content into it, using slots.
What is a slot? It's a space in your component output that is reserved, waiting to be filled.
You define a slot by putting in a component template:
When using this component, any content added between the opening and closing tag will be added inside the slot placeholder:
If you put any content side the tags, that serves as the default content in case nothing is passed in.
A complicated component layout might require a better way to organize content, with multiple slots as well.
This is why Vue offers us named slots.
Named slots
With a named slot you can assign parts of a slot to a specific position in your component template layout, and you use a slot attribute to any tag, to assign content to that slot.
Anything outside any template tag is added to the main slot.
For convenience I use a page single file component in this example:
Here is how we can use it, providing the slots content, in a parent component:
There is a handy shorthand, #:
Note: Vue 2.6 deprecated the slot attribute in favor of v-slot, and requires it to be added to a template tag (while slot could be applied to any tag)
Scoped slots
In a slot, we can't access the data contained in the child component from the parent.
Vue recognizes this use case and provides us a way to do so:
In the parent we can access the dog name we passed using:
slotProps is just a variable we used to access the props we passed. You can also avoid setting a variable just to hold the props you pass to the child component, by destructuring the object on the fly:
More vue tutorials:
