Custom v-model on components in Vue

Introduction

Custom v-model lets you connect a parent and child component easily. It helps sync data between them without extra code.

You want a child component to update a value in the parent automatically.

You build a reusable input component that works like a normal input with <code>v-model</code>.

You want to customize the event or prop name used for two-way binding.

You want to keep your template clean and simple when passing data back and forth.

Syntax

Vue

<script setup>
const props = defineProps({
  modelValue: String
})
const emit = defineEmits(['update:modelValue'])

function updateValue(newValue) {
  emit('update:modelValue', newValue)
}
</script>

<template>
  <input :value="modelValue" @input="e => updateValue(e.target.value)" />
</template>

The prop modelValue holds the value from the parent.

The event update:modelValue sends changes back to the parent.

Examples

Basic usage: v-model binds text to the child component's modelValue prop and listens for update:modelValue event.

Vue

<MyInput v-model="text" />

Using a custom prop and event name with v-model:custom.

Vue

<MyInput v-model:custom="text" />

// In child component:
const props = defineProps({ custom: String })
const emit = defineEmits(['update:custom'])

Sample Program

This example shows a parent component using CustomInput with v-model. When you type in the input, the text updates in the parent and shows below.

Vue

<script setup>
import { ref } from 'vue'

const text = ref('Hello')
</script>

<template>
  <CustomInput v-model="text" />
  <p>You typed: {{ text }}</p>
</template>

<!-- CustomInput.vue -->
<script setup>
const props = defineProps({ modelValue: String })
const emit = defineEmits(['update:modelValue'])

function onInput(event) {
  emit('update:modelValue', event.target.value)
}
</script>

<template>
  <input :value="modelValue" @input="onInput" aria-label="Custom input" />
</template>

Important Notes

Always use modelValue as the prop and update:modelValue as the event for default v-model.

You can add aria-label for accessibility on inputs.

Customizing v-model names helps avoid conflicts in complex components.

Summary

Custom v-model connects parent and child data easily.

Use modelValue prop and update:modelValue event by default.

Custom names are possible with v-model:customName.

Practice

1. What is the default prop name used in a Vue component to work with v-model?

easy

A. inputValue

B. value

C. vModel

D. modelValue

Solution

1. Step 1: Understand Vue's default v-model prop

   Vue uses modelValue as the default prop name to bind data from parent to child.

2. Step 2: Recall the default event name

   The event emitted to update the parent is update:modelValue, matching the prop name.

3. Final Answer:

   modelValue -> Option D

4. Quick Check:

   Default prop for v-model = modelValue [OK]

Hint: Default v-model prop is always 'modelValue' [OK]

Common Mistakes:

• Using 'value' as default prop
• Confusing event name with prop name
• Assuming 'vModel' is default prop

2. Which of the following is the correct syntax to use a custom v-model named checked on a component?

easy

A. <MyCheckbox v-model:checked="isChecked" />

B. <MyCheckbox v-model.checked="isChecked" />

C. <MyCheckbox v-model_checked="isChecked" />

D. <MyCheckbox v-modelChecked="isChecked" />

Solution

1. Step 1: Recall custom v-model syntax

   Vue uses v-model:customName syntax to bind custom model names.

2. Step 2: Match syntax with options

   Only <MyCheckbox v-model:checked="isChecked" /> uses the correct colon syntax for custom v-model binding.

3. Final Answer:

   <MyCheckbox v-model:checked="isChecked" /> -> Option A

4. Quick Check:

   Custom v-model uses colon syntax [OK]

Hint: Use colon for custom v-model names: v-model:customName [OK]

Common Mistakes:

• Using dot instead of colon
• Using underscore instead of colon
• Using camelCase without colon

3. Given this child component code:

props: ['modelValue'],
methods: {
  updateValue(val) {
    this.$emit('update:modelValue', val)
  }
}

And parent usage:

<ChildComponent v-model="parentData" />

What happens when updateValue('new') is called inside the child?

medium

A. The child's modelValue prop changes to 'new'.

B. Nothing happens because event name is wrong.

C. The parent's parentData updates to 'new'.

D. An error occurs because updateValue is not defined.

Solution

1. Step 1: Understand event emission in child

   The child emits update:modelValue with the new value, which Vue listens to for v-model updates.

2. Step 2: Effect on parent data

   The parent bound to v-model receives the event and updates parentData to 'new'.

3. Final Answer:

   The parent's parentData updates to 'new'. -> Option C

4. Quick Check:

   Child emits update:modelValue -> parent updates [OK]

Hint: Child emits update:modelValue event to update parent data [OK]

Common Mistakes:

• Thinking prop changes inside child
• Confusing event name with prop name
• Assuming no update without v-model modifier

4. Identify the error in this child component code for custom v-model named checked:

props: ['checked'],
methods: {
  updateChecked(val) {
    this.$emit('update:checked', val)
  }
}

Parent uses:

<MyCheckbox v-model:checked="isChecked" />

medium

A. Event name should be update:modelValue for custom v-model.

B. Prop name and event name are correct for custom v-model checked.

C. Prop name should be modelValue instead of checked.

D. The method should emit checked event, not update:checked.

Solution

1. Step 1: Check prop and event names for custom v-model

   For v-model:checked, the prop must be checked and event update:checked.

2. Step 2: Verify code matches custom v-model pattern

   The code uses props: ['checked'] and emits update:checked, which is correct.

3. Final Answer:

   Prop name and event name are correct for custom v-model checked. -> Option B

4. Quick Check:

   Custom v-model uses matching prop and update:event [OK]

Hint: Custom v-model uses prop and event names matching the model name [OK]

Common Mistakes:

• Using default modelValue prop for custom v-model
• Emitting wrong event name
• Confusing event and prop names

5. You want to create a component ToggleSwitch that uses a custom v-model named active. Which of these code snippets correctly implements the child component's props and emits to support this?

hard

A. props: ['active'],
methods: {
toggle() {
this.$emit('update:active', !this.active)
}
}

B. props: ['modelValue'],
methods: {
toggle() {
this.$emit('update:modelValue', !this.modelValue)
}
}

C. props: ['active'],
methods: {
toggle() {
this.$emit('update:modelValue', !this.active)
}
}

D. props: ['modelValue'],
methods: {
toggle() {
this.$emit('update:active', !this.modelValue)
}
}

Solution

1. Step 1: Match prop and event names to custom v-model name

   For v-model:active, the prop must be active and event update:active.

2. Step 2: Check each option for correct prop and event

   props: ['active'],
   methods: {
     toggle() {
       this.$emit('update:active', !this.active)
     }
   }

   uses props: ['active'] and emits update:active, matching the custom v-model name.

3. Final Answer:

   props: ['active'], methods: { toggle() { this.$emit('update:active', !this.active) } } -> Option A

4. Quick Check:

   Custom v-model prop and event must match model name [OK]

Hint: Custom v-model prop and event must match the model name exactly [OK]

Common Mistakes:

• Mixing default modelValue with custom names
• Emitting wrong event name
• Using wrong prop name for custom v-model