···

Api

Directives

Data Binding Directives

These directives can bind themselves to a property on the ViewModel, or to an expression which is evaluated in the context of the ViewModel. When the value of the underlying property or expression changes, the update() function of these directives will be called asynchronously on next tick.

v-text

Updates the element’s textContent.

Internally, {{ Mustache }} interpolations are also compiled as a v-text direcitve on a textNode.

v-html

Updates the element’s innerHTML.

Using v-html with user-supplied data can be dangerous. It is suggested that you only use v-html when you are absolutely sure about the security of the data source, or pipe it through a custom filter that sanitizes untrusted HTML.

v-show

Set the element’s display to none or its original value, depending on the truthy-ness of the binding’s value.

v-class

If no argument is provided, it will add the binding’s value to the element’s classList, and update the class as the value changes.

If a directive argument is provided, the argument will be the class to be toggled depending on the binding value’s truthy-ness. Combined with multiple clauses this can be pretty useful:

1
2
3
4
5
<span v-class="
    red    : hasError,
    bold   : isImportant,
    hidden : isHidden
"></span>

v-attr

Updates the element’s given attribute (indicated by the argument).

Example:

1
<canvas v-attr="width:w, height:h"></canvas>

Internally, {{ Mustache }} interpolations inside attributes are compiled into computed v-attr directives.

You should use v-attr instead of mustache binding when setting the src attribute on <img> elements. Your templates are parsed by the browser before being compiled by Vue.js, so the mustache binding will cause a 404 when the browser tries to fetch it as the image’s URL.

v-style

Apply inline CSS styles to the element.

When there is no argument, Vue.js will use the value to set el.style.cssText.

When there is an argument, it will be used as the CSS property to apply. Combined with multiple clauses you can set multiple properties together:

Example:

1
2
3
4
5
<div v-style="
    top: top + 'px',
    left: left + 'px',
    background-color: 'rgb(0,0,' + bg + ')'
"></div>

When the argument is prefixed with $, Vue.js will automatically apply prefixed version of the CSS rule too, so you don’t have to manually write all the prefixes inline. In the following example Vue.js will apply transform, webkitTransform, mozTransform and msTransform:

1
<div v-style="$transform: 'scale(' + scale + ')'"></div>

It is recommended to use v-style instead of mustache bindings inside style attribute because Internet Explorer, regardless of version, will remove invalid inline styles when parsing the HTML.

v-on

Attaches an event listener to the element. The event type is denoted by the argument. It is also the only directive that can be used with the key filter. For more details see Listening for Events.

v-model

Create a two-way binding on a form or editable element. Data is synced on every input event by default. When the ViewModel has the lazy option set to true, data will be synced only on change events. For more details see Handling Forms.

v-if

Conditionally insert / remove the element based on the truthy-ness of the binding value. A child ViewModel will be created on the bound element. It is instantiated when the value is truthy, and destroyed when the value becomes falsy. If the binding starts with a falsy value, the ViewModel will not be instantiated until the value actually becomes truthy.

v-repeat

Create a child ViewModel for every item in the binding Array. These child ViewModels will be automatically created / destroyed when mutating methods, e.g. push(), are called on the Array.

When no argument is provided, the child ViewModel will directly use the assigned element in the Array as its $data. If the value is not an object, a wrapper data object will be created and the value will be set on that object using the alias key $value.

Example:

1
2
3
4
5
<ul>
    <li v-repeat="users">
        {&#123;name&#125;} {&#123;email&#125;}
    </li>
</ul>

If an argument is provided, a wrapper data object will always be created, using the argument string as the alias key. This allows for more explicit property access in templates:

1
2
3
4
5
<ul>
    <li v-repeat="user : users">
        {&#123;user.name&#125;} {&#123;user.email&#125;}
    </li>
</ul>

For detailed examples, see Displaying a List.

v-view

Conditionally instantiate ViewModels, using the bound value as the Component ID to look up constructors with. When the bound value changes, existing ViewModel will be destroyed and a new ViewModel will be created. When a ViewModel is created, the original element will be replaced, but all attributes will be copied to the new element. For more details, see Routing.

v-with

Allows a child ViewModel to inherit data from the parents. You can either pass in an Object which will be used as the data option, or bind individual parent properties to the child with different keys. This directive must be used in combination with another directive that creates a child ViewModel, e.g. v-component or v-view.

Example inheriting an object:

1
2
3
4
5
6
7
// parent data looks like this
{
    user: {
        name: 'Foo Bar',
        email: 'foo@bar.com'
    }
}
1
2
3
4
<div v-with="user">
    <!-- you can access properties without `user.` -->
    {&#123;name&#125;} {&#123;email&#125;}
</div>

Example inheriting individual properties (using the same data):

1
<div v-with="myName : user.name, myEmail: user.email">
    <!-- you can access properties with the new keys -->
    {&#123;myName&#125;} {&#123;myEmail&#125;}
</div>

Literal Directives

Literal directives treat their attribute value as a plain string; they do not attempt to bind themselves to anything. All they do is executing the bind() function with the string value once. Literal directives accept mustache expressions inside their value, but these expressions will be evaluated only once on first compile and do not react to data changes.

v-component

Compile this element as a child ViewModel with a registered component constructor. This can be used with v-with to inehrit data from the parent. For more details see Composing ViewModels.

v-ref

Only respected when used in combination with directives that create child components: v-component, v-view, v-if or v-repeat. The ViewModel will be accessible in its parent’s $ object, e.g. parent.$[id]. When used with v-repeat, the value will be an Array containing the child ViewModel instances corresponding to the Array they are bound to. For examples see Accessing Child Components.

v-partial

Replace the element’s innerHTML with a registered partial. Partials can be registered with Vue.partial() or passed inside the partials option. You can also use this syntax (which doesn’t support expressions):

1
<div>&#123;&#123;> my-partial&#125;&#125;</div>

v-effect

Apply a registered JavaScript effect to the element. JavaScript effects can be registered with Vue.effect() or passed inside the effects option.

For details, see the guide.

Empty Directives

Empty directives do not require and will ignore their attribute value.

v-transition

Notify Vue.js to apply transition CSS classes to this element. The transition classes are applied when certain transition-triggering directives modify the element, or when the ViewModel’s DOM manipulation methods are called.

For details, see the guide.

v-animation

Notify Vue.js to apply animation CSS classes to this element. The order of CSS class application is different from v-transition.

For details, see the guide.

v-pre

Skip compilation for this element and all its children. Skipping large numbers of nodes with no directives on them can speed up compilation.

v-cloak

This property remains on the element until the associated ViewModel finishes compilation. Combined with CSS rules such as [v-cloak] { display: none }, this directive can be used to hide un-compiled mustache bindings until the ViewModel is ready.

Caught a mistake or want to contribute to the documentation? Fork this site on Github!