Skip to content

Home
Atlas

Sidebar Navigation

Introduction

What is Lit UI Router?
How this site runs

Tutorial

Hello World
Hello Solar System
Hello Galaxy
All Examples

Guides

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

Companion Packages

Overview
Effect
- ui-router-effect
  - ui-router-effect API
    routeRef
    RouteSnapshot
    snapshotRoute
    RouteTypes
    TypedRouteSnapshot
  lit-ui-router-effect
  - lit-ui-router-effect API
    defaultRefRuntime
    RefController
    RefControllerOptions
    RefRuntime
    RefSource
    RefValues
    routeRef
    RouterRefController
    RouterRefControllerOptions
    RouteSnapshot
    snapshotRoute
    SubscriptionRefs
    TypedRouteSnapshot
ESLint Plugin
MobX
- ui-router-mobx
  - ui-router-mobx API
    RouterStore
    RouteTypes
    TypedStoreName
    TypedStoreNarrowing
    TypedStoreState
    TypedStoreTarget
  lit-ui-router-mobx
  - lit-ui-router-mobx API
    ReactionController
    RouterReactionController
    RouterStore
    ReactionControllerOptions
    RouterReactionControllerOptions
Navigation Location
- navigation-location-plugin API
  - NavigationLocationService
    NavigationLocationPluginOptions
    NavigationTraverseInterceptOptions
    UIRouterNavigateEvent
    UIRouterNavigateInfo
    isUIRouterNavigateEvent
    navigationLocationPlugin
Registry
- ui-router-registry API
  - ui-router-registry
    Register
    RegisteredRouteTypes
    RegisteredStates
    TypedStateService
    AssertNoCollisions
    CollisionsOf
    LineageOf
    ParamArgs
    ParamsOf
    RelativeRef
    ResolvedParamsOf
    StateGlob
    StateName
    StatesOf
    TargetArgs
    TypedRouteSnapshot
    UncheckedRef
    ui-router-registry/effect
    ui-router-registry/mobx
    ui-router-registry/signals
Server
- ui-router-server API
  - ui-router-server
    MountConfig
    MountDiagnostic
    ServerRouter
    MountDiagnosticKind
    Verdict
    routeTrie
    createServerRouter
    diagnoseMounts
    mergeSearch
    ui-router-server/connect
    ConnectAdapterOptions
    ConnectRequest
    ConnectResponse
    ConnectMiddleware
    ConnectNext
    createConnectMiddleware
    ui-router-server/fetch
    DelegateSeam
    FetchAdapterOptions
    DelegateContext
    DelegateHandler
    DelegateHandlers
    DelegateKey
    DelegateParams
    DelegateState
    FetchHandler
    RequiredDelegates
    createFetchHandler
    delegateContext
    ui-router-server/hono
    HonoDelegateArgs
    serverRouterHono
    ui-router-server/location
    ServerLocationConfig
    ServerLocationOptions
    ServerLocationPluginOptions
    installServerLocation
    serverLocationPlugin
    ui-router-server/matcher
    CompiledMatcher
    CompiledParam
    ParamDeclaration
    ParamType
    Replace
    UrlMatcherCompileOptions
    UrlMatcherCompilerConfig
    compare
    exec
    format
    urlMatcherFactory
    ui-router-server/prerender
    EmittedPage
    PrerenderOptions
    PrerenderResult
    PrerenderTally
    RedirectLine
    RenderContext
    FileWriter
    prerender
    ui-router-server/redirects
    CompiledRoute
    RedirectRule
    RedirectTable
    RedirectTarget
    RouteDeclaration
    RouteMatch
    RouteIndex
    compileRedirects
    compileRoutes
    evaluateRedirects
    matchRoute
    ui-router-server/simulate
    createHeadlessRouter
    onceSettled
    ui-router-server/ssr
    DehydrateResult
    ResolvePayload
    SettleOptions
    JsonValue
    dehydrate
    settle
    ui-router-server/ssr-client
    seed
    ui-router-server/url-config
    RouterUrlConfig
    applyUrlConfig
    ui-router-server/vite
    ServerRouterPlugin
    ViteMiddlewareServer
    serverRouterPlugin
Signals
- ui-router-signals
  - ui-router-signals API
    RouterSignals
    RouteSnapshot
    watchSelection
    RouteTypes
    TypedRouteSnapshot
  lit-ui-router-signals
  - lit-ui-router-signals API
    RouterSignalController
    SignalController
    RouterSignalControllerOptions
    SignalControllerOptions
SSR
- lit-ui-router-ssr API
  - lit-ui-router-ssr
    LightElementRenderer
    UiViewRenderer
    EmittedPage
    PrerenderOptions
    PrerenderResult
    PrerenderTally
    RedirectLine
    RenderContext
    SettleOptions
    FileWriter
    settle
    prerender
    lit-ui-router-ssr/client
    AdoptableView
    AdoptUiViewContextKey
    BootstrapOptions
    BootstrapResult
    HydrateRootOptions
    HydrationSignature
    LightDomHydratingConstructor
    LightDomHydratingElement
    ServedUiView
    ServedUiViewConstructor
    UiViewAdoptDetail
    AdoptOutcome
    AdoptReporter
    AdoptUiViewContext
    BootstrapOutcome
    BootstrapSignature
    LightDomAdoptEvent
    LitElementConstructor
    UiViewAdoptEvent
    adoptUiViewContext
    lightDomAdoptEventName
    lightSlot
    servedViewBrand
    uiViewAdoptEventName
    uiViewSlot
    bootstrap
    hydrateRoot
    isServedViewClass
    LightDomHydrating
    readHydrationSignature
    withServedRender

Sample App

Overview
Vanilla
MobX
Effect
Signals
Hash

API

Overview
lit-ui-router
- Core
  - ContextRequestEvent
    contextRequestEventName
    getScopedRouter
    isContextRequest
    isRoutedLitElement
    isRouterContextRequest
    LitViewConfig
    parentUiViewContext
    provideContext
    provideRouter
    requestContext
    requestRouter
    routerContext
    RouterContextRequestEvent
    UIRouterLit
    viewRendered
    withRouterSync
  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
    Context
    ContextCallback
    ContextRequest
    ContextType
    DefaultResolvesType
    LitStateDeclaration
    LitViewDeclaration
    LitViewDeclarationElement
    LitViewDeclarationObject
    LitViewDeclarationTemplate
    NormalizedLitViewDeclaration
    ParentUiView
    ParentUiViewContext
    ParentUiViewContextKey
    RequestContextOptions
    RequestRouterOptions
    RoutedLitComponent
    RoutedLitElement
    RoutedLitTemplate
    RouterContext
    RouterContextKey
    SrefActiveClassParams
    SrefAriaCurrentParams
    SrefStatus
    SrefTargetParams
    TypedLitStateDeclaration
    TypedLitViewComponent
    TypedLitViewDeclaration
    UiSrefActiveParams
    UiSrefOptions
    UiSrefTransitionOptions
    UIViewInjectedProps
    UIViewResolves
    UnknownContext

On this page

lit-ui-router-effect

Other

defaultRefRuntime
RefController
RefControllerOptions
RefRuntime
RefSource
RefValues
routeRef
RouterRefController
RouterRefControllerOptions
RouteSnapshot
snapshotRoute
SubscriptionRefs

types

TypedRouteSnapshot

Pager

Previous pagelit-ui-router-effect

Next pagedefaultRefRuntime