Vue.js

Appearance

On this page

Component v-model ​

기본 사용법 ​

v-model을 컴포넌트에서 사용하여 양방향 바인딩을 구현할 수 있습니다.

Vue 3.4부터는 defineModel() 매크로를 사용하는 것이 권장되는 접근 방식입니다:

vue
<!-- Child.vue -->
<script setup>
const model = defineModel()

function update() {
  model.value++
}
</script>

<template>
  <div>부모 바인딩 v-model은: {{ model }}</div>
</template>

부모는 v-model을 사용하여 값을 바인딩할 수 있습니다:

template
<!-- Parent.vue -->
<Child v-model="countModel" />

defineModel()에 의해 반환되는 값은 ref입니다. 다른 ref처럼 접근하고 변경할 수 있지만, 부모 값과 로컬 값 사이의 양방향 바인딩으로 작동합니다:

  • .value는 부모 v-model에 의해 바인딩된 값과 동기화됩니다;
  • 자식에 의해 변경되면 부모 바인딩 값도 업데이트됩니다.

따라서 이 ref를 네이티브 입력 엘리먼트의 v-model에 바인딩할 수도 있어, 네이티브 입력 엘리먼트를 래핑하면서 동일한 v-model 사용을 제공하는 것이 간단해집니다:

vue
<script setup>
const model = defineModel()
</script>

<template>
  <input v-model="model" />
</template>

Try it in the Playground

내부 구조 ​

defineModel은 편의성을 위한 매크로입니다. 컴파일러는 다음과 같이 확장합니다:

  • 로컬 ref의 값과 동기화되는 modelValue라는 이름의 prop;
  • 로컬 ref의 값이 변경될 때 발생하는 update:modelValue라는 이벤트.

3.4 이전에 위와 같은 자식 컴포넌트를 구현하는 방법은 다음과 같습니다:

vue
<script setup>
const props = defineProps(['modelValue'])
const emit = defineEmits(['update:modelValue'])
</script>

<template>
  <input
    :value="props.modelValue"
    @input="emit('update:modelValue', $event.target.value)"
  />
</template>

보시다시피, 이것은 훨씬 더 장황합니다. 하지만 내부에서 무슨 일이 일어나는지 이해하는 것이 도움이 됩니다.

defineModel은 prop을 선언하므로, defineModel에 전달함으로써 기본 prop의 옵션을 선언할 수 있습니다:

js
// v-model을 필수로 만들기
const model = defineModel({ required: true })

// 기본값 제공
const model = defineModel({ default: 0 })

WARNING

defineModel prop에 default 값을 설정하고, 부모 컴포넌트에서 이 prop에 대한 값을 제공하지 않으면, 부모와 자식 컴포넌트 간의 동기화 문제가 발생할 수 있습니다. 아래 예시에서, 부모의 myRef는 값이 정의되지 않았지만(undefined) 자식의 model은 1 입니다:

js
// 자식 컴포넌트:
const model = defineModel({ default: 1 })

// 부모 컴포넌트:
const myRef = ref()
html
<Child v-model="myRef"></Child>

먼저 네이티브 엘리먼트에서 v-model이 어떻게 사용되는지 다시 살펴봅시다:

template
<input v-model="searchText" />

내부적으로 템플릿 컴파일러는 v-model을 좀 더 자세한 표현으로 확장합니다. 따라서 위의 코드는 다음과 같은 작업을 수행합니다:

template
<input
  :value="searchText"
  @input="searchText = $event.target.value"
/>

컴포넌트에 사용하면 v-model이 대신 이렇게 확장됩니다:

template
<CustomInput
  :model-value="searchText"
  @update:model-value="newValue => searchText = newValue"
/>

하지만 이 기능이 실제로 작동하려면 <CustomInput> 컴포넌트가 두 가지 작업을 수행해야 합니다:

  1. 네이티브 <input> 앨리먼트의 value 속성을 modelValue 프로퍼티에 바인딩합니다.
  2. 네이티브 input 이벤트가 트리거되면 새 값으로 update:modelValue 사용자 지정 이벤트를 내보냅니다.

실제로 작동하는 모습은 다음과 같습니다:

vue
<!-- CustomInput.vue -->
<script>
export default {
  props: ['modelValue'],
  emits: ['update:modelValue']
}
</script>

<template>
  <input
    :value="modelValue"
    @input="$emit('update:modelValue', $event.target.value)"
  />
</template>

이제 v-model이 이 컴포넌트와 완벽하게 작동합니다:

template
<CustomInput v-model="searchText" />

Try it in the Playground

