Material Tailwind

Documentation

Visit https://www.material-tailwind.com/docs/react/installation for full documentation.

Components

Accordion	Alert	Avatar
Badge	Breadcrumbs	Button
Button Group	Card	Checkbox
Chip	Collapse	Carousel
Dialog	Drawer	Icon Button
Input	Form	List
Menu	Navbar	Popover
Progress Bar	Pagination	Radio Button
Rating Bar	Select	Slider
Speed Dial	Spinner	Stepper
Switch	Tabs	Text Area
Timeline	Tooltip	Typography
Footer	Image	Video
Sidebar	Table

Getting Started

Learn how to use @material-tailwind/react components to quickly and easily create elegant and flexible pages using Tailwind CSS.

@material-tailwind/react is working with Tailwind CSS classes and you need to have Tailwind CSS installed on your project - Tailwind CSS Installation.

1. Intall @material-tailwind/react.

1npm i @material-tailwind/react

2. Once you install @material-tailwind/react you need to wrap your tailwind css configurations with the withMT() function coming from @material-tailwind/react/utils.

1const withMT = require("@material-tailwind/react/utils/withMT");
2
3module.exports = withMT({
4  content: ["./src/**/*.{js,jsx,ts,tsx}"],
5  theme: {
6    extend: {},
7  },
8  plugins: [],
9});

3. @material-tailwind/react comes with a theme provider that set's the default theme/styles for components or to provide your own theme/styles to your components. You need to wrap your entire application with the ThemeProvider coming from @material-tailwind/react.

1import React from "react";
2import ReactDOM from "react-dom/client";
3import App from "./App";
4
5// @material-tailwind/react
6import { ThemeProvider } from "@material-tailwind/react";
7
8const root = ReactDOM.createRoot(document.getElementById("root"));
9
10root.render(
11  <React.StrictMode>
12    <ThemeProvider>
13      <App />
14    </ThemeProvider>
15  </React.StrictMode>,
16);

4. Congratulations 🥳, you did it, now you're ready to use @material-tailwind/react.

1import { Button } from "@material-tailwind/react";
2
3export default function Example() {
4  return <Button>Button</Button>;
5}

Community

We're excited to see the community adopt Material Tailwind, raise issues, and provide feedback. Whether it's a feature request, bug report, or a project to showcase, please get involved!

• Discord

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

Please adhere to this project's CODE_OF_CONDUCT.md.

License

MIT