JS.VUE.VALID.V.BIND.SYNC

Enforce valid '.sync' modifier on 'v-bind' directives

This rule checks whether every .sync modifier on v-bind directives is valid.

Rule Details

This rule reports .sync modifier on v-bind directives in the following cases:

  • The .sync modifier does not have the attribute value which is valid as LHS. E.g. <MyComponent v-bind:aaa.sync="foo() + bar()" />, <MyComponent v-bind:aaa.sync="a?.b" />
  • The .sync modifier has potential null object property access. E.g. <MyComponent v-bind:aaa.sync="(a?.b).c" />
  • The .sync modifier is on non Vue-components. E.g. <input v-bind:aaa.sync="foo"></div>
  • The .sync modifier's reference is iteration variables. E.g. <div v-for="x in list"><MyComponent v-bind:aaa.sync="x" /></div>

{'vue/valid-v-bind-sync': ['error']}

<template>
  <!-- GOOD -->
  <MyComponent v-bind:aaa.sync="foo"/>
  <MyComponent :aaa.sync="foo"/>

  <div v-for="todo in todos">
    <MyComponent v-bind:aaa.sync="todo.name"/>
    <MyComponent :aaa.sync="todo.name"/>
  </div>

  <!-- BAD -->
  <MyComponent v-bind:aaa.sync="foo + bar" />
  <MyComponent :aaa.sync="foo + bar" />

  <MyComponent :aaa.sync="a?.b.c" />
  <MyComponent :aaa.sync="(a?.b).c" />

  <input v-bind:aaa.sync="foo">
  <input :aaa.sync="foo">

  <div v-for="todo in todos">
    <MyComponent v-bind:aaa.sync="todo" />
    <MyComponent :aaa.sync="todo" />
  </div>
</template>

This rule does not check syntax errors in directives because it's checked by no-parsing-error rule.

Options

Nothing.

Further Reading

  • Guide (for v2) - .sync Modifier (https://v2.vuejs.org/v2/guide/components-custom-events.html#sync-Modifier)

The content on this page is adapted from the ESLint User Guide. Copyright © OpenJS Foundation and other contributors, www.openjsf.org. All rights reserved. https://eslint.org/docs/rules/