Skip to content

injectLocal

Category
Export Size
246 B
Last Changed
2 weeks ago

Extended inject with ability to call provideLocal to provide the value in the same component.

Usage

vue
<script setup>
import { 
injectLocal
,
provideLocal
} from '@vueuse/core'
provideLocal
('MyInjectionKey', 1)
const
injectedValue
=
injectLocal
('MyInjectionKey') // injectedValue === 1
</script>

Type Declarations

ts
/**
 * On the basis of `inject`, it is allowed to directly call inject to obtain the value after call provide in the same component.
 *
 * @example
 * ```ts
 * injectLocal('MyInjectionKey', 1)
 * const injectedValue = injectLocal('MyInjectionKey') // injectedValue === 1
 * ```
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare const 
injectLocal
: typeof
inject

Source

SourceDocs

Contributors

Anthony Fu
ZHAO Jin-Xiang
SerKo
Anthony Fu

Changelog

d32f8 - refactor: add @__NO_SIDE_EFFECTS__ annotations to all pure functions (#4907)
b08a9 - fix: allow inject to app context
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)
cf757 - fix: vue 2 support for provideLocal and injectLocal (#3464)
5d948 - feat(createInjectionState): allow provide and inject in same component (#3387)

Released under the MIT License.