Package Exports

@nextui-org/react
@nextui-org/react/cjs/index.js
@nextui-org/react/esm/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nextui-org/react) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

NextUI

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

Warning 🚧: This project is still in development, it might have bugs and breaking changes so it is not recommended to use it in production.

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:

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

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

Go to the root of your application and do this:

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.

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

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

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

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!

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's CODE_OF_CONDUCT.

License

MIT