Interface History

back

• back(): void

• Move back one page in the history.

  Returns void

block

• block(blocker): (() => void)

• Registers a blocker that prevents navigation with history.

  Parameters

  • blocker: HistoryBlocker

    A blocker to register.

  Returns (() => void)

  A callback that removes blocker.

  • • (): void

    • Returns void

forward

• forward(): void

• Move forward one page in the history.

  Returns void

go

• go(delta): void

• Move forwards and backwards through the history depending on the delta.

  Parameters

  • delta: number

    The position in the history to which you want to move, relative to the current page. A negative value moves backwards, a positive value moves forwards.

  Returns void

push

• push(to): void

• Adds an entry to the history stack.

  Parameters

  • to: string | To

    A location to navigate to or a history-local URL.

  Returns void

  Example

  const userRoute = createRoute('/users/:userId');
  history.push(userRoute.getLocation({ userId: 42 }));
  // or
  history.push('/users/42');
  Copy

replace

• replace(to): void

• Modifies the current history entry, replacing it with the state object and URL passed in the method parameters.

  Parameters

  • to: string | To

    A location to navigate to or a history-local URL.

  Returns void

  Example

  const userRoute = createRoute('/users/:userId');
  history.replace(userRoute.getLocation({ userId: 42 }));
  // or
  history.replace('/users/42');
  Copy

subscribe

• subscribe(listener): (() => void)

• Subscribe to location changes.

  Parameters

  • listener: (() => void)

    A listener to subscribe.

    • • (): void

      • Returns void

  Returns (() => void)

  A callback to unsubscribe a listener.

  • • (): void

    • Returns void

toAbsoluteURL

• toAbsoluteURL(to): string

• Creates an absolute URL for a given location. If history was initialized with a basePathname then it is prepended to the returned URL.

  Note: The returned URL is incompatible with push and replace methods.

  Parameters

  • to: string | To

    A location or a history-local URL to create an absolute URL for.

  Returns string

toURL

• toURL(to): string

• Returns a history-local URL.

  This URL can be passed to push and replace as an argument.

  Parameters

  • to: To

  Returns string

Readonlylocation

Readonlyurl