Global API: General

version

Vue의 현재 버전(문자열)을 반환합니다.

타입: string

예제

import { version } from 'vue'

console.log(version)

nextTick()

다음 DOM 업데이트 발생을 기다리는 유틸리티입니다.

타입:

function nextTick(callback?: () => void): Promise<void>

세부 사항: 반응형 상태를 변경한 결과는 동기적으로 DOM에 업데이트되지 않습니다. 대신, 이것은 상태를 얼마나 많이 변경했는지에 관계없이 "다음 틱"까지 버퍼링하여, 각 컴포넌트가 한 번만 업데이트 되었음을 보장합니다.
nextTick()은 상태 변경 직후에 DOM 업데이트가 완료될 때까지 대기하는 데 사용할 수 있습니다. 콜백을 인자로 전달하거나, 프로미스(Promise) 반환을 기다릴 수 있습니다.

예제

vue

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

const count = ref(0)

async function increment() {
  count.value++

  // 아직 DOM 업데이트되지 않음.
  console.log(document.getElementById('counter').textContent) // 0

  await nextTick()
  // 이제 DOM 업데이트됨.
  console.log(document.getElementById('counter').textContent) // 1
}
</script>

<template>
  <button id="counter" @click="increment">{{ count }}</button>
</template>

vue

<script>
import { nextTick } from 'vue'

export default {
  data() {
    return {
      count: 0
    }
  },
  methods: {
    async increment() {
      this.count++

      // 아직 DOM 업데이트되지 않음.
      console.log(document.getElementById('counter').textContent) // 0

      await nextTick()
      // 이제 DOM 업데이트됨.
      console.log(document.getElementById('counter').textContent) // 1
    }
  }
}
</script>

<template>
  <button id="counter" @click="increment">{{ count }}</button>
</template>

참고: this.$nextTick()

defineComponent()

타입 추론으로 Vue 컴포넌트를 정의하기 위한 타입 핼퍼입니다.

타입:

// options 문법
function defineComponent(
  component: ComponentOptions
): ComponentConstructor

// function 문법 (requires 3.3+)
function defineComponent(
  setup: ComponentOptions['setup'],
  extraOptions?: ComponentOptions
): () => any

타입은 가독성을 위해 단순화되었습니다.

세부 사항:
첫 번째 인자로 컴포넌트 옵션 객체가 필요합니다. 이 함수는 본질적으로 타입 추론 목적이므로, 동일한 옵션 객체를 반환하며, 런타임에 작동하지 않습니다.
반환 타입은 약간 특별한데, 옵션을 기반으로 추론된 컴포넌트 인스턴스 타입인 생성자 타입이 됩니다. 이것은 반환된 타입이 TSX에서 태그로 사용될 때 타입 추론에 사용됩니다.
다음과 같이 defineComponent()의 반환 타입에서 컴포넌트의 인스턴스 타입(해당 옵션의 this 타입과 동일)을 추출할 수 있습니다:
ts
```
const Foo = defineComponent(/* ... */)

type FooInstance = InstanceType<typeof Foo>
```
Function Signature
defineComponent() also has an alternative signature that is meant to be used with Composition API and render functions or JSX.
Instead of passing in an options object, a function is expected instead. This function works the same as the Composition API setup() function: it receives the props and the setup context. The return value should be a render function - both h() and JSX are supported:
js
```
import { ref, h } from 'vue'

const Comp = defineComponent(
  (props) => {
    // use Composition API here like in <script setup>
    const count = ref(0)

    return () => {
      // render function or JSX
      return h('div', count.value)
    }
  },
  // extra options, e.g. declare props and emits
  {
    props: {
      /* ... */
    }
  }
)
```
The main use case for this signature is with TypeScript (and in particular with TSX), as it supports generics:
tsx
```
const Comp = defineComponent(
  <T extends string | number>(props: { msg: T; list: T[] }) => {
    // use Composition API here like in <script setup>
    const count = ref(0)

    return () => {
      // render function or JSX
      return <div>{count.value}</div>
    }
  },
  // manual runtime props declaration is currently still needed.
  {
    props: ['msg', 'list']
  }
)
```
In the future, we plan to provide a Babel plugin that automatically infers and injects the runtime props (like for defineProps in SFCs) so that the runtime props declaration can be omitted.
Note on webpack Treeshaking
defineComponent()는 함수 호출이기 때문에 웹팩과 같은 일부 빌드 도구에 부작용(Side-effect)을 일으키는 것처럼 보일 수 있습니다. 이렇게 하면 컴포넌트가 전혀 사용되지 않는 경우에도 트리가 흔들리는 것을 방지할 수 있습니다.
Because defineComponent() is a function call, it could look like that it would produce side-effects to some build tools, e.g. webpack. This will prevent the component from being tree-shaken even when the component is never used.
이 함수 호출이 트리 셰이크해도 안전하다는 것을 웹팩에 알리려면 함수 호출 앞에 /*#__PURE__*/ 주석 표기법을 추가하면 됩니다:
To tell webpack that this function call is safe to be tree-shaken, you can add a /*#__PURE__*/ comment notation before the function call:
js
```
export default /*#__PURE__*/ defineComponent(/* ... */)
```
롤업(Vite에서 사용하는 기본 프로덕션 번들러)은 수동 어노테이션 없이도 defineComponent()가 실제로 부작용이 없는지 판단할 수 있을 만큼 똑똑하기 때문에 Vite를 사용하는 경우 이 작업이 필요하지 않습니다.
Note this is not necessary if you are using Vite, because Rollup (the underlying production bundler used by Vite) is smart enough to determine that defineComponent() is in fact side-effect-free without the need for manual annotations.
참고: 가이드 - Vue에서 타입스크립트 사용하기

