Skip to content

🚀 Beautiful, fast and modern React UI library.

License

Notifications You must be signed in to change notification settings

sauloviniciusf/nextui

 
 

Repository files navigation

nextui

Nextui


codecov badge CI/CD nextui License

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

const Application = () => (
  <>
    <CssBaseline /> // ---> Normalize styles
    <AppComponent /> // ---> Your App Component
  </>
);
  1. Using NextUI components: Once NextUI is installed you can use any of the components as follows.
import { Button } from '@nextui-org/react';

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

About

🚀 Beautiful, fast and modern React UI library.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 95.6%
  • JavaScript 3.3%
  • HTML 1.1%