Files
stack/packages/mosaic/framework/skills/vueuse-functions/references/useBrowserLocation.md
T
fargo 1a822493ba format: apply repo prettier (3.8.1) to the folded skills tree
963 markdown files reformatted with the repository's pinned prettier so
pnpm format:check covers the folded tree like every other repo file.

The formatter's embedded-language pass also normalized code fences
(TS semicolons, closed HTML tags in examples, lowercased CSS hex colors,
one renumbered list that skipped an index). Alphanumeric token deltas vs
the fold commit were audited file-by-file; all are formatter-equivalent
markup normalizations plus the four sanitized skills.
2026-08-19 14:37:17 -05:00

1.9 KiB

category
category
Browser

useBrowserLocation

Reactive browser location

NOTE: If you're using Vue Router, use useRoute provided by Vue Router instead.

Usage

import { useBrowserLocation } from '@vueuse/core';

const location = useBrowserLocation();

Component Usage

<UseBrowserLocation v-slot="location">
  Browser Location: {{ location }}
</UseBrowserLocation>

Type Declarations

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;
}
/**
 * Reactive browser location.
 *
 * @see https://vueuse.org/useBrowserLocation
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useBrowserLocation(options?: ConfigurableWindow): Ref<
  {
    readonly trigger: string;
    readonly state?: any;
    readonly length?: number | undefined;
    readonly origin?: string | undefined;
    hash?: string | undefined;
    host?: string | undefined;
    hostname?: string | undefined;
    href?: string | undefined;
    pathname?: string | undefined;
    port?: string | undefined;
    protocol?: string | undefined;
    search?: string | undefined;
  },
  | BrowserLocationState
  | {
      readonly trigger: string;
      readonly state?: any;
      readonly length?: number | undefined;
      readonly origin?: string | undefined;
      hash?: string | undefined;
      host?: string | undefined;
      hostname?: string | undefined;
      href?: string | undefined;
      pathname?: string | undefined;
      port?: string | undefined;
      protocol?: string | undefined;
      search?: string | undefined;
    }
>;
export type UseBrowserLocationReturn = ReturnType<typeof useBrowserLocation>;