Connect your components up to that address bar.
npm install preact-router
Connect your Preact components up to that address bar.
preact-router provides a path. It also automatically wires up elements to the router.
> 💁 Note: This is not a preact-compatible version of React Router. preact-router is a simple URL wiring and does no orchestration for you.
>
> If you're looking for more complex solutions like nested routes and view composition, react-router works great with preact as long as you alias in preact/compat.
#### See a Real-world Example :arrow_right:
---
``js
import Router from 'preact-router';
import { h, render } from 'preact';
/* @jsx h /
const Main = () => (
// Advanced is an optional query
);
render(, document.body);
`
If there is an error rendering the destination route, a 404 will be displayed.
:information_desk_person: Pages are just regular components that get mounted when you navigate to a certain URL.
Any URL parameters get passed to the component as props.
Defining what component(s) to load for a given URL is easy and declarative.
Querystring and :parameter values are passed to the matched component as props.?
Parameters can be made optional by adding a , or turned into a wildcard match by adding * (zero or more characters) or + (one or more characters):
Lazy loading (code splitting) with preact-router can be implemented easily using the AsyncRoute module:
`js`
import AsyncRoute from 'preact-async-route';
getComponent={() => import('./friends').then(module => module.default)}
/>
getComponent={() => import('./friend').then(module => module.default)}
loading={() => loading...}
/>
preact-router includes an add-on module called match that lets you wire your components up to Router changes.
Here's a demo of , which invokes the function you pass it (as its only child) in response to any routing:
`js
import Router from 'preact-router';
import Match from 'preact-router/match';
render(
{url}}// another example: render only if at a given URL:
render(
is just a normal link, but it automatically adds and removes an "active" classname to itself based on whether it matches the current URL.`js
import { Router } from 'preact-router';
import { Link } from 'preact-router/match';render(
this is a demo route that always matches
);
`$3
Sometimes it's necessary to bypass preact-router's link handling and let the browser perform routing on its own.
This can be accomplished by adding a
boolean attribute to any link:`html
Foo
`$3
The
notifies you when a change event occurs for a route with the onChange callback:`js
import { render, Component } from 'preact';
import { Router, route } from 'preact-router';class App extends Component {
// some method that returns a promise
isAuthenticated() {}
handleRoute = async e => {
switch (e.url) {
case '/profile':
const isAuthed = await this.isAuthenticated();
if (!isAuthed) route('/', true);
break;
}
};
render() {
return (
);
}
}
`$3
Can easily be implemented with a custom
component;`js
import { Component } from 'preact';
import { route } from 'preact-router';export default class Redirect extends Component {
componentWillMount() {
route(this.props.to, true);
}
render() {
return null;
}
}
`Now to create a redirect within your application, you can add this
component to your router;`js
`$3
It's possible to use alternative history bindings, like
:`js
import { h } from 'preact';
import Router from 'preact-router';
import { createHashHistory } from 'history';const Main = () => (
);
render(, document.body);
`$3
It's possible to programmatically trigger a route to a page (like
)`js
import { route } from 'preact-router';route('/page-2'); // appends a history entry
route('/page-3', true); // replaces the current history entry
`$3
The
is a self-contained component that renders based on the page URL. When nested a Router inside of another Router, the inner Router does not share or observe the outer's URL or matches. Instead, inner routes must include the full path to be matched against the page's URL:`js
import { h, render } from 'preact';
import Router from 'preact-router';function Profile(props) {
//
props.rest is the rest of the URL after "/profile/"
return (
Profile
);
}
const MyProfile = () => My Profile
;
const UserProfile = props => {props.user}
;function App() {
return (
);
}render(
``