Version 0.10.0 requires Solid v1.8.4 or later.
A router lets you change your view based on the URL in the browser. This allows your "single-page" application to simulate a traditional multipage site. To use Solid Router, you specify components called Routes that depend on the value of the URL (the "path"), and the router handles the mechanism of swapping them in and out.
Solid Router is a universal router for SolidJS - it works whether you're rendering on the client or on the server. It was inspired by and combines paradigms of React Router and the Ember Router. Routes can be defined directly in your app's template using JSX, but you can also pass your route configuration directly as an object. It also supports nested routing, so navigation can change a part of a component, rather than completely replacing it.
It supports all of Solid's SSR methods and has Solid's transitions baked in, so use it freely with suspense, resources, and lazy components. Solid Router also allows you to define a load function that loads parallel to the routes (render-as-you-fetch).
- Getting Started
- Dynamic Routes
- Nested Routes
- Hash Mode Router
- Memory Mode Router
- Data APIs
- Config Based Routing
- Components
- Router Primitives
- SPAs in Deployed Environments
> npm i @solidjs/routerInstall @solidjs/router, then start your application by rendering the router component
import { render } from "solid-js/web";
import { Router } from "@solidjs/router";
render(
() => <Router />,
document.getElementById("app")
);This sets up a Router that will match on the url to display the desired page
Solid Router allows you to configure your routes using JSX:
- Add each route to a
<Router>using theRoutecomponent, specifying a path and a component to render when the user navigates to that path.
import { render } from "solid-js/web";
import { Router, Route } from "@solidjs/router";
import Home from "./pages/Home";
import Users from "./pages/Users";
render(() => (
<Router>
<Route path="/users" component={Users} />
<Route path="/" component={Home} />
</Router>
), document.getElementById("app"));- Provide a root level layout
This will always be there and won't update on page change. It is the ideal place to put top level navigation and Context Providers
import { render } from "solid-js/web";
import { Router, Route } from "@solidjs/router";
import Home from "./pages/Home";
import Users from "./pages/Users";
const App = props => (
<>
<h1>My Site with lots of pages</h1>
{props.children}
</>
)
render(() => (
<Router root={App}>
<Route path="/users" component={Users} />
<Route path="/" component={Home} />
</Router>
), document.getElementById("app"));- Create a CatchAll Route (404 page)
We can create catchall routes for pages not found at any nested level of the router. We use * and optionally the name of a parameter to retrieve the rest of the path.
import { render } from "solid-js/web";
import { Router, Route } from "@solidjs/router";
import Home from "./pages/Home";
import Users from "./pages/Users";
import NotFound from "./pages/404";
const App = props => (
<>
<h1>My Site with lots of pages</h1>
{props.children}
</>
)
render(() => (
<Router root={App}>
<Route path="/users" component={Users} />
<Route path="/" component={Home} />
<Route path="*404" component={NotFound} />
</Router>
), document.getElementById("app"));- Lazy-load route components
This way, the Users and Home components will only be loaded if you're navigating to /users or /, respectively.
import { lazy } from "solid-js";
import { render } from "solid-js/web";
import { Router, Route } from "@solidjs/router";
const Users = lazy(() => import("./pages/Users"));
const Home = lazy(() => import("./pages/Home"));
const App = props => (
<>
<h1>My Site with lots of pages</h1>
{props.children}
</>
)
render(() => (
<Router root={App}>
<Route path="/users" component={Users} />
<Route path="/" component={Home} />
</Router>
), document.getElementById("app"));Use an anchor tag that takes you to a route:
import { lazy } from "solid-js";
import { render } from "solid-js/web";
import { Router, Route } from "@solidjs/router";
const Users = lazy(() => import("./pages/Users"));
const Home = lazy(() => import("./pages/Home"));
const App = props => (
<>
<nav>
<a href="/about">About</a>
<a href="/">Home</a>
</nav>
<h1>My Site with lots of pages</h1>
{props.children}
</>
);
render(() => (
<Router root={App}>
<Route path="/users" component={Users} />
<Route path="/" component={Home} />
</Router>
), document.getElementById("app"));If you don't know the path ahead of time, you might want to treat part of the path as a flexible parameter that is passed on to the component.
import { lazy } from "solid-js";
import { render } from "solid-js/web";
import { Router, Route } from "@solidjs/router";
const Users = lazy(() => import("./pages/Users"));
const User = lazy(() => import("./pages/User"));
const Home = lazy(() => import("./pages/Home"));
render(() => (
<Router>
<Route path="/users" component={Users} />
<Route path="/users/:id" component={User} />
<Route path="/" component={Home} />
</Router>
), document.getElementById("app"));The colon indicates that id can be any string, and as long as the URL fits that pattern, the User component will show.
You can then access that id from within a route component with useParams.
Note on Animation/Transitions:
Routes that share the same path match will be treated as the same route. If you want to force re-render you can wrap your component in a keyed <Show> like:
<Show when={params.something} keyed><MyComponent></Show>Each path parameter can be validated using a MatchFilter.
This allows for more complex routing descriptions than just checking the presence of a parameter.
import { lazy } from "solid-js";
import { render } from "solid-js/web";
import { Router, Route } from "@solidjs/router";
import type { SegmentValidators } from "./types";
const User = lazy(() => import("./pages/User"));
const filters: MatchFilters = {
parent: ["mom", "dad"], // allow enum values
id: /^\d+$/, // only allow numbers
withHtmlExtension: (v: string) => v.length > 5 && v.endsWith(".html"), // we want an `*.html` extension
};
render(() => (
<Router>
<Route
path="/users/:parent/:id/:withHtmlExtension"
component={User}
matchFilters={filters}
/>
</Router>
), document.getElementById("app"));Here, we have added the matchFilters prop. This allows us to validate the parent, id and withHtmlExtension parameters against the filters defined in filters.
If the validation fails, the route will not match.
So in this example:
/users/mom/123/contact.htmlwould match,/users/dad/123/about.htmlwould match,/users/aunt/123/contact.htmlwould not match as:parentis not 'mom' or 'dad',/users/mom/me/contact.htmlwould not match as:idis not a number,/users/dad/123/contactwould not match as:withHtmlExtensionis missing.html.
Parameters can be specified as optional by adding a question mark to the end of the parameter name:
// Matches stories and stories/123 but not stories/123/comments
<Route path="/stories/:id?" component={Stories} />:param lets you match an arbitrary name at that point in the path. You can use * to match any end of the path:
// Matches any path that begins with foo, including foo/, foo/a/, foo/a/b/c
<Route path="foo/*" component={Foo} />If you want to expose the wild part of the path to the component as a parameter, you can name it:
<Route path="foo/*any" component={Foo} />Note that the wildcard token must be the last part of the path; foo/*any/bar won't create any routes.
Routes also support defining multiple paths using an array. This allows a route to remain mounted and not rerender when switching between two or more locations that it matches:
// Navigating from login to register does not cause the Login component to re-render
<Route path={["login", "register"]} component={Login} />The following two route definitions have the same result:
<Route path="/users/:id" component={User} /><Route path="/users">
<Route path="/:id" component={User} />
</Route>/users/:id renders the <User/> component, and /users/ is an empty route.
Only leaf Route nodes (innermost Route components) are given a route. If you want to make the parent its own route, you have to specify it separately:
//This won't work the way you'd expect
<Route path="/users" component={Users}>
<Route path="/:id" component={User} />
</Route>
// This works
<Route path="/users" component={Users} />
<Route path="/users/:id" component={User} />
// This also works
<Route path="/users">
<Route path="/" component={Users} />
<Route path="/:id" component={User} />
</Route>You can also take advantage of nesting by using props.children passed to the route component.
function PageWrapper(props) {
return (
<div>
<h1> We love our users! </h1>
{props.children}
<A href="/">Back Home</A>
</div>
);
}
<Route path="/users" component={PageWrapper}>
<Route path="/" component={Users} />
<Route path="/:id" component={User} />
</Route>;The routes are still configured the same, but now the route elements will appear inside the parent element where the props.children was declared.
You can nest indefinitely - just remember that only leaf nodes will become their own routes. In this example, the only route created is /layer1/layer2, and it appears as three nested divs.
<Route
path="/"
component={(props) =>
<div>
Onion starts here {props.children}
</div>
}
>
<Route
path="layer1"
component={(props) =>
<div>
Another layer {props.children}
</div>
}
>
<Route
path="layer2"
component={() => <div>Innermost layer</div>}
/>
</Route>
</Route>Even with smart caches it is possible that we have waterfalls both with view logic and with lazy loaded code. With load functions, we can instead start fetching the data parallel to loading the route, so we can use the data as soon as possible. The load function is called when the Route is loaded or eagerly when links are hovered.
As its only argument, the load function is passed an object that you can use to access route information:
import { lazy } from "solid-js";
import { Route } from "@solidjs/router";
const User = lazy(() => import("./pages/users/[id].js"));
// load function
function loadUser({params, location}) {
// do loading
}
// Pass it in the route definition
<Route path="/users/:id" component={User} load={loadUser} />;| key | type | description |
|---|---|---|
| params | object | The route parameters (same value as calling useParams() inside the route component) |
| location | { pathname, search, hash, query, state, key} |
An object that you can use to get more information about the path (corresponds to useLocation()) |
| intent | "initial", "navigate", "native", "preload" |
Indicates why this function is being called.
|
A common pattern is to export the load function and data wrappers that corresponds to a route in a dedicated route.data.js file. This way, the data function can be imported without loading anything else.
import { lazy } from "solid-js";
import { Route } from "@solidjs/router";
import loadUser from "./pages/users/[id].data.js";
const User = lazy(() => import("/pages/users/[id].js"));
// In the Route definition
<Route path="/users/:id" component={User} load={loadUser} />;The return value of the load function is passed to the page component when called at anytime other than "preload", so you can initialize things in there, or alternatively use our new Data APIs:
Keep in mind these are completely optional. To use but showcase the power of our load mechanism.
To prevent duplicate fetching and to trigger handle refetching we provide a cache api. That takes a function and returns the same function.
const getUser = cache(async (id) => {
return (await fetch(`/api/users${id}`)).json()
}, "users") // used as cache key + serialized argumentsIt is expected that the arguments to the cache function are serializable.
This cache accomplishes the following:
- It does just deduping on the server for the lifetime of the request.
- It does preload cache in the browser which lasts 10 seconds. When a route is preloaded on hover or when load is called when entering a route it will make sure to dedupe calls.
- We have a reactive refetch mechanism based on key. So we can tell routes that aren't new to retrigger on action revalidation.
- It will serve as a back/forward cache for browser navigation up to 5 mins. Any user based navigation or link click bypasses it. Revalidation or new fetch updates the cache.
Using it with load function might look like:
import { lazy } from "solid-js";
import { Route } from "@solidjs/router";
import { getUser } from ... // the cache function
const User = lazy(() => import("./pages/users/[id].js"));
// load function
function loadUser({params, location}) {
void getUser(params.id)
}
// Pass it in the route definition
<Route path="/users/:id" component={User} load={loadUser} />;Inside your page component you:
// pages/users/[id].js
import { getUser } from ... // the cache function
export default function User(props) {
const user = createAsync(() => getUser(props.params.id));
return <h1>{user().name}</h1>;
}Cached function has a few useful methods for getting the key that are useful for invalidation.
let id = 5;
getUser.key // returns "users"
getUser.keyFor(id) // returns "users[5]"You can revalidate the cache using the revalidate method or you can set revalidate keys on your response from your actions. If you pass the whole key it will invalidate all the entries for the cache (ie "users" in the example above). You can also invalidate a single entry by using keyFor.
cache can be defined anywhere and then used inside your components with:
This is light wrapper over createResource that aims to serve as stand-in for a future primitive we intend to bring to Solid core in 2.0. It is a simpler async primitive where the function tracks like createMemo and it expects a promise back that it turns into a Signal. Reading it before it is ready causes Suspense/Transitions to trigger.
const user = createAsync((currentValue) => getUser(params.id))Using cache in createResource directly won't work properly as the fetcher is not reactive and it won't invalidate properly.
Similar to createAsync except it uses a deeply reactive store. Perfect for applying fine-grained changes to large model data that updates.
const todos = createAsyncStore(() => getTodos());Actions are data mutations that can trigger invalidations and further routing. A list of prebuilt response helpers can be found below.
import { action, revalidate, redirect } from "@solidjs/router"
// anywhere
const myAction = action(async (data) => {
await doMutation(data);
throw redirect("/", { revalidate: getUser.keyFor(data.id) }); // throw a response to do a redirect
});
// in component
<form action={myAction} method="post" />
//or
<button type="submit" formaction={myAction}></button>Actions only work with post requests, so make sure to put method="post" on your form.
Sometimes it might be easier to deal with typed data instead of FormData and adding additional hidden fields. For that reason Actions have a with method. That works similar to bind which applies the arguments in order.
Picture an action that deletes Todo Item:
const deleteTodo = action(async (formData: FormData) => {
const id = Number(formData.get("id"))
await api.deleteTodo(id)
})
<form action={deleteTodo} method="post">
<input type="hidden" name="id" value={todo.id} />
<button type="submit">Delete</button>
</form>Instead with with you can write this:
const deleteUser = action(api.deleteTodo)
<form action={deleteTodo.with(todo.id)} method="post">
<button type="submit">Delete</button>
</form>This requires stable references as you can only serialize a string as an attribute, and across SSR they'd need to match. The solution is providing a unique name.
const myAction = action(async (args) => {}, "my-action");Instead of forms you can use actions directly by wrapping them in a useAction primitive. This is how we get the router context.
// in component
const submit = useAction(myAction)
submit(...args)The outside of a form context you can use custom data instead of formData, and these helpers preserve types. However, even when used with server functions (in projects like SolidStart) this requires client side javascript and is not Progressive Enhancible like forms are.
Are used to injecting the optimistic updates while actions are in flight. They either return a single Submission(latest) or all that match with an optional filter function.
type Submission<T, U> = {
readonly input: T;
readonly result?: U;
readonly pending: boolean;
readonly url: string;
clear: () => void;
retry: () => void;
};
const submissions = useSubmissions(action, (input) => filter(input));
const submission = useSubmission(action, (input) => filter(input));These are used to communicate router navigations from cache/actions, and can include invalidation hints. Generally these are thrown to not interfere the with the types and make it clear that function ends execution at that point.
Redirects to the next route
const getUser = cache(() => {
const user = await api.getCurrentUser()
if (!user) throw redirect("/login");
return user;
})Reloads the data on the current page
const getTodo = cache(async (id: number) => {
const todo = await fetchTodo(id);
return todo;
}, "todo")
const updateTodo = action(async (todo: Todo) => {
await updateTodo(todo.id, todo);
reload({ revalidate: getTodo.keyFor(id) })
})You don't have to use JSX to set up your routes; you can pass an array of route definitions:
import { lazy } from "solid-js";
import { render } from "solid-js/web";
import { Router } from "@solidjs/router";
const routes = [
{
path: "/users",
component: lazy(() => import("/pages/users.js")),
},
{
path: "/users/:id",
component: lazy(() => import("/pages/users/[id].js")),
children: [
{
path: "/",
component: lazy(() => import("/pages/users/[id]/index.js")),
},
{
path: "/settings",
component: lazy(() => import("/pages/users/[id]/settings.js")),
},
{
path: "/*all",
component: lazy(() => import("/pages/users/[id]/[...all].js")),
},
],
},
{
path: "/",
component: lazy(() => import("/pages/index.js")),
},
{
path: "/*all",
component: lazy(() => import("/pages/[...all].js")),
},
];
render(() =>
<Router>{routes}</Router>,
document.getElementById("app")
);Also you can pass a single route definition object for a single route:
import { lazy } from "solid-js";
import { render } from "solid-js/web";
import { Router } from "@solidjs/router";
const route = {
path: "/",
component: lazy(() => import("/pages/index.js"))
};
render(() => <Router>{route}</Router>, document.getElementById("app"));By default, Solid Router uses location.pathname as route path. You can simply switch to hash mode through using <HashRouter>.
import { HashRouter } from "@solidjs/router";
<HashRouter />;You can also use memory mode router for testing purpose.
import { MemoryRouter } from "@solidjs/router";
<MemoryRouter />;For SSR you can use the static router directly or the browser Router defaults to it on the server, just pass in the url.
import { isServer } from "solid-js/web";
import { Router } from "@solidjs/router";
<Router url={isServer ? req.url : ""} />;This is the main Router component for the browser.
| prop | type | description |
|---|---|---|
| children | JSX.Element, RouteDefinition, or RouteDefinition[] |
The route definitions |
| root | Component | Top level layout component |
| base | string | Base url to use for matching routes |
| actionBase | string | Root url for server actions, default: /_server |
| preload | boolean | Enables/disables preloads globally, default: true |
| explicitLinks | boolean | Disables all anchors being intercepted and instead requires <A>. default: false |
Like the <a> tag but supports automatic apply of base path + relative paths and active class styling (requires client side JavaScript).
The <A> tag has an active class if its href matches the current location, and inactive otherwise. Note: By default matching includes locations that are descendents (eg. href /users matches locations /users and /users/123), use the boolean end prop to prevent matching these. This is particularly useful for links to the root route / which would match everything.
| prop | type | description |
|---|---|---|
| href | string | The path of the route to navigate to. This will be resolved relative to the route that the link is in, but you can preface it with / to refer back to the root. |
| noScroll | boolean | If true, turn off the default behavior of scrolling to the top of the new page |
| replace | boolean | If true, don't add a new entry to the browser history. (By default, the new page will be added to the browser history, so pressing the back button will take you to the previous route.) |
| state | unknown | Push this value to the history stack when navigating |
| inactiveClass | string | The class to show when the link is inactive (when the current location doesn't match the link) |
| activeClass | string | The class to show when the link is active |
| end | boolean | If true, only considers the link to be active when the curent location matches the href exactly; if false, check if the current location starts with href |
Solid Router provides a Navigate component that works similarly to A, but it will immediately navigate to the provided path as soon as the component is rendered. It also uses the href prop, but you have the additional option of passing a function to href that returns a path to navigate to:
function getPath({ navigate, location }) {
// navigate is the result of calling useNavigate(); location is the result of calling useLocation().
// You can use those to dynamically determine a path to navigate to
return "/some-path";
}
// Navigating to /redirect will redirect you to the result of getPath
<Route path="/redirect" component={() => <Navigate href={getPath} />} />;The Component for defining Routes:
| prop | type | description |
|---|---|---|
| path | string | Path partial for defining the route segment |
| component | Component |
Component that will be rendered for the matched segment |
| matchFilters | MatchFilters |
Additional constraints for matching against the route |
| children | JSX.Element |
Nested <Route> definitions |
| load | RouteLoadFunc |
Function called during preload or when the route is navigated to. |
Solid Router provides a number of primitives that read off the Router and Route context.
Retrieves a reactive, store-like object containing the current route path parameters as defined in the Route.
const params = useParams();
// fetch user based on the id path parameter
const [user] = createResource(() => params.id, fetchUser);Retrieves method to do navigation. The method accepts a path to navigate to and an optional object with the following options:
- resolve (boolean, default
true): resolve the path against the current route - replace (boolean, default
false): replace the history entry - scroll (boolean, default
true): scroll to top after navigation - state (any, default
undefined): pass custom state tolocation.state
Note: The state is serialized using the structured clone algorithm which does not support all object types.
const navigate = useNavigate();
if (unauthorized) {
navigate("/login", { replace: true });
}Retrieves reactive location object useful for getting things like pathname
const location = useLocation();
const pathname = createMemo(() => parsePath(location.pathname));Retrieves a tuple containing a reactive object to read the current location's query parameters and a method to update them. The object is a proxy so you must access properties to subscribe to reactive updates. Note values will be strings and property names will retain their casing.
The setter method accepts an object whose entries will be merged into the current query string. Values '', undefined and null will remove the key from the resulting query string. Updates will behave just like a navigation and the setter accepts the same optional second parameter as navigate and auto-scrolling is disabled by default.
const [searchParams, setSearchParams] = useSearchParams();
return (
<div>
<span>Page: {searchParams.page}</span>
<button
onClick={() =>
setSearchParams({ page: (parseInt(searchParams.page) || 0) + 1 })
}
>
Next Page
</button>
</div>
);Retrieves signal that indicates whether the route is currently in a Transition. Useful for showing stale/pending state when the route resolution is Suspended during concurrent rendering.
const isRouting = useIsRouting();
return (
<div classList={{ "grey-out": isRouting() }}>
<MyAwesomeConent />
</div>
);useMatch takes an accessor that returns the path and creates a Memo that returns match information if the current path matches the provided path. Useful for determining if a given path matches the current route.
const match = useMatch(() => props.href);
return <div classList={{ active: Boolean(match()) }} />;useCurrentMatches returns all the matches for the current matched route. Useful for getting all the route information.
For example if you stored breadcrumbs on your route definition you could retrieve them like so:
const matches = useCurrentMatches();
const breadcrumbs = createMemo(() => matches().map(m => m.route.info.breadcrumb))usePreloadRoute returns a function that can be used to preload a route manual. This is what happens automatically with link hovering and similar focus based behavior, but it is available here as an API.
const preload = usePreloadRoute();
preload(`/users/settings`, { preloadData: true });useBeforeLeave takes a function that will be called prior to leaving a route. The function will be called with:
- from (Location): current location (before change).
- to (string | number}: path passed to
navigate. - options (NavigateOptions}: options passed to
navigate. - preventDefault (void function): call to block the route change.
- defaultPrevented (readonly boolean): true if any previously called leave handlers called preventDefault().
- retry (void function, force?: boolean ): call to retry the same navigation, perhaps after confirming with the user. Pass
trueto skip running the leave handlers again (ie force navigate without confirming).
Example usage:
useBeforeLeave((e: BeforeLeaveEventArgs) => {
if (form.isDirty && !e.defaultPrevented) {
// preventDefault to block immediately and prompt user async
e.preventDefault();
setTimeout(() => {
if (window.confirm("Discard unsaved changes - are you sure?")) {
// user wants to proceed anyway so retry with force=true
e.retry(true);
}
}, 100);
}
});v0.10.0 brings some big changes to support the future of routing including Islands/Partial Hydration hybrid solutions. Most notably there is no Context API available in non-hydrating parts of the application.
The biggest changes are around removed APIs that need to be replaced.
This is no longer used and instead will use props.children passed from into the page components for outlets. This keeps the outlet directly passed from its page and avoids oddness of trying to use context across Islands boundaries. Nested <Routes> components inherently cause waterfalls and are <Outlets> themselves so they have the same concerns.
Keep in mind no <Routes> means the <Router> API is different. The <Router> acts as the <Routes> component and its children can only be <Route> components. Your top-level layout should go in the root prop of the router as shown above
Related without Outlet component it has to be passed in manually. At which point the element prop has less value. Removing the second way to define route components to reduce confusion and edge cases.
These have been replaced by a load mechanism. This allows link hover preloads (as the load function can be run as much as wanted without worry about reactivity). It support deduping/cache APIs which give more control over how things are cached. It also addresses TS issues with getting the right types in the Component without typeof checks.
That being said you can reproduce the old pattern largely by turning off preloads at the router level and then injecting your own Context:
import { lazy } from "solid-js";
import { Route } from "@solidjs/router";
const User = lazy(() => import("./pages/users/[id].js"));
// load function
function loadUser({params, location}) {
const [user] = createResource(() => params.id, fetchUser);
return user;
}
// Pass it in the route definition
<Router preload={false}>
<Route path="/users/:id" component={User} load={loadUser} />
</Router>And then in your component taking the page props and putting them in a Context.
function User(props) {
<UserContext.Provider value={props.data}>
{/* my component content */}
</UserContext.Provider>
}
// Somewhere else
function UserDetails() {
const user = useContext(UserContext)
// render stuff
}When deploying applications that use a client side router that does not rely on Server Side Rendering you need to handle redirects to your index page so that loading from other URLs does not cause your CDN or Hosting to return not found for pages that aren't actually there.
Each provider has a different way of doing this. For example on Netlify you create a _redirects file that contains:
/* /index.html 200On Vercel you add a rewrites section to your vercel.json:
{
"rewrites": [
{
"source": "/(.*)",
"destination": "/index.html"
}
]
}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent