Ripple Router Documentation Website

Appearance

Ripple RouterA lightweight, type-safe router for Ripple applications built for the Ripple UI framework.

Get Started
API Reference

Type-safe

Route parameters and navigation helpers are typed to catch errors at compile time.

Minimal & Fast

A small runtime keeps your app responsive.

Dynamic Segments

Supports dynamic route segments (e.g. /users/:id) and query/hash handling.

First-class Link & Navigation

Declarative Link component and programmatic navigate helpers.

Why Ripple Router? ​

Ripple Router aims to be the simplest router you can use in a Ripple app while still providing enough features for common apps: nested routes, dynamic parameters, link components, and programmatic navigation. It's intentionally small so it can be composed with other libraries and integrated into existing projects easily.

  • Get started: /getting-started
  • API Reference: /api-reference
  • Deployment guidance: /deployment-guidelines

Highlights ​

  • Tiny public API surface that is easy to learn.
  • Strong typings for route params and navigation utilities.
  • Works well in single-page Ripple applications.

Contributing ​

See the repository README.md for contribution guidelines, code style and tests.