Signature

type NavigateFunction = (
  to: string | number | Partial<Pick<URL, "pathname" | "search" | "hash">>,
  options?: NavigateOptions,
) => void;

Contract

Accepts a string URL, a numeric history delta, or a partial URL containing pathname, search, and hash. A second NavigateOptions argument controls URL navigation. Returns void.

import type { NavigateFunction } from "@kasperrt/smolter/preact";

export function clearFragment(navigate: NavigateFunction): void {
  navigate({ hash: "" }, { replace: true });
}

Usage and limits

Missing fields in a partial URL retain their current values. Numeric history navigation requires a browser and ignores the options argument. Use router.navigate when an awaitable navigation promise is needed.