Skip to content

Application API

createApp()

앱 인스턴스를 생성합니다.

  • 타입:

    function createApp(rootComponent: Component, rootProps?: object): App
    
  • 세부 사항:

    첫 번째 인자는 루트 컴포넌트입니다. 선택적인 두 번째 인자는 루트 컴포넌트에 전달할 props입니다.

  • 예제:

    루트 컴포넌트를 직접 서술하는 방식(inline)으로 사용하는 경우:

    import { createApp } from 'vue'
    
    const app = createApp({
      /* 루트 컴포넌트 옵션 */
    })
    

    컴포넌트 불러오기(import)로 사용하는 경우:

    import { createApp } from 'vue'
    import App from './App.vue'
    
    const app = createApp(App)
    
  • 참고: 가이드 - 앱 생성

createSSRApp()

SSR 하이드레이션 모드에서 앱 인스턴스를 생성합니다. 사용법은 createApp()과 완전히 동일합니다.

app.mount()

컨테이너 엘리먼트에 앱 인스턴스를 마운트합니다.

  • 타입:

    interface App {
      mount(rootContainer: Element | string): ComponentPublicInstance
    }
    
  • 세부 사항:

    인자는 실제 DOM 엘리먼트 또는 CSS 셀렉터(첫 번째로 일치한 엘리먼트가 사용됨)일 수 있습니다. 루트 컴포넌트 인스턴스를 반환합니다.

    컴포넌트에 정의된 템플릿 또는 렌더링 함수가 있는 경우, 컨테이너 내부의 기존 DOM 노드를 대체합니다. 만약 런타임 컴파일러를 사용하는 경우, 컨테이너의 innerHTML이 템플릿으로 사용됩니다.

    SSR 하이드레이션 모드에서는 컨테이너 내부의 기존 DOM 노드를 하이드레이트합니다. 불일치할 경우, 기존 DOM 노드가 의도하는 출력과 일치하도록 변경됩니다.

    각 앱 인스턴스는 mount()를 한 번만 호출할 수 있습니다.

  • 예제:

    import { createApp } from 'vue'
    const app = createApp(/* ... */)
    
    app.mount('#app')
    

    실제 DOM 엘리먼트에 마운트할 수도 있습니다:

    app.mount(document.body.firstChild)
    

app.unmount()

마운트된 앱 인스턴스를 마운트 해제하여, 앱의 컴포넌트 트리에 있는 모든 컴포넌트에 마운트 해제 수명 주기 훅을 트리거합니다.

  • 타입:

    interface App {
      unmount(): void
    }
    

app.provide()

앱 내의 모든 하위 컴포넌트에 주입할 수 있는 값을 제공합니다.

  • 타입:

    interface App {
      provide<T>(key: InjectionKey<T> | symbol | string, value: T): this
    }
    
  • 세부 사항:

    첫 번째 인자는 주입 키이고, 두 번째 인자는 제공될 값입니다. 반환 값은 앱 인스턴스입니다.

  • 예제:

    import { createApp } from 'vue'
    
    const app = createApp(/* ... */)
    
    app.provide('message', '안녕!')
    

    앱 내 컴포넌트에서:

    ?
    import { inject } from 'vue'
    
    export default {
      setup() {
        console.log(inject('message')) // '안녕!'
      }
    }
    
    export default {
      inject: ['message'],
      created() {
        console.log(this.message) // '안녕!'
      }
    }
    
  • 참고:

app.component()

이름(문자열)과 컴포넌트정의를 모두 전달하는 경우, 전역 컴포넌트를 등록합니다. 이름만 전달되는 경우, 이미 등록된 것을 찾습니다.

  • 타입:

    interface App {
      component(name: string): Component | undefined
      component(name: string, component: Component): this
    }
    
  • 예제:

    import { createApp } from 'vue'
    
    const app = createApp({})
    
    // 선택적으로 객체를 등록할 수 있음
    app.component('my-component', {
      /* ... */
    })
    
    // 등록된 컴포넌트 찾기
    const MyComponent = app.component('my-component')
    
  • 참고: 컴포넌트 등록

app.directive()

