moeka-project/.agents/skills/vueuse-functions/references/useRouteHash.md

category

category
@Router

useRouteHash

Shorthand for a reactive route.hash.

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, RouteHashValueRaw>