vueuse 中文文档

Vue useUrlSearchParams 获取和设置url参数

Vue useUrlSearchParams 获取和设置url参数,这是一个非常有用的函数,我们在实际开发中经常或需要获取url参数的值,当然我们可以通过vue的路由和页面的属性获取,但是无法进行修改该参数,而useUrlSearchParams则是响应式的可以进行修改。

代码示例

iimport { useUrlSearchParams } from '@vueuse/core'

const params = useUrlSearchParams('history')

console.log(params)  

params.id= '100';
params.name= 'itxst.com'
// url参数更新为 100和itxst.com

hash模式

import { useUrlSearchParams } from '@vueuse/core'

const params = useUrlSearchParams('hash')

params.id= '100';
params.name= 'itxst.com'
// url updated to `#/your/route?id=100&itxst.com`

Hash Params

import { useUrlSearchParams } from '@vueuse/core'


const params = useUrlSearchParams('hash-params')

params.id= '100';
params.name= 'itxst.com'
// url updated to `/your/route#id=100&name=itxst.com`

在线例子

在线试一试

类型定义

export type UrlParams = Record<string, string[] | string>
export interface UseUrlSearchParamsOptions<T> extends ConfigurableWindow {
  /**
   * @default true
   */
  removeNullishValues?: boolean
  /**
   * @default false
   */
  removeFalsyValues?: boolean
  /**
   * @default {}
   */
  initialValue?: T
  /**
   * Write back to `window.history` automatically
   *
   * @default true
   */
  write?: boolean
}
/**
 * Reactive URLSearchParams
 *
 * @see https://vueuse.org/useUrlSearchParams
 * @param mode
 * @param options
 */
export declare function useUrlSearchParams<
  T extends Record<string, any> = UrlParams,
>(
  mode?: "history" | "hash" | "hash-params",
  options?: UseUrlSearchParamsOptions<T>,
): T
Catalog
vueuse 入门 State 状态 Elements 元素 Browser 浏览器 useBluetooth 蓝牙函数 useBreakpoints 网页网格断点 useBroadcastChannel 跨网页通讯 useBrowserLocation 响应式location useClipboard 粘贴复制 useColorMode 皮肤颜色切换 useCssVar 修改css变量 useEventListener 事件监听 useEyeDropper 取色器 useFavicon 设置浏览器窗口图标 useFileDialog 文件选择器 useFileSystemAccess 操作本地文件 useFullscreen 全屏模式 useGamepad 游戏手柄 useImage 图片 useMediaControls 视频音频控制 useMediaQuery 媒体查询 useMemory 响应式内存信息 useObjectUrl 响应式对象URL usePerformanceObserver 性能指标 usePermission 判断 api 权限 usePreferredColorScheme 获取系统主题 usePreferredContrast 色彩对比度 usePreferredDark 黑暗主题 usePreferredLanguages 用户系统语言 useScreenOrientation 屏幕方向API useScreenSafeArea 屏幕安全区域 useScriptTag 动态加载js文件 useShare 分享功能 useStyleTag 动态注入CSS useTextareaAutosize textarea自适应高度 useUrlSearchParams 获取设置URL参数 useTextDirection 文字方向 useTitle 修改网页标题 useVibrate 手机振动功能 useWakeLock 防止屏幕变黑或锁屏 useWebNotification 显示桌面通知 useWebWorker 创建多线程任务 useWebWorkerFn 多线程函数 Sensors 感应监测