Installation

Cotton UI is available on npm. Install it using your preferred package manager.

npm

npm install @akrade/cotton-ui

pnpm

pnpm add @akrade/cotton-ui

yarn

yarn add @akrade/cotton-ui

Peer Dependencies

Cotton UI requires React 18 or later:

npm install react react-dom

Dark Mode Setup

For dark mode and theme persistence, wrap your app with TokenProvider:

import { TokenProvider } from '@akrade/cotton-ui';

function App() {
  return (
    <TokenProvider colorScheme="system">
      <YourApp />
    </TokenProvider>
  );
}

Color Scheme Options

• "light" — Always light mode
• "dark" — Always dark mode
• "system" — Follow system preference

TypeScript

Cotton UI is written in TypeScript and includes type definitions. No additional setup required.

Next Steps

• Browse Components
• Design Tokens