vue-use-query-param

IMPORTANT: This plugin has a peer dependency on vue-router.
It will only work when using vue-router in your Vue app.

Features

• Get & set query parameters from the URL in a typesafe way
• Use query parameters like regular ref's

Don't want to read the rest of the README? Check out the examples.

Installing

npm

npm install vue-use-query-param

pnpm

pnpm add vue-use-query-param

yarn

yarn add vue-use-query-param

Usage

Add the plugin to your Vue app

import { createApp } from "vue";
import { createRouter } from "vue-router";
import useQueryParamPlugin from "vue-use-query-param";

const router = createRouter({ ... });

const app = createApp(App);
app.use(router);
app.use(useQueryParamPlugin, {});
app.mount("#app");

Use the useQueryParam composable

<script setup lang="ts">
import { stringParam, useQueryParam } from "vue-use-query-param";

// foo is a `Ref<string | undefined>`, use it like any other ref
// When setting foo, the URL will be modified, a query parameter `foo` will
// be added or updated. (or removed if you're setting `foo` to undefined.)
const foo = useQueryParam("foo", stringParam());

foo.value = "bar";
</script>

<template>
  <!-- Reactively updates -->
  {{ foo }}
</template>

Non-nullable query parameters (default values)

If your query parameter should always have a value, you can set a default value like this:

import { stringParam, useQueryParam, withDefault } from "vue-use-query-param";
const foo = useQueryParam("foo", withDefault(stringParam(), "bar"));

Supported types

Currently only a few basic types are supported.

• stringParam: for strings
• numberParam: for numbers (integers and floats)
• objectParam: custom Objects that will be serialized to JSON.
• booleanParam: for booleans
• dateParam: for dates and datetime
• arrayParam: for arrays of the above types
  NOTE: Nested arrays are currently only possible using objectParam. e.g.: objectParam<number[][]>();

For some examples on how to use these, check out these examples.

Extra options

Debounce time

Internally, to be able to set multiple query parameters at once, we don't update the URL immediately after every change. We use setTimeout to debounce the updates.
By default the debounce time is set to 0, meaning it will update the URL as soon as possible.
If however you want to delay this more, you can set the debounceTime option when adding the plugin to the Vue app.

app.use(useQueryParamPlugin, { debounceTime: 100 });
...
const foo = useQueryParam("foo", stringParam());
const bar = useQueryParam("bar", stringParam());

// the `foo` and `bar` query parameters in the URL won't be updated immediately, but only after 150ms.
// (50 ms for the bar timeout + 100ms for the debounce time)
foo.value = "fooval";
setTimeout(() => {
  bar.value = "barval";
}, 50);

Credits

How to publish a TypeScript package to npm

TypeScript NPM Package Publishing: A Beginner’s Guide (by Paul Ehikhuemen)

Inspiration for this package

I'm originally a React dev and I made much use of the use-query-params hook.

Sponsors

The original need for this plugin came when working on a project for ai-Gust. An initial implementation of useQueryParam was made there.
They were so kind to let me make this into a separate npm module and make it open source for the world to enjoy.
I've since built on this initial implementation.