@sekmet/headlessui
v0.0.1TypeScript
<h3 align="center"> @headlessui/react </h3>
0/weekUpdated 3 years agoMITUnpacked: 1.1 MB
Published by sekmet
npm install @sekmet/headlessui
@headlessui/react
A set of completely unstyled, fully accessible UI components for React, designed to integrate
beautifully with Tailwind CSS.
Installation
``shnpm
npm install @headlessui/react
Yarn
yarn add @headlessui/react
`
Components
_This project is still in early development. New components will be added regularly over the coming months._
- Transition
- Menu Button (Dropdown)
- Listbox (Select)
- Switch (Toggle)
$3
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:
- Modals
- Tabs
- Slide-overs
- Mobile menus
- Accordions
...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
The
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
- Showing and hiding content
- Animating transitions
- Co-ordinating multiple transitions
- Transitioning on initial mount
- Component API
$3
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.`tsx
import { Transition } from '@headlessui/react'
import { useState } from 'react'function MyComponent() {
const [isOpen, setIsOpen] = useState(false)
return (
<>
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
)
}
`$3
Wrap the content that should be conditionally rendered in a
component, and use the show prop to control whether the content should be visible or hidden.`tsx
import { Transition } from '@headlessui/react'
import { useState } from 'react'function MyComponent() {
const [isOpen, setIsOpen] = useState(false)
return (
<>
// ...
>
I will fade in and out
)
}
`
The
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.`tsx
import { Transition } from '@headlessui/react'
import { useState } from 'react'function MyComponent() {
const [isOpen, setIsOpen] = useState(false)
return (
<>
as="a"
href="/my-url"
className="font-bold"
// ...
>
I will fade in and out
)
}
`$3
By default, a
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:
`tsx
import { Transition } from '@headlessui/react'
import { useState } from 'react'function MyComponent() {
const [isOpen, setIsOpen] = useState(false)
return (
<>
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
)
}
`In this example, the transitioning element will take 75ms to enter (that's the
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.
$3
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.`tsx
import { Transition } from '@headlessui/react'function Sidebar({ isOpen }) {
return (
{/ Background overlay /}
enterFrom="opacity-0"
enterTo="opacity-100"
leave="transition-opacity ease-linear duration-300"
leaveFrom="opacity-100"
leaveTo="opacity-0"
>
{/ ... /}
{/ Sliding sidebar /}
enterFrom="-translate-x-full"
enterTo="translate-x-0"
leave="transition ease-in-out duration-300 transform"
leaveFrom="translate-x-0"
leaveTo="-translate-x-full"
>
{/ ... /}
)
}
`The
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.$3
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.
`tsx
import { Transition } from '@headlessui/react'function MyComponent({ isShowing }) {
return (
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/}
)
}
`$3
#### Transition
jsx
show={isOpen}
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/}
`##### Props
| Prop | Type | Description |
| ------------- | ------------------------------------- | ------------------------------------------------------------------------------------- |
|
| Boolean | Whether the children should be shown or hidden. |
| as | String Component _(Default: 'div')_ | The element or component to render in place of the Transition itself. |
| appear | Boolean _(Default: false)_ | Whether the transition should run on initial mount. |
| unmount | Boolean _(Default: true)_ | Whether the element should be unmounted or hidden based on the show state. |
| enter | String _(Default: '')_ | Classes to add to the transitioning element during the entire enter phase. |
| enterFrom | String _(Default: '')_ | Classes to add to the transitioning element before the enter phase starts. |
| enterTo | String _(Default: '')_ | Classes to add to the transitioning element immediately after the enter phase starts. |
| leave | String _(Default: '')_ | Classes to add to the transitioning element during the entire leave phase. |
| leaveFrom | String _(Default: '')_ | Classes to add to the transitioning element before the leave phase starts. |
| leaveTo | String _(Default: '')_ | 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 arguments
- None
#### Transition.Child
`jsx
enterFrom="opacity-0"
enterTo="opacity-100"
leave="transition-opacity ease-linear duration-300"
leaveFrom="opacity-100"
leaveTo="opacity-0"
>
{/ ... /}
{/ ... /}
`##### Props
| Prop | Type | Description |
| ------------- | ------------------------------------- | ------------------------------------------------------------------------------------- |
|
| String Component _(Default: 'div')_ | The element or component to render in place of the Transition.Child itself. |
| appear | Boolean _(Default: false)_ | Whether the transition should run on initial mount. |
| unmount | Boolean _(Default: true)_ | Whether the element should be unmounted or hidden based on the show state. |
| enter | String _(Default: '')_ | Classes to add to the transitioning element during the entire enter phase. |
| enterFrom | String _(Default: '')_ | Classes to add to the transitioning element before the enter phase starts. |
| enterTo | String _(Default: '')_ | Classes to add to the transitioning element immediately after the enter phase starts. |
| leave | String _(Default: '')_ | Classes to add to the transitioning element during the entire leave phase. |
| leaveFrom | String _(Default: '')_ | Classes to add to the transitioning element before the leave phase starts. |
| leaveTo | String _(Default: '')_ | 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 arguments
- None
---
Menu Button (Dropdown)
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
- Styling the active item
- Showing/hiding the menu
- Disabling an item
- Transitions
- Rendering additional content
- Rendering a different element for a component
- Component API
$3
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.`jsx
import { Menu } from '@headlessui/react'function MyDropdown() {
return (
)
}
`$3
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
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.
`jsx
import { Menu } from '@headlessui/react'function MyDropdown() {
return (
active state to conditionally style the active item. /}
{({ active }) => (
${active ? 'bg-blue-500 text-white' : 'bg-white text-black'}}
href="/account-settings"
>
Account settings
)}
{/ ... /}
)
}
`$3
By default, your
instance will be shown/hidden automatically based on the internal open state tracked within the Menu component itself.`jsx
import { Menu } from '@headlessui/react'function MyDropdown() {
return (
)
}
`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
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.`jsx
import { Menu } from '@headlessui/react'function MyDropdown() {
return (
)
}
`$3
Use the
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.`jsx
import { Menu } from '@headlessui/react'function MyDropdown() {
return (
)
}
`$3
To animate the opening/closing of the menu panel, use the provided
component. All you need to do is mark your Menu.Items as static, wrap it in a , and the transition will be applied automatically.`jsx
import { Menu, Transition } from '@headlessui/react'function MyDropdown() {
return (
)}
)
}
`
$3
The
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.`jsx
import { Menu } from '@headlessui/react'function MyDropdown() {
return (
)
}
`Note that only
instances will be navigable via the keyboard.$3
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.`jsx
import { Menu } from '@headlessui/react'function MyDropdown() {
return (
{/ Render a
div instead of no wrapper element /}
ul instead of a div /}
{/ Render an li instead of no wrapper element /}
{({ active }) => (
${active && 'bg-blue-500'}} href="/account-settings">
Account settings
)}
{/ ... /}
)
}
`To tell an element to render its children directly with no wrapper element, use
.`jsx
import { Menu } from '@headlessui/react'function MyDropdown() {
return (
)
}
`$3
#### Menu
jsx
`##### Props
| Prop | Type | Default | Description |
| ---- | ------------------- | --------------------------------------- | ----------------------------------------------------- |
|
| 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
`jsx
{({ open }) => (
<>
More options
${open ? 'transform rotate-90' : ''}} />
)}
`##### Props
| Prop | Type | Default | Description |
| ---- | ------------------- | -------- | ------------------------------------------------------------ |
|
| 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
`jsx
{/ ... /}>
{/ ... /}>
`##### Props
| Prop | Type | Default | Description |
| --------- | ------------------- | ------- | --------------------------------------------------------------------------------- |
|
| 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
`jsx
{({ active }) => (
${active ? 'bg-blue-500 text-white' : 'bg-white text-black'}}
href="/account-settings"
>
Account settings
)}
`##### Props
| Prop | Type | Default | Description |
| ---------- | ------------------- | --------------------------------------- | ------------------------------------------------------------------------------------- |
|
| 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)
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
- Styling the active and selected option
- Showing/hiding the listbox
- Using a custom label
- Disabling an option
- Transitions
- Rendering additional content
- Rendering a different element for a component
- Component API
$3
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.`jsx
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 (
{selectedPerson.name}
{people.map(person => (
{person.name}
))}
)
}
`$3
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
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.
`jsx
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 (
{selectedPerson.name}
{people.map(person => (
/ Use the
active state to conditionally style the active option. /
/ Use the selected state to conditionally style the selected option. /
{({ active, selected }) => (
${active ? 'bg-blue-500 text-white' : 'bg-white text-black'}}>
{selected &&
{person.name}
)}
))}
)
}
`$3
By default the
will use the button contents as the label for screenreaders. However you can also render a custom Listbox.Label.`jsx
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 (
Assignee:
{selectedPerson.name}
{people.map(person => (
{person.name}
))}
)
}
`$3
By default, your
instance will be shown/hidden automatically based on the internal open state tracked within the Listbox component itself.`jsx
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 (
{selectedPerson.name}
{/ By default, this will automatically show/hide when the Listbox.Button is pressed. /}
{people.map(person => (
{person.name}
))}
)
}
`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
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.`jsx
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 (
{({ open }) => (
<>
{selectedPerson.name}
{open && (
{/ Using static, Listbox.Options is always rendered and ignores the open state. /}
{people.map(person => (
{person.name}
))}
)}
)}
)
}
`$3
Use the
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.`jsx
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 (
{selectedPerson.name}
{people.map(person => (
/ Disabled options will be skipped by keyboard navigation. /
{person.name}
))}
)
}
`$3
To animate the opening/closing of the listbox panel, use the provided
component. All you need to do is mark your Listbox.Options as static, wrap it in a , and the transition will be applied automatically.`jsx
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 (
{({ open }) => (
<>
{selectedPerson.name}
{/ Use the Transition + open render prop argument to add transitions. /}
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"
>
{people.map(person => (
{person.name}
))}
)}
)
}
`
$3
By default, the
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.`jsx
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 (
{selectedPerson.name}
{people.map(person => (
{person.name}
))}
)
}
`To tell an element to render its children directly with no wrapper element, use
.`jsx
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 (
{selectedPerson.name}
{people.map(person => (
{person.name}
))}
)
}
`$3
#### Listbox
jsx
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 (
{selectedPerson.name}
{people.map(person => (
{person.name}
))}
)
}
`##### Props
| Prop | Type | Default | Description |
| ---------- | ------------------- | --------------------------------------- | -------------------------------------------------------- |
|
| 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
`jsx
{({ open }) => (
<>
More options
${open ? 'transform rotate-90' : ''}} />
)}
`##### Props
| Prop | Type | Default | Description |
| ---- | ------------------- | -------- | --------------------------------------------------------------- |
|
| 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
`jsx
Enable notifications
`##### Props
| Prop | Type | Default | Description |
| ---- | ------------------- | ------- | -------------------------------------------------------------- |
|
| 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
`jsx
{/ ... /}>
{/ ... /}>
`##### Props
| Prop | Type | Default | Description |
| --------- | ------------------- | ------- | --------------------------------------------------------------------------------- |
|
| 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
`jsx
Option A
`##### Props
| Prop | Type | Default | Description |
| ---------- | ------------------- | ------- | --------------------------------------------------------------------------------------- |
|
| 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)
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
- Using a custom label
- Component API
$3
Switches are built using the
Switch component. Optionally you can also use the Switch.Group and Switch.Label components.`jsx
import { useState } from 'react'
import { Switch } from '@headlessui/react'function NotificationsToggle() {
const [enabled, setEnabled] = useState(false)
return (
onChange={setEnabled}
className={
${enabled ? 'bg-blue-600' : 'bg-gray-200'
} relative inline-flex h-6 rounded-full w-8
}
>
Enable notifications
${enabled ? 'translate-x-4' : 'translate-x-0'
} inline-block w-4 h-4 transform bg-white rounded-full
}
/>
)
}
`$3
By default the
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.
`jsx
import { useState } from 'react'
import { Switch } from '@headlessui/react'function NotificationsToggle() {
const [enabled, setEnabled] = useState(false)
return (
Enable notifications
onChange={setEnabled}
className={
${enabled ? 'bg-blue-600' : 'bg-gray-200'
} relative inline-flex h-6 rounded-full w-8
}
>
${enabled ? 'translate-x-4' : 'translate-x-0'
} inline-block w-4 h-4 transform bg-white rounded-full
}
/>
)
}
`$3
#### Switch
jsx
Enable notifications
{/ ... /}
`##### Props
| Prop | Type | Default | Description |
| ---------- | ------------------------ | -------- | ------------------------------------------------------- |
|
| 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
`jsx
Enable notifications
{/ ... /}
`##### Props
| Prop | Type | Default | Description |
| ---- | ------------------- | ------- | ------------------------------------------------------------- |
|
| String \| Component | label | The element or component the Switch.Label should render as. |#### Switch.Group
`jsx
Enable notifications
{/ ... /}
`##### Props
| Prop | Type | Default | Description |
| ---- | ------------------- | --------------------------------------- | ------------------------------------------------------------- |
|
| String \| Component | React.Fragment _(no wrapper element)_ | The element or component the Switch.Group` should render as. |