NextUI

Beautiful, fast and modern React UI library.

Component Toolkit React

nextui-org/nextui nextui.org @nextui-org/react

README

NextUI

NOTE:This is a community project, not associated with Vercel , but does get some inspiration from there.

Getting Started

Visit https://nextui.org/guide to get started with NextUI.

Documentation

Visit https://nextui.org/docs to view the full documentation.

Quick Start

Installation: Inside your React project directory, install NextUI by running either of the following:

``` shell
yarn add @nextui-org/react
# or
npm i @nextui-org/react
```

Setup: For NextUI to work correctly, you need to set up the NextUIProviderat the root of your application.

Go to the root of your application and do this:

``` js
import {NextUIProvider} from '@nextui-org/react';
const Application = () => (
<NextUIProvider>
<AppComponent /> // ---> Your App Component
</NextUIProvider>
);
```

Using NextUI components: Once NextUI is installed you can use any of the components as follows. NextUI uses tree-shaking so the unused modules will not be included in the bundle during the build process and

each component is exported separately.

``` js
import {Button} from '@nextui-org/react';
const Component = () => <Button>Click me</Button>;
```

NextUI allows to manually import components if you need. E.g.

``` js
import Button from '@nextui-org/react/button';
const Component = () => <Button>Click me</Button>;
```

Community

We're excited to see the community adopt NextUI, raise issues, and provide feedback. Whether it's a feature request, bug report, or a project to showcase, please get involved!

Discord

Twitter

GitHub Discussions