이 컴포넌트 내에서 v-model을 구현하는 또 다른 방법은 getter와 setter가 모두 있는 쓰기 가능한 computed 프로퍼티를 사용하는 것입니다. get 메서드는 modelValue 프로퍼티를 반환하고 set 메서드는 해당 이벤트를 발생시켜야 합니다:

vue
<!-- CustomInput.vue -->
<script>
export default {
  props: ['modelValue'],
  emits: ['update:modelValue'],
  computed: {
    value: {
      get() {
        return this.modelValue
      },
      set(value) {
        this.$emit('update:modelValue', value)
      }
    }
  }
}
</script>

<template>
  <input v-model="value" />
</template>

v-model 인수 ​

v-model은 컴포넌트에서 인수를 받을 수도 있습니다:

template
<MyComponent v-model:title="bookTitle" />

자식 컴포넌트에서는 defineModel()의 첫 번째 인수로 문자열을 전달하여 해당 인수를 지원할 수 있습니다:

vue
<!-- MyComponent.vue -->
<script setup>
const title = defineModel('title')
</script>

<template>
  <input type="text" v-model="title" />
</template>

Try it in the Playground

prop 옵션이 필요한 경우, 모델 이름 뒤에 전달해야 합니다:

js
const title = defineModel('title', { required: true })
3.4 이전 사용법
vue
<!-- MyComponent.vue -->
<script setup>
defineProps({
  title: {
    required: true
  }
})
defineEmits(['update:title'])
</script>

<template>
  <input
    type="text"
    :value="title"
    @input="$emit('update:title', $event.target.value)"
  />
</template>

Try it in the Playground

이 경우, 기본 modelValue prop과 update:modelValue 이벤트 대신, 자식 컴포넌트는 title prop을 기대하고 부모 값을 업데이트하기 위해 update:title 이벤트를 발생시켜야 합니다:

vue
<!-- MyComponent.vue -->
<script>
export default {
  props: ['title'],
  emits: ['update:title']
}
</script>

<template>
  <input
    type="text"
    :value="title"
    @input="$emit('update:title', $event.target.value)"
  />
</template>

Try it in the Playground

Multiple v-model bindings ​

앞서 배운 것처럼 특정 prop과 이벤트를 타깃팅하는 기능을 v-model 인자로 활용하면 이제 단일 컴포넌트 인스턴스에 여러 개의 v-model 바인딩을 생성할 수 있습니다.

각 v-model은 컴포넌트에서 추가 옵션 없이도 다른 prop에 동기화됩니다:

template
<UserName
  v-model:first-name="first"
  v-model:last-name="last"
/>
vue
<script setup>
const firstName = defineModel('firstName')
const lastName = defineModel('lastName')
</script>

<template>
  <input type="text" v-model="firstName" />
  <input type="text" v-model="lastName" />
</template>

Try it in the Playground

3.4 이전 사용법
vue
<script setup>
defineProps({
  firstName: String,
  lastName: String
})

defineEmits(['update:firstName', 'update:lastName'])
</script>

<template>
  <input
    type="text"
    :value="firstName"
    @input="$emit('update:firstName', $event.target.value)"
  />
  <input
    type="text"
    :value="lastName"
    @input="$emit('update:lastName', $event.target.value)"
  />
</template>

Try it in the Playground

vue
<script>
export default {
  props: {
    firstName: String,
    lastName: String
  },
  emits: ['update:firstName', 'update:lastName']
}
</script>

<template>
  <input
    type="text"
    :value="firstName"
    @input="$emit('update:firstName', $event.target.value)"
  />
  <input
    type="text"
    :value="lastName"
    @input="$emit('update:lastName', $event.target.value)"
  />
</template>

Try it in the Playground

v-model 수정자 처리하기 ​

Form 양식 입력 바인딩에 대해 배울 때 v-model에 .trim, .number 및 .lazy와 같은 내장 수정자가 있다는 것을 알았습니다. 경우에 따라 사용자 정의 입력 컴포넌트에서 v-model이 사용자 정의 수정자를 지원하도록 할 수도 있습니다.

v-model 바인딩에서 제공하는 문자열의 첫 글자를 대문자로 표시하는 사용자 지정 수정자 예제인 capitalize를 만들어 보겠습니다:

template
<MyComponent v-model.capitalize="myText" />

컴포넌트 v-model에 추가된 수정자(modifiers)는 자식 컴포넌트에서 defineModel() 반환값을 구조 분해하여 다음과 같이 접근할 수 있습니다:

vue
<script setup>
const [model, modifiers] = defineModel()

console.log(modifiers) // { capitalize: true }
</script>

<template>
  <input type="text" v-model="model" />
</template>