defineAsyncComponent()

렌더링될 때 지연 로드되는 비동기 컴포넌트를 정의합니다. 인자는 로더 함수이거나 로드 동작의 고급 제어를 위한 옵션 객체일 수 있습니다.

타입:

function defineAsyncComponent(
  source: AsyncComponentLoader | AsyncComponentOptions
): Component

type AsyncComponentLoader = () => Promise<Component>

interface AsyncComponentOptions {
  loader: AsyncComponentLoader
  loadingComponent?: Component
  errorComponent?: Component
  delay?: number
  timeout?: number
  suspensible?: boolean
  onError?: (
    error: Error,
    retry: () => void,
    fail: () => void,
    attempts: number
  ) => any
}

참고: 가이드 - 비동기 컴포넌트

defineCustomElement()

이 메서드는 defineComponent와 동일한 인자를 사용하지만, 네이티브 커스텀 엘리먼트 클래스 생성자를 반환합니다.

타입:

function defineCustomElement(
  component:
    | (ComponentOptions & { styles?: string[] })
    | ComponentOptions['setup']
): {
  new (props?: object): HTMLElement
}

타입은 가독성을 위해 단순화되었습니다.

세부 사항:
defineCustomElement()는 일반 컴포넌트 옵션 외에도 추가로 엘리먼트의 섀도우 루트에 삽입되어야 하는 CSS를 제공하기 위해, 인라인 CSS 문자열을 배열로 감싼 특수 옵션 styles도 지원합니다.
반환 값은 customElements.define()을 사용하여 등록할 수 있는 커스텀 엘리먼트 생성자입니다.

예제

import { defineCustomElement } from 'vue'

const MyVueElement = defineCustomElement({
  /* 컴포넌트 옵션 */
})

// 커스텀 엘리먼트를 등록함
customElements.define('my-vue-element', MyVueElement)

참고:
- 가이드 - Vue로 커스텀 엘리먼트 만들기
- defineCustomElement()는 싱글 파일 컴포넌트와 함께 사용할 때, 특별한 설정이 필요합니다.

GitHub에서 이 페이지 편집

Global API: General ​

version ​

nextTick() ​

defineComponent() ​

Function Signature ​

Note on webpack Treeshaking ​

defineAsyncComponent() ​

defineCustomElement() ​