이름(문자열)과 디렉티브 정의를 모두 전달하는 경우, 전역 커스텀 디렉티브를 등록합니다. 이름만 전달되는 경우, 이미 등록된 것을 찾습니다.

  • 타입:

    interface App {
      directive(name: string): Directive | undefined
      directive(name: string, directive: Directive): this
    }
    
  • 예제:

    import { createApp } from 'vue'
    
    const app = createApp({
      /* ... */
    })
    
    // 등록 (객체 디렉티브)
    app.directive('my-directive', {
      /* 커스텀 디렉티브 훅 */
    })
    
    // 등록 (간단하게 사용하기 위한 함수형 디렉티브)
    app.directive('my-directive', () => {
      /* ... */
    })
    
    // 등록된 디렉티브 찾기
    const myDirective = app.directive('my-directive')
    
  • 참고: 커스텀 디렉티브

app.use()

플러그인 설치.

  • 타입:

    interface App {
      use(plugin: Plugin, ...options: any[]): this
    }
    
  • 세부 사항:

    첫 번째 인자는 플러그인입니다. 선택적인 두 번째 인자는 플러그인 옵션입니다.

    플러그인은 install() 메서드가 있는 객체이거나, install() 메서드로 사용될 함수입니다. app.use()의 두 번째 인자인 옵션은 플러그인의 install() 메서드에 전달됩니다.

    동일한 플러그인을 여러 번 app.use()로 호출하는 경우, 플러그인은 한 번만 설치됩니다.

  • 예제:

    import { createApp } from 'vue'
    import MyPlugin from './plugins/MyPlugin'
    
    const app = createApp({
      /* ... */
    })
    
    app.use(MyPlugin)
    
  • 참고: 플러그인

app.mixin()

앱 범위 전역에 믹스인을 적용합니다. 전역 믹스인에 포함된 옵션은 앱 내에 모든 컴포넌트 인스턴스에 적용됩니다.

권장하지 않음

믹스인은 라이브러리 생태계에서 널리 사용되고 있기 때문에, 하위 호환성을 위해 Vue 3에서 지원됩니다. 하지만 앱 내 코드에서 믹스인(특히 전역 믹스인)의 사용은 피해야 합니다.

로직 재상용은 컴포저블을 추천합니다.

  • 타입:

    interface App {
      mixin(mixin: ComponentOptions): this
    }
    

app.version

앱을 생성한 Vue 버전을 제공합니다. 이것은 Vue 버전에 기반한 플러그인 내부에서 조건부 로직이 필요한 경우에 유용합니다.

  • 타입:

    interface App {
      version: string
    }
    
  • 예제:

    플러그인 내부에서 버전 확인 진행:

    export default {
      install(app) {
        const version = Number(app.version.split('.')[0])
        if (version < 3) {
          console.warn('이 플러그인은 Vue 3가 필요합니다.')
        }
      }
    }
    
  • 참고: 전역 API - version

app.config

모든 앱 인스턴스는 해당 앱의 환경 설정이 포함된 config 객체를 노출합니다. 앱을 마운트하기 전에 속성을 수정할 수 있습니다(아래 문서 참조).

import { createApp } from 'vue'

const app = createApp(/* ... */)

console.log(app.config)

app.config.errorHandler

앱 내에서 예외 처리 되지 않은 에러 발생 시, 트리거 될 전역 핸들러를 정의합니다.

  • 타입:

    interface AppConfig {
      errorHandler?: (
        err: unknown,
        instance: ComponentPublicInstance | null,
        // `info`는 Vue 고유의 에러 정보입니다.
        // 예: 에러 발생 수명 주기 훅 표시: 'created hook'
        info: string
      ) => void
    }
    
  • 세부 사항:

    핸들러는 "에러", "에러를 트리거한 컴포넌트 인스턴스", "에러 출처 유형을 나타내는 문자열" 세 인자를 받습니다.

    다음 출처에서 에러를 캡처할 수 있습니다:

    • 컴포넌트 렌더
    • 이벤트 핸들러
    • 수명 주기 훅
    • setup() 함수
    • 감시자
    • 커스텀 디렉티브 훅
    • 트랜지션 훅
  • 예제:

    app.config.errorHandler = (err, instance, info) => {
      // 에러 핸들링: 서비스 에러 로그 기록
    }
    