수정자에 기반하여 값을 어떻게 읽거나 쓸지 조건적으로 조정하려면, defineModel()에 get과 set 옵션을 전달할 수 있습니다. 이 두 옵션은 모델 ref의 get / set에서 값을 받아 변환된 값을 반환해야 합니다. 다음은 set 옵션을 사용하여 capitalize 수정자를 구현하는 방법입니다:

vue
<script setup>
const [model, modifiers] = defineModel({
  set(value) {
    if (modifiers.capitalize) {
      return value.charAt(0).toUpperCase() + value.slice(1)
    }
    return value
  }
})
</script>

<template>
  <input type="text" v-model="model" />
</template>

Try it in the Playground

3.4 이전 사용법
vue
<script setup>
const props = defineProps({
  modelValue: String,
  modelModifiers: { default: () => ({}) }
})

const emit = defineEmits(['update:modelValue'])

function emitValue(e) {
  let value = e.target.value
  if (props.modelModifiers.capitalize) {
    value = value.charAt(0).toUpperCase() + value.slice(1)
  }
  emit('update:modelValue', value)
}
</script>

<template>
  <input type="text" :value="modelValue" @input="emitValue" />
</template>

Try it in the Playground

컴포넌트 v-model에 추가된 수정자는 modelModifiers prop을 통해 컴포넌트에 제공됩니다. 아래 예제에서는 빈 객체로 기본 설정된 modelModifiers prop이 포함된 컴포넌트를 만들었습니다:

vue
<script>
export default {
  props: {
    modelValue: String,
    modelModifiers: {
      default: () => ({})
    }
  },
  emits: ['update:modelValue'],
  created() {
    console.log(this.modelModifiers) // { capitalize: true }
  }
}
</script>

<template>
  <input
    type="text"
    :value="modelValue"
    @input="$emit('update:modelValue', $event.target.value)"
  />
</template>

컴포넌트의 modelModifiers 프로퍼티에 capitalize가 포함되어 있고 그 값은 v-model 바인딩 v-model.capitalize="myText"에 설정되어 있기 때문에 true인 것을 알 수 있습니다.

이제 prop이 설정되었으므로 modelModifiers 객체 키를 확인하고 발신된 값을 변경하는 핸들러를 작성할 수 있습니다. 아래 코드에서는 <input /> 앨리먼트가 input 이벤트를 실행할 때마다 문자열을 대문자로 표시합니다.

vue
<script>
export default {
  props: {
    modelValue: String,
    modelModifiers: {
      default: () => ({})
    }
  },
  emits: ['update:modelValue'],
  methods: {
    emitValue(e) {
      let value = e.target.value
      if (this.modelModifiers.capitalize) {
        value = value.charAt(0).toUpperCase() + value.slice(1)
      }
      this.$emit('update:modelValue', value)
    }
  }
}
</script>

<template>
  <input type="text" :value="modelValue" @input="emitValue" />
</template>

Try it in the Playground

인자와 수정자가 있는 v-model에 대한 수정자들 ​

인자와 수정자가 모두 있는 v-model 바인딩의 경우, 생성된 prop 이름은 arg + "수정자"가 됩니다. 예를 들어

template
<MyComponent v-model:title.capitalize="myText">

해당 선언은 다음과 같아야 합니다:

js
export default {
  props: ['title', 'titleModifiers'],
  emits: ['update:title'],
  created() {
    console.log(this.titleModifiers) // { capitalize: true }
  }
}

다음은 다른 인자를 가진 여러 v-model에 수정자를 사용한 예시입니다:

template
<UserName
  v-model:first-name.capitalize="first"
  v-model:last-name.uppercase="last"
/>
vue
<script setup>
const [firstName, firstNameModifiers] = defineModel('firstName')
const [lastName, lastNameModifiers] = defineModel('lastName')

console.log(firstNameModifiers) // { capitalize: true }
console.log(lastNameModifiers) // { uppercase: true}
</script>
3.4 이전 사용법
vue
<script setup>
const props = defineProps({
  firstName: String,
  lastName: String,
  firstNameModifiers: { default: () => ({}) },
  lastNameModifiers: { default: () => ({}) }
})
defineEmits(['update:firstName', 'update:lastName'])

console.log(props.firstNameModifiers) // { capitalize: true }
console.log(props.lastNameModifiers) // { uppercase: true}
</script>
vue
<script>
export default {
  props: {
    firstName: String,
    lastName: String,
    firstNameModifiers: {
      default: () => ({})
    },
    lastNameModifiers: {
      default: () => ({})
    }
  },
  emits: ['update:firstName', 'update:lastName'],
  created() {
    console.log(this.firstNameModifiers) // { capitalize: true }
    console.log(this.lastNameModifiers) // { uppercase: true}
  }
}
</script>

GitHub에서 이 페이지 편집