feat(useUrlSearchParams): add write option (#2165)

vueuse · Sep 4, 2022 · 7b2887e · 7b2887e
1 parent 48bf343
commit 7b2887e
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/packages/core/useUrlSearchParams/index.ts b/packages/core/useUrlSearchParams/index.ts
@@ -21,6 +21,13 @@ export interface UseUrlSearchParamsOptions<T> extends ConfigurableWindow {
    * @default {}
    */
   initialValue?: T
+
+  /**
+   * Write back to `window.history` automatically
+   *
+   * @default true
+   */
+  write?: boolean
 }
 
 /**
@@ -38,6 +45,7 @@ export function useUrlSearchParams<T extends Record<string, any> = UrlParams>(
     initialValue = {},
     removeNullishValues = true,
     removeFalsyValues = false,
+    write: enableWrite = true,
     window = defaultWindow!,
   } = options
 
@@ -126,6 +134,9 @@ export function useUrlSearchParams<T extends Record<string, any> = UrlParams>(
   }
 
   function onChanged() {
+    if (!enableWrite)
+      return
+
     write(read(), true)
   }