4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
138 lines
3.2 KiB
Markdown
138 lines
3.2 KiB
Markdown
---
|
|
category: Component
|
|
---
|
|
|
|
# computedInject
|
|
|
|
Combine `computed` and `inject`. Useful for creating a computed property based on an injected value.
|
|
|
|
## Usage
|
|
|
|
In Provider Component
|
|
|
|
```ts twoslash include main
|
|
import type { InjectionKey, Ref } from 'vue'
|
|
import { provide, ref } from 'vue'
|
|
|
|
interface Item {
|
|
key: number
|
|
value: string
|
|
}
|
|
|
|
export const ArrayKey: InjectionKey<Ref<Item[]>> = Symbol('symbol-key')
|
|
|
|
const array = ref([{ key: 1, value: '1' }, { key: 2, value: '2' }, { key: 3, value: '3' }])
|
|
|
|
provide(ArrayKey, array)
|
|
```
|
|
|
|
In Receiver Component
|
|
|
|
```ts
|
|
// @filename: provider.ts
|
|
// @include: main
|
|
// ---cut---
|
|
import { computedInject } from '@vueuse/core'
|
|
|
|
import { ArrayKey } from './provider'
|
|
|
|
const computedArray = computedInject(ArrayKey, (source) => {
|
|
const arr = [...source.value]
|
|
arr.unshift({ key: 0, value: 'all' })
|
|
return arr
|
|
})
|
|
```
|
|
|
|
### Default Value
|
|
|
|
You can provide a default value that will be used if the injection key is not provided by a parent component.
|
|
|
|
```ts
|
|
import { computedInject } from '@vueuse/core'
|
|
|
|
const computedArray = computedInject(
|
|
ArrayKey,
|
|
(source) => {
|
|
return source.value.map(item => item.value)
|
|
},
|
|
ref([]), // default source value
|
|
)
|
|
```
|
|
|
|
### Factory Default
|
|
|
|
Pass `true` as the fourth argument to treat the default value as a factory function.
|
|
|
|
```ts
|
|
import { computedInject } from '@vueuse/core'
|
|
|
|
const computedArray = computedInject(
|
|
ArrayKey,
|
|
(source) => {
|
|
return source.value.map(item => item.value)
|
|
},
|
|
() => ref([]), // factory function for default
|
|
true, // treat default as factory
|
|
)
|
|
```
|
|
|
|
### Writable Computed
|
|
|
|
You can also create a writable computed property by passing an object with `get` and `set` functions.
|
|
|
|
```ts
|
|
import { computedInject } from '@vueuse/core'
|
|
|
|
const computedArray = computedInject(ArrayKey, {
|
|
get(source) {
|
|
return source.value.map(item => item.value)
|
|
},
|
|
set(value) {
|
|
// handle setting the value
|
|
console.log('Setting value:', value)
|
|
},
|
|
})
|
|
```
|
|
|
|
## Type Declarations
|
|
|
|
```ts
|
|
export type ComputedInjectGetter<T, K> = (
|
|
source: T | undefined,
|
|
oldValue?: K,
|
|
) => K
|
|
export type ComputedInjectGetterWithDefault<T, K> = (
|
|
source: T,
|
|
oldValue?: K,
|
|
) => K
|
|
export type ComputedInjectSetter<T> = (v: T) => void
|
|
export interface WritableComputedInjectOptions<T, K> {
|
|
get: ComputedInjectGetter<T, K>
|
|
set: ComputedInjectSetter<K>
|
|
}
|
|
export interface WritableComputedInjectOptionsWithDefault<T, K> {
|
|
get: ComputedInjectGetterWithDefault<T, K>
|
|
set: ComputedInjectSetter<K>
|
|
}
|
|
export declare function computedInject<T, K = any>(
|
|
key: InjectionKey<T> | string,
|
|
getter: ComputedInjectGetter<T, K>,
|
|
): ComputedRef<K | undefined>
|
|
export declare function computedInject<T, K = any>(
|
|
key: InjectionKey<T> | string,
|
|
options: WritableComputedInjectOptions<T, K>,
|
|
): ComputedRef<K | undefined>
|
|
export declare function computedInject<T, K = any>(
|
|
key: InjectionKey<T> | string,
|
|
getter: ComputedInjectGetterWithDefault<T, K>,
|
|
defaultSource: T,
|
|
treatDefaultAsFactory?: false,
|
|
): ComputedRef<K>
|
|
export declare function computedInject<T, K = any>(
|
|
key: InjectionKey<T> | string,
|
|
options: WritableComputedInjectOptionsWithDefault<T, K>,
|
|
defaultSource: T | (() => T),
|
|
treatDefaultAsFactory: true,
|
|
): ComputedRef<K>
|
|
```
|