Solid2

History adapters

Import

import {
  browserHistory,
  hashHistory,
  memoryHistory,
  type MemoryHistoryAdapter,
  type RouterHistory,
} from "@solidjs/router";

RouterHistory

interface RouterHistory {
  get(): string | LocationChange;
  set(next: LocationChange): void;
  init?(notify: (value?: string | LocationChange) => void): () => void;
  utils?: Partial<RouterUtils>;
}
interface LocationChange<S = unknown> {
  value: string;
  replace?: boolean;
  scroll?: boolean;
  state?: S;
  rawPath?: string;
}

Pass a history adapter as createRouter({ history }). On the server, the request URL or router url prop selects the location.

browserHistory

function browserHistory(): RouterHistory;

Uses window.location, history.pushState, history.replaceState, and popstate. The router creates this adapter by default on the client.

hashHistory

function hashHistory(): RouterHistory;

Stores the routed path after #. The hashHistory renderPath utility prefixes generated Router.paths values with #.

const Router = createRouter({
  routes,
  history: hashHistory(),
});

memoryHistory

function memoryHistory(initial?: string): MemoryHistoryAdapter;

initial defaults to /.

interface MemoryHistoryAdapter extends RouterHistory {
  get(): string;
  go(delta: number): void;
  back(): void;
  forward(): void;
  listen(listener: (value: string) => void): () => void;
}
const history = memoryHistory("/users/42");
const Router = createRouter({ routes, history });


history.back();

Scroll restoration

createRouter wraps its default browser history with explicit scroll restoration unless scrollRestoration is false. A custom history adapter is not wrapped unless scrollRestoration is true.

Related

Last updated: 8/11/26, 7:55 PMEdit this pageReport an issue with this page