useRouteHash

Category

@Router

Export Size

514 B

Package

@vueuse/router

Last Changed

2 years ago

Shorthand for a reactive route.hash. Available in the @vueuse/router add-on.

Usage

import { useRouteHash } from '@vueuse/router'

const search = useRouteHash()

console.log(search.value) // route.hash
search.value = 'foobar' // router.replace({ hash: 'foobar' })

Type Declarations

export declare function useRouteHash(
  defaultValue?: MaybeRefOrGetter<RouteHashValueRaw>,
  { mode, route, router }?: ReactiveRouteOptions,
): Ref<RouteHashValueRaw>

Source

Source • Docs

Contributors

Anthony Fu

Antério Vieira

Dvir Hazout

Curt Grimes

Changelog

v10.3.0 on 7/30/2023

0d02f - fix(router): improves router functions: synchronize values, adds tests, and optimize performance (#3184)

v10.2.0 on 6/16/2023

d5252 - fix(useRouteHash,useRouteQuery,useRouteParams): re-evaluates the value immediately (#3002)

v9.4.0 on 10/25/2022

be36a - fix(useRouteHash, useRouteParams, useRouteQuery): override only selected route param (#2350)