Use our Tailwind CSS Accordion
component to allow the user to show and hide sections of related content on a page. There are many ways to use this component, like displaying a list of FAQs, showing various menus and submenus, displaying the locations of a particular company, and so on.
See below our simple and versatile Accordion
example that you can use in your React and Tailwind CSS projects. We also included some Accordion
props that are available.
import React from "react";
import {
Accordion,
AccordionHeader,
AccordionBody,
} from "@material-tailwind/react";
export function DefaultAccordion() {
const [open, setOpen] = React.useState(1);
const handleOpen = (value) => setOpen(open === value ? 0 : value);
return (
<>
<Accordion open={open === 1}>
<AccordionHeader onClick={() => handleOpen(1)}>What is Material Tailwind?</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 2}>
<AccordionHeader onClick={() => handleOpen(2)}>
How to use Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 3}>
<AccordionHeader onClick={() => handleOpen(3)}>
What can I do with Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
</>
);
}
You can make an Accordion
component to be always open and doesn't close when it's next or previous Accordion
component opened using a separate state.
import React from "react";
import {
Accordion,
AccordionHeader,
AccordionBody,
} from "@material-tailwind/react";
export function AccordionAlwaysOpen() {
const [open, setOpen] = React.useState(0);
const [alwaysOpen, setAlwaysOpen] = React.useState(true);
const handleAlwaysOpen = () => setAlwaysOpen((cur) => !cur);
const handleOpen = (value) => setOpen(open === value ? 0 : value);
return (
<>
<Accordion open={alwaysOpen}>
<AccordionHeader onClick={handleAlwaysOpen}>What is Material Tailwind?</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 1}>
<AccordionHeader onClick={() => handleOpen(1)}>
How to use Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 2}>
<AccordionHeader onClick={() => handleOpen(2)}>
What can I do with Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
</>
);
}
You can make the Accordion
component to be all open and doesn't close when it's next or previous Accordion
component opened using a separate state.
import React from "react";
import {
Accordion,
AccordionHeader,
AccordionBody,
} from "@material-tailwind/react";
export default function Example() {
const [openAcc1, setOpenAcc1] = React.useState(true);
const [openAcc2, setOpenAcc2] = React.useState(true);
const [openAcc3, setOpenAcc3] = React.useState(true);
const handleOpenAcc1 = () => setOpenAcc1((cur) => !cur);
const handleOpenAcc2 = () => setOpenAcc2((cur) => !cur);
const handleOpenAcc3 = () => setOpenAcc3((cur) => !cur);
return (
<>
<Accordion open={openAcc1}>
<AccordionHeader onClick={handleOpenAcc1}>What is Material Tailwind?</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={openAcc2}>
<AccordionHeader onClick={handleOpenAcc2}>How to use Material Tailwind?</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={openAcc3}>
<AccordionHeader onClick={handleOpenAcc3}>
What can I do with Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
</>
);
}
You can modify the open/close state icon for Accordion
component using the icon
prop.
import React from "react";
import {
Accordion,
AccordionHeader,
AccordionBody,
} from "@material-tailwind/react";
function Icon({ id, open }) {
return (
<svg
xmlns="http://www.w3.org/2000/svg"
fill="none"
viewBox="0 0 24 24"
strokeWidth={2}
stroke="currentColor"
className={`${id === open ? "rotate-180" : ""} h-5 w-5 transition-transform`}
>
<path strokeLinecap="round" strokeLinejoin="round" d="M19.5 8.25l-7.5 7.5-7.5-7.5" />
</svg>
);
}
export function AccordionCustomIcon() {
const [open, setOpen] = React.useState(0);
const handleOpen = (value) => setOpen(open === value ? 0 : value);
return (
<>
<Accordion open={open === 1} icon={<Icon id={1} open={open} />}>
<AccordionHeader onClick={() => handleOpen(1)}>What is Material Tailwind?</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 2} icon={<Icon id={2} open={open} />}>
<AccordionHeader onClick={() => handleOpen(2)}>
How to use Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 3} icon={<Icon id={3} open={open} />}>
<AccordionHeader onClick={() => handleOpen(3)}>
What can I do with Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
</>
);
}
You can modify the open/close state animation for Accordion
component using the animate
prop.
import React from "react";
import {
Accordion,
AccordionHeader,
AccordionBody,
} from "@material-tailwind/react";
const CUSTOM_ANIMATION = {
mount: { scale: 1 },
unmount: { scale: 0.9 },
};
export function AccordionCustomAnimation() {
const [open, setOpen] = React.useState(0);
const handleOpen = (value) => setOpen(open === value ? 0 : value);
return (
<>
<Accordion open={open === 1} animate={CUSTOM_ANIMATION}>
<AccordionHeader onClick={() => handleOpen(1)}>What is Material Tailwind?</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 2} animate={CUSTOM_ANIMATION}>
<AccordionHeader onClick={() => handleOpen(2)}>
How to use Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 3} animate={CUSTOM_ANIMATION}>
<AccordionHeader onClick={() => handleOpen(3)}>
What can I do with Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
</>
);
}
You can use tailwind css classes to add custom styles to the Accordion
component.
import React from "react";
import {
Accordion,
AccordionHeader,
AccordionBody,
} from "@material-tailwind/react";
export function AccordionCustomStyles() {
const [open, setOpen] = React.useState(1);
const handleOpen = (value) => setOpen(open === value ? 0 : value);
return (
<>
<Accordion open={open === 1} className="mb-2 rounded-lg border border-blue-gray-100 px-4">
<AccordionHeader
onClick={() => handleOpen(1)}
className={`border-b-0 transition-colors ${
open === 1 ? "text-blue-500 hover:!text-blue-700" : ""
}`}
>
What is Material Tailwind?
</AccordionHeader>
<AccordionBody className="pt-0 text-base font-normal">
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 2} className="mb-2 rounded-lg border border-blue-gray-100 px-4">
<AccordionHeader
onClick={() => handleOpen(2)}
className={`border-b-0 transition-colors ${
open === 2 ? "text-blue-500 hover:!text-blue-700" : ""
}`}
>
How to use Material Tailwind?
</AccordionHeader>
<AccordionBody className="pt-0 text-base font-normal">
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 3} className="rounded-lg border border-blue-gray-100 px-4">
<AccordionHeader
onClick={() => handleOpen(3)}
className={`border-b-0 transition-colors ${
open === 3 ? "text-blue-500 hover:!text-blue-700" : ""
}`}
>
What can I do with Material Tailwind?
</AccordionHeader>
<AccordionBody className="pt-0 text-base font-normal">
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
</>
);
}
An Accordion
could be disabled as well, it will help you to prevent user interactions like click over the Accordion
component.
import React from "react";
import {
Accordion,
AccordionHeader,
AccordionBody,
} from "@material-tailwind/react";
export function AccordionDisabled() {
const [open, setOpen] = React.useState(0);
const handleOpen = (value) => setOpen(open === value ? 0 : value);
return (
<>
<Accordion open={open === 1} disabled>
<AccordionHeader onClick={() => handleOpen(1)}>What is Material Tailwind?</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 2}>
<AccordionHeader onClick={() => handleOpen(2)}>
How to use Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
<Accordion open={open === 3}>
<AccordionHeader onClick={() => handleOpen(3)}>
What can I do with Material Tailwind?
</AccordionHeader>
<AccordionBody>
We're not always in the position that we want to be at. We're constantly
growing. We're constantly making mistakes. We're constantly trying to express
ourselves and actualize our dreams.
</AccordionBody>
</Accordion>
</>
);
}
The following props are available for accordion component. These are the custom props that we've added for the accordion component and you can use all the other native props as well.
Attribute | Type | Description | Default |
---|---|---|---|
open | boolean | Open accordion collapse | No default value it's a required prop. |
icon | node | Change accordion collapse end icon | undefined |
animate | Animate | Change accordion body animation | undefined |
disabled | boolean | Disable the accordion | false |
className | string | Add custom className for accordion | '' |
children | node | Add content for accordion | No default value it's a required prop. |
import type { AccordionProps } from "@material-tailwind/react";
The following props are available for accordion header component. These are the custom props that we've added for the accordion header component and you can use all the other native props as well.
Attribute | Type | Description | Default |
---|---|---|---|
className | string | Add custom className for accordion header | '' |
children | node | Add content for accordion header | No default value it's a required prop. |
import type { AccordionHeaderProps } from "@material-tailwind/react";
The following props are available for accordion body component. These are the custom props that we've added for the accordion body component and you can use all the other native props as well.
Attribute | Type | Description | Default |
---|---|---|---|
className | string | Add custom className for accordion body | '' |
children | node | Add content for accordion body | No default value it's a required prop. |
import type { AccordionBodyProps } from "@material-tailwind/react";
type animate = {
mount?: object;
unmount?: object;
};
Learn how to customize the theme and styles for accordion components, the theme object for accordion components has two main objects:
A. The defaultProps
object for setting up the default value for props of accordion components.
B. The styles
object for customizing the theme and styles of accordion components.
You can customize the theme and styles of accordion components by adding Tailwind CSS classes as key paired values for objects.
interface AccordionStylesType {
defaultProps: {
icon: node;
className: string;
animate: {
mount: object;
unmount: object;
};
disabled: boolean;
};
styles: {
base: {
container: object;
header: {
initial: object;
active: object;
icon: object;
};
body: object;
disabled: object;
};
};
}
import type { AccordionStylesType } from "@material-tailwind/react";
const theme = {
accordion: {
defaultProps: {
icon: undefined,
className: "",
animate: {
unmount: {},
mount: {},
},
disabled: false,
},
styles: {
base: {
container: {
display: "block",
position: "relative",
width: "w-full",
},
header: {
initial: {
display: "flex",
justifyContent: "justify-between",
alignItems: "items-center",
width: "w-full",
py: "py-4",
borderWidth: "border-b border-b-blue-gray-100",
color: "text-blue-gray-700",
fontSmoothing: "antialiased",
fontFamily: "font-sans",
fontSize: "text-xl",
textAlign: "text-left",
fontWeight: "font-semibold",
lineHeight: "leading-snug",
userSelect: "select-none",
hover: "hover:text-blue-gray-900",
transition: "transition-colors",
},
active: { color: "text-blue-gray-900" },
icon: {
ml: "ml-4",
},
},
body: {
display: "block",
width: "w-full",
py: "py-4",
color: "text-gray-700",
fontSmoothing: "antialiased",
fontFamily: "font-sans",
fontSize: "text-sm",
fontWeight: "font-light",
lineHeight: "leading-normal",
},
disabled: {
pointerEvents: "pointer-events-none",
opacity: "opacity-50",
},
},
},
},
};