Introduction

What is Lit UI Router?

Tutorial

Hello World
Hello Solar System
Hello Galaxy
All Examples

Guides

Overview
Location Plugins
Unmatched URLs (404)
Server-Side Routing
Route Guards
Component Lifecycle Hooks
View Fallback Content
Reactive Components
Design System Links
Development & Production Builds

Companion Packages

Overview
Effect
- lit-ui-router-effect API
  - RefController
    RouterRefController
    RefControllerOptions
    RefRuntime
    RouterRefControllerOptions
    RouteSnapshot
    RefSource
    RefValues
    SubscriptionRefs
    defaultRefRuntime
    routeRef
    snapshotRoute
ESLint Plugin
MobX
- lit-ui-router-mobx API
  - ReactionController
    RouterReactionController
    RouterStore
    ReactionControllerOptions
    RouterReactionControllerOptions
Navigation Location
- navigation-location-plugin API
  - NavigationLocationService
    UIRouterNavigateEvent
    navigationLocationPlugin
    isUIRouterNavigateEvent
Server
- ui-router-server API
  - ui-router-server
    MountConfig
    ServerRouter
    Verdict
    createServerRouter
    mergeSearch
    ui-router-server/connect
    ConnectAdapterOptions
    ConnectRequest
    ConnectResponse
    ConnectMiddleware
    ConnectNext
    createConnectMiddleware
    ui-router-server/fetch
    FetchAdapterOptions
    FetchHandler
    createFetchHandler
    ui-router-server/hono
    serverRouterHono
    ui-router-server/matcher
    CompiledMatcher
    CompiledParam
    ParamDeclaration
    ParamType
    Replace
    UrlMatcherCompileOptions
    UrlMatcherCompilerConfig
    compare
    exec
    format
    urlMatcherFactory
    ui-router-server/redirects
    CompiledRoute
    RedirectRule
    RedirectTable
    RedirectTarget
    RouteDeclaration
    RouteMatch
    compileRedirects
    compileRoutes
    evaluateRedirects
    matchRoute
    ui-router-server/simulate
    createHeadlessRouter
    onceSettled
    ui-router-server/vite
    ServerRouterPlugin
    ViteMiddlewareServer
    serverRouterPlugin

Sample App

Overview
Vanilla
MobX
Effect
Hash

API

Overview
lit-ui-router
- Core
  - UIRouterLit
  Components
  - UIRouterLitElement
    UiView
  Controllers
  - SrefStatusController
    SrefStatusControllerOptions
    TransitionCallback
    TransitionCallbackReason
    TransitionController
    TransitionControllerOptions
    TransitionEventType
  Directives
  - srefActiveClass
    SrefActiveClassDirective
    srefAriaCurrent
    SrefAriaCurrentDirective
    srefHref
    SrefHrefDirective
    SrefStatusDirective
    uiSref
    uiSrefActive
    UiSrefActiveDirective
    UiSrefDirective
  Hooks
  - UiOnExit
    UiOnParamsChanged
  Types
  - AriaCurrentValue
    AriaCurrentValues
    DefaultResolvesType
    LitStateDeclaration
    LitViewDeclaration
    LitViewDeclarationElement
    LitViewDeclarationObject
    LitViewDeclarationTemplate
    NormalizedLitViewDeclaration
    RoutedLitComponent
    RoutedLitElement
    RoutedLitTemplate
    SrefActiveClassParams
    SrefAriaCurrentParams
    SrefStatus
    SrefTargetParams
    UiSrefActiveParams
    UiSrefOptions
    UiSrefTransitionOptions
    UIViewInjectedProps
    UIViewResolves

On this page

Core

The main router class for Lit applications.

API

UIRouterLit

Pager

Previous pageAPI Reference

Next pageUIRouterLit

lit-ui-router-effect API

lit-ui-router-mobx API

navigation-location-plugin API

ui-router-server API

ui-router-server

ui-router-server/connect

ui-router-server/fetch

ui-router-server/hono

ui-router-server/matcher

ui-router-server/redirects

ui-router-server/simulate

ui-router-server/vite

Core

Components

Controllers

Directives

Hooks

Types

Core ​

API ​

Core

API