Skip to content
XMachines

Type Alias: SolidRouterHooks

API / @xmachines/play-solid-router / SolidRouterHooks

type SolidRouterHooks = object;

Defined in: packages/play-solid-router/src/play-router-provider.tsx:27

The three Solid Router hook results that PlayRouterProvider and SolidRouterBridge require. Pass these directly from your component’s hook calls:

const navigate = useNavigate(); // → SolidRouterHooks.navigate
const location = useLocation(); // → SolidRouterHooks.location
const params = useParams(); // → SolidRouterHooks.params
  • navigate — used to push URL changes when the actor’s currentRoute changes.
  • location — pathname and search are read at connect() time for deep-link sync. Subsequent pathname changes drive router→actor sync via createEffect.
  • params — Solid’s pre-parsed path parameters for the current route segment. Used directly in extractParams() to avoid re-parsing with URLPattern.

Properties

location

location: Location;

Defined in: packages/play-solid-router/src/play-router-provider.tsx:29

navigate: Navigator;

Defined in: packages/play-solid-router/src/play-router-provider.tsx:28

params

params: Params;

Defined in: packages/play-solid-router/src/play-router-provider.tsx:30