@jansedlon/next-ui-react
TypeScript icon, indicating that this package has built-in type declarations

1.0.0-beta.8-jan2ย โ€ขย Publicย โ€ขย Published

nextui

NextUI

License codecov badge CI/CD nextui npm downloads

Sponsored by vercel

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
  1. 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 { NextUIProvider } from '@nextui-org/react';

const Application = () => (
  <NextUIProvider>
    <AppComponent /> // ---> Your App Component
  </NextUIProvider>
);
  1. 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>;
  1. 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

Package Sidebar

Install

npm i @jansedlon/next-ui-react

Homepage

nextui.org/

Weekly Downloads

5

Version

1.0.0-beta.8-jan2

License

MIT

Unpacked Size

6.18 MB

Total Files

930

Last publish

Collaborators

  • jsedlon