From 2acf3e84b95d7f18925b4d7ada92f1992f5b7ee3 Mon Sep 17 00:00:00 2001 From: Evan You Date: Wed, 22 Apr 2020 18:00:10 -0400 Subject: [PATCH] feat(reactivity): add triggerRef API Also make shallowRef assignment behavior consistent with normal ref --- packages/reactivity/__tests__/ref.spec.ts | 4 ++-- packages/reactivity/src/index.ts | 1 + packages/reactivity/src/ref.ts | 11 ++++++++++- packages/runtime-core/src/index.ts | 1 + 4 files changed, 14 insertions(+), 3 deletions(-) diff --git a/packages/reactivity/__tests__/ref.spec.ts b/packages/reactivity/__tests__/ref.spec.ts index f6fc7f2319a..e0929e53526 100644 --- a/packages/reactivity/__tests__/ref.spec.ts +++ b/packages/reactivity/__tests__/ref.spec.ts @@ -9,7 +9,7 @@ import { isReactive } from '../src/index' import { computed } from '@vue/runtime-dom' -import { shallowRef, unref, customRef } from '../src/ref' +import { shallowRef, unref, customRef, triggerRef } from '../src/ref' describe('reactivity/ref', () => { it('should hold a value', () => { @@ -194,7 +194,7 @@ describe('reactivity/ref', () => { expect(dummy).toBe(1) // should not trigger yet // force trigger - sref.value = sref.value + triggerRef(sref) expect(dummy).toBe(2) }) diff --git a/packages/reactivity/src/index.ts b/packages/reactivity/src/index.ts index ea0a9592ce2..0ac9e5f3cc3 100644 --- a/packages/reactivity/src/index.ts +++ b/packages/reactivity/src/index.ts @@ -6,6 +6,7 @@ export { toRef, toRefs, customRef, + triggerRef, Ref, UnwrapRef } from './ref' diff --git a/packages/reactivity/src/ref.ts b/packages/reactivity/src/ref.ts index 59badad4d56..22d9c233025 100644 --- a/packages/reactivity/src/ref.ts +++ b/packages/reactivity/src/ref.ts @@ -55,7 +55,7 @@ function createRef(rawValue: unknown, shallow = false) { return value }, set value(newVal) { - if (shallow || hasChanged(toRaw(newVal), rawValue)) { + if (hasChanged(toRaw(newVal), rawValue)) { rawValue = newVal value = shallow ? newVal : convert(newVal) trigger( @@ -70,6 +70,15 @@ function createRef(rawValue: unknown, shallow = false) { return r } +export function triggerRef(ref: Ref) { + trigger( + ref, + TriggerOpTypes.SET, + 'value', + __DEV__ ? { newValue: ref.value } : void 0 + ) +} + export function unref(ref: T): T extends Ref ? V : T { return isRef(ref) ? (ref.value as any) : ref } diff --git a/packages/runtime-core/src/index.ts b/packages/runtime-core/src/index.ts index 316e1c7df64..3bf99a71ebf 100644 --- a/packages/runtime-core/src/index.ts +++ b/packages/runtime-core/src/index.ts @@ -16,6 +16,7 @@ export { isReadonly, // advanced customRef, + triggerRef, shallowRef, shallowReactive, shallowReadonly,