• English
  • Installation

    Install Leaf UI in your React application:

    pnpm add @sudden3/leaf-ui
    # or
    npm install @sudden3/leaf-ui
    # or
    yarn add @sudden3/leaf-ui

    React 18 or 19 and the matching React DOM version must be installed in your application. See the current release on npm.

    Styles

    Import the compiled stylesheet once in the application entry:

    import '@sudden3/leaf-ui/styles.css';

    The package includes compiled CSS; consuming it does not require Sass. Configure colors, shapes and sizes through ConfigProvider. Custom components can read the resulting CSS variables. See SSR usage for framework entry points.

    Icons

    When importing icons in your application, install Lucide:

    pnpm add lucide-react

    See icons for examples.

    Compatibility

    Leaf UI includes ESM and CommonJS entry points, TypeScript declarations, and support for modern browsers with CSS variables and color-mix(). Continue with quick start.