Search nx-ui

Jump to any foundation, component, block or example.

Overview
  • Home
  • Components
  • Documentation
  • Brand icons
  • Colours
  • Icons
  • Shadows
  • Theme matrix
  • Typography
  • Invoices
  • Waste movements
  • Organisations
  • Area
  • Bar
  • Composed
  • Donut & pie
  • Interactive
  • Line
  • Radial & gauge
  • Sparklines
  • Chain Of Custody
  • Compliance Checklist
  • Ewc Badge
  • Ewc Selector
  • Haulage Vehicle Select
  • Location Selector
  • Mass Input
  • Material Selector
  • Movement Form
  • Movement Status Badge
  • Movement Timeline
  • Opportunities
  • Pdf TemplatesNew
  • Permit Badge
  • Project Scope Selector
  • Stockpile Visualiser
  • Transfer Document
  • Transfer Note
  • Control Room
  • Dashboard
  • Empty states
  • Forgot password
  • Maintenance
  • Marketplace
  • Movement detail
  • Movements
  • 404 — Not found
  • Onboarding wizard
  • Opportunities
  • Scoped app
  • 500 — Server error
  • Settings — Billing
  • Settings — Profile
  • Settings — Team
  • Sign in
  • Sign up
  • Backdrop
  • Background Patterns
  • Cta Banner
  • Faq
  • Feature Card
  • Feature Row
  • Grid Backdrop
  • Hero Split
  • How It Works
  • Logo Cloud
  • Motion
  • Page Hero
  • Section
  • Site Footer
  • Site Header
  • Stats Band
  • Testimonials
  • Artifact
  • Chain of Thought
  • Chat
  • Checkpoint
  • Code Block
  • Confirmation
  • Context
  • Conversation
  • Image
  • Inline Citation
  • Loader
  • Message
  • Model Selector
  • Open in Chat
  • Plan
  • Prompt Input
  • Queue
  • Reasoning
  • Shimmer
  • Sources
  • Task
  • Tool
  • Web Preview
  • Workflow
  • Boundary Map
  • Camera & Tours
  • Globe
  • Isochrones
  • Map Marker
  • Map Stat Overlay
  • Map Toolbar
  • Map View
  • Route Map
  • Routing
  • Site Map
  • 3D Terrain
  • Tilted Routes
  • Transfer Preview
  • Listing Card
  • Listings Filters
  • Listings Panel
  • Marketplace Map
  • Price Range
  • App-shell pattern
  • Components & blocks
  • Contributing
  • Getting started
  • Theming
  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.