Skip to main content
The router service abstracts in-page navigation from any specific router implementation (Vue Router, React Router, Shopify navigation, plain location). Blocks call push, subscribe to navigation events, and read the list of registered pages without importing any concrete router. Unlike the other services, the router has no built-in adapter — the host application is expected to wire one up directly.

Setup

Shape

push accepts the same three shapes as vue-router’s push — a plain path, a path+query object, or a named-route object. The adapter decides how to resolve named routes.

Page registrations

getPages() returns the static page table — useful for blocks that render a nav menu or sitemap. Each entry maps a path to the block name that renders it, plus a display title.