SaaS navigation

The SaaS dashboard's sidebar as plain data: its brand, its 8 routes and the shared footer.

Every SaaS page imports NAV and ROUTES from here and passes activeHref={ROUTES.<page>}; install it alone to put the dashboard's sidebar on a page of your own. ROUTES is the one place the dashboard's routes are spelled, HOME is the overview's.

Install

npx shadcn@latest add @vibra/nav-saas

Needs the @vibra registry in your components.json — set it up once.

Dependencies

Registry

Source

lib/dashboards/saas/nav.ts

import { type NavConfig } from "@/lib/nav-config"

/** Every route of this dashboard, by page — what a page passes as activeHref. */
export const ROUTES = {
  overview: "/saas",
  revenue: "/saas/revenue",
  usage: "/saas/usage",
  retention: "/saas/retention",
  global: "/saas/global",
  live: "/saas/live",
  subscriptions: "/saas/subscriptions",
  customers: "/saas/customers",
} as const

export const HOME = ROUTES.overview

/**
 * The SaaS dashboard's navigation, as plain data. AppShell resolves the
 * icon names and works out which item is current from the pathname; every
 * page of the dashboard passes this NAV and its own ROUTES entry. The same
 * pages are listed in ./manifest.ts, which the registry reads and this file
 * must not import — the manifest does not ship, and this file does.
 */
export const NAV: NavConfig = {
  brand: { name: "Northwind", initial: "N", href: HOME, caption: "Analytics" },
  groups: [
    {
      label: "SaaS",
      items: [
        { title: "Overview", href: ROUTES.overview, icon: "layout-dashboard" },
        { title: "Revenue", href: ROUTES.revenue, icon: "credit-card" },
        { title: "Usage", href: ROUTES.usage, icon: "activity" },
        { title: "Retention", href: ROUTES.retention, icon: "users" },
        { title: "Global", href: ROUTES.global, icon: "chart-line" },
        { title: "Live", href: ROUTES.live, icon: "activity" },
        { title: "Subscriptions", href: ROUTES.subscriptions, icon: "package" },
        { title: "Customers", href: ROUTES.customers, icon: "users" },
      ],
    },
  ],
  footer: [
    { title: "Settings", href: "/settings", icon: "settings" },
    { title: "Support", href: "/support", icon: "life-buoy" },
  ],
}