Getting Started

Installation and setup

Edit this page

Solid Router is the universal router for Solid which works for rendering on the client or the server. It was inspired by and combines paradigms of React Router and the Ember Router.

A router provides a way to change a user's view based on the URL in the browser. This allows a "single-page" application to simulate a traditional multipage site. To use Solid Router, components called Routes that depend on the value of the URL (the "path") are specified, and the router handles the mechanism of swapping them in and out.


Setup

To get started with Solid Router, install it using your preferred package manager.


Configure the routes

The Router component is the root component of the router. It is responsible for managing the URL and rendering the appropriate Route based on the URL.

To configure your routes, import the Router component and then start the application by rendering the router component.

import { render } from "solid-js/web";
import { Router } from "@solidjs/router";
const wrapper = document.getElementById("app");
if (!wrapper) {
throw new Error("Wrapper div not found");
}
render(() => <Router />, wrapper)

This sets up the router that will match on the url and render the appropriate route.

Report an issue with this page