NextUI

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

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

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

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

Go to the root of your application and do this:

import { CssBaseline } from '@nextui-org/react';

const Application = () => (
  <>
    <CssBaseline /> // ---> Normalize styles
    <AppComponent /> // ---> Your App Component
  </>
);

3. 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.

import { Button } from '@nextui-org/react';

const Component = () => <Button>Click me</Button>;

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

import Button from '@nextui-org/react/button';

const Component = () => <Button>Click me</Button>;

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's CODE_OF_CONDUCT.

License

MIT