|
1 | 1 | --- |
2 | 2 | title: Flowbite React - UI Component Library |
3 | | -description: Learn more about the free and open-source Flowbite React UI components and start building modern web applications using React components based on Tailwind CSS |
| 3 | +description: Learn more about Flowbite React, a powerful UI component library that combines React components with Tailwind CSS to help you build modern web applications faster |
4 | 4 | --- |
5 | 5 |
|
6 | | -[Flowbite React](https://github.com/themesberg/flowbite-react) is a free and open-source UI component library based on the core Flowbite components and built with React components and interactivity handling. |
| 6 | +[Flowbite React](https://github.com/themesberg/flowbite-react) is a comprehensive UI component library that brings together the power of React and the utility-first approach of Tailwind CSS. Built on top of the core Flowbite components, it provides a robust foundation for creating modern, responsive web applications. |
7 | 7 |
|
8 | | -This library features hundreds of interactive elements such as navbars, dropdowns, modals, and sidebars all handled by React and based on the utility classes from Tailwind CSS. |
| 8 | +## What is Flowbite React? |
9 | 9 |
|
10 | | -## Getting started |
| 10 | +Flowbite React offers a collection of production-ready React components that are: |
11 | 11 |
|
12 | | -Learn how to get started with Flowbite React and start leveraging the interactive React components coupled with Flowbite and Tailwind CSS. |
| 12 | +- **Fully Interactive**: Each component is built with React's component model and handles all necessary interactivity out of the box |
| 13 | +- **Tailwind CSS Based**: Leverages Tailwind CSS utility classes for styling, providing complete customization flexibility |
| 14 | +- **Accessible**: Follows web accessibility best practices to ensure your applications are usable by everyone |
| 15 | +- **TypeScript Ready**: Comes with full TypeScript support for a better development experience |
| 16 | +- **Open Source**: Free to use and modify under the MIT license |
13 | 17 |
|
14 | | -### Setup Tailwind CSS |
| 18 | +## Component Ecosystem |
15 | 19 |
|
16 | | -Install Tailwind CSS by following the [official installation guide](https://tailwindcss.com/docs/installation). |
| 20 | +The library includes a growing collection of interactive elements such as: |
17 | 21 |
|
18 | | -### Install Flowbite React |
| 22 | +- Navigation components (navbars, breadcrumbs, tabs) |
| 23 | +- Data display elements (tables, cards, lists) |
| 24 | +- Form components (inputs, selects, checkboxes) |
| 25 | +- Feedback components (alerts, modals, toasts) |
| 26 | +- Layout components (sidebars, accordions, footers) |
| 27 | +- And many more |
19 | 28 |
|
20 | | -1. Run the following command to install `flowbite-react`: |
| 29 | +Each component is designed to be: |
21 | 30 |
|
22 | | -```bash |
23 | | -npm i flowbite-react |
24 | | -``` |
| 31 | +- **Modular**: Use only what you need |
| 32 | +- **Customizable**: Easily adapt to your brand and design system |
| 33 | +- **Responsive**: Works seamlessly across different screen sizes |
| 34 | +- **Well-documented**: Comprehensive documentation with examples and API references |
25 | 35 |
|
26 | | -2. Add `flowbite-react/tailwind` plugin to `tailwind.config.js`: |
| 36 | +## Why Choose Flowbite React? |
27 | 37 |
|
28 | | -```js {1,7} |
29 | | -const flowbite = require("flowbite-react/tailwind"); |
| 38 | +Flowbite React accelerates your development workflow by: |
30 | 39 |
|
31 | | -/** @type {import('tailwindcss').Config} */ |
32 | | -module.exports = { |
33 | | - plugins: [ |
34 | | - // ... |
35 | | - flowbite, |
36 | | - ], |
37 | | -}; |
38 | | -``` |
| 40 | +1. **Reducing Development Time**: Pre-built components mean less time writing boilerplate code |
| 41 | +2. **Ensuring Consistency**: Standardized components maintain visual and behavioral consistency |
| 42 | +3. **Providing Flexibility**: Extensive customization options through Tailwind CSS and theme configuration |
| 43 | +4. **Supporting Modern Development**: Built with current best practices and modern tooling |
39 | 44 |
|
40 | | -### Try it out |
| 45 | +## Next Steps |
41 | 46 |
|
42 | | -How you use Flowbite React depends on your project setup. In general, you can just import the components you want to use from `flowbite-react` and use them in a React `.jsx` or `.tsx` file: |
| 47 | +Ready to explore more? Check out: |
43 | 48 |
|
44 | | -```tsx |
45 | | -import { Button } from "flowbite-react"; |
| 49 | +- [Theme customization](/docs/customize/theme) to learn about styling components |
| 50 | +- [Dark mode implementation](/docs/customize/dark-mode) for adding dark theme support |
| 51 | +- [Contributing guide](/docs/getting-started/contributing) to get involved with the project |
46 | 52 |
|
47 | | -export default function MyPage() { |
48 | | - return <Button>Click me</Button>; |
49 | | -} |
50 | | -``` |
51 | | - |
52 | | -### Next steps |
53 | | - |
54 | | -#### Dark mode |
55 | | - |
56 | | -If you want to add a dark mode switcher to your app, you can follow the [dark mode guide](/docs/customize/dark-mode). |
57 | | - |
58 | | -#### Customization |
59 | | - |
60 | | -If you want to customize Flowbite React component, you can follow the [theme guide](/docs/customize/theme). |
61 | | - |
62 | | -#### Contributing |
63 | | - |
64 | | -If you want to contribute to Flowbite React, you can follow the [contributing guide](/docs/getting-started/contributing). |
| 53 | +For installation and setup instructions, visit our [quickstart guide](/docs/getting-started/quickstart). |
0 commit comments