Skip to content

provideLocal

Category
Export Size
226 B
Last Changed
5 months ago

Extended provide with ability to call injectLocal to obtain 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
export type 
ProvideLocalReturn
= void
/** * On the basis of `provide`, it is allowed to directly call inject to obtain the value after call provide in the same component. * * @example * ```ts * provideLocal('MyInjectionKey', 1) * const injectedValue = injectLocal('MyInjectionKey') // injectedValue === 1 * ``` */ export declare function
provideLocal
<
T
,
K
=
InjectionKey
<
T
> | string | number>(
key
:
K
,
value
:
K
extends
InjectionKey
<infer
V
> ?
V
:
T
,
):
ProvideLocalReturn

Source

SourceDocs

Contributors

ZHAO Jin-Xiang
Robin
Anthony Fu

Changelog

v13.1.0 on
c1d6e - feat(shared): ensure return types exists (#4659)
v12.0.0-beta.1 on
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)
v10.5.0 on
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.

FREE WEEKEND
Free access to Official Vue.js Certification Training
NOW LIVE
Start Now
23
hours
:
13
minutes
:
54
seconds
: