skills/vueuse-functions/references/useBrowserLocation.md
Reactive browser location
NOTE: If you're using Vue Router, use
useRouteprovided by Vue Router instead.
import { useBrowserLocation } from '@vueuse/core'
const location = useBrowserLocation()
<UseBrowserLocation v-slot="location">
Browser Location: {{ location }}
</UseBrowserLocation>
export interface UseBrowserLocationOptions extends ConfigurableWindow {}
export interface BrowserLocationState {
readonly trigger: string
readonly state?: any
readonly length?: number
readonly origin?: string
hash?: string
host?: string
hostname?: string
href?: string
pathname?: string
port?: string
protocol?: string
search?: string
}
export type UseBrowserLocationReturn = Ref<BrowserLocationState>
/**
* Reactive browser location.
*
* @see https://vueuse.org/useBrowserLocation
*
* @__NO_SIDE_EFFECTS__
*/
export declare function useBrowserLocation(
options?: UseBrowserLocationOptions,
): UseBrowserLocationReturn