computedWithControl

Category

Reactivity

Export Size

267 B

Last Changed

3 hours ago

Alias

controlledComputed

Related

refWithControl

显式定义计算属性的依赖关系。

用法

TypeScript

import { computedWithControl } from '@vueuse/core'

const source = ref('foo')
const counter = ref(0)

const computedRef = computedWithControl(
  () => source.value, // 监视 source，与 `watch` 相同
  () => counter.value, // 计算属性的 getter，与 `computed` 相同
)

import { computedWithControl } from '@vueuse/core'
const source = ref('foo')
const counter = ref(0)
const computedRef = computedWithControl(
  () => source.value, // 监视 source，与 `watch` 相同
  () => counter.value,
)

通过这种方式，counter 的更改不会触发 computedRef 更新，但是 source ref 会。

console.log(computedRef.value) // 0

counter.value += 1

console.log(computedRef.value) // 0

source.value = 'bar'

console.log(computedRef.value) // 1

手动触发

您还可以通过以下方式手动触发计算属性的更新：

const computedRef = computedWithControl(
  () => source.value,
  () => counter.value,
)

computedRef.trigger()

WARNING

手动触发仅适用于 Vue 3

Type Declarations

export interface ComputedWithControlRefExtra {
  /**
   * Force update the computed value.
   */
  trigger: () => void
}
export interface ComputedRefWithControl<T>
  extends ComputedRef<T>,
    ComputedWithControlRefExtra {}
export interface WritableComputedRefWithControl<T>
  extends WritableComputedRef<T>,
    ComputedWithControlRefExtra {}
export declare function computedWithControl<T, S>(
  source: WatchSource<S> | WatchSource<S>[],
  fn: ComputedGetter<T>,
): ComputedRefWithControl<T>
export declare function computedWithControl<T, S>(
  source: WatchSource<S> | WatchSource<S>[],
  fn: WritableComputedOptions<T>,
): WritableComputedRefWithControl<T>
export { computedWithControl as controlledComputed }

Source

Source • Docs

Contributors

jorshen

Changelog

No recent changes