Skip to content

Latest commit

 

History

History
553 lines (495 loc) · 19.2 KB

README.md

File metadata and controls

553 lines (495 loc) · 19.2 KB
Raw

Flowbite - Tailwind CSS components
Build websites even faster with components on top of Tailwind CSS

Discord Total Downloads Latest Release Licenese

Documentation

For full documentation, visit flowbite.com.

Table of Contents

Getting started

Flowbite can be included as a plugin into an existing Tailwind CSS project and it is supposed to help you build websites faster by having a set of web components to work with built with the utility classes from Tailwind CSS.

Install using NPM

Make sure that you have Node.js and Tailwind CSS installed.

  1. Install Flowbite as a dependency using NPM by running the following command:
npm install flowbite
  1. Require Flowbite as a plugin inside the tailwind.config.js file:
module.exports = {

    plugins: [
        require('flowbite/plugin')
    ]

}
  1. Make sure that you add the template path to the tailwind.config.js file:
module.exports = {

    content: [
        "./node_modules/flowbite/**/*.js"
    ]

}
  1. Include the main JavaScript file to make interactive elements work:
<script src="../path/to/flowbite/dist/flowbite.js"></script>

If you use Webpack or other bundlers you can also import it like this to automatically include all of the data attribute event listeners from Flowbite.

import 'flowbite/dist/flowbite.min.js';

You can also import components one by one like this and use the components programatically based on JavaScript API.

import { Modal } from 'flowbite';

const modal = new Modal(...parameters);

Check out the JavaScript behaviour section of each component's page to learn how you can use this.

Include via CDN

The quickest way to get started working with Flowbite is to simply include the CSS and JavaScript into your project via CDN.

Require the following minified stylesheet inside the head tag:

<link href="https://cdnjs.cloudflare.com/ajax/libs/flowbite/1.6.1/flowbite.min.css"  rel="stylesheet" />

And include the following javascript file before the end of the body tag:

<script src="https://cdnjs.cloudflare.com/ajax/libs/flowbite/1.6.1/flowbite.min.js"></script>

Components

Flowbite is an open source collection of UI components built with the utility classes from Tailwind CSS that you can use as a starting point when coding user interfaces and websites.

Alerts Badge Breadcrumbs
Tailwind CSS Alerts Tailwind CSS Badge Tailwind CSS Breadcrumbs
Buttons Button group Cards
Tailwind CSS Buttons Tailwind CSS Button Group Tailwind CSS Cards
Dropdown Forms List group
Tailwind CSS Dropdown Tailwind CSS Forms Tailwind CSS List group
Typography Modal Tabs
Tailwind CSS Typography Tailwind CSS Modal Tailwind CSS Tabs
Navbar Pagination Timeline
Tailwind CSS Navbar Tailwind CSS Pagination Tailwind CSS Timeline
Progress bar Tables Toast
Tailwind CSS Progress Bar Tailwind CSS Tables Tailwind CSS Toast
Tooltips Datepicker Spinner
Tailwind CSS Tooltips Tailwind CSS Datepicker Tailwind CSS Spinner
Footer Accordion Sidebar
Tailwind CSS Footer Tailwind CSS Accordion Tailwind CSS Sidebar
Carousel Avatar Rating
Tailwind CSS Carousel Tailwind CSS Avatar Tailwind CSS Rating
Input Field File Input Search Input
Tailwind CSS Input Field Tailwind CSS File Input Tailwind CSS Search Input
Select Textarea Checkbox
Tailwind CSS Select Tailwind CSS Textarea Tailwind CSS Checkbox
Radio Toggle Range Slider
Tailwind CSS Radio Tailwind CSS Toggle Tailwind CSS Range Slider
Floating Label Mega Menu Skeleton
Tailwind CSS Floating Label Tailwind CSS Mega Menu Tailwind CSS Skeleton
KBD (keyboard) Drawer (offcanvas) Popover
Tailwind CSS KBD (Keyboard) Tailwind CSS Drawer (offcanvas) Tailwind CSS Popover
Video Heading Paragraph
Tailwind CSS Video Tailwind CSS Heading Tailwind CSS Paragraph
Blockquote Image List
Tailwind CSS Blockquote Tailwind CSS Image Tailwind CSS List
Link Text Horizontal line (HR)
Tailwind CSS Link Tailwind CSS Text Tailwind CSS HR
Speed Dial Stepper Indicators
Tailwind CSS Speed Dial Tailwind CSS Stepper Tailwind CSS Indicators

TypeScript

Flowbite supports types and interfaces for TypeScript projects and you can learn more on how to work with Tailwind CSS, Flowbite, and TypeScript on the quickstart guide inside the documentation.

Figma Design System

If you need the Figma files for the components you can check out our website for more information:

🎨 Get access to the Figma design files

Flowbite Blocks

Check out Flowbite Blocks to get access to over 250+ website sections coded in Tailwind CSS and Flowbite:

📦 Check out Flowbite Blocks

Pro version

Get access to all premium features including the Figma design system, access to all Flowbite Block sections and a dashboard UI interface:

💎 Check out Flowbite Pro

Community

If you need help or just want to discuss about the library join the community on Github:

⌨️ Discuss about Flowbite on GitHub

For casual chatting with others using the library:

💬 Join the Flowbite Discord Server

Video tutorials and presentations using Flowbite:

🎥 Subscribe to our YouTube channel

Copyright and license

The Flowbite name and logos are trademarks of Bergside Inc.

📝 Read about the licensing terms