ユーティリティー型 #

PropType<T> #

ランタイムプロパティ宣言を使用する際、より具体的な型でプロパティに注釈を付けるために使われます。

• 例

  ts

  import type { PropType } from 'vue'
  
  interface Book {
    title: string
    author: string
    year: number
  }
  
  export default {
    props: {
      book: {
        // より具体的な型を `Object` に提供します
        type: Object as PropType<Book>,
        required: true
      }
    }
  }
  

• 参照: ガイド - コンポーネントプロパティの型付け

ComponentCustomProperties #

コンポーネントインスタンス型を拡張してカスタムグローバルプロパティのサポートするのに使われます。

• 例

  ts

  import axios from 'axios'
  
  declare module 'vue' {
    interface ComponentCustomProperties {
      $http: typeof axios
      $translate: (key: string) => string
    }
  }
  

  TIP

  拡張するには、モジュールを .ts または .d.ts ファイルとして配置する必要があります。詳細はグローバルプロパティの拡張を参照してください。

• 参照: ガイド - グローバルプロパティの拡張

ComponentCustomOptions #

コンポーネントオプション型を拡張してカスタムオプションをサポートするのに使われます。

• 例

  ts

  import { Route } from 'vue-router'
  
  declare module 'vue' {
    interface ComponentCustomOptions {
      beforeRouteEnter?(to: any, from: any, next: () => void): void
    }
  }
  

  TIP

  拡張するには、モジュールを .ts または .d.ts ファイルとして配置する必要があります。詳細はグローバルプロパティの拡張を参照してください。

• 参照: ガイド - カスタムオプションの拡張

ComponentCustomProps #

TSX 要素のプロパティとして宣言されていないプロパティを拡張して TSX プロパティとして使用します。

• 例

  ts

  declare module 'vue' {
    interface ComponentCustomProps {
      hello?: string
    }
  }
  
  export {}
  

  tsx

  // hello が宣言されていないプロパティでも使えるようになります
  <MyComponent hello="world" />
  

  TIP

  拡張するには、モジュールを .ts または .d.ts ファイルとして配置する必要があります。詳細はグローバルプロパティの拡張を参照してください。

CSSProperties #

スタイルプロパティに適用できる値を拡張します。

• 例

  どんなカスタム CSS プロパティでも適用できます

  ts

  declare module 'vue' {
    interface CSSProperties {
      [key: `--${string}`]: string
    }
  }
  

  tsx

  <div style={ { '--bg-color': 'blue' } }>
  

  html

  <div :style="{ '--bg-color': 'blue' }">