Ship faster with beautiful components
NextUI Pro

Installation

Requirements:

Automatic Installation

Using the CLI is now the easiest way to start a NextUI project. You can initialize your project and add components directly via the CLI:

npm install -g nextui-cli
nextui init my-nextui-app

You will be prompted to configure your project:

? Select a template › - Use arrow-keys. Return to submit.
❯   App
    A Next.js 13 with app directory template pre-configured with NextUI (v2) and Tailwind CSS.
    Pages
    A Next.js 13 with pages directory template pre-configured with NextUI (v2) and Tailwind CSS.

Once your NextUI project is initialized, you can add individual components using the CLI. For example, to add a button component:

nextui add button

This command adds the Button component to your project and manages all related dependencies.

You can also add multiple components at once:

nextui add button input

Or you can add the main library @nextui-org/react by running the following command:

nextui add --all

If you leave out the component name, the CLI will prompt you to select the components you want to add.

? Which components would you like to add? › - Space to select. Return to submit
Instructions:
    ↑/↓: Highlight option
    ←/→/[space]: Toggle selection
    [a,b,c]/delete: Filter choices
    enter/return: Complete answer


Filtered results for: Enter something to filter


◯  accordion
◯  autocomplete
◯  avatar
◯  badge
◯  breadcrumbs
◉  button
◯  card
◯  checkbox
◯  chip
◯  code

Manual Installation

If you prefer not to use the CLI, follow these steps to manually set up NextUI in your project:

Global Installation

The easiest way to get started with NextUI is to use the global installation. Which means that all the components are imported from a single package.

Follow the steps below to install all NextUI components:

Install Packages

To install NextUI, run one of the following commands in your terminal:

npm install @nextui-org/react framer-motion

Tailwind CSS Setup

NextUI is built on top of Tailwind CSS, so you need to install Tailwind CSS first. You can follow the official installation guide to install Tailwind CSS. Then you need to add the following code to your tailwind.config.js file:

// tailwind.config.js
const {nextui} = require("@nextui-org/react");


/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    // ...
    "./node_modules/@nextui-org/theme/dist/**/*.{js,ts,jsx,tsx}",
  ],
  theme: {
    extend: {},
  },
  darkMode: "class",
  plugins: [nextui()],
};

Provider Setup

It is essential to add the NextUIProvider at the root of your application.

import * as React from "react";


// 1. import `NextUIProvider` component
import {NextUIProvider} from "@nextui-org/react";


function App() {
  // 2. Wrap NextUIProvider at the root of your app
  return (
    <NextUIProvider>
      <YourApplication />
    </NextUIProvider>
  );
}

Setup pnpm (optional)

If you are using pnpm, you need to add the following code to your .npmrc file:

public-hoist-pattern[]=*@nextui-org/*

After modifying the .npmrc file, you need to run pnpm install again to ensure that the dependencies are installed correctly.

Individual Installation

NextUI is also available as individual packages. You can install each package separately. This is useful if you want to reduce the size of your CSS bundle as it will only include styles for the components you're actually using.

Note: JavaScript bundle size will not change due to tree shaking support in NextUI.

Follow the steps below to install each package separately:

Install Core Packages

Although you can install each package separately, you need to install the core packages first to ensure that all components work correctly.

Run one of the following commands in your terminal to install the core packages:

npm install @nextui-org/theme @nextui-org/system framer-motion

Install Component

Now, let's install the component you want to use. For example, if you want to use the Button component, you need to run one of the following commands in your terminal:

npm install @nextui-org/button

Tailwind CSS Setup

TailwindCSS setup changes a bit when you use individual packages. You only need to add the styles of the components your using to your tailwind.config.js file. For example, for the Button component, you need to add the following code to your tailwind.config.js file:

// tailwind.config.js
const {nextui} = require("@nextui-org/theme");


/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    // single component styles
    "./node_modules/@nextui-org/theme/dist/components/button.js",
    // or you can use a glob pattern (multiple component styles)
    './node_modules/@nextui-org/theme/dist/components/(button|snippet|code|input).js'
  ],
  theme: {
    extend: {},
  },
  darkMode: "class",
  plugins: [nextui()],
};

Provider Setup

It is essential to add the NextUIProvider at the root of your application.

import * as React from "react";


// 1. import `NextUIProvider` component
import {NextUIProvider} from "@nextui-org/system";


function App() {
  // 2. Wrap NextUIProvider at the root of your app
  return (
    <NextUIProvider>
      <YourApplication />
    </NextUIProvider>
  );
}

Use the Component

Now, you can use the component you installed in your application:

import * as React from "react";
import {Button} from "@nextui-org/button";


function App() {
  return (
    <Button>Press me</Button>
  );
}

Setup pnpm (optional)

If you are using pnpm, you need to add the following code to your .npmrc file:

public-hoist-pattern[]=*@nextui-org/*

After modifying the .npmrc file, you need to run pnpm install again to ensure that the dependencies are installed correctly.

Version 2 is only compatible with React 18 or later. If you are using React 17 or earlier, please use version 1 of NextUI.

Framework Guides

NextUI UI is compatible with your preferred framework. We have compiled comprehensive, step-by-step tutorials for the following frameworks:

IntroductionCLI