9

GitHub - nextui-org/nextui: 🚀 Beautiful, fast and modern React UI library.

 2 years ago
source link: https://github.com/nextui-org/nextui
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

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


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK