Search nx-ui

Jump to any foundation, component, block or example.

Overview
  • Home
  • Components
  • Documentation
  • Brand iconsNew
  • ColoursNew
  • IconsNew
  • ShadowsNew
  • Theme matrixNew
  • TypographyNew
  • Activity FeedNew
  • App BreadcrumbsNew
  • App ShellNew
  • App SidebarNew
  • App SwitcherNew
  • Auth LoginNew
  • Auth RecoveryNew
  • Auth SignupNew
  • Avatar GroupNew
  • Calendar ViewNew
  • Device MockupNew
  • Empty StateNew
  • Error PageNew
  • Featured IconNew
  • Filter BarNew
  • KanbanNew
  • Media PlayerNew
  • Metric CardNew
  • Notification CentreNew
  • Nx LogoNew
  • Onboarding ChecklistNew
  • Org SwitcherNew
  • Page HeaderNew
  • Pricing TableNew
  • Scoped NavNew
  • Scroll FadeNew
  • SettingsNew
  • Sidebar NavNew
  • Theme ToggleNew
  • User MenuNew
  • InvoicesNew
  • Waste movementsNew
  • OrganisationsNew
  • AreaNew
  • BarNew
  • ComposedNew
  • Donut & pieNew
  • InteractiveNew
  • LineNew
  • Radial & gaugeNew
  • SparklinesNew
  • Chain Of CustodyNew
  • Compliance ChecklistNew
  • Ewc SelectorNew
  • Location SelectorNew
  • Material SelectorNew
  • Movement FormNew
  • OpportunitiesNew
  • Permit BadgeNew
  • Project Scope SelectorNew
  • Transfer NoteNew
  • Control RoomNew
  • DashboardNew
  • Empty statesNew
  • Forgot passwordNew
  • MaintenanceNew
  • MarketplaceNew
  • Movement detailNew
  • MovementsNew
  • 404 — Not foundNew
  • Onboarding wizardNew
  • OpportunitiesNew
  • Scoped appNew
  • 500 — Server errorNew
  • Settings — BillingNew
  • Settings — ProfileNew
  • Settings — TeamNew
  • Sign inNew
  • Sign upNew
  • BackdropNew
  • Background PatternsNew
  • Cta BannerNew
  • FaqNew
  • Feature CardNew
  • Feature RowNew
  • Grid BackdropNew
  • Hero SplitNew
  • How It WorksNew
  • Logo CloudNew
  • MotionNew
  • Page HeroNew
  • SectionNew
  • Site FooterNew
  • Site HeaderNew
  • Stats BandNew
  • TestimonialsNew
  • ArtifactNew
  • Chain of ThoughtNew
  • ChatNew
  • CheckpointNew
  • Code BlockNew
  • ConfirmationNew
  • ContextNew
  • ConversationNew
  • ImageNew
  • Inline CitationNew
  • LoaderNew
  • MessageNew
  • Model SelectorNew
  • Open in ChatNew
  • PlanNew
  • Prompt InputNew
  • QueueNew
  • ReasoningNew
  • ShimmerNew
  • SourcesNew
  • TaskNew
  • ToolNew
  • Web PreviewNew
  • WorkflowNew
  • Boundary MapNew
  • Camera & ToursNew
  • GlobeNew
  • IsochronesNew
  • Map MarkerNew
  • Map Stat OverlayNew
  • Map ToolbarNew
  • Map ViewNew
  • Route MapNew
  • RoutingNew
  • Site MapNew
  • 3D TerrainNew
  • Tilted RoutesNew
  • Transfer PreviewNew
  • Listing CardNew
  • Listings FiltersNew
  • Listings PanelNew
  • Marketplace MapNew
  • App-shell patternNew
  • Components & blocksNew
  • ContributingNew
  • Getting startedNew
  • ThemingNew
  1. Home
  2. Docs

Documentation

How to set up, consume and contribute to the nx-ui registry — the Nexus ReGen shared component library. Start with getting started, then dip into theming, the component and block catalogue, the app-shell pattern, or the contributor guide.

Getting started
Wire a consumer repo to the registry: shadcn init, the two hosts, theme-first install, globals.css, next-themes and your first components.
Theming
The two-layer theme, the class-vocabulary rules, the nine brand variants, dark-mode behaviour and the shadcn-compat shim.
Components & blocks
The item types, block install paths, discovery with the shadcn CLI and ⌘K, and how to update vendored components.
App-shell pattern
The org ▸ project scoped shell — the scope model, top bar, breadcrumbs, sliding nav and app switcher every Nexus app adopts.
Contributing
Working in the nx-ui repo: the verify loop, the minimal-diff doctrine, and how demos, pages and nav are generated.