TrademarkTrademark
Docs
Ctrl k
Search docs...
Docs

Installation

Updated: October 10, 2026
View on GitHub

Starter template

Create a new Once UI app with our starter repository. It will install dependencies and set up the recommended structure:

Or add Once UI to an existing project:

Upgrading an app from 1.8? Follow the migration guide: a codemod does most of it, and it lists what is left in the order that keeps your app building.

Dependencies

Installed with Once UI Core, nothing to do:

Package
Version
Purpose
@floating-ui/react-dom^2.1.9Positioning for dropdowns, tooltips and popovers
clsx^2.1.1Conditional class names
date-fns^4.4.0Date pickers and inputs

Your app provides these. Components ship their styles as precompiled CSS modules, which Next.js, Vite and other bundlers handle with no setup; sass is optional (from 2.1):

Package
Version
Purpose
react>=18React
react-dom>=18React DOM
sass^1.77.6Optional: only if your own code uses Sass

Optional dependencies

Install these only for the features that need them. Each module named here comes from its own subpath, not the package root:

Package
Version
Used for
next>=15.5Next.js apps: LayoutProvider from @once-ui-system/core/next routes links and images through next/link and next/image
recharts^3.10.1Charts and gauges from @once-ui-system/core/data
prismjs^1.30.0CodeBlock from @once-ui-system/core/code
compressorjs^1.3.0MediaUpload from @once-ui-system/core/media

Icons ship inlined, so no icon library is required. To use more icons, register any React icon components — react-icons, lucide or your own SVGs — through IconProvider.

Edit this page on GitHub
TrademarkTrademark
Built with curiosity by Lorant One and the Design Engineers Club