@headlessui/react
A set of completely unstyled, fully accessible UI components for React, designed to integrate
beautifully with Tailwind CSS.
Installation
npm install @headlessui/react
yarn add @headlessui/react
Components
This project is still in early development. New components will be added regularly over the coming months.
Roadmap
This project is still in early development, but the plan is to build out all of the primitives we need to provide interactive React examples of all of the components included in Tailwind UI, the commercial component directory that helps us fund the development of our open-source work like Tailwind CSS.
This includes things like:
...and more in the future.
We'll be continuing to develop new components on an on-going basis, with a goal of reaching a pretty fleshed out v1.0 by the end of the year.
Transition
View live demo on CodeSandbox
The Transition
component lets you add enter/leave transitions to conditionally rendered elements, using CSS classes to control the actual transition styles in the different stages of the transition.
Basic example
The Transition
accepts a show
prop that controls whether the children should be shown or hidden, and a set of lifecycle props (like enterFrom
, and leaveTo
) that let you add CSS classes at specific phases of a transition.
import { Transition } from '@headlessui/react'
import { useState } from 'react'
function MyComponent() {
const [isOpen, setIsOpen] = useState(false)
return (
<>
<button onClick={() => setIsOpen(!isOpen)}>Toggle</button>
<Transition
show={isOpen}
enter="transition-opacity duration-75"
enterFrom="opacity-0"
enterTo="opacity-100"
leave="transition-opacity duration-150"
leaveFrom="opacity-100"
leaveTo="opacity-0"
>
I will fade in and out
</Transition>
</>
)
}
Showing and hiding content
Wrap the content that should be conditionally rendered in a <Transition>
component, and use the show
prop to control whether the content should be visible or hidden.
import { Transition } from '@headlessui/react'
import { useState } from 'react'
function MyComponent() {
const [isOpen, setIsOpen] = useState(false)
return (
<>
<button onClick={() => setIsOpen(!isOpen)}>Toggle</button>
<Transition
show={isOpen}
// ...
>
I will fade in and out
</Transition>
</>
)
}
The Transition
component will render a div
by default, but you can use the as
prop to render a different element instead if needed. Any other HTML attributes (like className
) can be added directly to the Transition
the same way they would be to regular elements.
import { Transition } from '@headlessui/react'
import { useState } from 'react'
function MyComponent() {
const [isOpen, setIsOpen] = useState(false)
return (
<>
<button onClick={() => setIsOpen(!isOpen)}>Toggle</button>
<Transition
show={isOpen}
as="a"
href="/my-url"
className="font-bold"
// ...
>
I will fade in and out
</Transition>
</>
)
}
Animating transitions
By default, a Transition
will enter and leave instantly, which is probably not what you're looking for if you're using this library.
To animate your enter/leave transitions, add classes that provide the styling for each phase of the transitions using these props:
- enter: Applied the entire time an element is entering. Usually you define your duration and what properties you want to transition here, for example
transition-opacity duration-75
. - enterFrom: The starting point to enter from, for example
opacity-0
if something should fade in. - enterTo: The ending point to enter to, for example
opacity-100
after fading in. - leave: Applied the entire time an element is leaving. Usually you define your duration and what properties you want to transition here, for example
transition-opacity duration-75
. - leaveFrom: The starting point to leave from, for example
opacity-100
if something should fade out. - leaveTo: The ending point to leave to, for example
opacity-0
after fading out.
Here's an example:
import { Transition } from '@headlessui/react'
import { useState } from 'react'
function MyComponent() {
const [isOpen, setIsOpen] = useState(false)
return (
<>
<button onClick={() => setIsOpen(!isOpen)}>Toggle</button>
<Transition
show={isOpen}
enter="transition-opacity duration-75"
enterFrom="opacity-0"
enterTo="opacity-100"
leave="transition-opacity duration-150"
leaveFrom="opacity-100"
leaveTo="opacity-0"
>
I will fade in and out
</Transition>
</>
)
}
In this example, the transitioning element will take 75ms to enter (that's the duration-75
class), and will transition the opacity property during that time (that's transition-opacity
).
It will start completely transparent before entering (that's opacity-0
in the enterFrom
phase), and fade in to completely opaque (opacity-100
) when finished (that's the enterTo
phase).
When the element is being removed (the leave
phase), it will transition the opacity property, and spend 150ms doing it (transition-opacity duration-150
).
It will start as completely opaque (the opacity-100
in the leaveFrom
phase), and finish as completely transparent (the opacity-0
in the leaveTo
phase).
All of these props are optional, and will default to just an empty string.
Co-ordinating multiple transitions
Sometimes you need to transition multiple elements with different animations but all based on the same state. For example, say the user clicks a button to open a sidebar that slides over the screen, and you also need to fade-in a background overlay at the same time.
You can do this by wrapping the related elements with a parent Transition
component, and wrapping each child that needs its own transition styles with a Transition.Child
component, which will automatically communicate with the parent Transition
and inherit the parent's show
state.
import { Transition } from '@headlessui/react'
function Sidebar({ isOpen }) {
return (
<Transition show={isOpen}>
{/* Background overlay */}
<Transition.Child
enter="transition-opacity ease-linear duration-300"
enterFrom="opacity-0"
enterTo="opacity-100"
leave="transition-opacity ease-linear duration-300"
leaveFrom="opacity-100"
leaveTo="opacity-0"
>
{/* ... */}
</Transition.Child>
{/* Sliding sidebar */}
<Transition.Child
enter="transition ease-in-out duration-300 transform"
enterFrom="-translate-x-full"
enterTo="translate-x-0"
leave="transition ease-in-out duration-300 transform"
leaveFrom="translate-x-0"
leaveTo="-translate-x-full"
>
{/* ... */}
</Transition.Child>
</Transition>
)
}
The Transition.Child
component has the exact same API as the Transition
component, but with no show
prop, since the show
value is controlled by the parent.
Parent Transition
components will always automatically wait for all children to finish transitioning before unmounting, so you don't need to manage any of that timing yourself.
Transitioning on initial mount
If you want an element to transition the very first time it's rendered, set the appear
prop to true
.
This is useful if you want something to transition in on initial page load, or when its parent is conditionally rendered.
import { Transition } from '@headlessui/react'
function MyComponent({ isShowing }) {
return (
<Transition
appear={true}
show={isShowing}
enter="transition-opacity duration-75"
enterFrom="opacity-0"
enterTo="opacity-100"
leave="transition-opacity duration-150"
leaveFrom="opacity-100"
leaveTo="opacity-0"
>
{/* Your content goes here*/}
</Transition>
)
}
Component API
Transition
<Transition
appear={true}
show={isOpen}
enter="transition-opacity duration-75"
enterFrom="opacity-0"
enterTo="opacity-100"
leave="transition-opacity duration-150"
leaveFrom="opacity-100"
leaveTo="opacity-0"
>
{}
</Transition>
Props
Prop | Type | Default | Description |
---|
show | Boolean | - | Whether the children should be shown or hidden. |
as | String | Component | div | The element or component to render in place of the Transition itself. |
appear | Boolean | false | Whether the transition should run on initial mount. |
unmount | Boolean | true | Whether the element should be unmounted or hidden based on the show state. |
enter | String | '' | Classes to add to the transitioning element during the entire enter phase. |
enterFrom | String | '' | Classes to add to the transitioning element before the enter phase starts. |
enterTo | String | '' | Classes to add to the transitioning element immediately after the enter phase starts. |
leave | String | '' | Classes to add to the transitioning element during the entire leave phase. |
leaveFrom | String | '' | Classes to add to the transitioning element before the leave phase starts. |
leaveTo | String | '' | Classes to add to the transitioning element immediately after the leave phase starts. |
beforeEnter | Function | - | Callback which is called before we start the enter transition. |
afterEnter | Function | - | Callback which is called after we finished the enter transition. |
beforeLeave | Function | - | Callback which is called before we start the leave transition. |
afterLeave | Function | - | Callback which is called after we finished the leave transition. |
Render prop object
Transition.Child
<Transition show={isOpen}>
<Transition.Child
enter="transition-opacity ease-linear duration-300"
enterFrom="opacity-0"
enterTo="opacity-100"
leave="transition-opacity ease-linear duration-300"
leaveFrom="opacity-100"
leaveTo="opacity-0"
>
{/* ... */}
</Transition.Child>
{}
</Transition>
Props
Prop | Type | Default | Description |
---|
as | String | Component | div | The element or component to render in place of the Transition.Child itself. |
appear | Boolean | false | Whether the transition should run on initial mount. |
unmount | Boolean | true | Whether the element should be unmounted or hidden based on the show state. |
enter | String | '' | Classes to add to the transitioning element during the entire enter phase. |
enterFrom | String | '' | Classes to add to the transitioning element before the enter phase starts. |
enterTo | String | '' | Classes to add to the transitioning element immediately after the enter phase starts. |
leave | String | '' | Classes to add to the transitioning element during the entire leave phase. |
leaveFrom | String | '' | Classes to add to the transitioning element before the leave phase starts. |
leaveTo | String | '' | Classes to add to the transitioning element immediately after the leave phase starts. |
beforeEnter | Function | - | Callback which is called before we start the enter transition. |
afterEnter | Function | - | Callback which is called after we finished the enter transition. |
beforeLeave | Function | - | Callback which is called before we start the leave transition. |
afterLeave | Function | - | Callback which is called after we finished the leave transition. |
Render prop object
View live demo on CodeSandbox
The Menu
component and related child components are used to quickly build custom dropdown components that are fully accessible out of the box, including correct ARIA attribute management and robust keyboard navigation support.
Basic example
Menu Buttons are built using the Menu
, Menu.Button
, Menu.Items
, and Menu.Item
components.
The Menu.Button
will automatically open/close the Menu.Items
when clicked, and when the menu is open, the list of items receives focus and is automatically navigable via the keyboard.
import { Menu } from '@headlessui/react'
function MyDropdown() {
return (
<Menu>
<Menu.Button>More</Menu.Button>
<Menu.Items>
<Menu.Item>
{({ active }) => (
<a className={`${active && 'bg-blue-500'}`} href="/account-settings">
Account settings
</a>
)}
</Menu.Item>
<Menu.Item>
{({ active }) => (
<a className={`${active && 'bg-blue-500'}`} href="/account-settings">
Documentation
</a>
)}
</Menu.Item>
<Menu.Item disabled>
<span className="opacity-75">Invite a friend (coming soon!)</span>
</Menu.Item>
</Menu.Items>
</Menu>
)
}
Styling the active item
This is a headless component so there are no styles included by default. Instead, the components expose useful information via render props that you can use to apply the styles you'd like to apply yourself.
To style the active Menu.Item
you can read the active
render prop argument, which tells you whether or not that menu item is the item that is currently focused via the mouse or keyboard.
You can use this state to conditionally apply whatever active/focus styles you like, for instance a blue background like is typical in most operating systems.
import { Menu } from '@headlessui/react'
function MyDropdown() {
return (
<Menu>
<Menu.Button>More</Menu.Button>
<Menu.Items>
{/* Use the `active` state to conditionally style the active item. */}
<Menu.Item>
{({ active }) => (
<a
className={`${active ? 'bg-blue-500 text-white' : 'bg-white text-black'}`}
href="/account-settings"
>
Account settings
</a>
)}
</Menu.Item>
{/* ... */}
</Menu.Items>
</Menu>
)
}
By default, your Menu.Items
instance will be shown/hidden automatically based on the internal open
state tracked within the Menu
component itself.
import { Menu } from '@headlessui/react'
function MyDropdown() {
return (
<Menu>
<Menu.Button>More</Menu.Button>
{/* By default, this will automatically show/hide when the Menu.Button is pressed. */}
<Menu.Items>
<Menu.Item>{/* ... */}</Menu.Item>
{/* ... */}
</Menu.Items>
</Menu>
)
}
If you'd rather handle this yourself (perhaps because you need to add an extra wrapper element for one reason or another), you can add a static
prop to the Menu.Items
instance to tell it to always render, and inspect the open
slot prop provided by the Menu
to control which element is shown/hidden yourself.
import { Menu } from '@headlessui/react'
function MyDropdown() {
return (
<Menu>
{({ open }) => (
<Menu.Button>More</Menu.Button>
{open && (
<div>
{/* Using `static`, `Menu.Items` is always rendered and ignores the `open` state. */}
<Menu.Items static>
<Menu.Item>{/* ... */}</Menu.Item>
{/* ... */}
</Menu.Items>
</div>
)}
)}
</Menu>
)
}
Disabling an item
Use the disabled
prop to disable a Menu.Item
. This will make it unselectable via keyboard navigation, and it will be skipped when pressing the up/down arrows.
import { Menu } from '@headlessui/react'
function MyDropdown() {
return (
<Menu>
<Menu.Button>More</Menu.Button>
<Menu.Items>
{/* ... */}
{/* This item will be skipped by keyboard navigation. */}
<Menu.Item disabled>
<span className="opacity-75">Invite a friend (coming soon!)</span>
</Menu.Item>
{/* ... */}
</Menu.Items>
</Menu>
)
}
Transitions
To animate the opening/closing of the menu panel, use the provided Transition
component. All you need to do is mark your Menu.Items
as static
, wrap it in a <Transition>
, and the transition will be applied automatically.
import { Menu, Transition } from '@headlessui/react'
function MyDropdown() {
return (
<Menu>
{({ open }) => (
<>
<Menu.Button>More</Menu.Button>
{/* Use the Transition + open render prop argument to add transitions. */}
<Transition
show={open}
enter="transition duration-100 ease-out"
enterFrom="transform scale-95 opacity-0"
enterTo="transform scale-100 opacity-100"
leave="transition duration-75 ease-out"
leaveFrom="transform scale-100 opacity-100"
leaveTo="transform scale-95 opacity-0"
>
<Menu.Items static>
<Menu.Item>{/* ... */}</Menu.Item>
{/* ... */}
</Menu.Items>
</Transition>
</>
)}
</Menu>
)
}
Rendering additional content
The Menu
component is not limited to rendering only its related subcomponents. You can render anything you like within a menu, which gives you complete control over exactly what you are building.
For example, if you'd like to add a little header section to the menu with some extra information in it, just render an extra div
with your content in it.
import { Menu } from '@headlessui/react'
function MyDropdown() {
return (
<Menu>
<Menu.Button>More</Menu.Button>
<Menu.Items>
<div className="px-4 py-3">
<p className="text-sm leading-5">Signed in as</p>
<p className="text-sm font-medium leading-5 text-gray-900 truncate">tom@example.com</p>
</div>
<Menu.Item>
{({ active }) => (
<a className={`${active && 'bg-blue-500'}`} href="/account-settings">
Account settings
</a>
)}
</Menu.Item>
{/* ... */}
</Menu.Items>
</Menu>
)
}
Note that only Menu.Item
instances will be navigable via the keyboard.
Rendering a different element for a component
By default, the Menu
and its subcomponents each render a default element that is sensible for that component.
For example, Menu.Button
renders a button
by default, and Menu.Items
renders a div
. Menu
and Menu.Item
interestingly do not render an extra element, and instead render their children directly by default.
This is easy to change using the as
prop, which exists on every component.
import { Menu } from '@headlessui/react'
function MyDropdown() {
return (
{}
<Menu as="div">
<Menu.Button>More</Menu.Button>
{}
<Menu.Items as="ul">
{}
<Menu.Item as="li">
{({ active }) => (
<a className={`${active && 'bg-blue-500'}`} href="/account-settings">
Account settings
</a>
)}
</Menu.Item>
{}
</Menu.Items>
</Menu>
)
}
To tell an element to render its children directly with no wrapper element, use as={React.Fragment}
.
import { Menu } from '@headlessui/react'
function MyDropdown() {
return (
<Menu>
{/* Render no wrapper, instead pass in a button manually. */}
<Menu.Button as={React.Fragment}>
<button>More</button>
</Menu.Button>
<Menu.Items>
<Menu.Item>
{({ active }) => (
<a className={`${active && 'bg-blue-500'}`} href="/account-settings">
Account settings
</a>
)}
</Menu.Item>
{/* ... */}
</Menu.Items>
</Menu>
)
}
Component API
<Menu>
<Menu.Button>More</Menu.Button>
<Menu.Items>
<Menu.Item>{/* ... */}</Menu.Item>
{/* ... */}
</Menu.Items>
</Menu>
Props
Prop | Type | Default | Description |
---|
as | String | Component | React.Fragment (no wrapper element) | The element or component the Menu should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the menu is open. |
<Menu.Button>
{({ open }) => (
<>
<span>More options</span>
<ChevronRightIcon className={`${open ? 'transform rotate-90' : ''}`} />
</>
)}
</Menu.Button>
Props
Prop | Type | Default | Description |
---|
as | String | Component | button | The element or component the Menu.Button should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the menu is open. |
<Menu.Items>
<Menu.Item>{/* ... */}></Menu.Item>
{}>
</Menu.Items>
Props
Prop | Type | Default | Description |
---|
as | String | Component | div | The element or component the Menu.Items should render as. |
static | Boolean | false | Whether the element should ignore the internally managed open/closed state. |
unmount | Boolean | true | Whether the element should be unmounted or hidden based on the open/closed state. |
note: static
and unmount
can not be used at the same time. You will get a TypeScript error if you try to do it.
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the menu is open. |
<Menu.Item>
{({ active }) => (
<a
className={`${active ? 'bg-blue-500 text-white' : 'bg-white text-black'}`}
href="/account-settings"
>
Account settings
</a>
)}
</Menu.Item>
Props
Prop | Type | Default | Description |
---|
as | String | Component | React.Fragment (no wrapper element) | The element or component the Menu.Item should render as. |
disabled | Boolean | false | Whether or not the item should be disabled for keyboard navigation and ARIA purposes. |
Render prop object
Prop | Type | Description |
---|
active | Boolean | Whether or not the item is the active/focused item in the list. |
disabled | Boolean | Whether or not the item is the disabled for keyboard navigation and ARIA purposes. |
Listbox (Select)
View live demo on CodeSandbox
The Listbox
component and related child components are used to quickly build custom listbox components that are fully accessible out of the box, including correct ARIA attribute management and robust keyboard navigation support.
Basic example
Listboxes are built using the Listbox
, Listbox.Button
, Listbox.Options
, Listbox.Option
and Listbox.Label
components.
The Listbox.Button
will automatically open/close the Listbox.Options
when clicked, and when the menu is open, the list of items receives focus and is automatically navigable via the keyboard.
import { useState } from 'react'
import { Listbox } from '@headlessui/react'
const people = [
{ id: 1, name: 'Durward Reynolds', unavailable: false },
{ id: 2, name: 'Kenton Towne', unavailable: false },
{ id: 3, name: 'Therese Wunsch', unavailable: false },
{ id: 4, name: 'Benedict Kessler', unavailable: true },
{ id: 5, name: 'Katelyn Rohan', unavailable: false },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox value={selectedPerson} onChange={setSelectedPerson}>
<Listbox.Button>{selectedPerson.name}</Listbox.Button>
<Listbox.Options>
{people.map(person => (
<Listbox.Option key={person.id} value={person} disabled={person.unavailable}>
{person.name}
</Listbox.Option>
))}
</Listbox.Options>
</Listbox>
)
}
Styling the active and selected option
This is a headless component so there are no styles included by default. Instead, the components expose useful information via render props that you can use to apply the styles you'd like to apply yourself.
To style the active Listbox.Option
you can read the active
render prop argument, which tells you whether or not that listbox option is the option that is currently focused via the mouse or keyboard.
To style the selected Listbox.Option
you can read the selected
render prop argument, which tells you whether or not that listbox option is the option that is currently the value
passed to the Listbox
.
Note: An option can be both active and selected at the same time!
You can use this state to conditionally apply whatever active/focus styles you like, for instance a blue background like is typical in most operating systems. For the selected state, a checkmark is also common.
import { useState, Fragment } from 'react'
import { Listbox } from '@headlessui/react'
import CheckmarkIcon from './CheckmarkIcon'
const people = [
{ id: 1, name: 'Durward Reynolds' },
{ id: 2, name: 'Kenton Towne' },
{ id: 3, name: 'Therese Wunsch' },
{ id: 4, name: 'Benedict Kessler' },
{ id: 5, name: 'Katelyn Rohan' },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox value={selectedPerson} onChange={setSelectedPerson}>
<Listbox.Button>{selectedPerson.name}</Listbox.Button>
<Listbox.Options>
{people.map(person => (
/* Use the `active` state to conditionally style the active option. */
/* Use the `selected` state to conditionally style the selected option. */
<Listbox.Option as={Fragment} key={person.id} value={person}>
{({ active, selected }) => (
<li className={`${active ? 'bg-blue-500 text-white' : 'bg-white text-black'}`}>
{selected && <CheckmarkIcon />}
{person.name}
</li>
)}
</Listbox.Option>
))}
</Listbox.Options>
</Listbox>
)
}
Using a custom label
By default the Listbox
will use the button contents as the label for screenreaders. However you can also render a custom Listbox.Label
.
import { useState, Fragment } from 'react'
import { Listbox } from '@headlessui/react'
const people = [
{ id: 1, name: 'Durward Reynolds' },
{ id: 2, name: 'Kenton Towne' },
{ id: 3, name: 'Therese Wunsch' },
{ id: 4, name: 'Benedict Kessler' },
{ id: 5, name: 'Katelyn Rohan' },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox value={selectedPerson} onChange={setSelectedPerson}>
<Listbox.Label>Assignee:</Listbox.Label>
<Listbox.Button>{selectedPerson.name}</Listbox.Button>
<Listbox.Options>
{people.map(person => (
<Listbox.Option as={Fragment} key={person.id} value={person}>
{person.name}
</Listbox.Option>
))}
</Listbox.Options>
</Listbox>
)
}
Showing/hiding the listbox
By default, your Listbox.Options
instance will be shown/hidden automatically based on the internal open
state tracked within the Listbox
component itself.
import { useState } from 'react'
import { Listbox } from '@headlessui/react'
const people = [
{ id: 1, name: 'Durward Reynolds', unavailable: false },
{ id: 2, name: 'Kenton Towne', unavailable: false },
{ id: 3, name: 'Therese Wunsch', unavailable: false },
{ id: 4, name: 'Benedict Kessler', unavailable: true },
{ id: 5, name: 'Katelyn Rohan', unavailable: false },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox value={selectedPerson} onChange={setSelectedPerson}>
<Listbox.Button>{selectedPerson.name}</Listbox.Button>
{/* By default, this will automatically show/hide when the Listbox.Button is pressed. */}
<Listbox.Options>
{people.map(person => (
<Listbox.Option key={person.id} value={person} disabled={person.unavailable}>
{person.name}
</Listbox.Option>
))}
</Listbox.Options>
</Listbox>
)
}
If you'd rather handle this yourself (perhaps because you need to add an extra wrapper element for one reason or another), you can add a static
prop to the Listbox.Options
instance to tell it to always render, and inspect the open
slot prop provided by the Listbox
to control which element is shown/hidden yourself.
import { useState } from 'react'
import { Listbox } from '@headlessui/react'
const people = [
{ id: 1, name: 'Durward Reynolds', unavailable: false },
{ id: 2, name: 'Kenton Towne', unavailable: false },
{ id: 3, name: 'Therese Wunsch', unavailable: false },
{ id: 4, name: 'Benedict Kessler', unavailable: true },
{ id: 5, name: 'Katelyn Rohan', unavailable: false },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox value={selectedPerson} onChange={setSelectedPerson}>
{({ open }) => (
<>
<Listbox.Button>{selectedPerson.name}</Listbox.Button>
{open && (
<div>
{/* Using `static`, `Listbox.Options` is always rendered and ignores the `open` state. */}
<Listbox.Options static>
{people.map(person => (
<Listbox.Option key={person.id} value={person} disabled={person.unavailable}>
{person.name}
</Listbox.Option>
))}
</Listbox.Options>
</div>
)}
</>
)}
</Listbox>
)
}
Disabling an option
Use the disabled
prop to disable a Listbox.Option
. This will make it unselectable via keyboard navigation, and it will be skipped when pressing the up/down arrows.
import { useState } from 'react'
import { Listbox } from '@headlessui/react'
const people = [
{ id: 1, name: 'Durward Reynolds', unavailable: false },
{ id: 2, name: 'Kenton Towne', unavailable: false },
{ id: 3, name: 'Therese Wunsch', unavailable: false },
{ id: 4, name: 'Benedict Kessler', unavailable: true },
{ id: 5, name: 'Katelyn Rohan', unavailable: false },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox value={selectedPerson} onChange={setSelectedPerson}>
<Listbox.Button>{selectedPerson.name}</Listbox.Button>
<Listbox.Options>
{people.map(person => (
/* Disabled options will be skipped by keyboard navigation. */
<Listbox.Option key={person.id} value={person} disabled={person.unavailable}>
<span className={person.unavailable ? 'opacity-75' : ''}>{person.name}</span>
</Listbox.Option>
))}
</Listbox.Options>
</Listbox>
)
}
Transitions
To animate the opening/closing of the listbox panel, use the provided Transition
component. All you need to do is mark your Listbox.Options
as static
, wrap it in a <Transition>
, and the transition will be applied automatically.
import { useState } from 'react'
import { Listbox, Transition } from '@headlessui/react'
const people = [
{ id: 1, name: 'Durward Reynolds', unavailable: false },
{ id: 2, name: 'Kenton Towne', unavailable: false },
{ id: 3, name: 'Therese Wunsch', unavailable: false },
{ id: 4, name: 'Benedict Kessler', unavailable: true },
{ id: 5, name: 'Katelyn Rohan', unavailable: false },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox value={selectedPerson} onChange={setSelectedPerson}>
{({ open }) => (
<>
<Listbox.Button>{selectedPerson.name}</Listbox.Button>
{/* Use the Transition + open render prop argument to add transitions. */}
<Transition
show={open}
enter="transition duration-100 ease-out"
enterFrom="transform scale-95 opacity-0"
enterTo="transform scale-100 opacity-100"
leave="transition duration-75 ease-out"
leaveFrom="transform scale-100 opacity-100"
leaveTo="transform scale-95 opacity-0"
>
<Listbox.Options static>
{people.map(person => (
<Listbox.Option key={person.id} value={person} disabled={person.unavailable}>
{person.name}
</Listbox.Option>
))}
</Listbox.Options>
</Transition>
</>
)}
</Listbox>
)
}
Rendering a different element for a component
By default, the Listbox
and its subcomponents each render a default element that is sensible for that component.
For example, Listbox.Label
renders a label
by default, Listbox.Button
renders a button
by default, Listbox.Options
renders a ul
and Listbox.Option
renders a li
by default. Listbox
interestingly does not render an extra element, and instead renders its children directly by default.
This is easy to change using the as
prop, which exists on every component.
import { useState } from 'react'
import { Listbox } from '@headlessui/react'
const people = [
{ id: 1, name: 'Durward Reynolds' },
{ id: 2, name: 'Kenton Towne' },
{ id: 3, name: 'Therese Wunsch' },
{ id: 4, name: 'Benedict Kessler' },
{ id: 5, name: 'Katelyn Rohan' },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox as="div" value={selectedPerson} onChange={setSelectedPerson}>
<Listbox.Button>{selectedPerson.name}</Listbox.Button>
<Listbox.Options as="div">
{people.map(person => (
<Listbox.Option as="span" key={person.id} value={person}>
{person.name}
</Listbox.Option>
))}
</Listbox.Options>
</Listbox>
)
}
To tell an element to render its children directly with no wrapper element, use as={React.Fragment}
.
import { useState, Fragment } from 'react'
import { Listbox } from '@headlessui/react'
const people = [
{ id: 1, name: 'Durward Reynolds' },
{ id: 2, name: 'Kenton Towne' },
{ id: 3, name: 'Therese Wunsch' },
{ id: 4, name: 'Benedict Kessler' },
{ id: 5, name: 'Katelyn Rohan' },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox value={selectedPerson} onChange={setSelectedPerson}>
<Listbox.Button as={Fragment}>{selectedPerson.name}</Listbox.Button>
<Listbox.Options>
{people.map(person => (
<Listbox.Option key={person.id} value={person}>
{person.name}
</Listbox.Option>
))}
</Listbox.Options>
</Listbox>
)
}
Component API
Listbox
import { useState } from 'react'
import { Listbox } from '@headlessui/react'
const people = [
{ id: 1, name: 'Durward Reynolds' },
{ id: 2, name: 'Kenton Towne' },
{ id: 3, name: 'Therese Wunsch' },
{ id: 4, name: 'Benedict Kessler' },
{ id: 5, name: 'Katelyn Rohan' },
]
function MyListbox() {
const [selectedPerson, setSelectedPerson] = useState(people[0])
return (
<Listbox value={selectedPerson} onChange={setSelectedPerson}>
<Listbox.Button>{selectedPerson.name}</Listbox.Button>
<Listbox.Options>
{people.map(person => (
<Listbox.Option key={person.id} value={person}>
{person.name}
</Listbox.Option>
))}
</Listbox.Options>
</Listbox>
)
}
Props
Prop | Type | Default | Description |
---|
as | String | Component | React.Fragment (no wrapper element) | The element or component the Listbox should render as. |
disabled | Boolean | false | Enable/Disable the Listbox component. |
value | T | - | The selected value. |
onChange | (value: T): void | - | The function to call when a new option is selected. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the listbox is open. |
disabled | Boolean | Whether or not the listbox is disabled. |
Listbox.Button
<Listbox.Button>
{({ open }) => (
<>
<span>More options</span>
<ChevronRightIcon className={`${open ? 'transform rotate-90' : ''}`} />
</>
)}
</Listbox.Button>
Props
Prop | Type | Default | Description |
---|
as | String | Component | button | The element or component the Listbox.Button should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the listbox is open. |
disabled | Boolean | Whether or not the listbox is disabled. |
Listbox.Label
<Listbox.Label>Enable notifications</Listbox.Label>
Props
Prop | Type | Default | Description |
---|
as | String | Component | label | The element or component the Listbox.Label should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the listbox is open. |
disabled | Boolean | Whether or not the listbox is disabled. |
Listbox.Options
<Listbox.Options>
<Listbox.Option value="option-a">{/* ... */}></Listbox.Option>
{}>
</Listbox.Options>
Props
Prop | Type | Default | Description |
---|
as | String | Component | ul | The element or component the Listbox.Options should render as. |
static | Boolean | false | Whether the element should ignore the internally managed open/closed state. |
unmount | Boolean | true | Whether the element should be unmounted or hidden based on the open/closed state. |
note: static
and unmount
can not be used at the same time. You will get a TypeScript error if you try to do it.
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the listbox is open. |
Listbox.Option
<Listbox.Option value="option-a">Option A</Listbox.Option>
Props
Prop | Type | Default | Description |
---|
as | String | Component | li | The element or component the Listbox.Option should render as. |
value | T | - | The option value. |
disabled | Boolean | false | Whether or not the option should be disabled for keyboard navigation and ARIA purposes. |
Render prop object
Prop | Type | Description |
---|
active | Boolean | Whether or not the option is the active/focused option in the list. |
selected | Boolean | Whether or not the option is the selected option in the list. |
disabled | Boolean | Whether or not the option is the disabled for keyboard navigation and ARIA purposes. |
Switch (Toggle)
View live demo on CodeSandbox
The Switch
component and related child components are used to quickly build custom switch/toggle components that are fully accessible out of the box, including correct ARIA attribute management and robust keyboard support.
Basic example
Switches are built using the Switch
component. Optionally you can also use the Switch.Group
and Switch.Label
components.
import { useState } from 'react'
import { Switch } from '@headlessui/react'
function NotificationsToggle() {
const [enabled, setEnabled] = useState(false)
return (
<Switch
checked={enabled}
onChange={setEnabled}
className={`${
enabled ? 'bg-blue-600' : 'bg-gray-200'
} relative inline-flex items-center h-6 rounded-full w-11`}
>
<span className="sr-only">Enable notifications</span>
<span
className={`${
enabled ? 'translate-x-6' : 'translate-x-1'
} inline-block w-4 h-4 transform bg-white rounded-full`}
/>
</Switch>
)
}
Using a custom label
By default the Switch
will use the contents as the label for screenreaders. If you need more control, you can render a Switch.Label
outside of the Switch
, as long as both the switch and label are within a parent Switch.Group
.
Clicking the label will toggle the switch state, like you'd expect from a native checkbox.
import { useState } from 'react'
import { Switch } from '@headlessui/react'
function NotificationsToggle() {
const [enabled, setEnabled] = useState(false)
return (
<Switch.Group>
<Switch.Label>Enable notifications</Switch.Label>
<Switch
checked={enabled}
onChange={setEnabled}
className={`${
enabled ? 'bg-blue-600' : 'bg-gray-200'
} relative inline-flex items-center h-6 rounded-full w-11`}
>
<span
className={`${
enabled ? 'translate-x-6' : 'translate-x-1'
} inline-block w-4 h-4 transform bg-white rounded-full`}
/>
</Switch>
</Switch.Group>
)
}
Component API
Switch
<Switch checked={checkedState} onChange={setCheckedState}>
<span className="sr-only">Enable notifications</span>
{}
</Switch>
Props
Prop | Type | Default | Description |
---|
as | String | Component | button | The element or component the Switch should render as. |
checked | Boolean | - | Whether or not the switch is checked. |
onChange | (value: boolean): void | - | The function to call when the switch is toggled. |
Render prop object
Prop | Type | Description |
---|
checked | Boolean | Whether or not the switch is checked. |
Switch.Label
<Switch.Group>
<Switch.Label>Enable notifications</Switch.Label>
<Switch checked={enabled} onChange={setEnabled} className="...">
{/* ... */}
</Switch>
</Switch.Group>
Props
Prop | Type | Default | Description |
---|
as | String | Component | label | The element or component the Switch.Label should render as. |
Switch.Description
<Switch.Group>
<Switch.Description>Enable notifications</Switch.Description>
<Switch checked={enabled} onChange={setEnabled} className="...">
{/* ... */}
</Switch>
</Switch.Group>
Props
Prop | Type | Default | Description |
---|
as | String | Component | label | The element or component the Switch.Description should render as. |
Switch.Group
<Switch.Group>
<Switch.Label>Enable notifications</Switch.Label>
<Switch checked={enabled} onChange={setEnabled} className="...">
{/* ... */}
</Switch>
</Switch.Group>
Props
Prop | Type | Default | Description |
---|
as | String | Component | React.Fragment (no wrapper element) | The element or component the Switch.Group should render as. |
Disclosure
A component for showing/hiding content.
Basic example
<Disclosure>
<Disclosure.Button>Toggle</Disclosure.Button>
<Disclosure.Panel>Contents</Disclosure.Panel>
</Disclosure>
Component API
Disclosure
<Disclosure>
<Disclosure.Button>Toggle</Disclosure.Button>
<Disclosure.Panel>Contents</Disclosure.Panel>
</Disclosure>
Props
Prop | Type | Default | Description |
---|
as | String | Component | React.Fragment (no wrapper element) | The element or component the Disclosure should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the disclosure is open. |
Disclosure.Button
Props
Prop | Type | Default | Description |
---|
as | String | Component | button | The element or component the Disclosure.Button should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the disclosure is open. |
Disclosure.Panel
Props
Prop | Type | Default | Description |
---|
as | String | Component | div | The element or component the Disclosure.Panel should render as. |
static | Boolean | false | Whether the element should ignore the internally managed open/closed state. |
unmount | Boolean | true | Whether the element should be unmounted or hidden based on the open/closed state. |
note: static
and unmount
can not be used at the same time. You will get a TypeScript error if you try to do it.
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the disclosure is open. |
FocusTrap
A component for making sure that you can't Tab out of the contents of this
component.
Focus strategy:
- An
initialFocus
prop can be passed in, this is a ref
object, which is a ref to the element that should receive initial focus. - If an input element exists with an
autoFocus
prop, it will receive initial focus. - If none of those exists, it will try and focus the first focusable element.
- If that doesn't exist, it will throw an error.
Once the FocusTrap
will unmount, the focus will be restored to the element that was focused before the FocusTrap
was rendered.
Basic example
<FocusTrap>
<form>
<input type="email" name="Email" />
<input type="password" name="password" />
<button>Submit</button>
</form>
</FocusTrap>
Component API
FocusTrap
<FocusTrap>
<form>
<input type="email" name="Email" />
<input type="password" name="password" />
<button>Submit</button>
</form>
</FocusTrap>
Props
Prop | Type | Default | Description |
---|
as | String | Component | div | The element or component the FocusTrap should render as. |
initialFocus | React.MutableRefObject | undefined | A ref to an element that should receive focus first. |
Portal
A component for rendering your contents within a Portal (at the end of document.body
).
Basic example
<Portal>
<p>This will be rendered inside a Portal, at the end of `document.body`</p>
</Portal>
Component API
Portal
<Portal>
<p>This will be rendered inside a Portal, at the end of `document.body`</p>
</Portal>
Props
Prop | Type | Default | Description |
---|
as | String | Component | React.Fragment (no wrapper element) | The element or component the Portal should render as. |
Render prop object
Dialog
This component can be used to render content inside a Dialog/Modal. This contains a ton of features:
- Renders inside a
Portal
- Controlled component
- Uses
FocusTrap
with its features (Focus first focusable element, autoFocus
or initialFocus
ref) - Adds a scroll lock
- Prevents content jumps by faking your scrollbar width
- Marks other elements as
inert
(hides other elements from screen readers) - Closes on
escape
- Closes on click outside
- Once the Dialog becomes hidden (e.g.:
md:hidden
) it will also trigger the onClose
Basic example
import { useState } from 'react'
import { Dialog } from '@headlessui/react'
function Example() {
let [isOpen, setIsOpen] = useState(true)
return (
<Dialog open={isOpen} onClose={setIsOpen}>
<Dialog.Overlay />
<Dialog.Title>Deactivate account</Dialog.Title>
<Dialog.Description>This will permanently deactivate your account</Dialog.Description>
<p>
Are you sure you want to deactivate your account? All of your data will be permanently
removed. This action cannot be undone.
</p>
<button onClick={() => setIsOpen(false)}>Deactivate</button>
<button onClick={() => setIsOpen(false)}>Cancel</button>
</Dialog>
)
}
Component API
Dialog
import { useState } from 'react'
import { Dialog } from '@headlessui/react'
function Example() {
let [isOpen, setIsOpen] = useState(true)
return (
<Dialog open={isOpen} onClose={setIsOpen}>
<Dialog.Overlay />
<Dialog.Title>Deactivate account</Dialog.Title>
<Dialog.Description>This will permanently deactivate your account</Dialog.Description>
<p>
Are you sure you want to deactivate your account? All of your data will be permanently
removed. This action cannot be undone.
</p>
<button onClick={() => setIsOpen(false)}>Deactivate</button>
<button onClick={() => setIsOpen(false)}>Cancel</button>
</Dialog>
)
}
Props
Prop | Type | Default | Description |
---|
open | Boolean | / | Wether the Dialog is open or not. |
onClose | Function | / | Called when the Dialog should close. For convenience we pass in a onClose(false) so that you can use: onClose={setIsOpen} . |
initialFocus | React.MutableRefObject | / | A ref to an element that should receive focus first. |
as | String | Component | div | The element or component the Dialog should render as. |
static | Boolean | false | Whether the element should ignore the internally managed open/closed state. |
unmount | Boolean | true | Whether the element should be unmounted or hidden based on the open/closed state. |
note: static
and unmount
can not be used at the same time. You will get a TypeScript error if you try to do it.
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the dialog is open. |
Dialog.Overlay
This can be used to create an overlay for your Dialog component. Clicking on the overlay will close the Dialog.
Props
Prop | Type | Default | Description |
---|
as | String | Component | div | The element or component the Dialog.Overlay should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the disclosure is open. |
Dialog.Title
This is the title for your Dialog. When this is used, it will set the aria-labelledby
on the Dialog.
Props
Prop | Type | Default | Description |
---|
as | String | Component | h2 | The element or component the Dialog.Title should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the disclosure is open. |
Dialog.Description
This is the description for your Dialog. When this is used, it will set the aria-describedby
on the Dialog.
Props
Prop | Type | Default | Description |
---|
as | String | Component | p | The element or component the Dialog.Description should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the disclosure is open. |
Popover
This component can be used for navigation menu's, mobile menu's and flyout menu's.
Basic example
<Popover.Group>
<Popover>
<Popover.Button>Solutions</Popover.Button>
<Popover.Panel>
<a href="#">Analytics</a>
<a href="#">Engagement</a>
<a href="#">Security</a>
<a href="#">Integrations</a>
<a href="#">Automations</a>
</Popover.Panel>
</Popover>
<a href="#">Pricing</a>
<a href="#">Docs</a>
<Popover>
<Popover.Button>More</Popover.Button>
<Popover.Panel focus>
<a href="#">Help Center</a>
<a href="#">Guides</a>
<a href="#">Events</a>
<a href="#">Security</a>
</Popover.Panel>
</Popover>
</Popover.Group>
Component API
Popover
<Popover.Group>
<Popover>
<Popover.Button>Solutions</Popover.Button>
<Popover.Panel>
<a href="#">Analytics</a>
<a href="#">Engagement</a>
<a href="#">Security</a>
<a href="#">Integrations</a>
<a href="#">Automations</a>
</Popover.Panel>
</Popover>
<a href="#">Pricing</a>
<a href="#">Docs</a>
<Popover>
<Popover.Button>More</Popover.Button>
<Popover.Panel focus>
<a href="#">Help Center</a>
<a href="#">Guides</a>
<a href="#">Events</a>
<a href="#">Security</a>
</Popover.Panel>
</Popover>
</Popover.Group>
Props
Prop | Type | Default | Description |
---|
as | String | Component | div | The element or component the Popover should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the dialog is open. |
Popover.Overlay
This can be used to create an overlay for your Popover component. Clicking on the overlay will close the Popover.
Props
Prop | Type | Default | Description |
---|
as | String | Component | div | The element or component the Popover.Overlay should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the disclosure is open. |
Popover.Button
This is the trigger component to open a Popover. You can also use this
Popover.Button
component inside a Popover.Panel
, if you do so, then it will
behave as a close
button. We will also make sure to provide the correct
aria-*
attributes onto the button.
Props
Prop | Type | Default | Description |
---|
as | String | Component | button | The element or component the Popover.Button should render as. |
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the disclosure is open. |
Popover.Panel
This component contains the contents of your Popover.
Props
Prop | Type | Default | Description |
---|
as | String | Component | div | The element or component the Popover.Panel should render as. |
focus | Boolean | false | This will force focus inside the Popover.Panel when the Popover is open. It will also close the Popover if focus left this component. |
static | Boolean | false | Whether the element should ignore the internally managed open/closed state. |
unmount | Boolean | true | Whether the element should be unmounted or hidden based on the open/closed state. |
note: static
and unmount
can not be used at the same time. You will get a TypeScript error if you try to do it.
Render prop object
Prop | Type | Description |
---|
open | Boolean | Whether or not the disclosure is open. |
Popover.Group
This allows you to wrap multiple elements and Popover's inside a group.
- When you tab out of a
Popover.Panel
, it will focus the next Popover.Button
in line. - If focus left the
Popover.Group
it will close all the Popover
's.
Props
Prop | Type | Default | Description |
---|
as | String | Component | div | The element or component the Popover.Group should render as. |
Render prop object