Vue.js

外観

目次

Composition API:
依存関係の注入 ​

provide() ​

子孫コンポーネントから注入可能な値を提供する。

  • 型

    ts
    function provide<T>(key: InjectionKey<T> | string, value: T): void

  • 詳細

    provide() はキー（文字列またはシンボル）と注入される値の 2 つの引数を取ります。

    TypeScript を使用する場合、キーは InjectionKey としてキャストされたシンボルにできます。これは Symbol を継承した Vue のユーティリティー型で、 provide() と inject() の間で値の型を同期するために使用されます。

    ライフサイクルフック登録 API と同様に、provide() はコンポーネントの setup() フェーズで同期的に呼び出される必要があります。

  • 例

    vue
    <script setup>
import { ref, provide } from 'vue'
import { countSymbol } from './injectionSymbols'

// 静的な値を提供
provide('path', '/project/')

// リアクティブな値を提供
const count = ref(0)
provide('count', count)

// シンボルのキーを使って提供
provide(countSymbol, count)
</script>

  • 参照

inject() ​

祖先のコンポーネントや（app.provide() 経由で）アプリケーションから提供された値を注入します。

  • 型

    ts
    // デフォルト値なし
function inject<T>(key: InjectionKey<T> | string): T | undefined

// デフォルト値あり
function inject<T>(key: InjectionKey<T> | string, defaultValue: T): T

// ファクトリーを使用
function inject<T>(
  key: InjectionKey<T> | string,
  defaultValue: () => T,
  treatDefaultAsFactory: true
): T

  • 詳細

    最初の引数は、注入キーです。Vue は、キーに一致する提供された値を見つけるために親チェーンを探索します。親チェーンにある複数のコンポーネントが同じキーを提供する場合、注入するコンポーネントに最も近いものが、より上位のコンポーネントを「シャドウ」します。キーに一致する値が見つからなかった場合、inject() はデフォルト値が提供されていない限り undefined を返します。

    第 2 引数は省略可能で、一致する値が見つからなかった場合に使用されるデフォルト値です。

    第 2 引数には、作成にコストがかかる値を返すファクトリー関数を指定することもできます。この場合、値そのものではなく、その関数をファクトリーとして使用することを示すために、第 3 引数に true を渡す必要があります。

    ライフサイクルフック登録 API と同様に、inject() はコンポーネントの setup() フェーズで同期的に呼び出される必要があります。

    TypeScript を使用する場合、キーは InjectionKey 型にできます。これは Symbol を継承した Vue のユーティリティー型で、 provide() と inject() の間で値の型を同期するために使用されます。

  • 例

    前の provide() の例で示したように、親コンポーネントが値を提供したと仮定します:

    vue
    <script setup>
import { inject } from 'vue'
import { countSymbol } from './injectionSymbols'

// デフォルト値なしの静的な値を注入
const path = inject('path')

// リアクティブな値を注入
const count = inject('count')

// シンボルのキーを使って注入
const count2 = inject(countSymbol)

// デフォルト値ありで注入
const bar = inject('path', '/default-path')

// 関数のデフォルト値を使って注入
const fn = inject('function', () => {})

// デフォルト値のファクトリーを使って注入
const baz = inject('factory', () => new ExpensiveObject(), true)
</script>

  • 参照

hasInjectionContext() ​

inject() が警告なしで使用できる場合に true を返します（setup() の外側など、間違った場所で呼び出されたという警告）。このメソッドは、エンドユーザーに警告を出すことなく、内部的に inject() を使用したいライブラリーが使用するように設計されています。

  • 型

    ts
    function hasInjectionContext(): boolean

このページを GitHub で編集