Vue.js

Зовнішній вигляд

На цій сторінці

Композиційний АРІ:
Ін'єкція залежностей ​

provide() ​

Надає значення, яке може бути вставлено компонентами-нащадками.

  • Тип

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

  • Подробиці

    provide() приймає два аргументи: ключ, який може бути рядком або символом, і значення, яке потрібно ввести.

    Під час використання TypeScript ключ може бути символом, приведеним утилітою типу InjectionKey наданою Vue, яка розширює Symbol, який можна використовувати для синхронізації типу значення між 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, якщо не вказано значення за замовчуванням.

    Другий аргумент є необов'язковим і є значенням за замовчуванням, яке використовується, якщо відповідне значення не знайдено. Це також може бути фабрична функція для повернення значень, створення яких є дорогим. Якщо значенням за замовчуванням є функція, тоді третім аргументом потрібно передати false, щоб вказати, що функція має використовуватися як значення замість фабрики.

    Другим аргументом також може бути фабрична функція, яка повертає значення, створення яких є дорогим. У цьому випадку "true" має бути передано як третій аргумент, щоб вказати, що функція має використовуватися як фабрика замість самого значення.

    Подібно до API реєстрації хуків життєвого циклу, inject() має викликатися синхронно під час фази setup() компонента.

    Під час використання TypeScript ключ може бути символом, приведеним утилітою типу InjectionKey наданою Vue, яка розширює Symbol, який можна використовувати для синхронізації типу значення між 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', () => {})

// ввести зі значенням за замовчуванням функцію, передаючи 3-й аргумент
const baz = inject('factory', () => new ExpensiveObject(), true)
</script>

hasInjectionContext() ​

Повертає true, якщо inject() можна використовувати без попередження про те, що його викликають не в тому місці (наприклад, поза setup()). Цей метод призначений для використання бібліотеками, які хочуть використовувати inject() всередині без ініціювання попередження для кінцевого користувача.

Редагувати цю сторінку на GitHub