app.config.warnHandler

Vue에서 런타임 경고 발생 시, 트리거 될 커스텀 핸들러를 정의합니다.

  • 타입:

    interface AppConfig {
      warnHandler?: (
        msg: string,
        instance: ComponentPublicInstance | null,
        trace: string
      ) => void
    }
    
  • 세부 사항:

    첫 번째 인자로 경고 메세지, 두 번째 인자로 발생한 컴포넌트 인스턴스, 세 번째 인자로 컴포넌트 추적 문자열을 받습니다.

    특정 경고를 필터링하여 콘솔의 장황함을 줄일 수 있습니다. 모든 Vue 경고는 개발 중에 해결돼야 합니다. 따라서 이 함수는 디버깅 시에 많은 경고 중에서 특정 경고에 초점을 맞추는 것이 좋으며, 디버깅이 완료되면 제거해야 합니다.

    TIP

    경고는 개발 모드에서만 발생하므로, 이것은 프로덕션 모드에서 무시됩니다.

  • 예제:

    app.config.warnHandler = (msg, instance, trace) => {
      // `trace`는 컴포넌트 계층 구조를 추적한 문자열입니다.
    }
    

app.config.performance

이것을 true로 설정하면 (크롬 기준) 브라우저 개발자 도구의 "성능(Performance) 탭 → 소요시간(Timings) 패널"에 컴포넌트 초기화, 컴파일, 렌더링, 패치 성능 추적 기록이 활성화 됩니다. 브라우저가 performance.mark API를 지원하고 개발 모드일 경우에만 작동(기록)합니다.

app.config.compilerOptions.isCustomElement

런타임 컴파일러 옵션을 설정합니다. 이 객체에 설정된 값은 브라우저 내 템플릿 컴파일러에 전달되고, 설정된 앱의 모든 컴포넌트에 영향을 미칩니다. compilerOptions 옵션을 사용하여 컴포넌트별로 이러한 옵션을 재정의할 수도 있습니다.

중요

이 옵션은 전체 빌드(예: 브라우저에서 템플릿을 컴파일할 수 있는 독립 실행형 vue.js)를 사용할 때만 적용됩니다. 빌드 셋업과 함께 런타임 전용 빌드를 사용하는 경우, 빌드 도구 환경설정을 통해 컴파일러 옵션을 @vue/compiler-dom으로 전달해야 합니다.

app.config.compilerOptions.isCustomElement

네이티브(native) 커스텀 엘리먼트를 인식하기 위한 검사 방법을 지정합니다.

  • 타입: (tag: string) => boolean

  • 세부 사항:

    태그가 네이티브 커스텀 엘레먼트로 처리되어야 하는 경우, true가 반환돼야 합니다. 일치하는 태그의 경우 Vue는 이를 Vue 컴포넌트로 확인하는 대신 기본 요소로 렌더링합니다.

    네이티브 HTML과 SVG 태그는 Vue 파서가 자동으로 인식하므로, 이 함수로 검사 작업을 할 필요가 없습니다.

  • 예제:

    // 'ion-'으로 시작하는 모든 태그를 커스텀 엘리먼트로 처리
    app.config.compilerOptions.isCustomElement = (tag) => {
      return tag.startsWith('ion-')
    }
    
  • 참고: Vue와 웹 컴포넌트

app.config.compilerOptions.whitespace

템플릿 내 공백 처리 방식을 설정합니다.

  • 타입: 'condense' | 'preserve'

  • 기본 값: 'condense'

  • 세부 사항:

    Vue는 템플릿에서 공백 문자를 제거/축소하여, 보다 효율적으로 컴파일된 결과물을 생성합니다. 다음과 같이 기본적으로 "축소"에 초첨을 두어 작동합니다.

    1. 엘리먼트 내부의 선행/종료 공백 문자열은 단일 공백으로 축소됩니다.
    2. 엘리먼트 간의 개행(줄바꿈)을 포함하는 공백 문자는 제거됩니다.
    3. 텍스트 노드의 연속된 공백 문자열는 단일 공백으로 축소됩니다.

    이 옵션을 'preserve'로 설정하면, (2)와 (3)이 비활성화됩니다.

  • 예제:

    app.config.compilerOptions.whitespace = 'preserve'
    

