Solid Integration: usePathname Hook Documentation

The usePathname hook returns the current browser pathname with the locale segment stripped, as a Solid Accessor<string>. It is useful for building locale-aware navigation — for example, determining which nav item is active — without having to manually remove the locale prefix.

Importing usePathname in Solid

import { usePathname } from "solid-intlayer";

Overview

usePathname creates a reactive signal initialized from window.location.pathname, strips the locale prefix via getPathWithoutLocale, and updates the signal whenever the browser fires a popstate event (back/forward navigation). The event listener is cleaned up automatically via onCleanup.

Usage

import type { Component } from "solid-js";import { usePathname } from "solid-intlayer";type NavItemProps = {  href: string;  label: string;};const NavItem: Component<NavItemProps> = ({ href, label }) => {  const pathname = usePathname();  return (    <a href={href} aria-current={pathname() === href ? "page" : undefined}>      {label}    </a>  );};export default NavItem;

Return Value

Behavior

• Locale stripping: Removes the leading locale segment (e.g. /fr/dashboard → /dashboard).
• Reactive: Updates automatically on popstate events (browser back / forward navigation).
• SSR-safe: Returns "" when window is not available.
• Cleanup: The popstate listener is removed automatically via Solid's onCleanup.

Example

import type { Component } from "solid-js";import { For } from "solid-js";import { usePathname } from "solid-intlayer";const links = [  { href: "/dashboard", label: "Dashboard" },  { href: "/settings", label: "Settings" },];const Sidebar: Component = () => {  const pathname = usePathname();  return (    <nav>      <For each={links}>        {({ href, label }) => (          <a            href={href}            style={{ "font-weight": pathname() === href ? "bold" : "normal" }}          >            {label}          </a>        )}      </For>    </nav>  );};export default Sidebar;

Related

• useLocale — current locale + locale switcher
• getPathWithoutLocale — the underlying utility used by this hook