From 4779d31e3f7fc3b886a90f7ef78ce625746b9b0d Mon Sep 17 00:00:00 2001 From: waldonUB <852727515@qq.com> Date: Sat, 3 Sep 2022 23:09:43 +0800 Subject: [PATCH 1/5] fix: add option in useUrlSearchParams --- packages/core/useUrlSearchParams/index.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/packages/core/useUrlSearchParams/index.ts b/packages/core/useUrlSearchParams/index.ts index a859a6a98a1..19ceda1af3e 100644 --- a/packages/core/useUrlSearchParams/index.ts +++ b/packages/core/useUrlSearchParams/index.ts @@ -21,6 +21,11 @@ export interface UseUrlSearchParamsOptions extends ConfigurableWindow { * @default {} */ initialValue?: T + + /** + * @default false + */ + onlyRead?: boolean } /** @@ -38,6 +43,7 @@ export function useUrlSearchParams = UrlParams>( initialValue = {}, removeNullishValues = true, removeFalsyValues = false, + onlyRead = false, window = defaultWindow!, } = options @@ -126,6 +132,9 @@ export function useUrlSearchParams = UrlParams>( } function onChanged() { + if (onlyRead) { + return + } write(read(), true) } From 22cc72248ac282fe4b7ed4d6cd777c32c0bb111d Mon Sep 17 00:00:00 2001 From: waldonUB <852727515@qq.com> Date: Sun, 4 Sep 2022 11:14:58 +0800 Subject: [PATCH 2/5] fix: change variable name and add description --- packages/core/useUrlSearchParams/index.ts | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/packages/core/useUrlSearchParams/index.ts b/packages/core/useUrlSearchParams/index.ts index 19ceda1af3e..7a6b460fd4d 100644 --- a/packages/core/useUrlSearchParams/index.ts +++ b/packages/core/useUrlSearchParams/index.ts @@ -23,9 +23,11 @@ export interface UseUrlSearchParamsOptions extends ConfigurableWindow { initialValue?: T /** - * @default false + * Write back to `window.history` automatically + * + * @default true */ - onlyRead?: boolean + autoWrite?: boolean } /** @@ -43,7 +45,7 @@ export function useUrlSearchParams = UrlParams>( initialValue = {}, removeNullishValues = true, removeFalsyValues = false, - onlyRead = false, + autoWrite = true, window = defaultWindow!, } = options @@ -132,7 +134,7 @@ export function useUrlSearchParams = UrlParams>( } function onChanged() { - if (onlyRead) { + if (!autoWrite) { return } write(read(), true) From c89469324c1e3f02b29b19dfcd87edf3326f2f65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=93=E4=B8=9A=E9=80=AE=E8=99=BE=E6=88=B7aa?= <30494925+waldonUB@users.noreply.github.com> Date: Sun, 4 Sep 2022 17:46:50 +0800 Subject: [PATCH 3/5] Update packages/core/useUrlSearchParams/index.ts Co-authored-by: Chris <1633711653@qq.com> --- packages/core/useUrlSearchParams/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/useUrlSearchParams/index.ts b/packages/core/useUrlSearchParams/index.ts index 7a6b460fd4d..0b961e85335 100644 --- a/packages/core/useUrlSearchParams/index.ts +++ b/packages/core/useUrlSearchParams/index.ts @@ -27,7 +27,7 @@ export interface UseUrlSearchParamsOptions extends ConfigurableWindow { * * @default true */ - autoWrite?: boolean + autoWrite?: boolean } /** From 7e8edf9cb1b801c9c1b9f254e6a1ec83b280d224 Mon Sep 17 00:00:00 2001 From: waldonUB <852727515@qq.com> Date: Sun, 4 Sep 2022 17:55:02 +0800 Subject: [PATCH 4/5] fix: Update the format --- packages/core/useUrlSearchParams/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/useUrlSearchParams/index.ts b/packages/core/useUrlSearchParams/index.ts index 0b961e85335..c3f6391914d 100644 --- a/packages/core/useUrlSearchParams/index.ts +++ b/packages/core/useUrlSearchParams/index.ts @@ -27,7 +27,7 @@ export interface UseUrlSearchParamsOptions extends ConfigurableWindow { * * @default true */ - autoWrite?: boolean + autoWrite?: boolean } /** From d627e8cd6039b1086f494c0cad4fa326ea006e57 Mon Sep 17 00:00:00 2001 From: Anthony Fu Date: Sun, 4 Sep 2022 18:00:20 +0800 Subject: [PATCH 5/5] chore: update --- packages/core/useUrlSearchParams/index.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/core/useUrlSearchParams/index.ts b/packages/core/useUrlSearchParams/index.ts index c3f6391914d..a4f55951668 100644 --- a/packages/core/useUrlSearchParams/index.ts +++ b/packages/core/useUrlSearchParams/index.ts @@ -27,7 +27,7 @@ export interface UseUrlSearchParamsOptions extends ConfigurableWindow { * * @default true */ - autoWrite?: boolean + write?: boolean } /** @@ -45,7 +45,7 @@ export function useUrlSearchParams = UrlParams>( initialValue = {}, removeNullishValues = true, removeFalsyValues = false, - autoWrite = true, + write: enableWrite = true, window = defaultWindow!, } = options @@ -134,9 +134,9 @@ export function useUrlSearchParams = UrlParams>( } function onChanged() { - if (!autoWrite) { + if (!enableWrite) return - } + write(read(), true) }