app.config.compilerOptions.delimiters

템플릿 내 텍스트 보간에 사용되는 구분 기호를 설정합니다.

  • 타입: [string, string]

  • 기본 값: ['{{', '}}']

  • 세부 사항:

    이것은 일반적으로 이중 중괄호 문법을 사용하는 서버 측 프레임워크와의 충돌을 피하기 위해 사용됩니다.

  • 예제:

    // 구분 기호가 ES6 템플릿 문자열 스타일로 변경됨
    app.config.compilerOptions.delimiters = ['${', '}']
    

app.compilerOptions.comments

템플릿에서 HTML 주석 보존 여부를 설정합니다.

  • 타입: boolean

  • 기본 값: false

  • 세부 사항:

    기본적으로 Vue는 프로덕션에서 주석을 제거하지만, 개발 중에는 항상 보존됩니다. 강제로 프로덕션 환경에서 주석을 보존해야 하는 경우, 이 옵션을 true로 설정해야 합니다. 일반적으로 이 옵션은 Vue와 HTML 주석에 의존하는 다른 라이브러리를 함께 사용해야 할 때 사용됩니다.

  • 예제:

    app.config.compilerOptions.comments = true
    

app.config.globalProperties

앱 내부의 모든 컴포넌트 인스턴스에서 접근할 수 있는 전역 속성을 등록하는 데 사용되는 객체입니다.

  • 타입:

    interface AppConfig {
      globalProperties: Record<string, any>
    }
    
  • 세부 사항:

    이것은 Vue 3에서 지원하지 않는 Vue 2의 Vue.prototype을 대체하며, 특별한 경우에만 사용해야 합니다.

    전역 속성이 컴포넌트 자체 속성과 충돌하는 경우, 컴포넌트 자체 속성이 더 높은 우선 순위를 갖습니다.

  • 사용법:

    app.config.globalProperties.msg = '안녕!'
    

    이렇게 하면 앱 내 모든 컴포넌트 인스턴스의 this와 컴포넌트 템플릿에서 msg를 사용할 수 있습니다:

    export default {
      mounted() {
        console.log(this.msg) // '안녕!'
      }
    }
    

app.config.optionMergeStrategies

컴포넌트 옵션의 커스텀 병합 함수를 정의하기 위한 객체입니다.

  • 타입:

    interface AppConfig {
      optionMergeStrategies: Record<string, OptionMergeFunction>
    }
    
    type OptionMergeFunction = (to: unknown, from: unknown) => any
    
  • 세부 사항:

    일부 플러그인/라이브러리는 전역 믹스인(mixin)을 삽입하여, 커스텀 컴포넌트 옵션을 추가로 지원합니다. 여러 소스(예: 믹스인 또는 컴포넌트 상속)에서 동일한 옵션을 "병합"해야 하는 경우, 이러한 옵션에는 특별한 병합 로직이 필요할 수 있습니다.

    app.config.optionMergeStrategies 객체에 옵션 이름을 키(key)로 하는 커스텀 병합 함수를 할당하여 등록할 수 있습니다.

    병합 함수는 부모 및 자식 인스턴스에 정의된 해당 옵션의 값을 각각 첫 번째 그리고 두 번째 인자로 받습니다.

  • 예제:

    const app = createApp({
      // 자체 옵션
      msg: 'Vue',
      // 믹스인으로부터 전달받는 옵션
      mixins: [
        {
          msg: '안녕 '
        }
      ],
      mounted() {
        // this.$options에 병합된 옵션이 노출됨
        console.log(this.$options.msg)
      }
    })
    
    // `msg`의 커스텀 병합 로직 정의
    app.config.optionMergeStrategies.msg = (parent, child) => {
      return (parent || '') + (child || '')
    }
    
    app.mount('#app')
    // 앱 mounted 트리거 후 로그: '안녕 Vue'
    
  • 참고: 컴포넌트 인스턴스 - $options

Application API has loaded