Impacteers Reusable UI

How to use the reusable components

Every component below is a live preview. Open Code (editable) to see the exact file that renders it, change it, and watch the preview update. Copy it into your page when it looks right.

The editor works like VS Code: Ctrl+Space (⌃Space on Mac) shows suggestions — component props after <Button , Tailwind classes with color swatches inside className="…". Hover a prop or class for its type or CSS. Edits stay in your browser and aren't saved to the file.

1. Import

import { Button } from "@/components/base/buttons/button";

2. Icons

import { Plus } from "@untitledui/icons"; → iconLeading={Plus}

3. Client

Add "use client" when you pass icons or event handlers.

Customizing

Custom colors

Every component takes className. Pass bg-, text- and ring- classes and they replace the component's own colors (cx uses tailwind-merge, so the last class wins).

Source: src/utils/cx.ts

PropValues
classNameroot element: bg-*, text-*, ring-*, hover:bg-*
ProgressBar progressClassNamethe filled part of the bar
ProgressBarCircle trackClassName / progressClassNamethe rings — use stroke-* classes
Input inputClassName / wrapperClassNamethe input box and its wrapper
TextArea textAreaClassNamethe textarea itself
Brand color everywherechange --color-brand-* in src/styles/theme.css

Colors through className

ShortlistedTop matchClosing soon
70%
35%

Colors as a prop (wrapper)

Actions

Buttons

Primary actions, links styled as buttons, icon buttons and loading states.

Source: src/components/base/buttons/button.tsx

Colors

Sizes

Icons, states and links

View all jobs

Props

<Button />

128 props · 1 for styling (highlighted)
PropTypeDefaultDescription
childrenReactNode—The button label. Omitting it while passing an icon renders a square, icon-only button.
color"secondary" | "tertiary" | "primary" | "link-color" | "link-gray" | "primary-destructive" | "secondary-destructive" | "tertiary-destructive" | "link-destructive""primary"The color variant of the button
hrefstring—A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).
iconLeadingReactNode | FC<{ className?: string; }>—Icon component or element to show before the text
iconTrailingReactNode | FC<{ className?: string; }>—Icon component or element to show after the text
isDisabledboolean—Disables the button and shows a disabled state
isLoadingboolean—Shows a loading spinner and disables the button
noTextPaddingboolean—Removes horizontal padding from the text content
showTextWhileLoadingboolean—When true, keeps the text visible during loading state
size"xs" | "sm" | "md" | "lg" | "xl""sm"The size variant of the button
classNamestring—The class name applied to the button.
›117 more props from react-aria, @react-types/shared, react-aria-components(aria-controls, aria-current, aria-describedby, aria-details…)
PropTypeDefaultDescription
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates whether this element represents the current item within a container or set of related
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-disabledboolean | "true" | "false"—Indicates whether the element is disabled to users of assistive technology.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
autoFocusboolean—Whether the element should receive focus on render.
dirstring—
downloadstring | boolean—Causes the browser to download the linked URL. A string may be provided to suggest a file name.
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the button with.
formActionstring | ((formData: FormData) => void | Promise<void>)—The URL that processes the information submitted by the button.
formEncTypestring—Indicates how to encode the form data that is submitted.
formMethodstring—Indicates the HTTP method used to submit the form.
formNoValidateboolean—Indicates that the form is not to be validated when it is submitted.
formTargetstring—Overrides the target attribute of the button's form owner.
hiddenboolean—
hrefLangstring—Hints at the human language of the linked URL.
idstring—The element's unique identifier. See
inertboolean—
isPendingboolean—Whether the button is in a pending state. This disables press and hover events
langstring—
namestring—Submitted as a pair with the button's value as part of the form data.
onAnimationEndAnimationEventHandler<HTMLAnchorElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLAnchorElement>—
onAnimationIterationAnimationEventHandler<HTMLAnchorElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLAnchorElement>—
onAnimationStartAnimationEventHandler<HTMLAnchorElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLAnchorElement>—
onAuxClickMouseEventHandler<HTMLAnchorElement>—
onAuxClickCaptureMouseEventHandler<HTMLAnchorElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLAnchorElement>—
onContextMenuMouseEventHandler<HTMLAnchorElement>—
onContextMenuCaptureMouseEventHandler<HTMLAnchorElement>—
onDoubleClickMouseEventHandler<HTMLAnchorElement>—
onDoubleClickCaptureMouseEventHandler<HTMLAnchorElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLAnchorElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLAnchorElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLAnchorElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLAnchorElement>—
onMouseDownMouseEventHandler<HTMLAnchorElement>—
onMouseDownCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseEnterMouseEventHandler<HTMLAnchorElement>—
onMouseLeaveMouseEventHandler<HTMLAnchorElement>—
onMouseMoveMouseEventHandler<HTMLAnchorElement>—
onMouseMoveCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseOutMouseEventHandler<HTMLAnchorElement>—
onMouseOutCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseOverMouseEventHandler<HTMLAnchorElement>—
onMouseOverCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseUpMouseEventHandler<HTMLAnchorElement>—
onMouseUpCaptureMouseEventHandler<HTMLAnchorElement>—
onPointerCancelPointerEventHandler<HTMLAnchorElement>—
onPointerCancelCapturePointerEventHandler<HTMLAnchorElement>—
onPointerDownPointerEventHandler<HTMLAnchorElement>—
onPointerDownCapturePointerEventHandler<HTMLAnchorElement>—
onPointerEnterPointerEventHandler<HTMLAnchorElement>—
onPointerLeavePointerEventHandler<HTMLAnchorElement>—
onPointerMovePointerEventHandler<HTMLAnchorElement>—
onPointerMoveCapturePointerEventHandler<HTMLAnchorElement>—
onPointerOutPointerEventHandler<HTMLAnchorElement>—
onPointerOutCapturePointerEventHandler<HTMLAnchorElement>—
onPointerOverPointerEventHandler<HTMLAnchorElement>—
onPointerOverCapturePointerEventHandler<HTMLAnchorElement>—
onPointerUpPointerEventHandler<HTMLAnchorElement>—
onPointerUpCapturePointerEventHandler<HTMLAnchorElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLAnchorElement>—
onScrollCaptureUIEventHandler<HTMLAnchorElement>—
onTouchCancelTouchEventHandler<HTMLAnchorElement>—
onTouchCancelCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchEndTouchEventHandler<HTMLAnchorElement>—
onTouchEndCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchMoveTouchEventHandler<HTMLAnchorElement>—
onTouchMoveCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchStartTouchEventHandler<HTMLAnchorElement>—
onTouchStartCaptureTouchEventHandler<HTMLAnchorElement>—
onTransitionCancelTransitionEventHandler<HTMLAnchorElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionEndTransitionEventHandler<HTMLAnchorElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionRunTransitionEventHandler<HTMLAnchorElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionStartTransitionEventHandler<HTMLAnchorElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLAnchorElement>—
onWheelWheelEventHandler<HTMLAnchorElement>—
onWheelCaptureWheelEventHandler<HTMLAnchorElement>—
pingstring—A space-separated list of URLs to ping when the link is followed. See
preventFocusOnPressboolean—Whether to prevent focus from moving to the button when pressing it.
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—How much of the referrer to send when following the link. See
relstring—The relationship between the linked resource and the current page. See
render((props: React.DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement> | React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, renderProps: LinkRenderProps) => ReactElement)—Overrides the default DOM element with a custom render function.
routerOptionsundefined—Options for the configured client side router.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<LinkRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
targetHTMLAttributeAnchorTarget—The target window for the link. See
translate"yes" | "no"—
type"button" | "submit" | "reset"—The behavior of the button when used in an HTML form.
valuestring—The value associated with the button's name when it's submitted with the form data.

Utility buttons

Compact icon-only buttons with a tooltip, and the standard close (×) button.

Source: src/components/base/buttons/button-utility.tsx · close-button.tsx

Utility buttons

Props

<ButtonUtility />

126 props · 1 for styling (highlighted)
PropTypeDefaultDescription
color"secondary" | "tertiary""secondary"The color variant of the button
hrefstring—The link target. Required as a key to select the link variant, but may be `undefined` (e.g. a disabled nav button).
iconFC<{ className?: string; }> | ReactNode—The icon to display in the button
isDisabledboolean—Disables the button and shows a disabled state
size"xs" | "sm""sm"The size variant of the button
tooltipstring—The tooltip to display when hovering over the button
tooltipPlacement"bottom" | "bottom left" | "bottom right" | "bottom start" | "bottom end" | "top" | "top left" | "top right" | "top start" | "top end" | "left" | "left top" | "left bottom" | "start" | "start top" | "start bottom" | "right" | "right top" | "right bottom" | "end" | "end top" | "end bottom""top"The placement of the tooltip
classNamestring—The class name applied to the button.
›118 more props from react-aria, @react-types/shared, react-aria-components, react(aria-controls, aria-current, aria-describedby, aria-details…)
PropTypeDefaultDescription
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates whether this element represents the current item within a container or set of related
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-disabledboolean | "true" | "false"—Indicates whether the element is disabled to users of assistive technology.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
autoFocusboolean—Whether the element should receive focus on render.
dirstring—
downloadstring | boolean—Causes the browser to download the linked URL. A string may be provided to suggest a file name.
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the button with.
formActionstring | ((formData: FormData) => void | Promise<void>)—The URL that processes the information submitted by the button.
formEncTypestring—Indicates how to encode the form data that is submitted.
formMethodstring—Indicates the HTTP method used to submit the form.
formNoValidateboolean—Indicates that the form is not to be validated when it is submitted.
formTargetstring—Overrides the target attribute of the button's form owner.
hiddenboolean—
hrefLangstring—Hints at the human language of the linked URL.
idstring—The element's unique identifier. See
inertboolean—
isPendingboolean—Whether the button is in a pending state. This disables press and hover events
langstring—
namestring—Submitted as a pair with the button's value as part of the form data.
onAnimationEndAnimationEventHandler<HTMLAnchorElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLAnchorElement>—
onAnimationIterationAnimationEventHandler<HTMLAnchorElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLAnchorElement>—
onAnimationStartAnimationEventHandler<HTMLAnchorElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLAnchorElement>—
onAuxClickMouseEventHandler<HTMLAnchorElement>—
onAuxClickCaptureMouseEventHandler<HTMLAnchorElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLAnchorElement>—
onContextMenuMouseEventHandler<HTMLAnchorElement>—
onContextMenuCaptureMouseEventHandler<HTMLAnchorElement>—
onDoubleClickMouseEventHandler<HTMLAnchorElement>—
onDoubleClickCaptureMouseEventHandler<HTMLAnchorElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLAnchorElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLAnchorElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLAnchorElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLAnchorElement>—
onMouseDownMouseEventHandler<HTMLAnchorElement>—
onMouseDownCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseEnterMouseEventHandler<HTMLAnchorElement>—
onMouseLeaveMouseEventHandler<HTMLAnchorElement>—
onMouseMoveMouseEventHandler<HTMLAnchorElement>—
onMouseMoveCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseOutMouseEventHandler<HTMLAnchorElement>—
onMouseOutCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseOverMouseEventHandler<HTMLAnchorElement>—
onMouseOverCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseUpMouseEventHandler<HTMLAnchorElement>—
onMouseUpCaptureMouseEventHandler<HTMLAnchorElement>—
onPointerCancelPointerEventHandler<HTMLAnchorElement>—
onPointerCancelCapturePointerEventHandler<HTMLAnchorElement>—
onPointerDownPointerEventHandler<HTMLAnchorElement>—
onPointerDownCapturePointerEventHandler<HTMLAnchorElement>—
onPointerEnterPointerEventHandler<HTMLAnchorElement>—
onPointerLeavePointerEventHandler<HTMLAnchorElement>—
onPointerMovePointerEventHandler<HTMLAnchorElement>—
onPointerMoveCapturePointerEventHandler<HTMLAnchorElement>—
onPointerOutPointerEventHandler<HTMLAnchorElement>—
onPointerOutCapturePointerEventHandler<HTMLAnchorElement>—
onPointerOverPointerEventHandler<HTMLAnchorElement>—
onPointerOverCapturePointerEventHandler<HTMLAnchorElement>—
onPointerUpPointerEventHandler<HTMLAnchorElement>—
onPointerUpCapturePointerEventHandler<HTMLAnchorElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLAnchorElement>—
onScrollCaptureUIEventHandler<HTMLAnchorElement>—
onTouchCancelTouchEventHandler<HTMLAnchorElement>—
onTouchCancelCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchEndTouchEventHandler<HTMLAnchorElement>—
onTouchEndCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchMoveTouchEventHandler<HTMLAnchorElement>—
onTouchMoveCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchStartTouchEventHandler<HTMLAnchorElement>—
onTouchStartCaptureTouchEventHandler<HTMLAnchorElement>—
onTransitionCancelTransitionEventHandler<HTMLAnchorElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionEndTransitionEventHandler<HTMLAnchorElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionRunTransitionEventHandler<HTMLAnchorElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionStartTransitionEventHandler<HTMLAnchorElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLAnchorElement>—
onWheelWheelEventHandler<HTMLAnchorElement>—
onWheelCaptureWheelEventHandler<HTMLAnchorElement>—
pingstring—A space-separated list of URLs to ping when the link is followed. See
preventFocusOnPressboolean—Whether to prevent focus from moving to the button when pressing it.
refLegacyRef<HTMLAnchorElement>—Allows getting a ref to the component instance.
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—How much of the referrer to send when following the link. See
relstring—The relationship between the linked resource and the current page. See
render((props: React.DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement> | React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, renderProps: LinkRenderProps) => ReactElement)—Overrides the default DOM element with a custom render function.
routerOptionsundefined—Options for the configured client side router.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<LinkRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
targetHTMLAttributeAnchorTarget—The target window for the link. See
translate"yes" | "no"—
type"button" | "submit" | "reset"—The behavior of the button when used in an HTML form.
valuestring—The value associated with the button's name when it's submitted with the form data.

<CloseButton />

116 props · 1 for styling (highlighted)
PropTypeDefaultDescription
labelstring—The accessible name of the button, applied as `aria-label`. Defaults to "Close".
size"xs" | "sm" | "md" | "lg""sm"Controls the dimensions of the button and its icon.
slotstring | null"close"The React Aria slot the button fills. Defaults to `"close"` so it
theme"light" | "dark""light"Whether the icon is styled for a light background (`light`) or a dark one (`dark`).
›112 more props from react-aria-components, react-aria, @react-types/shared(aria-controls, aria-current, aria-describedby, aria-details…)
PropTypeDefaultDescription
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates whether this element represents the current item within a container or set of related
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-disabledboolean | "true" | "false"—Indicates whether the element is disabled to users of assistive technology.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
autoFocusboolean—Whether the element should receive focus on render.
childrenReact.ReactNode | ((values: ButtonRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<ButtonRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the button with.
formActionstring | ((formData: FormData) => void | Promise<void>)—The URL that processes the information submitted by the button.
formEncTypestring—Indicates how to encode the form data that is submitted.
formMethodstring—Indicates the HTTP method used to submit the form.
formNoValidateboolean—Indicates that the form is not to be validated when it is submitted.
formTargetstring—Overrides the target attribute of the button's form owner.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the button is disabled.
isPendingboolean—Whether the button is in a pending state. This disables press and hover events
langstring—
namestring—Submitted as a pair with the button's value as part of the form data.
onAnimationEndAnimationEventHandler<HTMLButtonElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLButtonElement>—
onAnimationIterationAnimationEventHandler<HTMLButtonElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLButtonElement>—
onAnimationStartAnimationEventHandler<HTMLButtonElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLButtonElement>—
onAuxClickMouseEventHandler<HTMLButtonElement>—
onAuxClickCaptureMouseEventHandler<HTMLButtonElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLButtonElement>—
onContextMenuMouseEventHandler<HTMLButtonElement>—
onContextMenuCaptureMouseEventHandler<HTMLButtonElement>—
onDoubleClickMouseEventHandler<HTMLButtonElement>—
onDoubleClickCaptureMouseEventHandler<HTMLButtonElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLButtonElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLButtonElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLButtonElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLButtonElement>—
onMouseDownMouseEventHandler<HTMLButtonElement>—
onMouseDownCaptureMouseEventHandler<HTMLButtonElement>—
onMouseEnterMouseEventHandler<HTMLButtonElement>—
onMouseLeaveMouseEventHandler<HTMLButtonElement>—
onMouseMoveMouseEventHandler<HTMLButtonElement>—
onMouseMoveCaptureMouseEventHandler<HTMLButtonElement>—
onMouseOutMouseEventHandler<HTMLButtonElement>—
onMouseOutCaptureMouseEventHandler<HTMLButtonElement>—
onMouseOverMouseEventHandler<HTMLButtonElement>—
onMouseOverCaptureMouseEventHandler<HTMLButtonElement>—
onMouseUpMouseEventHandler<HTMLButtonElement>—
onMouseUpCaptureMouseEventHandler<HTMLButtonElement>—
onPointerCancelPointerEventHandler<HTMLButtonElement>—
onPointerCancelCapturePointerEventHandler<HTMLButtonElement>—
onPointerDownPointerEventHandler<HTMLButtonElement>—
onPointerDownCapturePointerEventHandler<HTMLButtonElement>—
onPointerEnterPointerEventHandler<HTMLButtonElement>—
onPointerLeavePointerEventHandler<HTMLButtonElement>—
onPointerMovePointerEventHandler<HTMLButtonElement>—
onPointerMoveCapturePointerEventHandler<HTMLButtonElement>—
onPointerOutPointerEventHandler<HTMLButtonElement>—
onPointerOutCapturePointerEventHandler<HTMLButtonElement>—
onPointerOverPointerEventHandler<HTMLButtonElement>—
onPointerOverCapturePointerEventHandler<HTMLButtonElement>—
onPointerUpPointerEventHandler<HTMLButtonElement>—
onPointerUpCapturePointerEventHandler<HTMLButtonElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLButtonElement>—
onScrollCaptureUIEventHandler<HTMLButtonElement>—
onTouchCancelTouchEventHandler<HTMLButtonElement>—
onTouchCancelCaptureTouchEventHandler<HTMLButtonElement>—
onTouchEndTouchEventHandler<HTMLButtonElement>—
onTouchEndCaptureTouchEventHandler<HTMLButtonElement>—
onTouchMoveTouchEventHandler<HTMLButtonElement>—
onTouchMoveCaptureTouchEventHandler<HTMLButtonElement>—
onTouchStartTouchEventHandler<HTMLButtonElement>—
onTouchStartCaptureTouchEventHandler<HTMLButtonElement>—
onTransitionCancelTransitionEventHandler<HTMLButtonElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLButtonElement>—
onTransitionEndTransitionEventHandler<HTMLButtonElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLButtonElement>—
onTransitionRunTransitionEventHandler<HTMLButtonElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLButtonElement>—
onTransitionStartTransitionEventHandler<HTMLButtonElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLButtonElement>—
onWheelWheelEventHandler<HTMLButtonElement>—
onWheelCaptureWheelEventHandler<HTMLButtonElement>—
preventFocusOnPressboolean—Whether to prevent focus from moving to the button when pressing it.
renderDOMRenderFunction<"button", ButtonRenderProps>—Overrides the default DOM element with a custom render function.
styleStyleOrFunction<ButtonRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
type"button" | "submit" | "reset"—The behavior of the button when used in an HTML form.
valuestring—The value associated with the button's name when it's submitted with the form data.

Button groups

Segmented controls for switching views or filters.

Source: src/components/base/button-group/button-group.tsx

Button group

Props

<ButtonGroup />

88 props · 2 for styling (highlighted)
PropTypeDefaultDescription
size"sm" | "md" | "lg""md"Controls the padding, text size and icon size of every item in the group.
classNamestring—The class name applied to the group wrapper.
selectedClassNamestring—Classes applied to every item while selected, e.g. "bg-[#095E15] text-white ring-[#095E15] hover:bg-[#074A11]".
›85 more props from react-aria-components, react-stately, @react-types/shared, react(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((values: ToggleButtonGroupRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
defaultSelectedKeysIterable<Key>—The initial selected keys in the collection (uncontrolled).
dirstring—
disallowEmptySelectionboolean—Whether the collection allows empty selection.
hiddenboolean—
inertboolean—
isDisabledboolean—Whether all items are disabled.
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectionChange((keys: Set<Key>) => void)—Handler that is called when the selection changes.
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
refLegacyRef<HTMLDivElement>—Allows getting a ref to the component instance.
renderDOMRenderFunction<"div", ToggleButtonGroupRenderProps>—Overrides the default DOM element with a custom render function.
selectedKeysIterable<Key>—The currently selected keys in the collection (controlled).
selectionMode"single" | "multiple"—Whether single or multiple selection is enabled.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ToggleButtonGroupRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

<ButtonGroupItem />

109 props · 2 for styling (highlighted)
PropTypeDefaultDescription
iconLeadingReactNode | FC<{ className?: string; }>—An icon rendered before the label. Passing only an icon with no children renders an icon-only button.
iconTrailingReactNode | FC<{ className?: string; }>—An icon rendered after the label.
onClick(() => void)—Handler called when the button is clicked.
classNamestring—The class name applied to the button.
selectedClassNamestring—Classes applied while selected; overrides the ButtonGroup's selectedClassName. Icons follow the text-* color.
›104 more props from react-aria-components, react-aria, @react-types/shared, react(aria-controls, aria-describedby, aria-details, aria-disabled…)
PropTypeDefaultDescription
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-disabledboolean | "true" | "false"—Indicates whether the element is disabled to users of assistive technology.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
autoFocusboolean—Whether the element should receive focus on render.
children((string | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | ((values: ToggleButtonRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)) & (string | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode>)) | null—The children of the component. A function may be provided to alter the children based on
defaultSelectedboolean—Whether the element should be selected (uncontrolled).
dirstring—
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
hiddenboolean—
idKey—When used in a ToggleButtonGroup, an identifier for the item in `selectedKeys`. When used
inertboolean—
isDisabledboolean—Whether the button is disabled.
isSelectedboolean—Whether the element should be selected (controlled).
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((isSelected: boolean) => void)—Handler that is called when the element's selection state changes.
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
preventFocusOnPressboolean—Whether to prevent focus from moving to the button when pressing it.
refLegacyRef<HTMLButtonElement>—Allows getting a ref to the component instance.
renderDOMRenderFunction<"button", ToggleButtonRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ToggleButtonRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

Social buttons

Sign-in buttons with brand logos.

Source: src/components/base/buttons/social-button.tsx

Social sign-in

Props

<SocialButton />

126 props · 1 for styling (highlighted)
PropTypeDefaultDescription
social*"google" | "facebook" | "apple" | "twitter" | "figma" | "dribble"—
childrenReactNode—
disabledboolean—Disables the button and shows a disabled state.
hrefstring—The link target. Required as a key to select the link variant, but may be `undefined` (e.g. a disabled nav button).
isDisabledboolean—Disables the button and shows a disabled state
size"md" | "lg""lg"
theme"color" | "brand" | "gray""brand"
classNamestring—
›118 more props from react-aria, @react-types/shared, react-aria-components, react(aria-controls, aria-current, aria-describedby, aria-details…)
PropTypeDefaultDescription
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates whether this element represents the current item within a container or set of related
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-disabledboolean | "true" | "false"—Indicates whether the element is disabled to users of assistive technology.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
autoFocusboolean—Whether the element should receive focus on render.
dirstring—
downloadstring | boolean—Causes the browser to download the linked URL. A string may be provided to suggest a file name.
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the button with.
formActionstring | ((formData: FormData) => void | Promise<void>)—The URL that processes the information submitted by the button.
formEncTypestring—Indicates how to encode the form data that is submitted.
formMethodstring—Indicates the HTTP method used to submit the form.
formNoValidateboolean—Indicates that the form is not to be validated when it is submitted.
formTargetstring—Overrides the target attribute of the button's form owner.
hiddenboolean—
hrefLangstring—Hints at the human language of the linked URL.
idstring—The element's unique identifier. See
inertboolean—
isPendingboolean—Whether the button is in a pending state. This disables press and hover events
langstring—
namestring—Submitted as a pair with the button's value as part of the form data.
onAnimationEndAnimationEventHandler<HTMLAnchorElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLAnchorElement>—
onAnimationIterationAnimationEventHandler<HTMLAnchorElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLAnchorElement>—
onAnimationStartAnimationEventHandler<HTMLAnchorElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLAnchorElement>—
onAuxClickMouseEventHandler<HTMLAnchorElement>—
onAuxClickCaptureMouseEventHandler<HTMLAnchorElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLAnchorElement>—
onContextMenuMouseEventHandler<HTMLAnchorElement>—
onContextMenuCaptureMouseEventHandler<HTMLAnchorElement>—
onDoubleClickMouseEventHandler<HTMLAnchorElement>—
onDoubleClickCaptureMouseEventHandler<HTMLAnchorElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLAnchorElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLAnchorElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLAnchorElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLAnchorElement>—
onMouseDownMouseEventHandler<HTMLAnchorElement>—
onMouseDownCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseEnterMouseEventHandler<HTMLAnchorElement>—
onMouseLeaveMouseEventHandler<HTMLAnchorElement>—
onMouseMoveMouseEventHandler<HTMLAnchorElement>—
onMouseMoveCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseOutMouseEventHandler<HTMLAnchorElement>—
onMouseOutCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseOverMouseEventHandler<HTMLAnchorElement>—
onMouseOverCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseUpMouseEventHandler<HTMLAnchorElement>—
onMouseUpCaptureMouseEventHandler<HTMLAnchorElement>—
onPointerCancelPointerEventHandler<HTMLAnchorElement>—
onPointerCancelCapturePointerEventHandler<HTMLAnchorElement>—
onPointerDownPointerEventHandler<HTMLAnchorElement>—
onPointerDownCapturePointerEventHandler<HTMLAnchorElement>—
onPointerEnterPointerEventHandler<HTMLAnchorElement>—
onPointerLeavePointerEventHandler<HTMLAnchorElement>—
onPointerMovePointerEventHandler<HTMLAnchorElement>—
onPointerMoveCapturePointerEventHandler<HTMLAnchorElement>—
onPointerOutPointerEventHandler<HTMLAnchorElement>—
onPointerOutCapturePointerEventHandler<HTMLAnchorElement>—
onPointerOverPointerEventHandler<HTMLAnchorElement>—
onPointerOverCapturePointerEventHandler<HTMLAnchorElement>—
onPointerUpPointerEventHandler<HTMLAnchorElement>—
onPointerUpCapturePointerEventHandler<HTMLAnchorElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLAnchorElement>—
onScrollCaptureUIEventHandler<HTMLAnchorElement>—
onTouchCancelTouchEventHandler<HTMLAnchorElement>—
onTouchCancelCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchEndTouchEventHandler<HTMLAnchorElement>—
onTouchEndCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchMoveTouchEventHandler<HTMLAnchorElement>—
onTouchMoveCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchStartTouchEventHandler<HTMLAnchorElement>—
onTouchStartCaptureTouchEventHandler<HTMLAnchorElement>—
onTransitionCancelTransitionEventHandler<HTMLAnchorElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionEndTransitionEventHandler<HTMLAnchorElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionRunTransitionEventHandler<HTMLAnchorElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionStartTransitionEventHandler<HTMLAnchorElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLAnchorElement>—
onWheelWheelEventHandler<HTMLAnchorElement>—
onWheelCaptureWheelEventHandler<HTMLAnchorElement>—
pingstring—A space-separated list of URLs to ping when the link is followed. See
preventFocusOnPressboolean—Whether to prevent focus from moving to the button when pressing it.
refLegacyRef<HTMLAnchorElement>—Allows getting a ref to the component instance.
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—How much of the referrer to send when following the link. See
relstring—The relationship between the linked resource and the current page. See
render((props: React.DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement> | React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, renderProps: LinkRenderProps) => ReactElement)—Overrides the default DOM element with a custom render function.
routerOptionsundefined—Options for the configured client side router.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<LinkRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
targetHTMLAttributeAnchorTarget—The target window for the link. See
translate"yes" | "no"—
type"button" | "submit" | "reset"—The behavior of the button when used in an HTML form.
valuestring—The value associated with the button's name when it's submitted with the form data.

Mobile app store buttons

Official-style App Store and Google Play badges.

Source: src/components/base/buttons/app-store-buttons.tsx

Store badges

Props

<AppStoreButton />

286 props · 1 for styling (highlighted)
PropTypeDefaultDescription
size"md" | "lg""md"
›285 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
downloadany—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
hrefstring—
hrefLangstring—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
mediastring—
noncestring—
onAbortReactEventHandler<HTMLAnchorElement>—
onAbortCaptureReactEventHandler<HTMLAnchorElement>—
onAnimationEndAnimationEventHandler<HTMLAnchorElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLAnchorElement>—
onAnimationIterationAnimationEventHandler<HTMLAnchorElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLAnchorElement>—
onAnimationStartAnimationEventHandler<HTMLAnchorElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLAnchorElement>—
onAuxClickMouseEventHandler<HTMLAnchorElement>—
onAuxClickCaptureMouseEventHandler<HTMLAnchorElement>—
onBeforeInputInputEventHandler<HTMLAnchorElement>—
onBeforeInputCaptureFormEventHandler<HTMLAnchorElement>—
onBeforeToggleToggleEventHandler<HTMLAnchorElement>—
onBlurFocusEventHandler<HTMLAnchorElement>—
onBlurCaptureFocusEventHandler<HTMLAnchorElement>—
onCanPlayReactEventHandler<HTMLAnchorElement>—
onCanPlayCaptureReactEventHandler<HTMLAnchorElement>—
onCanPlayThroughReactEventHandler<HTMLAnchorElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLAnchorElement>—
onChangeFormEventHandler<HTMLAnchorElement>—
onChangeCaptureFormEventHandler<HTMLAnchorElement>—
onClickMouseEventHandler<HTMLAnchorElement>—
onClickCaptureMouseEventHandler<HTMLAnchorElement>—
onCompositionEndCompositionEventHandler<HTMLAnchorElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLAnchorElement>—
onCompositionStartCompositionEventHandler<HTMLAnchorElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLAnchorElement>—
onCompositionUpdateCompositionEventHandler<HTMLAnchorElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLAnchorElement>—
onContextMenuMouseEventHandler<HTMLAnchorElement>—
onContextMenuCaptureMouseEventHandler<HTMLAnchorElement>—
onCopyClipboardEventHandler<HTMLAnchorElement>—
onCopyCaptureClipboardEventHandler<HTMLAnchorElement>—
onCutClipboardEventHandler<HTMLAnchorElement>—
onCutCaptureClipboardEventHandler<HTMLAnchorElement>—
onDoubleClickMouseEventHandler<HTMLAnchorElement>—
onDoubleClickCaptureMouseEventHandler<HTMLAnchorElement>—
onDragDragEventHandler<HTMLAnchorElement>—
onDragCaptureDragEventHandler<HTMLAnchorElement>—
onDragEndDragEventHandler<HTMLAnchorElement>—
onDragEndCaptureDragEventHandler<HTMLAnchorElement>—
onDragEnterDragEventHandler<HTMLAnchorElement>—
onDragEnterCaptureDragEventHandler<HTMLAnchorElement>—
onDragExitDragEventHandler<HTMLAnchorElement>—
onDragExitCaptureDragEventHandler<HTMLAnchorElement>—
onDragLeaveDragEventHandler<HTMLAnchorElement>—
onDragLeaveCaptureDragEventHandler<HTMLAnchorElement>—
onDragOverDragEventHandler<HTMLAnchorElement>—
onDragOverCaptureDragEventHandler<HTMLAnchorElement>—
onDragStartDragEventHandler<HTMLAnchorElement>—
onDragStartCaptureDragEventHandler<HTMLAnchorElement>—
onDropDragEventHandler<HTMLAnchorElement>—
onDropCaptureDragEventHandler<HTMLAnchorElement>—
onDurationChangeReactEventHandler<HTMLAnchorElement>—
onDurationChangeCaptureReactEventHandler<HTMLAnchorElement>—
onEmptiedReactEventHandler<HTMLAnchorElement>—
onEmptiedCaptureReactEventHandler<HTMLAnchorElement>—
onEncryptedReactEventHandler<HTMLAnchorElement>—
onEncryptedCaptureReactEventHandler<HTMLAnchorElement>—
onEndedReactEventHandler<HTMLAnchorElement>—
onEndedCaptureReactEventHandler<HTMLAnchorElement>—
onErrorReactEventHandler<HTMLAnchorElement>—
onErrorCaptureReactEventHandler<HTMLAnchorElement>—
onFocusFocusEventHandler<HTMLAnchorElement>—
onFocusCaptureFocusEventHandler<HTMLAnchorElement>—
onGotPointerCapturePointerEventHandler<HTMLAnchorElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLAnchorElement>—
onInputFormEventHandler<HTMLAnchorElement>—
onInputCaptureFormEventHandler<HTMLAnchorElement>—
onInvalidFormEventHandler<HTMLAnchorElement>—
onInvalidCaptureFormEventHandler<HTMLAnchorElement>—
onKeyDownKeyboardEventHandler<HTMLAnchorElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLAnchorElement>—
onKeyPressKeyboardEventHandler<HTMLAnchorElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLAnchorElement>—
onKeyUpKeyboardEventHandler<HTMLAnchorElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLAnchorElement>—
onLoadReactEventHandler<HTMLAnchorElement>—
onLoadCaptureReactEventHandler<HTMLAnchorElement>—
onLoadedDataReactEventHandler<HTMLAnchorElement>—
onLoadedDataCaptureReactEventHandler<HTMLAnchorElement>—
onLoadedMetadataReactEventHandler<HTMLAnchorElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLAnchorElement>—
onLoadStartReactEventHandler<HTMLAnchorElement>—
onLoadStartCaptureReactEventHandler<HTMLAnchorElement>—
onLostPointerCapturePointerEventHandler<HTMLAnchorElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLAnchorElement>—
onMouseDownMouseEventHandler<HTMLAnchorElement>—
onMouseDownCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseEnterMouseEventHandler<HTMLAnchorElement>—
onMouseLeaveMouseEventHandler<HTMLAnchorElement>—
onMouseMoveMouseEventHandler<HTMLAnchorElement>—
onMouseMoveCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseOutMouseEventHandler<HTMLAnchorElement>—
onMouseOutCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseOverMouseEventHandler<HTMLAnchorElement>—
onMouseOverCaptureMouseEventHandler<HTMLAnchorElement>—
onMouseUpMouseEventHandler<HTMLAnchorElement>—
onMouseUpCaptureMouseEventHandler<HTMLAnchorElement>—
onPasteClipboardEventHandler<HTMLAnchorElement>—
onPasteCaptureClipboardEventHandler<HTMLAnchorElement>—
onPauseReactEventHandler<HTMLAnchorElement>—
onPauseCaptureReactEventHandler<HTMLAnchorElement>—
onPlayReactEventHandler<HTMLAnchorElement>—
onPlayCaptureReactEventHandler<HTMLAnchorElement>—
onPlayingReactEventHandler<HTMLAnchorElement>—
onPlayingCaptureReactEventHandler<HTMLAnchorElement>—
onPointerCancelPointerEventHandler<HTMLAnchorElement>—
onPointerCancelCapturePointerEventHandler<HTMLAnchorElement>—
onPointerDownPointerEventHandler<HTMLAnchorElement>—
onPointerDownCapturePointerEventHandler<HTMLAnchorElement>—
onPointerEnterPointerEventHandler<HTMLAnchorElement>—
onPointerLeavePointerEventHandler<HTMLAnchorElement>—
onPointerMovePointerEventHandler<HTMLAnchorElement>—
onPointerMoveCapturePointerEventHandler<HTMLAnchorElement>—
onPointerOutPointerEventHandler<HTMLAnchorElement>—
onPointerOutCapturePointerEventHandler<HTMLAnchorElement>—
onPointerOverPointerEventHandler<HTMLAnchorElement>—
onPointerOverCapturePointerEventHandler<HTMLAnchorElement>—
onPointerUpPointerEventHandler<HTMLAnchorElement>—
onPointerUpCapturePointerEventHandler<HTMLAnchorElement>—
onProgressReactEventHandler<HTMLAnchorElement>—
onProgressCaptureReactEventHandler<HTMLAnchorElement>—
onRateChangeReactEventHandler<HTMLAnchorElement>—
onRateChangeCaptureReactEventHandler<HTMLAnchorElement>—
onResetFormEventHandler<HTMLAnchorElement>—
onResetCaptureFormEventHandler<HTMLAnchorElement>—
onScrollUIEventHandler<HTMLAnchorElement>—
onScrollCaptureUIEventHandler<HTMLAnchorElement>—
onSeekedReactEventHandler<HTMLAnchorElement>—
onSeekedCaptureReactEventHandler<HTMLAnchorElement>—
onSeekingReactEventHandler<HTMLAnchorElement>—
onSeekingCaptureReactEventHandler<HTMLAnchorElement>—
onSelectReactEventHandler<HTMLAnchorElement>—
onSelectCaptureReactEventHandler<HTMLAnchorElement>—
onStalledReactEventHandler<HTMLAnchorElement>—
onStalledCaptureReactEventHandler<HTMLAnchorElement>—
onSubmitFormEventHandler<HTMLAnchorElement>—
onSubmitCaptureFormEventHandler<HTMLAnchorElement>—
onSuspendReactEventHandler<HTMLAnchorElement>—
onSuspendCaptureReactEventHandler<HTMLAnchorElement>—
onTimeUpdateReactEventHandler<HTMLAnchorElement>—
onTimeUpdateCaptureReactEventHandler<HTMLAnchorElement>—
onToggleToggleEventHandler<HTMLAnchorElement>—
onTouchCancelTouchEventHandler<HTMLAnchorElement>—
onTouchCancelCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchEndTouchEventHandler<HTMLAnchorElement>—
onTouchEndCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchMoveTouchEventHandler<HTMLAnchorElement>—
onTouchMoveCaptureTouchEventHandler<HTMLAnchorElement>—
onTouchStartTouchEventHandler<HTMLAnchorElement>—
onTouchStartCaptureTouchEventHandler<HTMLAnchorElement>—
onTransitionCancelTransitionEventHandler<HTMLAnchorElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionEndTransitionEventHandler<HTMLAnchorElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionRunTransitionEventHandler<HTMLAnchorElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLAnchorElement>—
onTransitionStartTransitionEventHandler<HTMLAnchorElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLAnchorElement>—
onVolumeChangeReactEventHandler<HTMLAnchorElement>—
onVolumeChangeCaptureReactEventHandler<HTMLAnchorElement>—
onWaitingReactEventHandler<HTMLAnchorElement>—
onWaitingCaptureReactEventHandler<HTMLAnchorElement>—
onWheelWheelEventHandler<HTMLAnchorElement>—
onWheelCaptureWheelEventHandler<HTMLAnchorElement>—
partstring—
pingstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
targetHTMLAttributeAnchorTarget—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typestring—
typeofstring—
unselectable"off" | "on"—
vocabstring—

Forms

Inputs

Text fields with label, hint, icon, validation and controlled values.

Source: src/components/base/input/input.tsx

Label, hint, icon, states

We'll never share your email.
Enter a valid 10-digit number.

Controlled value

Hello, …

Prefix and suffix

linkedin.com/in/
LPA

Sizes

We'll send job alerts here.
We'll send job alerts here.
We'll send job alerts here.

Leading icon, dropdowns, text and button add-ons

We'll send job alerts here.
We'll send an OTP to this number.

₹

Per year, before tax.
linkedin.com/in/
days
Share it with friends to earn rewards.

Password, card, date, number, tags, file

Must be at least 8 characters.
We don't store your card details.
Interview date*
Pick a date and time.
Arrows on the right.
Minus and plus on both ends.
React
TypeScript
Type a skill and press Enter.
Chennai
Bengaluru
PDF or DOCX, up to 5 MB.

Custom colors

React

Props

<Input />

135 props · 5 for styling (highlighted)
PropTypeDefaultDescription
groupRefRef<HTMLDivElement>—
hideRequiredIndicatorboolean—Whether to hide required indicator from label
hintReactNode—Helper text displayed below the input
iconComponentType<HTMLAttributes<HTMLOrSVGElement>>—Icon component to display on the left side of the input.
labelstring—Label text for the input
placeholderstring—Placeholder text.
refRef<HTMLInputElement>—
shortcutstring | boolean—Keyboard shortcut to display.
size"sm" | "md" | "lg""md"Input size.
tooltipstring—Tooltip message on hover.
iconClassNamestring—Class name for the icon.
inputClassNamestring—Class name for the input.
tooltipClassNamestring—Class name for the tooltip.
wrapperClassNamestring—Class name for the input wrapper.
›121 more props from react-aria-components, @react-types/shared, react-aria(aria-activedescendant, aria-autocomplete, aria-controls, aria-describedby…)
PropTypeDefaultDescription
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox,
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoCompletestring—Describes the type of autocomplete functionality the input should provide if any. See
autoCorrectstring—An attribute that takes as its value a space-separated string that describes what, if any, type
autoFocusboolean—Whether the element should receive focus on render.
childrenReact.ReactNode | ((values: TextFieldRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<TextFieldRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultValuestring—The default value (uncontrolled).
dirstring—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—An enumerated attribute that defines what action label or icon to preset for the enter key on
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the value is invalid.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
maxLengthnumber—The maximum number of characters supported by the input. See
minLengthnumber—The minimum number of characters required by the input. See
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputFormEventHandler<HTMLInputElement>—Handler that is called when the input value is about to be modified. See
onBlur((e: FocusEvent<HTMLInputElement, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: string) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLInputElement>—Handler that is called when a text composition system completes or cancels the current text
onCompositionStartCompositionEventHandler<HTMLInputElement>—Handler that is called when a text composition system starts a new text composition session.
onCompositionUpdateCompositionEventHandler<HTMLInputElement>—Handler that is called when a new character is received in the current text composition
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLInputElement>—Handler that is called when the user copies text. See
onCutClipboardEventHandler<HTMLInputElement>—Handler that is called when the user cuts text. See
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<HTMLInputElement, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLInputElement>—Handler that is called when the input value is modified. See
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLInputElement>—Handler that is called when the user pastes text. See
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLInputElement>—Handler that is called when text in the input is selected. See
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
patternstring—Regex pattern that the value of the input must match to be valid. See
renderDOMRenderFunction<"div", TextFieldRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
spellCheckstring—An enumerated attribute that defines whether the element may be checked for spelling errors.
styleStyleOrFunction<TextFieldRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
type(string & {}) | "search" | "text" | "tel" | "url" | "email" | "password""text"The type of input to render. See
validate((value: string) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valuestring—The current value (controlled).

<InputGroup />

132 props · 5 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The children of the input group (i.e `<InputBase />`)
hideRequiredIndicatorboolean—Whether to hide the required indicator from the label.
hintReactNode—Helper text displayed below the input
labelstring—Label text for the input
leadingAddonReactNode—A leading addon that is displayed with visual separation from the input.
prefixstring—A prefix text that is displayed in the same box as the input.
size"sm" | "md" | "lg""md"Input size.
trailingAddonReactNode—A trailing addon that is displayed with visual separation from the input.
classNamestring—The class name to apply to the input group.
iconClassNamestring—Class name for the icon.
inputClassNamestring—Class name for the input.
tooltipClassNamestring—Class name for the tooltip.
wrapperClassNamestring—Class name for the input wrapper.
›119 more props from react-aria-components, @react-types/shared, react-aria(aria-activedescendant, aria-autocomplete, aria-controls, aria-describedby…)
PropTypeDefaultDescription
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox,
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoCompletestring—Describes the type of autocomplete functionality the input should provide if any. See
autoCorrectstring—An attribute that takes as its value a space-separated string that describes what, if any, type
autoFocusboolean—Whether the element should receive focus on render.
defaultValuestring—The default value (uncontrolled).
dirstring—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—An enumerated attribute that defines what action label or icon to preset for the enter key on
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the value is invalid.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
maxLengthnumber—The maximum number of characters supported by the input. See
minLengthnumber—The minimum number of characters required by the input. See
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputFormEventHandler<HTMLInputElement>—Handler that is called when the input value is about to be modified. See
onBlur((e: FocusEvent<HTMLInputElement, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: string) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLInputElement>—Handler that is called when a text composition system completes or cancels the current text
onCompositionStartCompositionEventHandler<HTMLInputElement>—Handler that is called when a text composition system starts a new text composition session.
onCompositionUpdateCompositionEventHandler<HTMLInputElement>—Handler that is called when a new character is received in the current text composition
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLInputElement>—Handler that is called when the user copies text. See
onCutClipboardEventHandler<HTMLInputElement>—Handler that is called when the user cuts text. See
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<HTMLInputElement, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLInputElement>—Handler that is called when the input value is modified. See
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLInputElement>—Handler that is called when the user pastes text. See
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLInputElement>—Handler that is called when text in the input is selected. See
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
patternstring—Regex pattern that the value of the input must match to be valid. See
renderDOMRenderFunction<"div", TextFieldRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
spellCheckstring—An enumerated attribute that defines whether the element may be checked for spelling errors.
styleStyleOrFunction<TextFieldRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
type(string & {}) | "search" | "text" | "tel" | "url" | "email" | "password"—The type of input to render. See
validate((value: string) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valuestring—The current value (controlled).

<InputNumber />

125 props · 3 for styling (highlighted)
PropTypeDefaultDescription
groupRefRef<HTMLDivElement>—
hideRequiredIndicatorboolean—
hintReactNode—Helper text displayed below the input
labelstring—Label text for the input
orientation"horizontal" | "vertical""vertical"Orientation of buttons.
placeholderstring—Placeholder text.
refRef<HTMLInputElement>—
size"sm" | "md" | "lg""md"Input size.
inputClassNamestring—Class name for the input.
wrapperClassNamestring—Class name for the input wrapper.
›115 more props from react-aria-components, @react-types/shared, react-aria, react-stately(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoFocusboolean—Whether the element should receive focus on render.
childrenReact.ReactNode | ((values: NumberFieldRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<NumberFieldRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
commitBehavior"validate" | "snap"—Controls the behavior of the number field when the user blurs the field after editing. 'snap'
decrementAriaLabelstring—A custom aria-label for the decrement button. If not provided, the localized string "Decrement"
defaultValuenumber—The default value (uncontrolled).
dirstring—
formstring—The `<form>` element to associate the input with.
formatOptionsIntl.NumberFormatOptions—Formatting options for the value displayed in the number field.
granularity"day" | "hour" | "minute" | "second"—Determines the smallest unit that is displayed in the date picker. By default, this is `"day"`
hiddenboolean—
idstring—The element's unique identifier. See
incrementAriaLabelstring—A custom aria-label for the increment button. If not provided, the localized string "Increment"
inertboolean—
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the input value is invalid.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
isWheelDisabledboolean—Enables or disables changing the value with scroll.
langstring—
maxValuenumber—The largest value allowed for the input.
minValuenumber—The smallest value allowed for the input.
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputFormEventHandler<HTMLInputElement>—Handler that is called when the input value is about to be modified. See
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: number) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLInputElement>—Handler that is called when a text composition system completes or cancels the current text
onCompositionStartCompositionEventHandler<HTMLInputElement>—Handler that is called when a text composition system starts a new text composition session.
onCompositionUpdateCompositionEventHandler<HTMLInputElement>—Handler that is called when a new character is received in the current text composition
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLInputElement>—Handler that is called when the user copies text. See
onCutClipboardEventHandler<HTMLInputElement>—Handler that is called when the user cuts text. See
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLInputElement>—Handler that is called when the input value is modified. See
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLInputElement>—Handler that is called when the user pastes text. See
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLInputElement>—Handler that is called when text in the input is selected. See
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
renderDOMRenderFunction<"div", NumberFieldRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
stepnumber—The amount that the input value changes with each increment or decrement "tick".
styleStyleOrFunction<NumberFieldRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
validate((value: number) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valuenumber—The current value (controlled).

<InputTags />

18 props · 1 for styling (highlighted)
PropTypeDefaultDescription
allowDuplicatesbooleanfalseWhether to allow duplicate tag values.
defaultValuestring[]—Default tags for uncontrolled mode.
hideRequiredIndicatorboolean—Whether to hide the required indicator from the label.
hintReactNode—Helper text displayed below the input.
isDisabledboolean—Whether the field is disabled.
isInvalidboolean—Whether the field is in an invalid/error state.
isRequiredboolean—Whether the field is required.
labelstring—Label text displayed above the input.
maxTagsnumber—Maximum number of tags allowed.
onChange((tags: string[]) => void)—Called when the tags array changes.
onTagAdded((tag: string) => void)—Called when a tag is added.
onTagRemoved((tag: string) => void)—Called when a tag is removed.
placeholderstring—Placeholder text for the input field.
size"sm" | "md" | "lg""md"Input size variant.
tooltipstring—Tooltip message displayed via a help icon inside the input.
validate((value: string) => boolean)—Validation function for new tags.
valuestring[]—Controlled value: array of tag strings.
classNamestring—Optional className for the outer container.

<InputFile />

14 props · 1 for styling (highlighted)
PropTypeDefaultDescription
acceptedFileTypesstring[]—Specifies what mime type of files are allowed.
allowsMultipleboolean—Whether multiple files can be selected.
buttonTextstring"Upload"The text of the upload button.
hideRequiredIndicatorboolean—Whether to hide the required indicator from the label.
hintReactNode—Helper text displayed below the input.
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the input is invalid.
isLoadingboolean—Whether the file is currently uploading.
isRequiredboolean—Whether the input is required.
labelstring—Label text for the input.
onChange((files: FileList | null) => void)—Handler when a user selects files.
placeholderstring"Choose a file"Placeholder text displayed when no file is selected.
size"sm" | "md" | "lg""sm"The size of the input.
classNamestring—The class name for the root element.

<AccentScope />

279 props · 1 for styling (highlighted)
PropTypeDefaultDescription
color*string—Any CSS color for brand-colored parts inside (focus rings, selected states, primary buttons…), e.g. "#095E15".
hoverColorstring—Hover color; defaults to a darker version of color.
›277 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

Textarea

Multi-line text input.

Source: src/components/base/textarea/textarea.tsx

Textarea

Max 500 characters.
0/200

Props

<TextArea />

133 props · 2 for styling (highlighted)
PropTypeDefaultDescription
colsnumber—Visible width of textarea in columns.
hideRequiredIndicatorboolean—Whether to hide required indicator from label.
hintstring | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | null—Helper text displayed below the textarea
labelstring—Label text for the textarea
placeholderstring—Placeholder text.
refRef<HTMLDivElement>—Ref for the textarea wrapper
rowsnumber—Visible height of textarea in rows .
showCountboolean—Shows a character counter under the textarea, e.g. "120/500" when maxLength is set.
size"sm" | "md""md"Textarea size.
textAreaRefRef<HTMLTextAreaElement>—Ref for the textarea
tooltipstring—Tooltip message displayed after the label.
textAreaClassNameClassNameOrFunction<InputRenderProps>—Class name for the textarea wrapper
›121 more props from react-aria-components, @react-types/shared, react-aria(aria-activedescendant, aria-autocomplete, aria-controls, aria-describedby…)
PropTypeDefaultDescription
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox,
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoCompletestring—Describes the type of autocomplete functionality the input should provide if any. See
autoCorrectstring—An attribute that takes as its value a space-separated string that describes what, if any, type
autoFocusboolean—Whether the element should receive focus on render.
childrenReact.ReactNode | ((values: TextFieldRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<TextFieldRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultValuestring—The default value (uncontrolled).
dirstring—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—An enumerated attribute that defines what action label or icon to preset for the enter key on
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the value is invalid.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
maxLengthnumber—The maximum number of characters supported by the input. See
minLengthnumber—The minimum number of characters required by the input. See
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputFormEventHandler<HTMLInputElement>—Handler that is called when the input value is about to be modified. See
onBlur((e: FocusEvent<HTMLInputElement, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: string) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLInputElement>—Handler that is called when a text composition system completes or cancels the current text
onCompositionStartCompositionEventHandler<HTMLInputElement>—Handler that is called when a text composition system starts a new text composition session.
onCompositionUpdateCompositionEventHandler<HTMLInputElement>—Handler that is called when a new character is received in the current text composition
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLInputElement>—Handler that is called when the user copies text. See
onCutClipboardEventHandler<HTMLInputElement>—Handler that is called when the user cuts text. See
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<HTMLInputElement, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLInputElement>—Handler that is called when the input value is modified. See
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLInputElement>—Handler that is called when the user pastes text. See
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLInputElement>—Handler that is called when text in the input is selected. See
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
patternstring—Regex pattern that the value of the input must match to be valid. See
renderDOMRenderFunction<"div", TextFieldRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
spellCheckstring—An enumerated attribute that defines whether the element may be checked for spelling errors.
styleStyleOrFunction<TextFieldRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
type(string & {}) | "search" | "text" | "tel" | "url" | "email" | "password"—The type of input to render. See
validate((value: string) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valuestring—The current value (controlled).

Verification code inputs

One box per digit, for OTP and verification codes.

Source: src/components/base/input/pin-input.tsx

OTP input

0
0
0
0
0
0
We sent a code to +91 ••••••2078

Sizes

0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0

Common patterns (verify flow, masked PIN, error, disabled)

0
0
0
0
0
0
We sent a code to +91 ••••••2078
0
0
0
0
mask shows • so the PIN stays private.
1
2
3
4
Code expired. Request a new one.
0
0
0
0
Too many attempts. Try again in 5 minutes.

Custom colors

4
8
0
0
2
7
0
0
9
0
0
0

Props

<PinInput />

283 props · 1 for styling (highlighted)
PropTypeDefaultDescription
accentColorstring—Any CSS color for the focus ring, filled boxes, digits and caret, e.g. "#095E15".
disabledbooleanfalse
invalidbooleanfalse
maskbooleanfalseShow • instead of the typed digits (for PINs).
size"xs" | "sm" | "md" | "lg" | "xxxs" | "xxs""md"
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

<PinInput.Group />

316 props · 3 for styling (highlighted)
PropTypeDefaultDescription
inputClassNamestring—
›315 more props from react, input-otp, next(about, accept, accessKey, alt…)
PropTypeDefaultDescription
aboutstring—
acceptstring—
accessKeystring—
altstring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCompleteHTMLInputAutoCompleteAttribute—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
captureboolean | "user" | "environment"—
checkedboolean—
childrenundefined—
classNamestring—
colorstring—
containerClassNamestring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
disabledboolean—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
formstring—
formActionstring | ((formData: FormData) => void | Promise<void>)—
formEncTypestring—
formMethodstring—
formNoValidateboolean—
formTargetstring—
heightstring | number—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
liststring—
maxstring | number—
maxLength*number—
minstring | number—
minLengthnumber—
multipleboolean—
namestring—
noncestring—
noScriptCSSFallbackstring | null—
onAbortReactEventHandler<HTMLInputElement>—
onAbortCaptureReactEventHandler<HTMLInputElement>—
onAnimationEndAnimationEventHandler<HTMLInputElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLInputElement>—
onAnimationIterationAnimationEventHandler<HTMLInputElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLInputElement>—
onAnimationStartAnimationEventHandler<HTMLInputElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLInputElement>—
onAuxClickMouseEventHandler<HTMLInputElement>—
onAuxClickCaptureMouseEventHandler<HTMLInputElement>—
onBeforeInputInputEventHandler<HTMLInputElement>—
onBeforeInputCaptureFormEventHandler<HTMLInputElement>—
onBeforeToggleToggleEventHandler<HTMLInputElement>—
onBlurFocusEventHandler<HTMLInputElement>—
onBlurCaptureFocusEventHandler<HTMLInputElement>—
onCanPlayReactEventHandler<HTMLInputElement>—
onCanPlayCaptureReactEventHandler<HTMLInputElement>—
onCanPlayThroughReactEventHandler<HTMLInputElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLInputElement>—
onChange((newValue: string) => unknown)—
onChangeCaptureFormEventHandler<HTMLInputElement>—
onClickMouseEventHandler<HTMLInputElement>—
onClickCaptureMouseEventHandler<HTMLInputElement>—
onComplete((...args: any[]) => unknown)—
onCompositionEndCompositionEventHandler<HTMLInputElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLInputElement>—
onCompositionStartCompositionEventHandler<HTMLInputElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLInputElement>—
onCompositionUpdateCompositionEventHandler<HTMLInputElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLInputElement>—
onContextMenuMouseEventHandler<HTMLInputElement>—
onContextMenuCaptureMouseEventHandler<HTMLInputElement>—
onCopyClipboardEventHandler<HTMLInputElement>—
onCopyCaptureClipboardEventHandler<HTMLInputElement>—
onCutClipboardEventHandler<HTMLInputElement>—
onCutCaptureClipboardEventHandler<HTMLInputElement>—
onDoubleClickMouseEventHandler<HTMLInputElement>—
onDoubleClickCaptureMouseEventHandler<HTMLInputElement>—
onDragDragEventHandler<HTMLInputElement>—
onDragCaptureDragEventHandler<HTMLInputElement>—
onDragEndDragEventHandler<HTMLInputElement>—
onDragEndCaptureDragEventHandler<HTMLInputElement>—
onDragEnterDragEventHandler<HTMLInputElement>—
onDragEnterCaptureDragEventHandler<HTMLInputElement>—
onDragExitDragEventHandler<HTMLInputElement>—
onDragExitCaptureDragEventHandler<HTMLInputElement>—
onDragLeaveDragEventHandler<HTMLInputElement>—
onDragLeaveCaptureDragEventHandler<HTMLInputElement>—
onDragOverDragEventHandler<HTMLInputElement>—
onDragOverCaptureDragEventHandler<HTMLInputElement>—
onDragStartDragEventHandler<HTMLInputElement>—
onDragStartCaptureDragEventHandler<HTMLInputElement>—
onDropDragEventHandler<HTMLInputElement>—
onDropCaptureDragEventHandler<HTMLInputElement>—
onDurationChangeReactEventHandler<HTMLInputElement>—
onDurationChangeCaptureReactEventHandler<HTMLInputElement>—
onEmptiedReactEventHandler<HTMLInputElement>—
onEmptiedCaptureReactEventHandler<HTMLInputElement>—
onEncryptedReactEventHandler<HTMLInputElement>—
onEncryptedCaptureReactEventHandler<HTMLInputElement>—
onEndedReactEventHandler<HTMLInputElement>—
onEndedCaptureReactEventHandler<HTMLInputElement>—
onErrorReactEventHandler<HTMLInputElement>—
onErrorCaptureReactEventHandler<HTMLInputElement>—
onFocusFocusEventHandler<HTMLInputElement>—
onFocusCaptureFocusEventHandler<HTMLInputElement>—
onGotPointerCapturePointerEventHandler<HTMLInputElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLInputElement>—
onInputFormEventHandler<HTMLInputElement>—
onInputCaptureFormEventHandler<HTMLInputElement>—
onInvalidFormEventHandler<HTMLInputElement>—
onInvalidCaptureFormEventHandler<HTMLInputElement>—
onKeyDownKeyboardEventHandler<HTMLInputElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLInputElement>—
onKeyPressKeyboardEventHandler<HTMLInputElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLInputElement>—
onKeyUpKeyboardEventHandler<HTMLInputElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLInputElement>—
onLoadReactEventHandler<HTMLInputElement>—
onLoadCaptureReactEventHandler<HTMLInputElement>—
onLoadedDataReactEventHandler<HTMLInputElement>—
onLoadedDataCaptureReactEventHandler<HTMLInputElement>—
onLoadedMetadataReactEventHandler<HTMLInputElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLInputElement>—
onLoadStartReactEventHandler<HTMLInputElement>—
onLoadStartCaptureReactEventHandler<HTMLInputElement>—
onLostPointerCapturePointerEventHandler<HTMLInputElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLInputElement>—
onMouseDownMouseEventHandler<HTMLInputElement>—
onMouseDownCaptureMouseEventHandler<HTMLInputElement>—
onMouseEnterMouseEventHandler<HTMLInputElement>—
onMouseLeaveMouseEventHandler<HTMLInputElement>—
onMouseMoveMouseEventHandler<HTMLInputElement>—
onMouseMoveCaptureMouseEventHandler<HTMLInputElement>—
onMouseOutMouseEventHandler<HTMLInputElement>—
onMouseOutCaptureMouseEventHandler<HTMLInputElement>—
onMouseOverMouseEventHandler<HTMLInputElement>—
onMouseOverCaptureMouseEventHandler<HTMLInputElement>—
onMouseUpMouseEventHandler<HTMLInputElement>—
onMouseUpCaptureMouseEventHandler<HTMLInputElement>—
onPasteClipboardEventHandler<HTMLInputElement>—
onPasteCaptureClipboardEventHandler<HTMLInputElement>—
onPauseReactEventHandler<HTMLInputElement>—
onPauseCaptureReactEventHandler<HTMLInputElement>—
onPlayReactEventHandler<HTMLInputElement>—
onPlayCaptureReactEventHandler<HTMLInputElement>—
onPlayingReactEventHandler<HTMLInputElement>—
onPlayingCaptureReactEventHandler<HTMLInputElement>—
onPointerCancelPointerEventHandler<HTMLInputElement>—
onPointerCancelCapturePointerEventHandler<HTMLInputElement>—
onPointerDownPointerEventHandler<HTMLInputElement>—
onPointerDownCapturePointerEventHandler<HTMLInputElement>—
onPointerEnterPointerEventHandler<HTMLInputElement>—
onPointerLeavePointerEventHandler<HTMLInputElement>—
onPointerMovePointerEventHandler<HTMLInputElement>—
onPointerMoveCapturePointerEventHandler<HTMLInputElement>—
onPointerOutPointerEventHandler<HTMLInputElement>—
onPointerOutCapturePointerEventHandler<HTMLInputElement>—
onPointerOverPointerEventHandler<HTMLInputElement>—
onPointerOverCapturePointerEventHandler<HTMLInputElement>—
onPointerUpPointerEventHandler<HTMLInputElement>—
onPointerUpCapturePointerEventHandler<HTMLInputElement>—
onProgressReactEventHandler<HTMLInputElement>—
onProgressCaptureReactEventHandler<HTMLInputElement>—
onRateChangeReactEventHandler<HTMLInputElement>—
onRateChangeCaptureReactEventHandler<HTMLInputElement>—
onResetFormEventHandler<HTMLInputElement>—
onResetCaptureFormEventHandler<HTMLInputElement>—
onScrollUIEventHandler<HTMLInputElement>—
onScrollCaptureUIEventHandler<HTMLInputElement>—
onSeekedReactEventHandler<HTMLInputElement>—
onSeekedCaptureReactEventHandler<HTMLInputElement>—
onSeekingReactEventHandler<HTMLInputElement>—
onSeekingCaptureReactEventHandler<HTMLInputElement>—
onSelectReactEventHandler<HTMLInputElement>—
onSelectCaptureReactEventHandler<HTMLInputElement>—
onStalledReactEventHandler<HTMLInputElement>—
onStalledCaptureReactEventHandler<HTMLInputElement>—
onSubmitFormEventHandler<HTMLInputElement>—
onSubmitCaptureFormEventHandler<HTMLInputElement>—
onSuspendReactEventHandler<HTMLInputElement>—
onSuspendCaptureReactEventHandler<HTMLInputElement>—
onTimeUpdateReactEventHandler<HTMLInputElement>—
onTimeUpdateCaptureReactEventHandler<HTMLInputElement>—
onToggleToggleEventHandler<HTMLInputElement>—
onTouchCancelTouchEventHandler<HTMLInputElement>—
onTouchCancelCaptureTouchEventHandler<HTMLInputElement>—
onTouchEndTouchEventHandler<HTMLInputElement>—
onTouchEndCaptureTouchEventHandler<HTMLInputElement>—
onTouchMoveTouchEventHandler<HTMLInputElement>—
onTouchMoveCaptureTouchEventHandler<HTMLInputElement>—
onTouchStartTouchEventHandler<HTMLInputElement>—
onTouchStartCaptureTouchEventHandler<HTMLInputElement>—
onTransitionCancelTransitionEventHandler<HTMLInputElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLInputElement>—
onTransitionEndTransitionEventHandler<HTMLInputElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLInputElement>—
onTransitionRunTransitionEventHandler<HTMLInputElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLInputElement>—
onTransitionStartTransitionEventHandler<HTMLInputElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLInputElement>—
onVolumeChangeReactEventHandler<HTMLInputElement>—
onVolumeChangeCaptureReactEventHandler<HTMLInputElement>—
onWaitingReactEventHandler<HTMLInputElement>—
onWaitingCaptureReactEventHandler<HTMLInputElement>—
onWheelWheelEventHandler<HTMLInputElement>—
onWheelCaptureWheelEventHandler<HTMLInputElement>—
partstring—
pasteTransformer((pasted: string) => string)—
patternstring—
placeholderstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
pushPasswordManagerStrategy"none" | "increase-width"—
radioGroupstring—
readOnlyboolean—
ref((instance: HTMLInputElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLInputElement> | null—
relstring—
render(props: RenderProps) => React.ReactNode—
requiredboolean—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
sizenumber—
slotstring—
spellCheckboolean | "true" | "false"—
srcstring—
stepstring | number—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
textAlign"left" | "right" | "center"—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeHTMLInputTypeAttribute—
typeofstring—
unselectable"off" | "on"—
valuestring—
vocabstring—
widthnumber—

<PinInput.Slot />

279 props · 1 for styling (highlighted)
PropTypeDefaultDescription
index*number—
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

Select

Pick one option from a list, with optional search.

Source: src/components/base/select/select.tsx

Select and combobox

Target role

Props

<Select />

118 props · 2 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode | ((item: SelectItemType) => ReactNode)—The dropdown contents: either `Select.Item` elements, or a render function called with each entry of `items`.
hideRequiredIndicatorboolean—Whether to hide the required indicator from the label.
hintstring—Helper text displayed below the input.
iconReactNode | FC—Leading icon shown in the trigger, used as a fallback when the selected item has no icon of its own. Accepts a component reference or a rendered element.
itemsSelectItemType[]—The options to render in the dropdown. When `children` is a function it is called once per item to render it.
labelstring—Field label displayed above the input.
size"sm" | "md" | "lg""md"The size of the component.
tooltipstring—Tooltip text for the help icon next to the label.
popoverClassNamestring—Additional classes merged onto the dropdown popover.
›109 more props from react-aria-components, @react-types/shared, react-aria, react-stately, react(allowsEmptyCollection, aria-describedby, aria-details, aria-label…)
PropTypeDefaultDescription
allowsEmptyCollectionboolean—Whether the select should be allowed to be open when the collection is empty.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoCompletestring—Describes the type of autocomplete functionality the input should provide if any. See
autoFocusboolean—Whether the element should receive focus on render.
classNameClassNameOrFunction<SelectRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultOpenboolean—Sets the default open state of the menu.
defaultSelectedKeyKey | null—The initial selected key in the collection (uncontrolled).
defaultValueKey | null—The default value (uncontrolled).
dirstring—
disabledKeysIterable<Key>—The item keys that are disabled. These items cannot be selected, focused, or otherwise
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the input value is invalid.
isOpenboolean—Sets the open state of the menu.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
namestring—The name of the input, used when submitting an HTML form.
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: Key | null) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean) => void)—Method that is called when the open state of the menu changes.
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectionChange((key: Key | null) => void)—Handler that is called when the selection changes.
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
placeholderstring"Select"Temporary text that occupies the select when it is empty.
refLegacyRef<HTMLDivElement>—Allows getting a ref to the component instance.
renderDOMRenderFunction<"div", SelectRenderProps>—Overrides the default DOM element with a custom render function.
selectedKeyKey | null—The currently selected key in the collection (controlled).
selectionMode"single"—Whether single or multiple selection is enabled.
shouldCloseOnSelectboolean—Whether the Select should close when an item is selected. Defaults to true if selectionMode is
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<SelectRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
validate((value: Key) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valueKey | null—The current value (controlled).

<Select.Item />

107 props · 1 for styling (highlighted)
PropTypeDefaultDescription
id*string | number—Unique identifier for the item.
avatarUrlstring—Avatar image URL.
iconReactNode | FC—Leading icon component or element.
labelstring—The primary display text.
selectionIndicator"none" | "checkbox" | "checkmark"—The selection indicator to be displayed on the item.
selectionIndicatorAlign"left" | "right"—The alignment of the selection indicator.
supportingTextstring—Secondary text displayed alongside the label.
›100 more props from react-aria-components, @react-types/shared(aria-label, children, className, dir…)
PropTypeDefaultDescription
aria-labelstring—An accessibility label for this item.
childrenReact.ReactNode | ((values: ListBoxItemRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<ListBoxItemRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
downloadstring | boolean—Causes the browser to download the linked URL. A string may be provided to suggest a file name.
hiddenboolean—
hrefstring—A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).
hrefLangstring—Hints at the human language of the linked URL.
inertboolean—
isDisabledboolean—Whether the item is disabled.
langstring—
onAction(() => void)—Handler that is called when a user performs an action on the item. The exact user event depends
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<HTMLDivElement, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<HTMLDivElement, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
pingstring—A space-separated list of URLs to ping when the link is followed. See
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—How much of the referrer to send when following the link. See
relstring—The relationship between the linked resource and the current page. See
render((props: React.DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement> | React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, renderProps: ListBoxItemRenderProps) => ReactElement)—Overrides the default DOM element with a custom render function.
routerOptionsundefined—Options for the configured client side router.
styleStyleOrFunction<ListBoxItemRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
targetHTMLAttributeAnchorTarget—The target window for the link. See
textValuestring—A string representation of the item's contents, used for features like typeahead.
translate"yes" | "no"—
valueSelectItemType—The object value that this item represents. When using dynamic collections, this is set

<Select.ComboBox />

125 props · 3 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode | ((item: SelectItemType) => ReactNode)—The dropdown contents: either `Select.Item` elements, or a render function called with each entry of `items`.
hideRequiredIndicatorboolean—Whether to hide the required indicator from the label.
hintstring—Helper text displayed below the input.
iconReactNode | FC—Leading icon component displayed before the input.
itemsSelectItemType[]—The options to render in the dropdown. When `children` is a function it is called once per item to render it.
labelstring—Field label displayed above the input.
placeholderstring—Placeholder text when no value is selected.
shortcutboolean—Whether to pin a ⌘K key hint to the right edge of the input. It is hidden below the medium breakpoint.
size"sm" | "md" | "lg"—The size of the component.
tooltipstring—Tooltip text for the help icon next to the label.
popoverClassNamestring—Additional classes merged onto the dropdown popover, which is sized to match the input.
shortcutClassNamestring—Additional classes merged onto the ⌘K hint container, useful for adjusting its fade and spacing.
›113 more props from react-aria-components, @react-types/shared, react-stately, react-aria, react(allowsCustomValue, allowsEmptyCollection, aria-describedby, aria-details…)
PropTypeDefaultDescription
allowsCustomValueboolean—Whether the ComboBox allows a non-item matching input value to be set.
allowsEmptyCollectionboolean—Whether the combo box allows the menu to be open when the collection is empty.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoFocusboolean—Whether the element should receive focus on render.
classNameClassNameOrFunction<ComboBoxRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultFilter((textValue: string, inputValue: string) => boolean)—The filter function used to determine if an option should be included in the combo box list.
defaultInputValuestring—The default value of the ComboBox input (uncontrolled).
defaultItemsIterable<SelectItemType>—The list of ComboBox items (uncontrolled).
defaultSelectedKeyKey | null—The initial selected key in the collection (uncontrolled).
defaultValueKey | null—The default value (uncontrolled).
dirstring—
disabledKeysIterable<Key>—The item keys that are disabled. These items cannot be selected, focused, or otherwise
formstring—The `<form>` element to associate the input with.
formValue"key" | "text"—Whether the text or key of the selected item is submitted as part of an HTML form. When
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
inputValuestring—The value of the ComboBox input (controlled).
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the input value is invalid.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
menuTrigger"manual" | "input" | "focus"—The interaction required to display the ComboBox menu.
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<HTMLInputElement, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: Key | null) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<HTMLInputElement, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputChange((value: string) => void)—Handler that is called when the ComboBox input value changes.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean, menuTrigger?: MenuTriggerAction) => void)—Method that is called when the open state of the menu changes. Returns the new open state and
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectionChange((key: Key | null) => void)—Handler that is called when the selection changes.
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
refLegacyRef<HTMLDivElement>—Allows getting a ref to the component instance.
renderDOMRenderFunction<"div", ComboBoxRenderProps>—Overrides the default DOM element with a custom render function.
selectedKeyKey | null—The currently selected key in the collection (controlled).
selectionMode"single"—Whether single or multiple selection is enabled.
shouldFocusWrapboolean—Whether keyboard navigation is circular.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ComboBoxRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
validate((value: ComboBoxValidationValue<"single">) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valueKey | null—The current value (controlled).

Checkboxes

On/off choices, with label and hint.

Source: src/components/base/checkbox/checkbox.tsx

Checkboxes

Props

<Checkbox />

116 props · 2 for styling (highlighted)
PropTypeDefaultDescription
hintReactNode—Supporting text rendered under the label. Clicks on it are stopped so reading the hint does not toggle the checkbox.
labelReactNode—Content rendered beside the box. It sits inside the checkbox's label element, so it also acts as the accessible name and toggles the checkbox when clicked.
refRef<HTMLLabelElement>—Ref to the underlying label element that wraps the box and the text.
size"sm" | "md""sm"Controls the box size, the gap between it and the text, and the label and hint typography.
selectedClassNamestring—Classes applied to the box while checked/indeterminate, e.g. "bg-[#095E15] ring-[#095E15]".
›111 more props from react-aria-components, @react-types/shared, react-aria, react-stately(aria-controls, aria-describedby, aria-details, aria-errormessage…)
PropTypeDefaultDescription
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoFocusboolean—Whether the element should receive focus on render.
childrenReact.ReactNode | ((values: CheckboxRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<CheckboxRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultSelectedboolean—Whether the element should be selected (uncontrolled).
dirstring—
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
inputRefReact.Ref<HTMLInputElement | null>—A ref for the HTML input element.
isDisabledboolean—Whether the input is disabled.
isIndeterminateboolean—Indeterminism is presentational only.
isInvalidboolean—Whether the input value is invalid.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
isSelectedboolean—Whether the element should be selected (controlled).
langstring—
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLLabelElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLLabelElement>—
onAnimationIterationAnimationEventHandler<HTMLLabelElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLLabelElement>—
onAnimationStartAnimationEventHandler<HTMLLabelElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLLabelElement>—
onAuxClickMouseEventHandler<HTMLLabelElement>—
onAuxClickCaptureMouseEventHandler<HTMLLabelElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((isSelected: boolean) => void)—Handler that is called when the element's selection state changes.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLLabelElement>—
onContextMenuMouseEventHandler<HTMLLabelElement>—
onContextMenuCaptureMouseEventHandler<HTMLLabelElement>—
onDoubleClickMouseEventHandler<HTMLLabelElement>—
onDoubleClickCaptureMouseEventHandler<HTMLLabelElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLLabelElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLLabelElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLLabelElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLLabelElement>—
onMouseDownMouseEventHandler<HTMLLabelElement>—
onMouseDownCaptureMouseEventHandler<HTMLLabelElement>—
onMouseEnterMouseEventHandler<HTMLLabelElement>—
onMouseLeaveMouseEventHandler<HTMLLabelElement>—
onMouseMoveMouseEventHandler<HTMLLabelElement>—
onMouseMoveCaptureMouseEventHandler<HTMLLabelElement>—
onMouseOutMouseEventHandler<HTMLLabelElement>—
onMouseOutCaptureMouseEventHandler<HTMLLabelElement>—
onMouseOverMouseEventHandler<HTMLLabelElement>—
onMouseOverCaptureMouseEventHandler<HTMLLabelElement>—
onMouseUpMouseEventHandler<HTMLLabelElement>—
onMouseUpCaptureMouseEventHandler<HTMLLabelElement>—
onPointerCancelPointerEventHandler<HTMLLabelElement>—
onPointerCancelCapturePointerEventHandler<HTMLLabelElement>—
onPointerDownPointerEventHandler<HTMLLabelElement>—
onPointerDownCapturePointerEventHandler<HTMLLabelElement>—
onPointerEnterPointerEventHandler<HTMLLabelElement>—
onPointerLeavePointerEventHandler<HTMLLabelElement>—
onPointerMovePointerEventHandler<HTMLLabelElement>—
onPointerMoveCapturePointerEventHandler<HTMLLabelElement>—
onPointerOutPointerEventHandler<HTMLLabelElement>—
onPointerOutCapturePointerEventHandler<HTMLLabelElement>—
onPointerOverPointerEventHandler<HTMLLabelElement>—
onPointerOverCapturePointerEventHandler<HTMLLabelElement>—
onPointerUpPointerEventHandler<HTMLLabelElement>—
onPointerUpCapturePointerEventHandler<HTMLLabelElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLLabelElement>—
onScrollCaptureUIEventHandler<HTMLLabelElement>—
onTouchCancelTouchEventHandler<HTMLLabelElement>—
onTouchCancelCaptureTouchEventHandler<HTMLLabelElement>—
onTouchEndTouchEventHandler<HTMLLabelElement>—
onTouchEndCaptureTouchEventHandler<HTMLLabelElement>—
onTouchMoveTouchEventHandler<HTMLLabelElement>—
onTouchMoveCaptureTouchEventHandler<HTMLLabelElement>—
onTouchStartTouchEventHandler<HTMLLabelElement>—
onTouchStartCaptureTouchEventHandler<HTMLLabelElement>—
onTransitionCancelTransitionEventHandler<HTMLLabelElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLLabelElement>—
onTransitionEndTransitionEventHandler<HTMLLabelElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLLabelElement>—
onTransitionRunTransitionEventHandler<HTMLLabelElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLLabelElement>—
onTransitionStartTransitionEventHandler<HTMLLabelElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLLabelElement>—
onWheelWheelEventHandler<HTMLLabelElement>—
onWheelCaptureWheelEventHandler<HTMLLabelElement>—
renderDOMRenderFunction<"label", CheckboxRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<CheckboxRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
validate((value: boolean) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valuestring—The value of the input element, used when submitting an HTML form. See

Radio buttons

Pick exactly one option from a short list.

Source: src/components/base/radio-buttons/radio-buttons.tsx

Radio group & custom color

Label, hint, disabled, no label

Sizes

Props

<RadioGroup />

98 props · 2 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The `RadioButton` elements belonging to the group, stacked in a vertical column.
size"sm" | "md""sm"Size applied to every `RadioButton` inside the group through context, taking precedence over a `size` set on the individual radio.
classNamestring—Additional classes merged onto the group wrapper that lays the radios out.
selectedClassNamestring—Classes applied to every radio in the group while selected, e.g. "bg-[#095E15] ring-[#095E15]".
›94 more props from @react-types/shared, react-stately, react-aria-components(aria-describedby, aria-details, aria-errormessage, aria-label…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
defaultValuestring | null—The default value (uncontrolled).
dirstring—
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the input value is invalid.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: string) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
orientation"horizontal" | "vertical"—The axis the Radio Button(s) should align with.
renderDOMRenderFunction<"div", RadioGroupRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<RadioGroupRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
validate((value: string) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valuestring | null—The current value (controlled).

<RadioButton />

102 props · 2 for styling (highlighted)
PropTypeDefaultDescription
hintReactNode—Supporting text rendered under the label. Clicks on it are stopped so reading the hint does not select the radio.
labelReactNode—Content rendered beside the circle. It sits inside the radio's label element, so it also acts as the accessible name and selects the radio when clicked.
refRef<HTMLLabelElement>—Ref to the underlying label element that wraps the circle and the text.
size"sm" | "md""sm"Controls the circle size, the gap between it and the text, and the label and hint typography. Ignored when a surrounding `RadioGroup` sets a size.
selectedClassNamestring—Classes applied to the circle while selected; overrides the RadioGroup's selectedClassName.
›97 more props from react-aria-components, react-aria, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoFocusboolean—Whether the element should receive focus on render.
childrenReact.ReactNode | ((values: RadioRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<RadioRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
inputRefReact.Ref<HTMLInputElement | null>—A ref for the HTML input element.
isDisabledboolean—Whether the radio button is disabled or not.
langstring—
onAnimationEndAnimationEventHandler<HTMLLabelElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLLabelElement>—
onAnimationIterationAnimationEventHandler<HTMLLabelElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLLabelElement>—
onAnimationStartAnimationEventHandler<HTMLLabelElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLLabelElement>—
onAuxClickMouseEventHandler<HTMLLabelElement>—
onAuxClickCaptureMouseEventHandler<HTMLLabelElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLLabelElement>—
onContextMenuMouseEventHandler<HTMLLabelElement>—
onContextMenuCaptureMouseEventHandler<HTMLLabelElement>—
onDoubleClickMouseEventHandler<HTMLLabelElement>—
onDoubleClickCaptureMouseEventHandler<HTMLLabelElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLLabelElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLLabelElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLLabelElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLLabelElement>—
onMouseDownMouseEventHandler<HTMLLabelElement>—
onMouseDownCaptureMouseEventHandler<HTMLLabelElement>—
onMouseEnterMouseEventHandler<HTMLLabelElement>—
onMouseLeaveMouseEventHandler<HTMLLabelElement>—
onMouseMoveMouseEventHandler<HTMLLabelElement>—
onMouseMoveCaptureMouseEventHandler<HTMLLabelElement>—
onMouseOutMouseEventHandler<HTMLLabelElement>—
onMouseOutCaptureMouseEventHandler<HTMLLabelElement>—
onMouseOverMouseEventHandler<HTMLLabelElement>—
onMouseOverCaptureMouseEventHandler<HTMLLabelElement>—
onMouseUpMouseEventHandler<HTMLLabelElement>—
onMouseUpCaptureMouseEventHandler<HTMLLabelElement>—
onPointerCancelPointerEventHandler<HTMLLabelElement>—
onPointerCancelCapturePointerEventHandler<HTMLLabelElement>—
onPointerDownPointerEventHandler<HTMLLabelElement>—
onPointerDownCapturePointerEventHandler<HTMLLabelElement>—
onPointerEnterPointerEventHandler<HTMLLabelElement>—
onPointerLeavePointerEventHandler<HTMLLabelElement>—
onPointerMovePointerEventHandler<HTMLLabelElement>—
onPointerMoveCapturePointerEventHandler<HTMLLabelElement>—
onPointerOutPointerEventHandler<HTMLLabelElement>—
onPointerOutCapturePointerEventHandler<HTMLLabelElement>—
onPointerOverPointerEventHandler<HTMLLabelElement>—
onPointerOverCapturePointerEventHandler<HTMLLabelElement>—
onPointerUpPointerEventHandler<HTMLLabelElement>—
onPointerUpCapturePointerEventHandler<HTMLLabelElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLLabelElement>—
onScrollCaptureUIEventHandler<HTMLLabelElement>—
onTouchCancelTouchEventHandler<HTMLLabelElement>—
onTouchCancelCaptureTouchEventHandler<HTMLLabelElement>—
onTouchEndTouchEventHandler<HTMLLabelElement>—
onTouchEndCaptureTouchEventHandler<HTMLLabelElement>—
onTouchMoveTouchEventHandler<HTMLLabelElement>—
onTouchMoveCaptureTouchEventHandler<HTMLLabelElement>—
onTouchStartTouchEventHandler<HTMLLabelElement>—
onTouchStartCaptureTouchEventHandler<HTMLLabelElement>—
onTransitionCancelTransitionEventHandler<HTMLLabelElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLLabelElement>—
onTransitionEndTransitionEventHandler<HTMLLabelElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLLabelElement>—
onTransitionRunTransitionEventHandler<HTMLLabelElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLLabelElement>—
onTransitionStartTransitionEventHandler<HTMLLabelElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLLabelElement>—
onWheelWheelEventHandler<HTMLLabelElement>—
onWheelCaptureWheelEventHandler<HTMLLabelElement>—
renderDOMRenderFunction<"label", RadioRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<RadioRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
value*string—The value of the radio button, used when submitting an HTML form.

Radio groups

Selectable cards (plans, people, payment methods) where only one can be picked.

Source: src/components/base/radio-groups/radio-groups.tsx

Icon simple, avatar, payment icon

Icon card (plans with price)

Radio button & checkbox

Sizes & custom colors

Props

<RadioCardGroup />

99 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—
accentColorstring—Any CSS color for the selected border and marker, e.g. "#095E15".
indicator"checkbox" | "radio""checkbox"Selection marker: a checkbox-style square (default) or a radio circle.
size"sm" | "md""sm"
classNamestring—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
›94 more props from @react-types/shared, react-aria-components, react-stately(aria-describedby, aria-details, aria-errormessage, aria-label…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
defaultValuestring | null—The default value (uncontrolled).
dirstring—
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the input value is invalid.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: string) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
orientation"horizontal" | "vertical"—The axis the Radio Button(s) should align with.
renderDOMRenderFunction<"div", RadioGroupRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<RadioGroupRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
validate((value: string) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valuestring | null—The current value (controlled).

<RadioCard />

8 props · 1 for styling (highlighted)
PropTypeDefaultDescription
title*ReactNode—
value*string—
childrenReactNode—Extra content under the description, e.g. links.
descriptionReactNode—
isDisabledboolean—
leadingReactNode | FC<{ className?: string; }>—Icon component (shown in a box), or any element such as an <Avatar /> or a payment icon.
titleSuffixReactNode—Lighter text right after the title, e.g. "$10/month" or "@olivia".
classNamestring—

<RadioPlanCard />

9 props · 1 for styling (highlighted)
PropTypeDefaultDescription
price*ReactNode—
title*ReactNode—
value*string—
badgeReactNode—Shown top-right in the body, e.g. a <Badge />.
descriptionReactNode—
iconFC<{ className?: string; }>—Icon component shown in a box before the title.
isDisabledboolean—
periodReactNode—Text after the price, e.g. "per month".
classNamestring—

Toggles

Switches for settings that apply immediately.

Source: src/components/base/toggle/toggle.tsx

Toggles

Props

<Toggle />

114 props · 3 for styling (highlighted)
PropTypeDefaultDescription
hintReactNode—Supporting text rendered under the label. Clicks on it are stopped so reading the hint does not flip the toggle.
iconOffReactNode | FC<{ className?: string; }>—Icon shown inside the knob while off, e.g. Sun.
iconOnReactNode | FC<{ className?: string; }>—Icon shown inside the knob while on, e.g. Moon01.
labelstring—Text rendered beside the toggle. It sits inside the switch's label element, so it also acts as the accessible name and flips the toggle when clicked.
size"sm" | "md""sm"
slimboolean—Renders the compact toggle variant, with a shorter track and a bordered knob that overlaps its edges.
selectedClassNamestring—Track classes while on, e.g. "bg-gray-900 text-gray-900". text-* sets the "on" icon color.
trackClassNamestring—Track classes while off, e.g. "bg-amber-100 text-amber-500". text-* sets the "off" icon color.
›106 more props from react-aria-components, @react-types/shared, react-aria, react-stately(aria-controls, aria-describedby, aria-details, aria-errormessage…)
PropTypeDefaultDescription
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoFocusboolean—Whether the element should receive focus on render.
childrenReact.ReactNode | ((values: SwitchRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<SwitchRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultSelectedboolean—Whether the element should be selected (uncontrolled).
dirstring—
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
inputRefReact.Ref<HTMLInputElement | null>—A ref for the HTML input element.
isDisabledboolean—Whether the input is disabled.
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isSelectedboolean—Whether the element should be selected (controlled).
langstring—
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLLabelElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLLabelElement>—
onAnimationIterationAnimationEventHandler<HTMLLabelElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLLabelElement>—
onAnimationStartAnimationEventHandler<HTMLLabelElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLLabelElement>—
onAuxClickMouseEventHandler<HTMLLabelElement>—
onAuxClickCaptureMouseEventHandler<HTMLLabelElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((isSelected: boolean) => void)—Handler that is called when the element's selection state changes.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLLabelElement>—
onContextMenuMouseEventHandler<HTMLLabelElement>—
onContextMenuCaptureMouseEventHandler<HTMLLabelElement>—
onDoubleClickMouseEventHandler<HTMLLabelElement>—
onDoubleClickCaptureMouseEventHandler<HTMLLabelElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLLabelElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLLabelElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLLabelElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLLabelElement>—
onMouseDownMouseEventHandler<HTMLLabelElement>—
onMouseDownCaptureMouseEventHandler<HTMLLabelElement>—
onMouseEnterMouseEventHandler<HTMLLabelElement>—
onMouseLeaveMouseEventHandler<HTMLLabelElement>—
onMouseMoveMouseEventHandler<HTMLLabelElement>—
onMouseMoveCaptureMouseEventHandler<HTMLLabelElement>—
onMouseOutMouseEventHandler<HTMLLabelElement>—
onMouseOutCaptureMouseEventHandler<HTMLLabelElement>—
onMouseOverMouseEventHandler<HTMLLabelElement>—
onMouseOverCaptureMouseEventHandler<HTMLLabelElement>—
onMouseUpMouseEventHandler<HTMLLabelElement>—
onMouseUpCaptureMouseEventHandler<HTMLLabelElement>—
onPointerCancelPointerEventHandler<HTMLLabelElement>—
onPointerCancelCapturePointerEventHandler<HTMLLabelElement>—
onPointerDownPointerEventHandler<HTMLLabelElement>—
onPointerDownCapturePointerEventHandler<HTMLLabelElement>—
onPointerEnterPointerEventHandler<HTMLLabelElement>—
onPointerLeavePointerEventHandler<HTMLLabelElement>—
onPointerMovePointerEventHandler<HTMLLabelElement>—
onPointerMoveCapturePointerEventHandler<HTMLLabelElement>—
onPointerOutPointerEventHandler<HTMLLabelElement>—
onPointerOutCapturePointerEventHandler<HTMLLabelElement>—
onPointerOverPointerEventHandler<HTMLLabelElement>—
onPointerOverCapturePointerEventHandler<HTMLLabelElement>—
onPointerUpPointerEventHandler<HTMLLabelElement>—
onPointerUpCapturePointerEventHandler<HTMLLabelElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLLabelElement>—
onScrollCaptureUIEventHandler<HTMLLabelElement>—
onTouchCancelTouchEventHandler<HTMLLabelElement>—
onTouchCancelCaptureTouchEventHandler<HTMLLabelElement>—
onTouchEndTouchEventHandler<HTMLLabelElement>—
onTouchEndCaptureTouchEventHandler<HTMLLabelElement>—
onTouchMoveTouchEventHandler<HTMLLabelElement>—
onTouchMoveCaptureTouchEventHandler<HTMLLabelElement>—
onTouchStartTouchEventHandler<HTMLLabelElement>—
onTouchStartCaptureTouchEventHandler<HTMLLabelElement>—
onTransitionCancelTransitionEventHandler<HTMLLabelElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLLabelElement>—
onTransitionEndTransitionEventHandler<HTMLLabelElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLLabelElement>—
onTransitionRunTransitionEventHandler<HTMLLabelElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLLabelElement>—
onTransitionStartTransitionEventHandler<HTMLLabelElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLLabelElement>—
onWheelWheelEventHandler<HTMLLabelElement>—
onWheelCaptureWheelEventHandler<HTMLLabelElement>—
renderDOMRenderFunction<"label", SwitchRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<SwitchRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
valuestring—The value of the input element, used when submitting an HTML form. See

Sliders

Choose a value or a range.

Source: src/components/base/slider/slider.tsx

Single and range

40%
3 LPA
12 LPA
60%
2 yrs
6 yrs

Props

<Slider />

95 props · 4 for styling (highlighted)
PropTypeDefaultDescription
labelFormatter((value: number) => string)—
labelPosition"bottom" | "default" | "top-floating""default"
fillClassNamestring—Classes for the filled part of the track, e.g. "bg-[#095E15]".
thumbClassNamestring—Classes for the thumb, e.g. "ring-[#095E15]" (border) or "bg-[#095E15]" (fill).
trackClassNamestring—Classes for the empty track, e.g. "bg-gray-200".
›90 more props from react-aria-components, react-stately, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((values: SliderRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<SliderRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultValuenumber | number[]—The default value (uncontrolled).
dirstring—
formatOptionsIntl.NumberFormatOptions—The display format of the value label.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the whole Slider is disabled.
langstring—
maxValuenumber100The slider's maximum value.
minValuenumber0The slider's minimum value.
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onChange((value: number | number[]) => void)—Handler that is called when the value changes.
onChangeEnd((value: number | number[]) => void)—Fired when the slider stops moving, due to being let go.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
orientation"horizontal" | "vertical"—The orientation of the Slider.
renderDOMRenderFunction<"div", SliderRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
stepnumber—The slider's step value.
styleStyleOrFunction<SliderRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
valuenumber | number[]—The current value (controlled).

Tags

Removable chips, e.g. skills or filters.

Source: src/components/base/tags/tags.tsx

Tags

React
TypeScript
SQL
Figma
Active
Applications12

Props

<TagGroup />

94 props · 1 for styling (highlighted)
PropTypeDefaultDescription
label*string—
size"sm" | "md" | "lg""sm"
›92 more props from react-aria-components, @react-types/shared, react-aria, react(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenstring | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | null—The children of the component.
classNamestring—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultSelectedKeysIterable<Key> | "all"—The initial selected keys in the collection (uncontrolled).
dirstring—
disabledKeysIterable<Key>—The item keys that are disabled. These items cannot be selected, focused, or otherwise
disallowEmptySelectionboolean—Whether the collection allows empty selection.
escapeKeyBehavior"none" | "clearSelection"—Whether pressing the escape key should clear selection in the TagGroup or not.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
langstring—
onAction((key: Key) => void)—Handler that is called when a user performs an action on an item. The exact user event depends
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onRemove((keys: Set<Key>) => void)—Handler that is called when a user deletes a tag.
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectionChange((keys: Selection) => void)—Handler that is called when the selection changes.
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
refLegacyRef<HTMLDivElement>—Allows getting a ref to the component instance.
renderDOMRenderFunction<"div", undefined>—Overrides the default DOM element with a custom render function.
selectedKeysIterable<Key> | "all"—The currently selected keys in the collection (controlled).
selectionBehavior"replace" | "toggle"—How multiple selection should behave in the collection.
selectionMode"single" | "multiple" | "none""none"The type of selection that is allowed in the collection.
shouldSelectOnPressUpboolean—Whether selection should occur on press up instead of press down.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleReact.CSSProperties—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

<Tag />

104 props · 2 for styling (highlighted)
PropTypeDefaultDescription
avatarContrastBorderbooleantrue
avatarSrcstring—
countnumber—
dotboolean—
onClose((id: string) => void)—
dotClassNamestring—
›98 more props from react-aria-components, @react-types/shared, react(children, className, dir, download…)
PropTypeDefaultDescription
children((string | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | ((values: TagRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)) & (string | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode>)) | null—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<TagRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
downloadstring | boolean—Causes the browser to download the linked URL. A string may be provided to suggest a file name.
hiddenboolean—
hrefstring—A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).
hrefLangstring—Hints at the human language of the linked URL.
idKey—A unique id for the tag.
inertboolean—
isDisabledboolean—Whether the tag is disabled.
langstring—
onAction(() => void)—Handler that is called when a user performs an action on the item. The exact user event depends
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
pingstring—A space-separated list of URLs to ping when the link is followed. See
refLegacyRef<object>—Allows getting a ref to the component instance.
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—How much of the referrer to send when following the link. See
relstring—The relationship between the linked resource and the current page. See
renderDOMRenderFunction<"div", TagRenderProps>—Overrides the default DOM element with a custom render function.
routerOptionsundefined—Options for the configured client side router.
styleStyleOrFunction<TagRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
targetHTMLAttributeAnchorTarget—The target window for the link. See
textValuestring—A string representation of the tags's contents, used for accessibility.
translate"yes" | "no"—

Date pickers

Single date and date range pickers with a calendar popover.

Source: src/components/application/date-picker/

Date and range

Props

<DatePicker />

118 props · 2 for styling (highlighted)
PropTypeDefaultDescription
accentColorstring—Any CSS color for the selected day, range, today dot, focus ring and Apply button, e.g. "#095E15".
accentHoverColorstring—Hover color for the selected day and Apply button. Defaults to a darker accentColor.
onApply(() => void)—The function to call when the apply button is clicked.
onCancel(() => void)—The function to call when the cancel button is clicked.
size"xs" | "sm" | "md" | "lg" | "xl""sm"Size of the trigger button.
triggerClassNamestring—Classes for the trigger button, e.g. "text-[#095E15] ring-[#095E15]".
›112 more props from react-aria-components, @react-types/shared, react-stately, react-aria(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoCompletestring—Describes the type of autocomplete functionality the input should provide if any. See
autoFocusboolean—Whether the element should receive focus on render.
childrenReact.ReactNode | ((values: DatePickerRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<DatePickerRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultOpenboolean—Whether the overlay is open by default (uncontrolled).
defaultValueDateValue | null—The default value (uncontrolled).
dirstring—
firstDayOfWeek"sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat"—The day that starts the week.
formstring—The `<form>` element to associate the input with.
granularity"day" | "hour" | "minute" | "second"—Determines the smallest unit that is displayed in the date picker. By default, this is `"day"`
hiddenboolean—
hideTimeZoneboolean—Whether to hide the time zone abbreviation.
hourCycle12 | 24—Whether to display the time in 12 or 24 hour format. By default, this is determined by the
idstring—The element's unique identifier. See
inertboolean—
isDateUnavailable((date: DateValue) => boolean)—Callback that is called for each date of the calendar. If it returns true, then the date is
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the input value is invalid.
isOpenboolean—Whether the overlay is open by default (controlled).
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
maxValueDateValue | null—The maximum allowed date that a user may select.
minValueDateValue | null—The minimum allowed date that a user may select.
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: DateValue | null) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean) => void)—Handler that is called when the overlay's open state changes.
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
pageBehavior"single" | "visible"—Controls the behavior of paging. Pagination either works by advancing the visible page by
placeholderValueDateValue | null—A placeholder date that influences the format of the placeholder shown when no value is
renderDOMRenderFunction<"div", DatePickerRenderProps>—Overrides the default DOM element with a custom render function.
shouldCloseOnSelectboolean | (() => boolean)—Determines whether the date picker popover should close automatically when a date is selected.
shouldForceLeadingZerosboolean—Whether to always show leading zeros in the month, day, and hour fields.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<DatePickerRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
validate((value: DateValue) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valueDateValue | null—The current value (controlled).

<DateRangePicker />

119 props · 2 for styling (highlighted)
PropTypeDefaultDescription
accentColorstring—Any CSS color for the selected day, range, today dot, focus ring and Apply button, e.g. "#095E15".
accentHoverColorstring—Hover color for the selected day and Apply button. Defaults to a darker accentColor.
onApply(() => void)—The function to call when the apply button is clicked.
onCancel(() => void)—The function to call when the cancel button is clicked.
size"xs" | "sm" | "md" | "lg" | "xl""sm"Size of the trigger button.
triggerClassNamestring—Classes for the trigger button, e.g. "text-[#095E15] ring-[#095E15]".
›113 more props from react-aria-components, @react-types/shared, react-stately(allowsNonContiguousRanges, aria-describedby, aria-details, aria-label…)
PropTypeDefaultDescription
allowsNonContiguousRangesboolean—When combined with `isDateUnavailable`, determines whether non-contiguous ranges,
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoFocusboolean—Whether the element should receive focus on render.
childrenReact.ReactNode | ((values: DateRangePickerRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<DateRangePickerRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultOpenboolean—Whether the overlay is open by default (uncontrolled).
defaultValueRangeValue<DateValue> | null—The default value (uncontrolled).
dirstring—
endNamestring—The name of the end date input element, used when submitting an HTML form. See
firstDayOfWeek"sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat"—The day that starts the week.
formstring—The `<form>` element to associate the input with.
granularity"day" | "hour" | "minute" | "second"—Determines the smallest unit that is displayed in the date picker. By default, this is `"day"`
hiddenboolean—
hideTimeZoneboolean—Whether to hide the time zone abbreviation.
hourCycle12 | 24—Whether to display the time in 12 or 24 hour format. By default, this is determined by the
idstring—The element's unique identifier. See
inertboolean—
isDateUnavailable((date: DateValue, anchorDate: CalendarDate | null) => boolean)—Callback that is called for each date of the calendar. If it returns true, then the date is
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the input value is invalid.
isOpenboolean—Whether the overlay is open by default (controlled).
isReadOnlyboolean—Whether the input can be selected but not changed by the user.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
maxValueDateValue | null—The maximum allowed date that a user may select.
minValueDateValue | null—The minimum allowed date that a user may select.
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: RangeValue<DateValue> | null) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean) => void)—Handler that is called when the overlay's open state changes.
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
pageBehavior"single" | "visible"—Controls the behavior of paging. Pagination either works by advancing the visible page by
placeholderValueDateValue | null—A placeholder date that influences the format of the placeholder shown when no value is
renderDOMRenderFunction<"div", DateRangePickerRenderProps>—Overrides the default DOM element with a custom render function.
shouldCloseOnSelectboolean | (() => boolean)—Determines whether the date picker popover should close automatically when a date is selected.
shouldForceLeadingZerosboolean—Whether to always show leading zeros in the month, day, and hour fields.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
startNamestring—The name of the start date input element, used when submitting an HTML form. See
styleStyleOrFunction<DateRangePickerRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
validate((value: RangeValue<DateValue>) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valueRangeValue<DateValue> | null—The current value (controlled).

Calendars

Event calendar with month, week and day views, multi-day events and a live current-time line (Untitled UI PRO).

Source: src/components/application/calendar/calendar.tsx

Calendar month view

Calendar week view

Calendar day view

Props

<Calendar />

3 props · 1 for styling (highlighted)
PropTypeDefaultDescription
events*CalendarEvent[]—Events to place on the grid. Each is positioned from its `start`/`end` and may span several days.
view"day" | "month" | "week""month"The view the calendar opens on. Users can switch between day, week and month from the header dropdown afterwards.
classNamestring—Additional class name for the calendar wrapper.

File uploaders

Drag-and-drop zone with a file list and progress bars.

Source: src/components/application/file-upload/file-upload-base.tsx

Resume upload

or drag and drop

PDF or DOCX, up to 5 MB

  • Arun_Resume.pdf

    178 KB


    Complete

    100%
or drag and drop

PNG or JPG, up to 2 MB

  • Profile_photo.jpg

    825 KB


    Uploading...

    64%
  • Portfolio.pdf

    1 MB


    40%

Props

<FileUpload.DropZone />

10 props · 1 for styling (highlighted)
PropTypeDefaultDescription
accentColorstring—Any CSS color for the drag ring, upload icon and "Click to upload" link, e.g. "#095E15". Inherited from FileUpload.Root.
acceptstring—Specifies the types of files that the server accepts.
allowsMultiplebooleantrueAllows multiple file uploads.
hintstring—A hint text explaining what files can be dropped.
isDisabledboolean—Disables dropping or uploading files.
maxSizenumber—Maximum file size in bytes.
onDropFiles((files: FileList) => void)—Callback function that is called with the list of dropped files
onDropUnacceptedFiles((files: FileList) => void)—Callback function that is called with the list of unaccepted files
onSizeLimitExceed((files: FileList) => void)—Callback function that is called with the list of files that exceed
classNamestring—The class name of the drop zone.

<FileUpload.ListItemProgressBar />

9 props · 1 for styling (highlighted)
PropTypeDefaultDescription
name*string—The name of the file.
progress*number—The upload progress of the file.
size*number—The size of the file.
failedboolean—Whether the file failed to upload.
fileIconVariant"gray" | "default" | "solid"—The variant of the file icon.
onDelete(() => void)—The function to call when the file is deleted.
onRetry(() => void)—The function to call when the file upload is retried.
typeFileType—The type of the file.
classNamestring—The class name of the file list item.

Display

Avatars

User photos, initials, status dots and name + subtitle groups.

Source: src/components/base/avatar/

Sizes and variants

Olivia Rhye
Olivia Rhye
Olivia Rhye
Olivia Rhye
Olivia Rhye
Olivia Rhye
AK

Avatar with name

Phoenix Baker

phoenix@impacteers.com

MA

Manikandan Arumugam

Frontend Developer

Props

<Avatar />

16 props · 2 for styling (highlighted)
PropTypeDefaultDescription
altstring—The alternative text for the avatar image.
badgeReactNode—Display a badge (i.e. company logo).
borderboolean—Display an outer border around the avatar.
contrastBorderboolean—Display an inner contrast border around the avatar image.
countnumber—Display a count badge.
focusablebooleanfalseWhether the avatar should show a focus ring when the parent group is in focus.
initialsstring—The initials of the user to display if no image is available.
placeholderReactNode—A placeholder to display if no image is available.
placeholderIconFC<{ className?: string; }>—An icon to display if no image is available.
roundedbooleantrueWhether the avatar should be rounded.
size"xs" | "sm" | "md" | "lg" | "xl" | "2xl""md"The dimensions of the avatar, which also scale the initials, placeholder icon and status indicator.
srcstring | null—The URL of the avatar image. Falls back to the initials, placeholder icon or placeholder if it is missing or fails to load.
status"online" | "offline"—Display a status indicator.
verifiedboolean—Display a verified tick icon.
classNamestring—The class name for the outer wrapper of the avatar.
contentClassNamestring—The class name for the main child of the avatar.

<AvatarLabelGroup />

21 props · 5 for styling (highlighted)
PropTypeDefaultDescription
size*"sm" | "md" | "lg"—The dimensions of the avatar, which also scale the initials, placeholder icon and status indicator.
subtitle*ReactNode—
title*ReactNode—
altstring—The alternative text for the avatar image.
badgeReactNode—Display a badge (i.e. company logo).
borderboolean—Display an outer border around the avatar.
contrastBorderboolean—Display an inner contrast border around the avatar image.
countnumber—Display a count badge.
focusableboolean—Whether the avatar should show a focus ring when the parent group is in focus.
initialsstring—The initials of the user to display if no image is available.
placeholderReactNode—A placeholder to display if no image is available.
placeholderIconFC<{ className?: string; }>—An icon to display if no image is available.
roundedboolean—Whether the avatar should be rounded.
srcstring | null—The URL of the avatar image. Falls back to the initials, placeholder icon or placeholder if it is missing or fails to load.
status"online" | "offline"—Display a status indicator.
verifiedboolean—Display a verified tick icon.
avatarClassNamestring—
classNamestring—The class name for the outer wrapper of the avatar.
contentClassNamestring—The class name for the main child of the avatar.
subtitleClassNamestring—Classes for the subtitle text.
titleClassNamestring—Classes for the title text, e.g. a text color. `className` styles the outer wrapper only.

Badges

Short status labels.

Source: src/components/base/badges/badges.tsx

Types, colors, sizes

GrayBrandHiredPendingRejectedBlue
SquareModern
SmallMediumLarge

Dot, icon, flag, removable

Online12%IN flagIndiaRemote

Custom text, background and border

ShortlistedTop matchClosing soon12% salary hikeIN flagIndiaRemote

Props

<Badge />

5 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The content of the badge, usually a short text label.
color"brand" | "gray" | "warning" | "error" | "success" | "slate" | "sky" | "blue" | "indigo" | "purple" | "pink" | "orange""gray"The color palette used for the badge background, text, and ring. The `modern` type only supports `gray`.
size"sm" | "md" | "lg""md"Controls the padding and font size of the badge.
type"color" | "modern" | "pill-color""pill-color"The shape and treatment of the badge: `pill-color` is fully rounded, `color` is a rounded rectangle, and `modern` is a white badge with a border and a subtle shadow.
classNamestring—Root element: bg-*, text-*, ring-* (border) classes replace the badge colors.

<BadgeWithDot />

6 props · 2 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—
color"brand" | "gray" | "warning" | "error" | "success" | "slate" | "sky" | "blue" | "indigo" | "purple" | "pink" | "orange""gray"The color palette used for the badge background, text, ring, and the leading dot. With the `modern` type only the dot is colored.
size"sm" | "md" | "lg""md"Controls the gap, padding, and font size of the badge.
type"color" | "modern" | "pill-color""pill-color"The shape and treatment of the badge: `pill-color` is fully rounded, `color` is a rounded rectangle, and `modern` is a white badge with a border and a subtle shadow.
addonClassNamestring—The dot, e.g. "text-[#095E15]".
classNamestring—Root element: bg-*, text-*, ring-* (border) classes replace the badge colors.

<BadgeWithIcon />

8 props · 2 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The content shown between the icons, usually a short text label.
color"brand" | "gray" | "warning" | "error" | "success" | "slate" | "sky" | "blue" | "indigo" | "purple" | "pink" | "orange""gray"The color palette used for the badge background, text, ring, and icons. With the `modern` type only the icons are colored.
iconLeadingIconComponentType—An icon component rendered before the label. Providing it also switches the badge to the tighter leading padding.
iconTrailingIconComponentType—An icon component rendered after the label.
size"sm" | "md" | "lg""md"Controls the gap, padding, and font size of the badge.
type"color" | "modern" | "pill-color""pill-color"The shape and treatment of the badge: `pill-color` is fully rounded, `color` is a rounded rectangle, and `modern` is a white badge with a border and a subtle shadow.
addonClassNamestring—The leading/trailing icon, e.g. "text-[#095E15]".
classNamestring—Root element: bg-*, text-*, ring-* (border) classes replace the badge colors.

<BadgeWithFlag />

6 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The content shown after the flag, usually a country or region name.
color"brand" | "gray" | "warning" | "error" | "success" | "slate" | "sky" | "blue" | "indigo" | "purple" | "pink" | "orange""gray"The color palette used for the badge background, text, and ring. The `modern` type only supports `gray`.
flag"AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AR" | "AS" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ-1" | "BQ-2" | "BQ" | "BR" | "BS" | "BT" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD-1" | "CD" | "CF" | "CH" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DS" | "DZ" | "earth" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FM" | "FO" | "FR" | "GA" | "GB-2" | "GB" | "GD" | "GE" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GQ" | "GR" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MG" | "MH" | "MK" | "ML" | "MM" | "MN" | "MO" | "MP" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PT" | "PW" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VI" | "VN" | "VU" | "WF" | "WS" | "YE" | "YT" | "ZA" | "ZM" | "ZW""AU"The ISO country code of the flag shown before the label. It is loaded as a circular SVG from the Untitled UI flag CDN and also used for the image alt text.
size"sm" | "md" | "lg""md"Controls the gap, padding, and font size of the badge.
type"color" | "modern" | "pill-color""pill-color"The shape and treatment of the badge: `pill-color` is fully rounded, `color` is a rounded rectangle, and `modern` is a white badge with a border and a subtle shadow.
classNamestring—Root element: bg-*, text-*, ring-* (border) classes replace the badge colors.

<BadgeWithButton />

9 props · 2 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The content shown before the button, usually a short text label.
buttonLabelstring—The label for the button.
color"brand" | "gray" | "warning" | "error" | "success" | "slate" | "sky" | "blue" | "indigo" | "purple" | "pink" | "orange""gray"The color palette used for the badge background, text, ring, and the trailing button's hover state. The `modern` type only supports `gray`.
iconIconComponentTypeCloseXThe icon component rendered inside the trailing button, typically a dismiss icon.
onButtonClickMouseEventHandler<HTMLButtonElement>—The click event handler for the button.
size"sm" | "md" | "lg""md"Controls the gap, padding, and font size of the badge.
type"color" | "modern" | "pill-color""pill-color"The shape and treatment of the badge: `pill-color` is fully rounded, `color` is a rounded rectangle, and `modern` is a white badge with a border and a subtle shadow.
addonClassNamestring—The close (×) button, e.g. "text-[#095E15]".
classNamestring—Root element: bg-*, text-*, ring-* (border) classes replace the badge colors.

<BadgeIcon />

7 props · 2 for styling (highlighted)
PropTypeDefaultDescription
icon*FunctionComponent<{ className?: string; strokeWidth?: string | number; }>—The icon component rendered as the sole content of the badge.
childrenReactNode—Accepted for consistency with the other badges but not rendered — this badge shows only the icon.
color"brand" | "gray" | "warning" | "error" | "success" | "slate" | "sky" | "blue" | "indigo" | "purple" | "pink" | "orange""gray"The color palette used for the badge background, ring, and icon. The `modern` type only supports `gray`.
size"sm" | "md" | "lg""md"Controls the padding around the icon, which sets the overall size of the badge.
type"color" | "modern" | "pill-color""pill-color"The shape and treatment of the badge: `pill-color` is fully rounded, `color` is a rounded rectangle, and `modern` is a white badge with a border and a subtle shadow.
addonClassNamestring—The icon, e.g. "text-[#095E15]".
classNamestring—Root element: bg-*, text-*, ring-* (border) classes replace the badge colors.

Badge groups

Announcement pills, e.g. above a hero heading.

Source: src/components/base/badges/badge-groups.tsx

Badge groups

NewAI mock interviews are live
Resume analyser v2Update

Props

<BadgeGroup />

8 props · 1 for styling (highlighted)
PropTypeDefaultDescription
addonText*string—
color*"brand" | "gray" | "warning" | "error" | "success""brand"
align"leading" | "trailing""leading"Alignment of the badge addon element.
childrenReactNode—
iconTrailingReactNode | FC<{ className?: string; }>ArrowRight
size"md" | "lg""md"
theme"light" | "modern""light"
classNamestring—

Tooltips

Extra info on hover or focus.

Source: src/components/base/tooltip/tooltip.tsx

Tooltips

Props

<Tooltip />

99 props · 1 for styling (highlighted)
PropTypeDefaultDescription
title*ReactNode—The title of the tooltip.
arrowbooleanfalseWhether to show the arrow on the tooltip.
delaynumber300Delay in milliseconds before the tooltip is shown.
descriptionReactNode—The description of the tooltip.
›95 more props from react-aria-components, react-stately, @react-types/shared, react-aria(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
arrowBoundaryOffsetnumber—The minimum distance the arrow's edge should be from the edge of the overlay element.
children*string | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | null—
classNameClassNameOrFunction<TooltipRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
closeDelaynumber0The delay time for the tooltip to close. [See
containerPaddingnumber—The placement padding that should be applied between the element and its
crossOffsetnumber—The additional offset applied along the cross axis between the element and its
defaultOpenboolean—Whether the overlay is open by default (uncontrolled).
dirstring—
hiddenboolean—
inertboolean—
isDisabledboolean—Whether the tooltip should be disabled, independent from the trigger.
isEnteringboolean—Whether the tooltip is currently performing an entry animation.
isExitingboolean—Whether the tooltip is currently performing an exit animation.
isOpenboolean—Whether the overlay is open by default (controlled).
langstring—
offsetnumber6The additional offset applied along the main axis between the element and its
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean) => void)—Handler that is called when the overlay's open state changes.
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
placement"bottom" | "bottom left" | "bottom right" | "bottom start" | "bottom end" | "top" | "top left" | "top right" | "top start" | "top end" | "left" | "left top" | "left bottom" | "start" | "start top" | "start bottom" | "right" | "right top" | "right bottom" | "end" | "end top" | "end bottom""top"The placement of the tooltip with respect to the trigger.
renderDOMRenderFunction<"div", TooltipRenderProps>—Overrides the default DOM element with a custom render function.
shouldCloseOnPressboolean—Whether the tooltip should close when the trigger is pressed.
shouldFlipboolean—Whether the element should flip its orientation (e.g. top to bottom or left to right) when
styleStyleOrFunction<TooltipRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
trigger"focus" | "hover"—By default, opens for both focus and hover. Can be made to open only for focus.
triggerRefRefObject<Element | null>—The ref for the element which the tooltip positions itself with respect to.
UNSTABLE_portalContainerElement—The container element in which the overlay portal will be placed. This may have unknown

Progress indicators

Bars and circles for completion and scores.

Source: src/components/base/progress-indicators/

Bars and circles

65%
80%
Profile
72%
Skills
45%
Match
60%

Impacteers gradient (3 colors)

30%
70%
100%
Profile
72%
Job match
88%
Future-ready score
64%

Score gauge (orange → green)

20%
Score
55%
Resume Score
90%
Score

Props

<ProgressBar />

7 props · 2 for styling (highlighted)
PropTypeDefaultDescription
value*number—The current value of the progress bar.
labelPosition"bottom" | "right" | "top-floating" | "bottom-floating"—Specifies the layout of the text relative to the progress bar.
maxnumber100The maximum value of the progress bar.
minnumber0The minimum value of the progress bar.
valueFormatter((value: number, valueInPercentage: number) => string | number)—Optional function to format the displayed value.
classNamestring—Optional additional CSS class names for the progress bar container.
progressClassNamestring—Optional additional CSS class names for the progress bar indicator element.

<ProgressBarCircle />

12 props · 5 for styling (highlighted)
PropTypeDefaultDescription
size*"xs" | "sm" | "md" | "lg" | "xxs"—
value*number—
labelstring—
maxnumber100
minnumber0
progressGradientstring[]—Gradient colors for the filled ring (any CSS colors), e.g. ["#2A3180", "#39B8D5", "#287624"]. Overrides progressClassName's stroke.
valueFormatter((value: number, valueInPercentage: number) => string | number)—
classNamestring—Outer wrapper.
labelClassNamestring—The label text.
progressClassNamestring—The filled part of the ring, e.g. "stroke-[#095E15]". Use stroke-* classes.
trackClassNamestring—The empty ring behind the progress, e.g. "stroke-gray-200". Use stroke-* classes.
valueClassNamestring—The percentage text.

<ProgressBarHalfCircle />

12 props · 5 for styling (highlighted)
PropTypeDefaultDescription
size*"xs" | "sm" | "md" | "lg" | "xxs"—
value*number—
labelstring—
maxnumber100
minnumber0
progressGradientstring[]—Gradient colors for the filled ring (any CSS colors), e.g. ["#2A3180", "#39B8D5", "#287624"]. Overrides progressClassName's stroke.
valueFormatter((value: number, valueInPercentage: number) => string | number)—
classNamestring—Outer wrapper.
labelClassNamestring—The label text.
progressClassNamestring—The filled part of the ring, e.g. "stroke-[#095E15]". Use stroke-* classes.
trackClassNamestring—The empty ring behind the progress, e.g. "stroke-gray-200". Use stroke-* classes.
valueClassNamestring—The percentage text.

Loading indicators

Spinners for loading and processing states.

Source: src/components/application/loading-indicator/loading-indicator.tsx

Spinners

Loading…
Uploading…
Analysing…
Saving…

Props

<LoadingIndicator />

7 props · 4 for styling (highlighted)
PropTypeDefaultDescription
labelstring—Optional text label displayed below the indicator.
size"sm" | "md" | "lg" | "xl""sm"The size of the loading indicator.
type"line-simple" | "line-spinner" | "dot-circle""line-simple"The visual style of the loading indicator.
classNamestring—Outer wrapper.
labelClassNamestring—The label text.
spinnerClassNamestring—Spinner color, e.g. "text-[#095E15]". Use text-* classes (works for every type).
trackClassNamestring—The faint ring behind the "line-simple" spinner, e.g. "text-gray-200".

Illustrations

Small illustrations for empty states.

Source: src/components/shared-assets/illustrations/

Illustrations

Props

<Illustration />

281 props · 3 for styling (highlighted)
PropTypeDefaultDescription
type*"box" | "cloud" | "documents" | "credit-card"—
size"sm" | "md" | "lg"—
childrenClassNamestring—
svgClassNamestring—
›277 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

QR codes

Scannable QR code in a styled frame.

Source: src/components/shared-assets/qr-code.tsx

QR codes

Props

<QRCode />

4 props · 1 for styling (highlighted)
PropTypeDefaultDescription
value*string—The value to encode in the QR code.
optionsQRCodeStylingOptions—Additional options to customize the QR code.
size"md" | "lg""md"The size of the QR code.
classNamestring—The class name to apply to the QR code.

Rating badge and stars

Read-only star ratings, including partial stars.

Source: src/components/foundations/rating-stars.tsx

Rating stars

4.5 · 1,240 reviews

Sizes

size="xs"
size="sm"
size="md"
size="lg"
size="xl"

Custom colors

4.2 · Green
3.5 · Orange
4.8 · Navy (class)
7.5 / 10 · Cyan
4.6(2,318 learners)

Props

<RatingStars />

282 props · 2 for styling (highlighted)
PropTypeDefaultDescription
colorstring—Any CSS color for the filled part of the stars, e.g. "#095E15".
emptyColorstring—Any CSS color for the unfilled part of the stars, e.g. "#E8F3EA".
ratingnumber5The rating to display.
size"xs" | "sm" | "md" | "lg" | "xl""md"Star size: xs (12px) · sm (16px) · md (20px) · lg (24px) · xl (32px).
starsnumber5The number of stars to display.
starClassNamestring—The class name of the star icon, e.g. "text-[#095E15]" (filled color) or "size-7" (custom size).
›276 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

Video players

Native video with custom controls, thumbnail and keyboard shortcuts (Untitled UI PRO).

Source: src/components/base/video-player/video-player.tsx

Video player sm

Untitled UI product demo

Video player md

Untitled UI product demo
0:00
-0:00

Video player lg

Untitled UI product demo
0:00
-0:00

Props

<VideoPlayer />

10 props · 2 for styling (highlighted)
PropTypeDefaultDescription
src*string—The URL of the video.
autoPlaybooleanfalseWhether the video should start playing as soon as it's ready.
refRef<VideoPlayerRef>—Ref to access imperative methods (play, pause, etc.).
showThumbnailOverlayboolean—Whether to show a semi-transparent overlay on top of the thumbnail image.
size"sm" | "md" | "lg""md"Size of the video player.
thumbnailAltstring—Alt text for the thumbnail image.
thumbnailUrlstring—URL of the thumbnail image to show before the video starts playing.
typestring"video/mp4"The MIME type of the video.
classNamestring—Class name for the player wrapper.
thumbnailButtonClassNamestring—Class name for the thumbnail button.

Alerts

Floating and full-width alerts with a featured icon, message and dismiss / confirm actions.

Source: src/components/application/alerts/alerts.tsx

Floating default

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Floating brand

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Floating gray

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Floating error

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Floating warning

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Floating success

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Full-width default

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Full-width brand

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Full-width gray

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Full-width error

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Full-width warning

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Full-width success

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Props

<AlertFloating />

7 props
PropTypeDefaultDescription
confirmLabel*string—The label for the confirm button.
description*ReactNode—The description of the alert.
title*string—The title of the alert.
color"brand" | "gray" | "default" | "warning" | "error" | "success""default"The color of the alert.
dismissLabelstring"Dismiss"The label for the dismiss button.
onClose(() => void)—The function to call when the dismiss button is clicked.
onConfirm(() => void)—The function to call when the confirm button is clicked.

<AlertFullWidth />

9 props · 1 for styling (highlighted)
PropTypeDefaultDescription
confirmLabel*string—The label for the confirm button.
description*ReactNode—The description of the alert.
title*string—The title of the alert.
actionType"button" | "link""button"The type of the action buttons.
color"brand" | "gray" | "default" | "warning" | "error" | "success""default"The color of the alert.
dismissLabelstring"Dismiss"The label for the dismiss button.
onClose(() => void)—The function to call when the dismiss button is clicked.
onConfirm(() => void)—The function to call when the confirm button is clicked.
classNamestring—Class name applied to the root banner element.

Content dividers

Horizontal dividers that hold a label, a button or a button group.

Source: src/components/application/content-divider/content-divider.tsx

Single line

Today

Dual line

Today

Background fill

Today

Props

<ContentDivider />

3 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The content sitting in the divider, typically a short label or a button.
type*"single-line" | "dual-line" | "background-fill"—Selects the divider layout — a rule on either side of the content, top and bottom rules around it, or a filled band behind it.
classNamestring—Additional class name for the divider wrapper.

Carousels

Embla-based image carousel with arrow triggers and a dot indicator.

Source: src/components/application/carousel/carousel-base.tsx

Carousel md

Image by Unsplash
Image by Unsplash
Image by Unsplash

Carousel lg

Image by Unsplash
Image by Unsplash
Image by Unsplash

Props

<Carousel.Root />

282 props · 1 for styling (highlighted)
PropTypeDefaultDescription
optsPartial<OptionsType>—The options for the Embla carousel.
orientation"horizontal" | "vertical""horizontal"The orientation of the carousel.
pluginsCreatePluginType<LoosePluginType, {}>[]—The plugins for the Embla carousel.
setApi((api: CarouselApi) => void)—The function to set the API for the carousel.
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

<Carousel.Content />

279 props · 1 for styling (highlighted)
PropTypeDefaultDescription
overflowHiddenbooleantrueWhether to hide the overflow.
classNamestring—The class name of the content.
›277 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

<Carousel.Item />

278 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react, next (below).
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

<Carousel.PrevTrigger />

5 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode | ((props: TriggerRenderProps) => ReactNode)—The children of the trigger. Can be a render prop or a valid element.
asChildboolean—If true, the child element will be cloned and passed down the prop of the trigger.
refRef<HTMLButtonElement>—The ref of the trigger.
styleCSSProperties—The style of the trigger.
classNamestring | ((args: { isDisabled: boolean; }) => string)—The class name of the trigger.

<Carousel.NextTrigger />

5 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode | ((props: TriggerRenderProps) => ReactNode)—The children of the trigger. Can be a render prop or a valid element.
asChildboolean—If true, the child element will be cloned and passed down the prop of the trigger.
refRef<HTMLButtonElement>—The ref of the trigger.
styleCSSProperties—The style of the trigger.
classNamestring | ((args: { isDisabled: boolean; }) => string)—The class name of the trigger.

Notifications

Toast cards with a featured icon, progress bar, image or avatar, plus dismiss and confirm actions.

Source: src/components/application/notifications/notifications.tsx

Icon default

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Icon gray

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Icon brand

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Icon error

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Icon warning

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Icon success

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Progress notification

Uploading 'IMG_0482.jpg'

Please wait while we upload your file. You can keep working in the meantime.

40% uploaded...

Image notification

We've just released a new feature

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Image Desktop

Avatar notification

Drew Cano

Drew Cano

2 mins ago

Hey Olivia, can you please review the latest design when you can?

Props

<IconNotification />

10 props
PropTypeDefaultDescription
description*string—Body text shown under the notification title.
title*string—Bold heading shown at the top of the toast.
color"brand" | "gray" | "default" | "warning" | "error" | "success""default"Semantic color of the featured icon, which also picks the fallback icon. `default` renders a gray modern featured icon, the rest an outlined one in the matching color.
confirmLabelstring—Label for the primary action button. The button is only rendered when a label is provided.
dismissLabelstring"Dismiss"Label for the secondary text button that triggers `onClose`.
hideDismissLabelboolean—Whether to hide the dismiss text button. The close icon button in the top-right corner is always rendered.
iconFC<{ className?: string; }>—Icon rendered inside the featured icon. Falls back to an icon picked from `color`: a check circle for success, an alert circle for error and warning, an info circle otherwise.
onClose(() => void)—Handler called when the close icon button or the dismiss button is pressed. Typically dismisses the toast.
onConfirm(() => void)—Handler called when the confirm button is pressed.
progressnumber—Completion percentage for a progress bar rendered between the text and the actions, labelled "{value}% uploaded...". Omit it to render no progress bar.

<AvatarNotification />

11 props
PropTypeDefaultDescription
avatar*string—Image URL for the sender's avatar, which always renders with an online status dot.
confirmLabel*string—Label for the primary action button. The button is only rendered when a label is provided.
content*string—Message body shown under the name and date.
date*string—Timestamp shown in muted text next to the sender's name.
name*string—Name of the person the notification is from. Shown in bold beside the date and used as the avatar's alt text.
color"brand" | "gray" | "default" | "warning" | "error" | "success"—Not rendered by this variant, which has no featured icon to color.
dismissLabelstring"Dismiss"Label for the secondary text button that triggers `onClose`.
hideDismissLabelboolean—Whether to hide the dismiss text button. The close icon button in the top-right corner is always rendered.
iconFC<{ className?: string; }>—Not rendered by this variant, which always shows the sender's avatar in place of an icon.
onClose(() => void)—Handler called when the close icon button or the dismiss button is pressed. Typically dismisses the toast.
onConfirm(() => void)—Handler called when the confirm button is pressed.

<ImageNotification />

9 props
PropTypeDefaultDescription
confirmLabel*string—Label for the primary action button. The button is only rendered when a label is provided.
description*string—Body text shown under the notification title.
imageDesktop*string—Image source for the wide banner above the action buttons, which is only shown below the `md` breakpoint.
imageMobile*string—Image source for the tall thumbnail in the left column, which is only shown from the `md` breakpoint up.
title*string—Bold heading shown at the top of the toast.
dismissLabelstring"Dismiss"Label for the secondary text button that triggers `onClose`.
hideDismissLabelboolean—Whether to hide the dismiss text button. The close icon button in the top-right corner is always rendered.
onClose(() => void)—Handler called when the close icon button or the dismiss button is pressed. Typically dismisses the toast.
onConfirm(() => void)—Handler called when the confirm button is pressed.

Code snippets

Shiki-highlighted code blocks with line numbers, copy button, show more and file tabs (Untitled UI PRO).

Source: src/components/application/code-snippet/code-snippet.tsx

With line number

import { useState } from "react"; import { Button } from "@/components/base/buttons/button"; export const Counter = () => { const [count, setCount] = useState(0); return ( <Button size="md" onClick={() => setCount(count + 1)}> Clicked {count} times </Button> ); };

Without line number

import { useState } from "react"; import { Button } from "@/components/base/buttons/button"; export const Counter = () => { const [count, setCount] = useState(0); return ( <Button size="md" onClick={() => setCount(count + 1)}> Clicked {count} times </Button> ); };

Show more

"use client"; import { useState } from "react"; import { Mail01 } from "@untitledui/icons"; import { Button } from "@/components/base/buttons/button"; import { Input } from "@/components/base/input/input"; export const NewsletterForm = () => { const [email, setEmail] = useState(""); const [isSubmitted, setIsSubmitted] = useState(false); const handleSubmit = (event: React.FormEvent) => { event.preventDefault(); if (!email) return; setIsSubmitted(true); }; if (isSubmitted) { return <p className="text-md text-secondary">Thanks for subscribing!</p>; } return ( <form onSubmit={handleSubmit} className="flex flex-col gap-4 md:flex-row"> <Input isRequired type="email" icon={Mail01} placeholder="Enter your email" value={email} onChange={setEmail} /> <Button type="submit" size="lg"> Subscribe </Button> </form> ); };

With tabs

import { Button } from "@/components/base/buttons/button"; export const SaveButton = () => ( <Button size="md" color="primary" className="save-button"> Save changes </Button> );

Props

<CodeSnippet />

283 props · 1 for styling (highlighted)
PropTypeDefaultDescription
language*SupportedLanguages | SpecialLanguage | (string & Nothing)—The programming language of the code snippet.
childrenReactNode—Pre-highlighted code nodes that were generated on the server.
codestring—The code to be syntax highlighted. Can be provided in two ways:
maxHeightnumber—Maximum height (in px) before the "Show more" overlay appears.
modernbooleantrueWhether to show the modern shadow wrapper.
onExpand(() => void)—Callback fired when the expand button is clicked.
showLineNumbersbooleantrueWhether to render a line-number gutter. When false, the code is padded instead.
›276 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

<CodeSnippet.Tabs />

87 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, react-stately, @react-types/shared, react-aria (below).
›87 more props from react-aria-components, react-stately, @react-types/shared, react-aria(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((values: TabsRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<TabsRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultSelectedKeyKey—The initial selected keys in the collection (uncontrolled).
dirstring—
disabledKeysIterable<Key>—The item keys that are disabled. These items cannot be selected, focused, or otherwise
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the TabList is disabled.
keyboardActivation"manual" | "automatic"—Whether tabs are activated automatically on focus or manually.
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectionChange((key: Key) => void)—Handler that is called when the selection changes.
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
orientation"horizontal" | "vertical"—The orientation of the tabs.
renderDOMRenderFunction<"div", TabsRenderProps>—Overrides the default DOM element with a custom render function.
selectedKeyKey—The currently selected key in the collection (controlled).
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<TabsRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

<CodeSnippet.TabList />

80 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, @react-types/shared (below).
›80 more props from react-aria-components, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((item: T) => ReactNode)—The contents of the collection.
classNameClassNameOrFunction<TabListRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dependenciesreadonly any[]—Values that should invalidate the item cache when using dynamic collections.
dirstring—
hiddenboolean—
inertboolean—
itemsIterable<T>—Item objects in the collection.
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
renderDOMRenderFunction<"div", TabListRenderProps>—Overrides the default DOM element with a custom render function.
styleStyleOrFunction<TabListRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

<CodeSnippet.Tab />

99 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The tab label, usually a file name or language.
›98 more props from react-aria-components, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
classNameClassNameOrFunction<TabRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
downloadstring | boolean—Causes the browser to download the linked URL. A string may be provided to suggest a file name.
hiddenboolean—
hrefstring—A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).
hrefLangstring—Hints at the human language of the linked URL.
idKey—The unique id of the tab.
inertboolean—
isDisabledboolean—Whether the tab is disabled.
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
pingstring—A space-separated list of URLs to ping when the link is followed. See
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—How much of the referrer to send when following the link. See
relstring—The relationship between the linked resource and the current page. See
render((props: React.DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement> | React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, renderProps: TabRenderProps) => ReactElement)—Overrides the default DOM element with a custom render function.
routerOptionsundefined—Options for the configured client side router.
styleStyleOrFunction<TabRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
targetHTMLAttributeAnchorTarget—The target window for the link. See
translate"yes" | "no"—

<CodeSnippet.TabPanel />

80 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, react-aria, @react-types/shared (below).
›80 more props from react-aria-components, react-aria, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((values: TabPanelRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<TabPanelRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
hiddenboolean—
idKey—The unique id of the tab.
inertboolean—
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
renderDOMRenderFunction<"div", TabPanelRenderProps>—Overrides the default DOM element with a custom render function.
shouldForceMountboolean—Whether to mount the tab panel in the DOM even when it is not currently selected. Inactive tab
styleStyleOrFunction<TabPanelRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

Color pickers

Composable color picker built on React Aria: area, hue/alpha sliders, format input, eyedropper and swatches (Untitled UI PRO).

Source: src/components/application/color-picker/color-picker.tsx

Color picker

Saved colors

Color swatch picker

Theme color

Selected: #7F56D9

Saved swatches small

Saved

Saved swatches medium

Saved

Brand swatches

Brand

Brand 600 · #7F56D9

Gray swatches

Gray

Gray 500 · #667085

Minimal picker

Hue slider

Hue

#7F56D9

Transparency slider

Opacity

100%

Palette picker

Palette

Props

<Provider />

5 props
PropTypeDefaultDescription
children*ReactNode—The color picker parts that read and update the shared color state.
defaultColorFormat"css" | "hex" | "rgb" | "hsl" | "hsb""hex"Initial color format for the value input.
defaultValuestring | Color"#7F56D9"Initial color value as a CSS string or React Aria Color object.
onChange((color: Color) => void)—Called when the selected color changes.
valuestring | Color—Controlled color value as a CSS string or React Aria Color object.

<ColorPicker.Dialog />

2 props · 1 for styling (highlighted)
PropTypeDefaultDescription
childrenstring | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | null—The picker sections to render inside the card.
classNamestring—Additional class name for the card. Useful for overriding the default fixed width.

<ColorPicker.Area />

91 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, react-aria, react-stately, @react-types/shared (below).
›91 more props from react-aria-components, react-aria, react-stately, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((values: ColorAreaRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<ColorAreaRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
colorSpace"rgb" | "hsl" | "hsb"—The color space that the color area operates in. The `xChannel` and `yChannel` must be in this
defaultValuestring | Color—The default value (uncontrolled).
dirstring—
formstring—The `<form>` element to associate the ColorArea with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the ColorArea is disabled.
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onChange((value: Color) => void)—Handler that is called when the value changes, as the user drags.
onChangeEnd((value: Color) => void)—Handler that is called when the user stops dragging.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
renderDOMRenderFunction<"div", ColorAreaRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ColorAreaRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
valuestring | Color—The current value (controlled).
xChannel"blue" | "hue" | "saturation" | "brightness" | "lightness" | "red" | "green" | "alpha"—Color channel for the horizontal axis.
xNamestring—The name of the x channel input element, used when submitting an HTML form. See
yChannel"blue" | "hue" | "saturation" | "brightness" | "lightness" | "red" | "green" | "alpha"—Color channel for the vertical axis.
yNamestring—The name of the y channel input element, used when submitting an HTML form. See

<ColorPicker.HueSlider />

89 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, react-stately, @react-types/shared (below).
›89 more props from react-aria-components, react-stately, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((values: ColorSliderRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<ColorSliderRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
colorSpace"rgb" | "hsl" | "hsb"—The color space that the slider operates in. The `channel` must be in this color space.
defaultValuestring | Color—The default value (uncontrolled).
dirstring—
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the whole Slider is disabled.
langstring—
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onChange((value: Color) => void)—Handler that is called when the value changes, as the user drags.
onChangeEnd((value: Color) => void)—Handler that is called when the user stops dragging.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
orientation"horizontal" | "vertical"—The orientation of the Slider.
renderDOMRenderFunction<"div", ColorSliderRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ColorSliderRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
valuestring | Color—The current value (controlled).

<ColorPicker.AlphaSlider />

89 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, react-stately, @react-types/shared (below).
›89 more props from react-aria-components, react-stately, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((values: ColorSliderRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<ColorSliderRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
colorSpace"rgb" | "hsl" | "hsb"—The color space that the slider operates in. The `channel` must be in this color space.
defaultValuestring | Color—The default value (uncontrolled).
dirstring—
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the whole Slider is disabled.
langstring—
namestring—The name of the input element, used when submitting an HTML form. See
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onChange((value: Color) => void)—Handler that is called when the value changes, as the user drags.
onChangeEnd((value: Color) => void)—Handler that is called when the user stops dragging.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
orientation"horizontal" | "vertical"—The orientation of the Slider.
renderDOMRenderFunction<"div", ColorSliderRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ColorSliderRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
valuestring | Color—The current value (controlled).

<ColorPicker.EyeDropper />

120 props · 1 for styling (highlighted)
PropTypeDefaultDescription
childrenReactNode—The button label. Omitting it while passing an icon renders a square, icon-only button.
color"secondary" | "tertiary" | "primary" | "link-color" | "link-gray" | "primary-destructive" | "secondary-destructive" | "tertiary-destructive" | "link-destructive"—The color variant of the button
iconLeadingReactNode | FC<{ className?: string; }>—Icon component or element to show before the text
iconTrailingReactNode | FC<{ className?: string; }>—Icon component or element to show after the text
isDisabledboolean—Disables the button and shows a disabled state
isLoadingboolean—Shows a loading spinner and disables the button
noTextPaddingboolean—Removes horizontal padding from the text content
showTextWhileLoadingboolean—When true, keeps the text visible during loading state
size"xs" | "sm" | "md" | "lg" | "xl"—The size variant of the button
classNamestring—The class name applied to the button.
›110 more props from react-aria, @react-types/shared, react-aria-components(aria-controls, aria-current, aria-describedby, aria-details…)
PropTypeDefaultDescription
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates whether this element represents the current item within a container or set of related
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-disabledboolean | "true" | "false"—Indicates whether the element is disabled to users of assistive technology.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
autoFocusboolean—Whether the element should receive focus on render.
dirstring—
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the button with.
formActionstring | ((formData: FormData) => void | Promise<void>)—The URL that processes the information submitted by the button.
formEncTypestring—Indicates how to encode the form data that is submitted.
formMethodstring—Indicates the HTTP method used to submit the form.
formNoValidateboolean—Indicates that the form is not to be validated when it is submitted.
formTargetstring—Overrides the target attribute of the button's form owner.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isPendingboolean—Whether the button is in a pending state. This disables press and hover events
langstring—
namestring—Submitted as a pair with the button's value as part of the form data.
onAnimationEndAnimationEventHandler<HTMLButtonElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLButtonElement>—
onAnimationIterationAnimationEventHandler<HTMLButtonElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLButtonElement>—
onAnimationStartAnimationEventHandler<HTMLButtonElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLButtonElement>—
onAuxClickMouseEventHandler<HTMLButtonElement>—
onAuxClickCaptureMouseEventHandler<HTMLButtonElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLButtonElement>—
onContextMenuMouseEventHandler<HTMLButtonElement>—
onContextMenuCaptureMouseEventHandler<HTMLButtonElement>—
onDoubleClickMouseEventHandler<HTMLButtonElement>—
onDoubleClickCaptureMouseEventHandler<HTMLButtonElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLButtonElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLButtonElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLButtonElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLButtonElement>—
onMouseDownMouseEventHandler<HTMLButtonElement>—
onMouseDownCaptureMouseEventHandler<HTMLButtonElement>—
onMouseEnterMouseEventHandler<HTMLButtonElement>—
onMouseLeaveMouseEventHandler<HTMLButtonElement>—
onMouseMoveMouseEventHandler<HTMLButtonElement>—
onMouseMoveCaptureMouseEventHandler<HTMLButtonElement>—
onMouseOutMouseEventHandler<HTMLButtonElement>—
onMouseOutCaptureMouseEventHandler<HTMLButtonElement>—
onMouseOverMouseEventHandler<HTMLButtonElement>—
onMouseOverCaptureMouseEventHandler<HTMLButtonElement>—
onMouseUpMouseEventHandler<HTMLButtonElement>—
onMouseUpCaptureMouseEventHandler<HTMLButtonElement>—
onPointerCancelPointerEventHandler<HTMLButtonElement>—
onPointerCancelCapturePointerEventHandler<HTMLButtonElement>—
onPointerDownPointerEventHandler<HTMLButtonElement>—
onPointerDownCapturePointerEventHandler<HTMLButtonElement>—
onPointerEnterPointerEventHandler<HTMLButtonElement>—
onPointerLeavePointerEventHandler<HTMLButtonElement>—
onPointerMovePointerEventHandler<HTMLButtonElement>—
onPointerMoveCapturePointerEventHandler<HTMLButtonElement>—
onPointerOutPointerEventHandler<HTMLButtonElement>—
onPointerOutCapturePointerEventHandler<HTMLButtonElement>—
onPointerOverPointerEventHandler<HTMLButtonElement>—
onPointerOverCapturePointerEventHandler<HTMLButtonElement>—
onPointerUpPointerEventHandler<HTMLButtonElement>—
onPointerUpCapturePointerEventHandler<HTMLButtonElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLButtonElement>—
onScrollCaptureUIEventHandler<HTMLButtonElement>—
onTouchCancelTouchEventHandler<HTMLButtonElement>—
onTouchCancelCaptureTouchEventHandler<HTMLButtonElement>—
onTouchEndTouchEventHandler<HTMLButtonElement>—
onTouchEndCaptureTouchEventHandler<HTMLButtonElement>—
onTouchMoveTouchEventHandler<HTMLButtonElement>—
onTouchMoveCaptureTouchEventHandler<HTMLButtonElement>—
onTouchStartTouchEventHandler<HTMLButtonElement>—
onTouchStartCaptureTouchEventHandler<HTMLButtonElement>—
onTransitionCancelTransitionEventHandler<HTMLButtonElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLButtonElement>—
onTransitionEndTransitionEventHandler<HTMLButtonElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLButtonElement>—
onTransitionRunTransitionEventHandler<HTMLButtonElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLButtonElement>—
onTransitionStartTransitionEventHandler<HTMLButtonElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLButtonElement>—
onWheelWheelEventHandler<HTMLButtonElement>—
onWheelCaptureWheelEventHandler<HTMLButtonElement>—
preventFocusOnPressboolean—Whether to prevent focus from moving to the button when pressing it.
renderDOMRenderFunction<"button", ButtonRenderProps>—Overrides the default DOM element with a custom render function.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ButtonRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
type"button" | "submit" | "reset"—The behavior of the button when used in an HTML form.
valuestring—The value associated with the button's name when it's submitted with the form data.

<ColorPicker.ColorFormatSelect />

117 props · 2 for styling (highlighted)
PropTypeDefaultDescription
hideRequiredIndicatorboolean—Whether to hide the required indicator from the label.
hintstring—Helper text displayed below the input.
iconReactNode | FC—Leading icon shown in the trigger, used as a fallback when the selected item has no icon of its own. Accepts a component reference or a rendered element.
itemsSelectItemType[]—The options to render in the dropdown. When `children` is a function it is called once per item to render it.
labelstring—Field label displayed above the input.
size"sm" | "md" | "lg"—The size of the component.
tooltipstring—Tooltip text for the help icon next to the label.
popoverClassNamestring—Additional classes merged onto the dropdown popover.
›109 more props from react-aria-components, @react-types/shared, react-aria, react-stately, react(allowsEmptyCollection, aria-describedby, aria-details, aria-label…)
PropTypeDefaultDescription
allowsEmptyCollectionboolean—Whether the select should be allowed to be open when the collection is empty.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoCompletestring—Describes the type of autocomplete functionality the input should provide if any. See
autoFocusboolean—Whether the element should receive focus on render.
classNameClassNameOrFunction<SelectRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultOpenboolean—Sets the default open state of the menu.
defaultSelectedKeyKey | null—The initial selected key in the collection (uncontrolled).
defaultValueKey | null—The default value (uncontrolled).
dirstring—
disabledKeysIterable<Key>—The item keys that are disabled. These items cannot be selected, focused, or otherwise
excludeFromTabOrderboolean—Whether to exclude the element from the sequential tab order. If true,
formstring—The `<form>` element to associate the input with.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the input is disabled.
isInvalidboolean—Whether the input value is invalid.
isOpenboolean—Sets the open state of the menu.
isRequiredboolean—Whether user input is required on the input before form submission.
langstring—
namestring—The name of the input, used when submitting an HTML form.
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onChange((value: Key | null) => void)—Handler that is called when the value changes.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onKeyDown((e: KeyboardEvent) => void)—Handler that is called when a key is pressed.
onKeyUp((e: KeyboardEvent) => void)—Handler that is called when a key is released.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean) => void)—Method that is called when the open state of the menu changes.
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectionChange((key: Key | null) => void)—Handler that is called when the selection changes.
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
placeholderstring—Temporary text that occupies the select when it is empty.
refLegacyRef<HTMLDivElement>—Allows getting a ref to the component instance.
renderDOMRenderFunction<"div", SelectRenderProps>—Overrides the default DOM element with a custom render function.
selectedKeyKey | null—The currently selected key in the collection (controlled).
selectionMode"single"—Whether single or multiple selection is enabled.
shouldCloseOnSelectboolean—Whether the Select should close when an item is selected. Defaults to true if selectionMode is
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<SelectRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
validate((value: Key) => ValidationError | true | null | undefined)—A function that returns an error message if a given value is invalid.
validationBehavior"native" | "aria"—Whether to use native HTML form validation to prevent form submission
valueKey | null—The current value (controlled).

<ColorPicker.SavedColors />

4 props
PropTypeDefaultDescription
colors*string[]—Array of CSS color strings or gradient strings to display as swatches.
labelstring"Saved"Heading text above the swatch list.
onAdd(() => void)—Called when the "Add" button is clicked. Omit to hide the button.
onSelect((color: string) => void)—Called when a swatch is selected, with the color/gradient string.

<ColorPicker.SwatchItem />

85 props · 1 for styling (highlighted)
PropTypeDefaultDescription
size"sm" | "md""md"Diameter of the swatch dot — 16px for "sm", 20px for "md".
›84 more props from react-aria-components, @react-types/shared(children, className, color, dir…)
PropTypeDefaultDescription
childrenReact.ReactNode | ((values: ColorSwatchPickerItemRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<ColorSwatchPickerItemRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
color*string | Color—The color of the swatch.
dirstring—
hiddenboolean—
inertboolean—
isDisabledboolean—Whether the color swatch is disabled.
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
renderDOMRenderFunction<"div", ColorSwatchPickerItemRenderProps>—Overrides the default DOM element with a custom render function.
styleStyleOrFunction<ColorSwatchPickerItemRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

<InputCell />

3 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*string | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | null—The input (or other control) rendered inside the cell.
position"first" | "middle" | "last" | "only""only"Where the cell sits in a group of adjacent cells. Rounds the matching corners and pulls the cell onto its neighbour's border.
classNamestring—Additional class name for the cell wrapper.

Gradient pickers

Gradient editor with draggable stops on a 2D area, type select, stop slider and stop list (Untitled UI PRO).

Source: src/components/application/gradient-picker/gradient-picker.tsx

Gradient picker

Stops

Props

<GradientProvider />

7 props
PropTypeDefaultDescription
children*ReactNode—The gradient picker parts that read and update the shared gradient state.
defaultAnglenumber135Initial gradient angle in degrees.
defaultStopsGradientStop[]—Initial gradient stops.
defaultType"linear" | "radial" | "angular" | "diamond""linear"Initial gradient type.
onAngleChange((angle: number) => void)—Called when the gradient angle changes.
onStopsChange((stops: GradientStop[]) => void)—Called when gradient stops change.
onTypeChange((type: GradientType) => void)—Called when the gradient type changes.

Messaging

Chat bubbles for text, replies, reactions, files, audio, images and link previews, plus message status ticks and composer inputs.

Source: src/components/application/messaging/messaging.tsx

Message status

Message action minimal

Message action textarea

Message action advanced

Olivia Rhye

Olivia

Message simple

  • Phoenix Baker
    Phoenix Baker
    Hey Olivia, can you please review the latest design when you can?

Message reactions

  • Phoenix Baker
    Phoenix Baker
    Hey Olivia, can you please review the latest design when you can?
    • ❤️
    • 👌2

Message reply

  • Phoenix Baker
    Phoenix Baker
    Sure thing, I'll have a look today.
    Awesome, thanks!

Message attachment

  • Phoenix Baker
    Phoenix Baker

    Latest design screenshot.jpg

    1.2 MB

Message audio

  • Phoenix Baker
    Phoenix Baker

    00:28

Message image

  • Phoenix Baker
    Phoenix Baker
    Latest design screenshot
    Latest design screenshot.jpg128 KB

Message link preview

Message link minimal

  • Phoenix Baker
    Phoenix Baker
    https://www.untitledui.com

Message writing

  • Phoenix Baker
    Phoenix Baker

Props

<MessageItem />

281 props · 1 for styling (highlighted)
PropTypeDefaultDescription
msg*{ id: string; sentAt?: string; readAt?: string; typing?: boolean; status?: "sent" | "read" | "failed"; user?: { name?: string; avatarUrl?: string; status?: "online" | "offline"; me?: boolean; }; text?: ReactNode; audio?: { duration: string; }; image?: { src: string; alt: string; name: string; size: string; }; video?: { src: string; alt: string; }; reply?: { text: ReactNode; }; urlPreview?: { title: string; description: string; }; reactions?: { content: string; count: number; }[]; attachment?: { name: string; size: string; type: "jpg" | "txt" | "pdf" | "mp4"; }; }—The message to render. Its populated fields decide which bubble is drawn — text, image, audio, attachment, reply quote, URL preview, reactions or typing indicator.
showUserLabelbooleantrueWhether to show the sender's name above the bubble. Turn it off for consecutive messages from the same person.
›279 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLLIElement>—
onAbortCaptureReactEventHandler<HTMLLIElement>—
onAnimationEndAnimationEventHandler<HTMLLIElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLLIElement>—
onAnimationIterationAnimationEventHandler<HTMLLIElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLLIElement>—
onAnimationStartAnimationEventHandler<HTMLLIElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLLIElement>—
onAuxClickMouseEventHandler<HTMLLIElement>—
onAuxClickCaptureMouseEventHandler<HTMLLIElement>—
onBeforeInputInputEventHandler<HTMLLIElement>—
onBeforeInputCaptureFormEventHandler<HTMLLIElement>—
onBeforeToggleToggleEventHandler<HTMLLIElement>—
onBlurFocusEventHandler<HTMLLIElement>—
onBlurCaptureFocusEventHandler<HTMLLIElement>—
onCanPlayReactEventHandler<HTMLLIElement>—
onCanPlayCaptureReactEventHandler<HTMLLIElement>—
onCanPlayThroughReactEventHandler<HTMLLIElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLLIElement>—
onChangeFormEventHandler<HTMLLIElement>—
onChangeCaptureFormEventHandler<HTMLLIElement>—
onClickMouseEventHandler<HTMLLIElement>—
onClickCaptureMouseEventHandler<HTMLLIElement>—
onCompositionEndCompositionEventHandler<HTMLLIElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLLIElement>—
onCompositionStartCompositionEventHandler<HTMLLIElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLLIElement>—
onCompositionUpdateCompositionEventHandler<HTMLLIElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLLIElement>—
onContextMenuMouseEventHandler<HTMLLIElement>—
onContextMenuCaptureMouseEventHandler<HTMLLIElement>—
onCopyClipboardEventHandler<HTMLLIElement>—
onCopyCaptureClipboardEventHandler<HTMLLIElement>—
onCutClipboardEventHandler<HTMLLIElement>—
onCutCaptureClipboardEventHandler<HTMLLIElement>—
onDoubleClickMouseEventHandler<HTMLLIElement>—
onDoubleClickCaptureMouseEventHandler<HTMLLIElement>—
onDragDragEventHandler<HTMLLIElement>—
onDragCaptureDragEventHandler<HTMLLIElement>—
onDragEndDragEventHandler<HTMLLIElement>—
onDragEndCaptureDragEventHandler<HTMLLIElement>—
onDragEnterDragEventHandler<HTMLLIElement>—
onDragEnterCaptureDragEventHandler<HTMLLIElement>—
onDragExitDragEventHandler<HTMLLIElement>—
onDragExitCaptureDragEventHandler<HTMLLIElement>—
onDragLeaveDragEventHandler<HTMLLIElement>—
onDragLeaveCaptureDragEventHandler<HTMLLIElement>—
onDragOverDragEventHandler<HTMLLIElement>—
onDragOverCaptureDragEventHandler<HTMLLIElement>—
onDragStartDragEventHandler<HTMLLIElement>—
onDragStartCaptureDragEventHandler<HTMLLIElement>—
onDropDragEventHandler<HTMLLIElement>—
onDropCaptureDragEventHandler<HTMLLIElement>—
onDurationChangeReactEventHandler<HTMLLIElement>—
onDurationChangeCaptureReactEventHandler<HTMLLIElement>—
onEmptiedReactEventHandler<HTMLLIElement>—
onEmptiedCaptureReactEventHandler<HTMLLIElement>—
onEncryptedReactEventHandler<HTMLLIElement>—
onEncryptedCaptureReactEventHandler<HTMLLIElement>—
onEndedReactEventHandler<HTMLLIElement>—
onEndedCaptureReactEventHandler<HTMLLIElement>—
onErrorReactEventHandler<HTMLLIElement>—
onErrorCaptureReactEventHandler<HTMLLIElement>—
onFocusFocusEventHandler<HTMLLIElement>—
onFocusCaptureFocusEventHandler<HTMLLIElement>—
onGotPointerCapturePointerEventHandler<HTMLLIElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLLIElement>—
onInputFormEventHandler<HTMLLIElement>—
onInputCaptureFormEventHandler<HTMLLIElement>—
onInvalidFormEventHandler<HTMLLIElement>—
onInvalidCaptureFormEventHandler<HTMLLIElement>—
onKeyDownKeyboardEventHandler<HTMLLIElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLLIElement>—
onKeyPressKeyboardEventHandler<HTMLLIElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLLIElement>—
onKeyUpKeyboardEventHandler<HTMLLIElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLLIElement>—
onLoadReactEventHandler<HTMLLIElement>—
onLoadCaptureReactEventHandler<HTMLLIElement>—
onLoadedDataReactEventHandler<HTMLLIElement>—
onLoadedDataCaptureReactEventHandler<HTMLLIElement>—
onLoadedMetadataReactEventHandler<HTMLLIElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLLIElement>—
onLoadStartReactEventHandler<HTMLLIElement>—
onLoadStartCaptureReactEventHandler<HTMLLIElement>—
onLostPointerCapturePointerEventHandler<HTMLLIElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLLIElement>—
onMouseDownMouseEventHandler<HTMLLIElement>—
onMouseDownCaptureMouseEventHandler<HTMLLIElement>—
onMouseEnterMouseEventHandler<HTMLLIElement>—
onMouseLeaveMouseEventHandler<HTMLLIElement>—
onMouseMoveMouseEventHandler<HTMLLIElement>—
onMouseMoveCaptureMouseEventHandler<HTMLLIElement>—
onMouseOutMouseEventHandler<HTMLLIElement>—
onMouseOutCaptureMouseEventHandler<HTMLLIElement>—
onMouseOverMouseEventHandler<HTMLLIElement>—
onMouseOverCaptureMouseEventHandler<HTMLLIElement>—
onMouseUpMouseEventHandler<HTMLLIElement>—
onMouseUpCaptureMouseEventHandler<HTMLLIElement>—
onPasteClipboardEventHandler<HTMLLIElement>—
onPasteCaptureClipboardEventHandler<HTMLLIElement>—
onPauseReactEventHandler<HTMLLIElement>—
onPauseCaptureReactEventHandler<HTMLLIElement>—
onPlayReactEventHandler<HTMLLIElement>—
onPlayCaptureReactEventHandler<HTMLLIElement>—
onPlayingReactEventHandler<HTMLLIElement>—
onPlayingCaptureReactEventHandler<HTMLLIElement>—
onPointerCancelPointerEventHandler<HTMLLIElement>—
onPointerCancelCapturePointerEventHandler<HTMLLIElement>—
onPointerDownPointerEventHandler<HTMLLIElement>—
onPointerDownCapturePointerEventHandler<HTMLLIElement>—
onPointerEnterPointerEventHandler<HTMLLIElement>—
onPointerLeavePointerEventHandler<HTMLLIElement>—
onPointerMovePointerEventHandler<HTMLLIElement>—
onPointerMoveCapturePointerEventHandler<HTMLLIElement>—
onPointerOutPointerEventHandler<HTMLLIElement>—
onPointerOutCapturePointerEventHandler<HTMLLIElement>—
onPointerOverPointerEventHandler<HTMLLIElement>—
onPointerOverCapturePointerEventHandler<HTMLLIElement>—
onPointerUpPointerEventHandler<HTMLLIElement>—
onPointerUpCapturePointerEventHandler<HTMLLIElement>—
onProgressReactEventHandler<HTMLLIElement>—
onProgressCaptureReactEventHandler<HTMLLIElement>—
onRateChangeReactEventHandler<HTMLLIElement>—
onRateChangeCaptureReactEventHandler<HTMLLIElement>—
onResetFormEventHandler<HTMLLIElement>—
onResetCaptureFormEventHandler<HTMLLIElement>—
onScrollUIEventHandler<HTMLLIElement>—
onScrollCaptureUIEventHandler<HTMLLIElement>—
onSeekedReactEventHandler<HTMLLIElement>—
onSeekedCaptureReactEventHandler<HTMLLIElement>—
onSeekingReactEventHandler<HTMLLIElement>—
onSeekingCaptureReactEventHandler<HTMLLIElement>—
onSelectReactEventHandler<HTMLLIElement>—
onSelectCaptureReactEventHandler<HTMLLIElement>—
onStalledReactEventHandler<HTMLLIElement>—
onStalledCaptureReactEventHandler<HTMLLIElement>—
onSubmitFormEventHandler<HTMLLIElement>—
onSubmitCaptureFormEventHandler<HTMLLIElement>—
onSuspendReactEventHandler<HTMLLIElement>—
onSuspendCaptureReactEventHandler<HTMLLIElement>—
onTimeUpdateReactEventHandler<HTMLLIElement>—
onTimeUpdateCaptureReactEventHandler<HTMLLIElement>—
onToggleToggleEventHandler<HTMLLIElement>—
onTouchCancelTouchEventHandler<HTMLLIElement>—
onTouchCancelCaptureTouchEventHandler<HTMLLIElement>—
onTouchEndTouchEventHandler<HTMLLIElement>—
onTouchEndCaptureTouchEventHandler<HTMLLIElement>—
onTouchMoveTouchEventHandler<HTMLLIElement>—
onTouchMoveCaptureTouchEventHandler<HTMLLIElement>—
onTouchStartTouchEventHandler<HTMLLIElement>—
onTouchStartCaptureTouchEventHandler<HTMLLIElement>—
onTransitionCancelTransitionEventHandler<HTMLLIElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLLIElement>—
onTransitionEndTransitionEventHandler<HTMLLIElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLLIElement>—
onTransitionRunTransitionEventHandler<HTMLLIElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLLIElement>—
onTransitionStartTransitionEventHandler<HTMLLIElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLLIElement>—
onVolumeChangeReactEventHandler<HTMLLIElement>—
onVolumeChangeCaptureReactEventHandler<HTMLLIElement>—
onWaitingReactEventHandler<HTMLLIElement>—
onWaitingCaptureReactEventHandler<HTMLLIElement>—
onWheelWheelEventHandler<HTMLLIElement>—
onWheelCaptureWheelEventHandler<HTMLLIElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLLIElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLLIElement> | null—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
valuestring | number | readonly string[]—
vocabstring—

<MessageStatus />

2 props
PropTypeDefaultDescription
status*"failed" | "sent" | "read"—Delivery state of the message — a single tick for "sent", a double tick for "read", or an error circle for "failed".
readAtstring—When the message was read. Appended to the tooltip for the "read" status.

Metrics

KPI cards with a headline figure, change indicator, optional featured icon, sparkline chart and footer actions.

Source: src/components/application/metrics/metrics.tsx

Simple

Total customers

2,420

40%

Members

1,210

10%

Active now

316

20%

Simple actions

Total customers

2,420

40%

Members

1,210

10%

Active now

316

20%

Metrics icon 01

Total customers

2,420

100%

Members

1,210

100%

Active now

316

100%

Metrics icon actions 01

Total customers

2,420

100%

Members

1,210

100%

Active now

316

100%

Metrics icon 02

Total customers

2,420

100%
vs last month

Members

1,210

100%
vs last month

Active now

316

100%
vs last month

Metrics icon actions 02

Total customers

2,420

100%
vs last month

Members

1,210

100%
vs last month

Active now

316

100%
vs last month

Metrics icon 03

Total customers

2,420

40%
vs last month

Members

1,210

10%
vs last month

Active now

316

20%
vs last month

Metrics icon actions 03

Total customers

2,420

40%
vs last month

Members

1,210

10%
vs last month

Active now

316

20%
vs last month

Metrics icon 04

Total customers

2,420

40%

Members

1,210

10%

Active now

316

20%

Metrics icon actions 04

Total customers

2,420

40%

Members

1,210

10%

Active now

316

20%

Chart 01

Total customers

2,420

40%
vs last month

Members

1,210

10%
vs last month

Active now

316

20%
vs last month

Chart actions 01

Total customers

2,420

40%
vs last month

Members

1,210

10%
vs last month

Active now

316

20%
vs last month

Chart 02

Total customers

2,420

40%

Members

1,210

10%

Active now

316

20%

Chart actions 02

Total customers

2,420

40%

Members

1,210

10%

Active now

316

20%

Chart 03

Total customers

2,420

40%

Members

1,210

10%

Active now

316

20%

Chart actions 03

Total customers

2,420

40%

Members

1,210

10%

Active now

316

20%

Chart 04

Total customers

2,420

40%
vs last month

Members

1,210

10%
vs last month

Active now

316

20%
vs last month

Chart actions 04

Total customers

2,420

40%
vs last month

Members

1,210

10%
vs last month

Active now

316

20%
vs last month

Props

<MetricsSimple />

7 props · 1 for styling (highlighted)
PropTypeDefaultDescription
trend*"positive" | "negative"—Direction of the change, setting the indicator's arrow direction and its green or red tint.
type*"modern" | "simple" | "trend"—Visual style of the change indicator shown beside the figure.
changestring—The change amount rendered inside the indicator, such as "100%".
footerReactNode—Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed.
subtitlestring"View 24 hours"Label above the figure naming the metric or the period it covers.
titlestring"2,000"The metric's headline figure, rendered as the large display number.
classNamestring—Additional CSS classes to apply to the card.

<MetricsIcon01 />

4 props · 1 for styling (highlighted)
PropTypeDefaultDescription
footerReactNode—Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed.
subtitlestring"View 24 hours"Label above the figure naming the metric or the period it covers.
titlestring"2,000"The metric's headline figure, rendered as the large display number.
classNamestring—Additional CSS classes to apply to the card.

<MetricsIcon02 />

4 props · 1 for styling (highlighted)
PropTypeDefaultDescription
footerReactNode—Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed.
subtitlestring"View 24 hours"Heading shown next to the featured icon at the top of the card.
titlestring"2,000"The metric's headline figure, rendered as the large display number.
classNamestring—Additional CSS classes to apply to the card.

<MetricsIcon03 />

8 props · 1 for styling (highlighted)
PropTypeDefaultDescription
actionsbooleantrueWhether to render the actions dropdown button in the top-right corner of the card.
changestring"100%"The change amount rendered inside the trend indicator, such as "100%".
changeTrend"positive" | "negative""positive"Direction of the change, setting the trend indicator's arrow direction and its green or red tint.
footerReactNode—Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed.
iconFC<{ className?: string; }>TrendUp01Icon component rendered inside the featured icon block above the metric.
subtitlestring"View 24 hours"Label above the figure naming the metric or the period it covers.
titlestring"2,000"The metric's headline figure, rendered as the large display number.
classNamestring—Additional CSS classes to apply to the card.

<MetricsIcon04 />

8 props · 1 for styling (highlighted)
PropTypeDefaultDescription
actionsbooleantrueWhether to render the actions dropdown button in the top-right corner of the card.
changestring"100%"The change amount rendered inside the pill indicator, such as "100%".
changeTrend"positive" | "negative""positive"Direction of the change, setting the pill indicator's arrow direction and its green or red tint.
footerReactNode—Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed.
iconFC<{ className?: string; }>TrendUp01Icon component rendered inside the featured icon block beside the metric.
subtitlestring"View 24 hours"Label above the figure naming the metric or the period it covers.
titlestring"2,000"The metric's headline figure, rendered as the large display number.
classNamestring—Additional CSS classes to apply to the card.

<MetricsChart01 />

9 props · 1 for styling (highlighted)
PropTypeDefaultDescription
actionsbooleantrueWhether to render the actions dropdown button in the top-right corner of the card.
changestring"100%"The change amount rendered inside the indicator, such as "100%".
changeDescriptionstring"vs last month"Supporting text shown after the change indicator, typically the comparison period.
chartData{ value: number; highlight?: boolean; }[]lineDataPoints plotted in the fixed-size area chart. Each entry's `value` is its height, and `highlight: true` draws a ringed dot on that point.
footerReactNode—Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed.
subtitlestring"View 24 hours"Heading shown at the top of the card, naming the metric or the period it covers.
titlestring"2,000"The metric's headline figure, rendered as the large display number.
trend"positive" | "negative""positive"Direction of the change. It sets the indicator's arrow direction and tints both the indicator and the area chart green when positive or red when negative.
classNamestring—Additional CSS classes to apply to the card.

<MetricsChart02 />

7 props · 1 for styling (highlighted)
PropTypeDefaultDescription
changestring"100%"The change amount rendered inside the trend indicator, such as "100%".
changeTrend"positive" | "negative""positive"Direction of the change. It sets the trend indicator's arrow direction and tints both the indicator and the area chart green when positive or red when negative.
footerReactNode—Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed.
iconFC<{ className?: string; }>EyeIcon component rendered inside the featured icon beside the heading.
subtitlestring"View 24 hours"Heading shown next to the featured icon at the top of the card.
titlestring"2,000"The metric's headline figure, rendered as the large display number.
classNamestring—Additional CSS classes to apply to the card.

<MetricsChart03 />

12 props · 1 for styling (highlighted)
PropTypeDefaultDescription
change*string—The change amount rendered inside the indicator, such as "100%".
changeTrend*"positive" | "negative"—Direction of the change. It sets the indicator's arrow direction and, unless `chartColor` is given, whether the chart is drawn green or red.
changeDescriptionstring—Supporting text shown after the change indicator, typically the comparison period. It is left out when empty.
chartAreaFillstring—Fill for the area under the line, replacing the generated top-to-bottom gradient.
chartColorstring—Text color class applied to the chart's line and to its gradient fill. When omitted, the chart follows `changeTrend`, drawing green for a positive
chartCurveTypeCurveType—Interpolation Recharts uses to draw the line between points.
chartData{ value: number; }[]lineData3Points plotted in the full-width area chart, where each entry's `value` is its height.
footerReactNode—Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed.
subtitlestring"View 24 hours"Label above the figure naming the metric or the period it covers.
titlestring"2,000"The metric's headline figure, rendered as the large display number.
type"modern" | "simple" | "trend""trend"Visual style of the change indicator shown beside the figure.
classNamestring—Additional CSS classes to apply to the card.

<MetricsChart04 />

12 props · 1 for styling (highlighted)
PropTypeDefaultDescription
change*string—The change amount rendered inside the indicator, such as "100%".
changeTrend*"positive" | "negative"—Direction of the change, setting the indicator's arrow direction and its green or red tint.
subtitle*string—Heading shown in the tinted strip above the metric card.
title*string—The metric's headline figure, rendered as the large display number.
changeDescriptionstring—Supporting text shown after the change indicator, typically the comparison period. It is left out when empty.
chartAreaFillstring—Fill for the area under the line, replacing the generated top-to-bottom gradient.
chartColorstring"text-fg-success-secondary"Text color class applied to the chart's line and to its gradient fill.
chartCurveTypeCurveType—Interpolation Recharts uses to draw the line between points.
chartData{ value: number; }[]lineData3Points plotted in the full-width area chart, where each entry's `value` is its height.
footerReactNode—Content rendered in a right-aligned row at the bottom of the card. It is left out entirely when nothing is passed.
type"modern" | "simple" | "trend""trend"Visual style of the change indicator shown beside the figure.
classNamestring—Additional CSS classes to apply to the card.

<MetricChangeIndicator />

4 props · 1 for styling (highlighted)
PropTypeDefaultDescription
trend*"positive" | "negative"—Direction of the change. "positive" points the arrow up and tints it green, "negative" points it down and tints it red; outside the "modern" style the value text is tinted to match.
type*"modern" | "simple" | "trend"—Visual style of the indicator: "simple" uses a straight arrow, "trend" a trend line arrow, and "modern" a diagonal arrow inside a bordered pill.
valuestring—The change amount rendered next to the arrow, such as "100%".
classNamestring—Additional CSS classes to apply to the indicator wrapper.

Inline CTAs

Copy-paste call-to-action cards composed from Button, Input, Form, FeaturedIcon, payment and file icons.

Source: src/app/reusable-ui/_examples/inline-cta-*.tsx

PropValues
Card wrapperrounded-xl bg-primary shadow-xs ring-1 ring-secondary ring-inset p-4 sm:p-6
ActionsButton color="secondary" + primary, size="sm"; flex-col-reverse sm:flex-row
Email fieldForm + Input isRequired hideRequiredIndicator icon={Mail01}
ReceiptFileIcon theme="light" dark:hidden + theme="dark" not-dark:hidden

Actions

Smiling girl

We've just released a new update!

Check out the all new dashboard view. Pages and now load faster.

Email field

We've just released a new update!

Check out the all new dashboard view. Pages and now load faster.

Change plan

Change your plan

Flexible pricing that grows with you.

Basic plan

$10per month

Includes up to 10 users, 20 GB individual data and access to all features.

Upgrade plan

Upgrade your plan

Need more space? Upgrade your plan today.

  • 10 users

    Add up to 10 team members.

  • 20 GB data

    Up to 20 GB individual data.

  • All features

    Access to advanced features and analytics.

Payment method

Payment method

Change how you pay for your plan.

Visa ending in 1234

Expiry 06/2028

billing@untitledui.com

Receipt

Your latest receipt is available

Download receipt for January 2027.

Receipt_January_2027.pdf

200 KB

Layout & data

Page headers

Untitled UI PRO page headers (breadcrumbs, title, actions, search, avatar, banner) — compositions of Breadcrumbs, Button, Input and Avatar; the Impacteers PageHeader component is kept for the custom-colors example.

Source: src/app/reusable-ui/_examples/page-header-*.tsx · components/application/page-header/page-header.tsx

Simple

Team members

Manage your team members and their account permissions here.

Avatar

Olivia Rhye

Olivia Rhye

olivia@untitledui.com

Banner simple

Back

Team members

Manage your team members and their account permissions here.

Banner avatar

Olivia Rhye

olivia@untitledui.com

Banner simple centered

Olivia Rhye

olivia@untitledui.com

Banner avatar centered

Olivia Rhye
Olivia Rhye

Olivia Rhye

olivia@untitledui.com

Custom colors

Hiring manager

Frontend Developer

Impacteers · Chennai · Full-time

Campus drive 2026

Register before 30 November to book your interview slot.

Applications

Review and shortlist candidates.

Props

<Breadcrumbs />

5 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*string | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | null—The `Breadcrumbs.Item` and `Breadcrumbs.AccountItem` elements to render.
divider"chevron" | "slash""chevron"Separator drawn between items. Applied to every item through context.
maxVisibleItemsnumber4The maximum number of visible items. If the number of items
type"button" | "text" | "text-line""text"Visual style of the trail — plain text, text framed by top and bottom rules, or button-like items with a hover background.
classNamestring—Additional class name for the `nav` wrapper.

<PageHeader />

14 props · 2 for styling (highlighted)
PropTypeDefaultDescription
title*ReactNode—
accentColorstring—Any CSS color for brand-colored parts (primary buttons, focus rings), e.g. "#095E15".
actionsReactNode—Buttons on the right (or under the title when centered).
avatar{ src: string; alt?: string; verified?: boolean; }—Profile photo; becomes a large overlapping photo when there is a banner.
bannerboolean—Show a cover banner above the header.
breadcrumbsBreadcrumbItem[]—
centeredboolean—Center everything (best with a banner).
descriptionReactNode—
dividerbooleantrueBottom border under the header.
onSearchChange((value: string) => void)—
searchboolean—Show a search box with a ⌘K hint.
searchPlaceholderstring"Search"
bannerClassNamestring—Banner classes, e.g. "bg-linear-to-b from-[#C7E9CB] to-[#F6FBF6]" or "bg-[url(/cover.jpg)] bg-cover".
classNamestring—

Tabs

Switch between views on the same page — button, underline and line styles, horizontal or vertical.

Source: src/components/application/tabs/tabs.tsx

Button brand horizontal

Button gray horizontal

Button border horizontal

Button minimal horizontal

Underline

Button brand vertical

Button gray vertical

Button border vertical

Button minimal vertical

Line

Tabs

Your profile details.

Props

<Tabs />

88 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, react-stately, @react-types/shared, react-aria, react (below).
›88 more props from react-aria-components, react-stately, @react-types/shared, react-aria, react(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((values: TabsRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<TabsRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultSelectedKeyKey—The initial selected keys in the collection (uncontrolled).
dirstring—
disabledKeysIterable<Key>—The item keys that are disabled. These items cannot be selected, focused, or otherwise
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isDisabledboolean—Whether the TabList is disabled.
keyboardActivation"manual" | "automatic"—Whether tabs are activated automatically on focus or manually.
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectionChange((key: Key) => void)—Handler that is called when the selection changes.
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
orientation"horizontal" | "vertical"—The orientation of the tabs.
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
renderDOMRenderFunction<"div", TabsRenderProps>—Overrides the default DOM element with a custom render function.
selectedKeyKey—The currently selected key in the collection (controlled).
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<TabsRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

<Tabs.List />

84 props · 1 for styling (highlighted)
PropTypeDefaultDescription
fullWidthboolean—Whether the tab list is full width.
itemsTabComponentProps[]—The items of the tab list. When provided, tabs are rendered automatically via the render function in children.
orientation"horizontal" | "vertical"—The orientation of the tab list.
size"sm" | "md"—The size of the tab list.
type"line" | "button-brand" | "button-gray" | "button-border" | "button-minimal" | "underline"—The type of the tab list.
›79 more props from react-aria-components, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((item: TabComponentProps) => ReactNode)—The contents of the collection.
classNameClassNameOrFunction<TabListRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dependenciesreadonly any[]—Values that should invalidate the item cache when using dynamic collections.
dirstring—
hiddenboolean—
inertboolean—
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
renderDOMRenderFunction<"div", TabListRenderProps>—Overrides the default DOM element with a custom render function.
styleStyleOrFunction<TabListRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

<Tabs.Item />

102 props · 1 for styling (highlighted)
PropTypeDefaultDescription
badgestring | number—The badge displayed next to the label.
childrenReactNode | ((props: AriaTabRenderProps) => ReactNode)—The children of the tab.
iconReactNode | FC<{ className?: string; }>—Icon component or element to show before the text
labelReactNode—The label of the tab.
›98 more props from react-aria-components, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
classNameClassNameOrFunction<TabRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
downloadstring | boolean—Causes the browser to download the linked URL. A string may be provided to suggest a file name.
hiddenboolean—
hrefstring—A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).
hrefLangstring—Hints at the human language of the linked URL.
idKey—The unique id of the tab.
inertboolean—
isDisabledboolean—Whether the tab is disabled.
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
pingstring—A space-separated list of URLs to ping when the link is followed. See
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—How much of the referrer to send when following the link. See
relstring—The relationship between the linked resource and the current page. See
render((props: React.DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement> | React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, renderProps: TabRenderProps) => ReactElement)—Overrides the default DOM element with a custom render function.
routerOptionsundefined—Options for the configured client side router.
styleStyleOrFunction<TabRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
targetHTMLAttributeAnchorTarget—The target window for the link. See
translate"yes" | "no"—

<Tabs.Panel />

81 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, @react-types/shared, react-aria, react (below).
›81 more props from react-aria-components, @react-types/shared, react-aria, react(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((values: TabPanelRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<TabPanelRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
hiddenboolean—
idKey—The unique id of the tab.
inertboolean—
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
renderDOMRenderFunction<"div", TabPanelRenderProps>—Overrides the default DOM element with a custom render function.
shouldForceMountboolean—Whether to mount the tab panel in the DOM even when it is not currently selected. Inactive tab
styleStyleOrFunction<TabPanelRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

Modals

Dialogs for confirmations and focused tasks — every Untitled UI PRO modal example (components/application/modals/*-modal.tsx).

Source: src/components/application/modals/modal.tsx

Stacked left aligned

Warning stacked left aligned

Destructive stacked left aligned

Horizontal

Warning horizontal

Destructive horizontal

Login

Signup 01

Signup 02

Checkboxes

Toggles

Link field

Dropdown

Input field

Labels

Access request

Email invite

User invite

Stacked with team

Stacked with team and link

Stacked with team and invites

Verification code

Two-factor code

Password prompt

Centered photo

Centered photo carousel

Centered video carousel

Payment details

Payment details with image

Plan 01

Plan 02

Payment method

Date picker

File upload

Profile settings

User selection

Form 01

Form 02

Image crop

Calendar event

Banner appearance

Appearance settings

AI assistant

User settings

New project

Text editor

Share project

Create event

Integration

New message empty state

New message filled

Confirm modal (Impacteers)

Props

<ModalOverlay />

88 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, react-aria, react-stately, @react-types/shared (below).
›88 more props from react-aria-components, react-aria, react-stately, @react-types/shared(children, className, defaultOpen, dir…)
PropTypeDefaultDescription
childrenReact.ReactNode | ((values: ModalRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<ModalRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultOpenboolean—Whether the overlay is open by default (uncontrolled).
dirstring—
hiddenboolean—
inertboolean—
isDismissableboolean—Whether to close the modal when the user interacts outside it.
isEnteringboolean—Whether the modal is currently performing an entry animation.
isExitingboolean—Whether the modal is currently performing an exit animation.
isKeyboardDismissDisabledboolean—Whether pressing the escape key to close the modal should be disabled.
isOpenboolean—Whether the overlay is open by default (controlled).
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onEnter((element: HTMLElement) => void | Promise<void>)—Callback when the modal starts entering. Return a promise to indicate when the entry animation
onExit((element: HTMLElement) => void | Promise<void>)—Callback when the modal starts exiting. Return a promise to indicate when the exit animation
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean) => void)—Handler that is called when the overlay's open state changes.
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
renderDOMRenderFunction<"div", ModalRenderProps>—Overrides the default DOM element with a custom render function.
shouldCloseOnInteractOutside((element: Element) => boolean)—When user interacts with the argument element outside of the overlay ref,
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ModalRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
UNSTABLE_deferUntilEnteredboolean—Whether to wait until the entry animation completes before hiding content outside the modal
UNSTABLE_overrideFocusboolean—Whether to override the `focus()` method so it does not scroll the page.
UNSTABLE_portalContainerElement—The container element in which the overlay portal will be placed. This may have unknown

<Modal />

88 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, react-aria, react-stately, @react-types/shared (below).
›88 more props from react-aria-components, react-aria, react-stately, @react-types/shared(children, className, defaultOpen, dir…)
PropTypeDefaultDescription
childrenReact.ReactNode | ((values: ModalRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<ModalRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultOpenboolean—Whether the overlay is open by default (uncontrolled).
dirstring—
hiddenboolean—
inertboolean—
isDismissableboolean—Whether to close the modal when the user interacts outside it.
isEnteringboolean—Whether the modal is currently performing an entry animation.
isExitingboolean—Whether the modal is currently performing an exit animation.
isKeyboardDismissDisabledboolean—Whether pressing the escape key to close the modal should be disabled.
isOpenboolean—Whether the overlay is open by default (controlled).
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onEnter((element: HTMLElement) => void | Promise<void>)—Callback when the modal starts entering. Return a promise to indicate when the entry animation
onExit((element: HTMLElement) => void | Promise<void>)—Callback when the modal starts exiting. Return a promise to indicate when the exit animation
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean) => void)—Handler that is called when the overlay's open state changes.
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
renderDOMRenderFunction<"div", ModalRenderProps>—Overrides the default DOM element with a custom render function.
shouldCloseOnInteractOutside((element: Element) => boolean)—When user interacts with the argument element outside of the overlay ref,
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ModalRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
UNSTABLE_deferUntilEnteredboolean—Whether to wait until the entry animation completes before hiding content outside the modal
UNSTABLE_overrideFocusboolean—Whether to override the `focus()` method so it does not scroll the page.
UNSTABLE_portalContainerElement—The container element in which the overlay portal will be placed. This may have unknown

<Dialog />

82 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, react-aria, @react-types/shared (below).
›82 more props from react-aria-components, react-aria, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
childrenReact.ReactNode | ((opts: DialogRenderProps) => ReactNode)—Children of the dialog. A function may be provided to access a function to close the dialog.
classNamestring—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
isEnteringboolean—Whether the dialog is currently performing an entry animation. Focus is not moved into the
langstring—
onAnimationEndAnimationEventHandler<HTMLElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLElement>—
onAnimationIterationAnimationEventHandler<HTMLElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLElement>—
onAnimationStartAnimationEventHandler<HTMLElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLElement>—
onAuxClickMouseEventHandler<HTMLElement>—
onAuxClickCaptureMouseEventHandler<HTMLElement>—
onClickMouseEventHandler<HTMLElement>—
onClickCaptureMouseEventHandler<HTMLElement>—
onContextMenuMouseEventHandler<HTMLElement>—
onContextMenuCaptureMouseEventHandler<HTMLElement>—
onDoubleClickMouseEventHandler<HTMLElement>—
onDoubleClickCaptureMouseEventHandler<HTMLElement>—
onGotPointerCapturePointerEventHandler<HTMLElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLElement>—
onLostPointerCapturePointerEventHandler<HTMLElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLElement>—
onMouseDownMouseEventHandler<HTMLElement>—
onMouseDownCaptureMouseEventHandler<HTMLElement>—
onMouseEnterMouseEventHandler<HTMLElement>—
onMouseLeaveMouseEventHandler<HTMLElement>—
onMouseMoveMouseEventHandler<HTMLElement>—
onMouseMoveCaptureMouseEventHandler<HTMLElement>—
onMouseOutMouseEventHandler<HTMLElement>—
onMouseOutCaptureMouseEventHandler<HTMLElement>—
onMouseOverMouseEventHandler<HTMLElement>—
onMouseOverCaptureMouseEventHandler<HTMLElement>—
onMouseUpMouseEventHandler<HTMLElement>—
onMouseUpCaptureMouseEventHandler<HTMLElement>—
onPointerCancelPointerEventHandler<HTMLElement>—
onPointerCancelCapturePointerEventHandler<HTMLElement>—
onPointerDownPointerEventHandler<HTMLElement>—
onPointerDownCapturePointerEventHandler<HTMLElement>—
onPointerEnterPointerEventHandler<HTMLElement>—
onPointerLeavePointerEventHandler<HTMLElement>—
onPointerMovePointerEventHandler<HTMLElement>—
onPointerMoveCapturePointerEventHandler<HTMLElement>—
onPointerOutPointerEventHandler<HTMLElement>—
onPointerOutCapturePointerEventHandler<HTMLElement>—
onPointerOverPointerEventHandler<HTMLElement>—
onPointerOverCapturePointerEventHandler<HTMLElement>—
onPointerUpPointerEventHandler<HTMLElement>—
onPointerUpCapturePointerEventHandler<HTMLElement>—
onScrollUIEventHandler<HTMLElement>—
onScrollCaptureUIEventHandler<HTMLElement>—
onTouchCancelTouchEventHandler<HTMLElement>—
onTouchCancelCaptureTouchEventHandler<HTMLElement>—
onTouchEndTouchEventHandler<HTMLElement>—
onTouchEndCaptureTouchEventHandler<HTMLElement>—
onTouchMoveTouchEventHandler<HTMLElement>—
onTouchMoveCaptureTouchEventHandler<HTMLElement>—
onTouchStartTouchEventHandler<HTMLElement>—
onTouchStartCaptureTouchEventHandler<HTMLElement>—
onTransitionCancelTransitionEventHandler<HTMLElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLElement>—
onTransitionEndTransitionEventHandler<HTMLElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLElement>—
onTransitionRunTransitionEventHandler<HTMLElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLElement>—
onTransitionStartTransitionEventHandler<HTMLElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLElement>—
onWheelWheelEventHandler<HTMLElement>—
onWheelCaptureWheelEventHandler<HTMLElement>—
renderDOMRenderFunction<"section", undefined>—Overrides the default DOM element with a custom render function.
role"dialog" | "alertdialog"—The accessibility role for the dialog.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleReact.CSSProperties—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

Drawers

Slideout menus (drawers) from the screen edge — every Untitled UI PRO drawer example (components/application/slideout-menus/*-menu.tsx).

Source: src/components/application/slideout-menus/slideout-menu.tsx

Placeholder menu

User profile menu

Messages menu

Message chat menu

Payment method menu

Payment details menu

Plan menu

Team members menu

Filters menu

Filters advanced empty state menu

Filters advanced active menu

File upload menu

Labels menu

Project details menu

Notification settings checkbox menu

Notification settings button menu

Notifications menu

Order summary menu

Calendar event menu

User settings menu

AI assistant menu

AI assistant message menu

Share project menu

Create event menu

Integration menu

Props

<SlideoutMenu />

90 props · 2 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode | ((children: AriaModalRenderProps & { close: () => void; }) => ReactNode)—The content of the menu. Can be a render prop that receives the modal state along with a `close` function.
dialogClassNamestring—The class name applied to the inner dialog, while `className` styles the sliding panel.
›88 more props from react-aria-components, @react-types/shared, react-stately, react-aria, react(className, defaultOpen, dir, hidden…)
PropTypeDefaultDescription
classNameClassNameOrFunction<ModalRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultOpenboolean—Whether the overlay is open by default (uncontrolled).
dirstring—
hiddenboolean—
inertboolean—
isDismissableboolean—Whether to close the modal when the user interacts outside it.
isEnteringboolean—Whether the modal is currently performing an entry animation.
isExitingboolean—Whether the modal is currently performing an exit animation.
isKeyboardDismissDisabledboolean—Whether pressing the escape key to close the modal should be disabled.
isOpenboolean—Whether the overlay is open by default (controlled).
langstring—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onEnter((element: HTMLElement) => void | Promise<void>)—Callback when the modal starts entering. Return a promise to indicate when the entry animation
onExit((element: HTMLElement) => void | Promise<void>)—Callback when the modal starts exiting. Return a promise to indicate when the exit animation
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean) => void)—Handler that is called when the overlay's open state changes.
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
refLegacyRef<HTMLDivElement>—Allows getting a ref to the component instance.
renderDOMRenderFunction<"div", ModalRenderProps>—Overrides the default DOM element with a custom render function.
shouldCloseOnInteractOutside((element: Element) => boolean)—When user interacts with the argument element outside of the overlay ref,
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ModalRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—
UNSTABLE_deferUntilEnteredboolean—Whether to wait until the entry animation completes before hiding content outside the modal
UNSTABLE_overrideFocusboolean—Whether to override the `focus()` method so it does not scroll the page.
UNSTABLE_portalContainerElement—The container element in which the overlay portal will be placed. This may have unknown

Command menus

⌘K command palettes: searchable users, actions and integrations with previews (Untitled UI PRO).

Source: src/components/application/command-menus/command-menu.tsx

Users

Users stacked

Actions

Actions stacked

Empty state

Users menu

Users menu stacked

Integrations menu

Integrations menu stacked

Props

<CommandMenu />

116 props · 2 for styling (highlighted)
PropTypeDefaultDescription
defaultItemsCommandMenuGroupType[]—Groups used to seed the list when `items` is not provided. Their `shortcutKeys` are registered as global hotkeys either way.
emptyStateReactNode—Content rendered in place of the list when the search matches no items.
filterfalse | ((textValue: string, inputValue: string, node: Node<object>) => boolean)—Custom match function for the underlying Autocomplete. Defaults to a `contains` match built from `sensitivity`; pass `false` to skip client-side filtering entirely and show `items` as given.
itemsCommandMenuGroupType[]—Groups of items rendered in the list. They are also flattened so that any item `shortcutKeys` can be registered as global hotkeys.
placeholderstring"Search"Placeholder text for the search input at the top of the dialog.
sensitivity"base" | "variant" | "accent" | "case""base"Collation sensitivity passed to React Aria's `useFilter`, controlling how loosely search text matches — `base` ignores case and accents, `variant` matches exactly.
shortcutstring | null"⌘/"Keyboard shortcut that focuses the search input, written as a display string such as `⌘/`. Each character is one key of the combination, and the string is also shown as a hint inside the input. Pass `null` for no shortcut.
dialogClassNameClassNameOrFunction<ModalRenderProps>—Class name applied to the modal panel — the rounded, elevated box that holds the input, list and footer.
overlayClassNameClassNameOrFunction<ModalRenderProps>—Class name applied to the full-screen blurred backdrop behind the modal panel.
›107 more props from @react-types/shared, react-aria, react-aria-components, react-stately(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoFocusboolean | "first" | "last"—Whether to auto focus the listbox or an option.
children*ReactNode—The children wrapped by the autocomplete. Consists of at least an input element and a
defaultInputValuestring—The default value of the autocomplete input (uncontrolled).
defaultOpenboolean—Whether the overlay is open by default (uncontrolled).
defaultSelectedKeysIterable<Key> | "all"—The initial selected keys in the collection (uncontrolled).
dependenciesreadonly any[]—Values that should invalidate the item cache when using dynamic collections.
dirstring—
disableAutoFocusFirstboolean—Whether or not to focus the first item in the collection after a filter is performed. Note this
disabledKeysIterable<Key>—The item keys that are disabled. These items cannot be selected, focused, or otherwise
disableVirtualFocusboolean—Whether the autocomplete should disable virtual focus, instead making the wrapped collection
disallowEmptySelectionboolean—Whether the collection allows empty selection.
dragAndDropHooksDragAndDropHooks<NoInfer<CommandMenuGroupType>>—The drag and drop hooks returned by `useDragAndDrop` used to enable drag and drop behavior for
escapeKeyBehavior"none" | "clearSelection"—Whether pressing the escape key should clear selection in the listbox or not.
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
inputValuestring—The value of the autocomplete input (controlled).
isOpenboolean—Whether the overlay is open by default (controlled).
langstring—
layout"grid" | "stack"—Whether the items are arranged in a stack or grid.
onAction((key: Key) => void)—Handler that is called when a user performs an action on an item. The exact user event depends
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBlur((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element loses focus.
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onFocus((e: FocusEvent<Element, Element>) => void)—Handler that is called when the element receives focus.
onFocusChange((isFocused: boolean) => void)—Handler that is called when the element's focus status changes.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputChange((value: string) => void)—Handler that is called when the autocomplete input value changes.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onOpenChange((isOpen: boolean) => void)—Handler that is called when the overlay's open state changes.
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectionChange((keys: Selection) => void)—Handler that is called when the selection changes.
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
orientation"horizontal" | "vertical"—The primary orientation of the items. Usually this is the
renderDOMRenderFunction<"div", ListBoxRenderProps>—Overrides the default DOM element with a custom render function.
renderEmptyState((props: ListBoxRenderProps) => ReactNode)—Provides content to display when there are no items in the list.
selectionBehavior"replace" | "toggle"—How multiple selection should behave in the collection.
selectionMode"single" | "multiple" | "none"—The type of selection that is allowed in the collection.
shouldFocusOnHoverboolean—Whether options should be focused when the user hovers over them.
shouldFocusWrapboolean—Whether focus should wrap around when the end/start is reached.
shouldSelectOnPressUpboolean—Whether selection should occur on press up instead of press down.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<ListBoxRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

Tables

Data tables with sorting and row selection inside a card, plus empty, error and offline states.

Source: src/components/application/table/table.tsx

Divider line 01

Team members

100 users
Name
Status
Role
Email address
Teams
Olivia Rhye

Olivia Rhye

@olivia

ActiveProduct Designerolivia@untitledui.com
DesignProductMarketing+4
Phoenix Baker

Phoenix Baker

@phoenix

ActiveProduct Managerphoenix@untitledui.com
DesignProductMarketing+4
Lana Steiner

Lana Steiner

@lana

ActiveFrontend Developerlana@untitledui.com
DesignProductMarketing+2
Demi Wilkinson

Demi Wilkinson

@demi

ActiveBackend Developerdemi@untitledui.com
DesignProductMarketing+1
Candice Wu

Candice Wu

@candice

ActiveFullstack Developercandice@untitledui.com
DesignProductMarketing+2
Natali Craig

Natali Craig

@natali

ActiveUX Designernatali@untitledui.com
DesignProductMarketing+2
Drew Cano

Drew Cano

@drew

ActiveUX Copywriterdrew@untitledui.com
DesignProductMarketing+4
Orlando Diggs

Orlando Diggs

@orlando

ActiveUI Designerorlando@untitledui.com
DesignProductMarketing+4
Andi Lane

Andi Lane

@andi

ActiveProduct Managerandi@untitledui.com
DesignProductMarketing+4
Kate Morrison

Kate Morrison

@kate

ActiveQA Engineerkate@untitledui.com
DesignProductMarketing+2

Alternating fills 01

Team members

100 users
Name
Status
Role
Email address
Teams
Olivia Rhye

Olivia Rhye

@olivia

ActiveProduct Designerolivia@untitledui.com
DesignProductMarketing+4
Phoenix Baker

Phoenix Baker

@phoenix

ActiveProduct Managerphoenix@untitledui.com
DesignProductMarketing+4
Lana Steiner

Lana Steiner

@lana

ActiveFrontend Developerlana@untitledui.com
DesignProductMarketing+2
Demi Wilkinson

Demi Wilkinson

@demi

ActiveBackend Developerdemi@untitledui.com
DesignProductMarketing+1
Candice Wu

Candice Wu

@candice

ActiveFullstack Developercandice@untitledui.com
DesignProductMarketing+2
Natali Craig

Natali Craig

@natali

ActiveUX Designernatali@untitledui.com
DesignProductMarketing+2
Drew Cano

Drew Cano

@drew

ActiveUX Copywriterdrew@untitledui.com
DesignProductMarketing+4
Orlando Diggs

Orlando Diggs

@orlando

ActiveUI Designerorlando@untitledui.com
DesignProductMarketing+4
Andi Lane

Andi Lane

@andi

ActiveProduct Managerandi@untitledui.com
DesignProductMarketing+4
Kate Morrison

Kate Morrison

@kate

ActiveQA Engineerkate@untitledui.com
DesignProductMarketing+2

Divider line 02

Customers

These companies have purchased in the last 12 months.

Company
Status
About
Users
License use
Stack3d Lab

Stack3d Lab

stack3dlab.com

Churned

Design software

Super lightweight design app

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
60%
ContrastAI

ContrastAI

contrastai.com

Churned

Web app integrations

Connect web apps seamlessly

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
20%
Ephemeral

Ephemeral

ephemeral.io

Customer

Content curating app

Brings all your news into one place

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
70%
Warpspeed

Warpspeed

getwarpspeed.com

Customer

Data prediction

AI and machine learning data

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
30%
CloudWatch

CloudWatch

cloudwatch.app

Customer

Productivity app

Time management and productivity

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
80%
Convergence

Convergence

convergence.io

Customer

Sales CRM

Web-based sales doc management

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
10%
Sisyphus

Sisyphus

sisyphus.com

Customer

Automation and workflow

Time tracking, invoicing and expenses

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
40%

Alternating fills 02

Customers

These companies have purchased in the last 12 months.

Company
Status
About
Users
License use
Stack3d Lab

Stack3d Lab

stack3dlab.com

Churned

Design software

Super lightweight design app

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
60%
ContrastAI

ContrastAI

contrastai.com

Churned

Web app integrations

Connect web apps seamlessly

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
20%
Ephemeral

Ephemeral

ephemeral.io

Customer

Content curating app

Brings all your news into one place

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
70%
Warpspeed

Warpspeed

getwarpspeed.com

Customer

Data prediction

AI and machine learning data

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
30%
CloudWatch

CloudWatch

cloudwatch.app

Customer

Productivity app

Time management and productivity

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
80%
Convergence

Convergence

convergence.io

Customer

Sales CRM

Web-based sales doc management

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
10%
Sisyphus

Sisyphus

sisyphus.com

Customer

Automation and workflow

Time tracking, invoicing and expenses

Olivia Rhye
Phoenix Baker
Lana Steiner
Demi Wilkinson
Candice Wu
+5
40%

Divider line 03

Invoice
Date
Status
Customer
Purchase
#3066Jan 6, 2025paid
Olivia Rhye

Olivia Rhye

olivia@untitledui.com

Monthly subscription
#3065Jan 6, 2025paid
Phoenix Baker

Phoenix Baker

phoenix@untitledui.com

Monthly subscription
#3064Jan 6, 2025paid
LS

Lana Steiner

lana@untitledui.com

Monthly subscription
#3063Jan 5, 2025paid
DW

Demi Wilkinson

demi@untitledui.com

Monthly subscription
#3062Jan 5, 2025refunded
Candice Wu

Candice Wu

candice@untitledui.com

Monthly subscription
#3061Jan 5, 2025refunded
NC

Natali Craig

natali@untitledui.com

Monthly subscription
#3060Jan 4, 2025cancelled
Drew Cano

Drew Cano

drew@untitledui.com

Monthly subscription
#3059Jan 3, 2025paid
Orlando Diggs

Orlando Diggs

orlando@untitledui.com

Monthly subscription
#3058Jan 3, 2025paid
Andi Lane

Andi Lane

andi@untitledui.com

Monthly subscription
#3057Jan 3, 2025paid
Kate Morrison

Kate Morrison

kate@untitledui.com

Monthly subscription

Alternating fills 03

Invoice
Date
Status
Customer
Purchase
#30662025-01-06paid
Olivia Rhye

Olivia Rhye

olivia@untitledui.com

Monthly subscription
#30652025-01-06paid
Phoenix Baker

Phoenix Baker

phoenix@untitledui.com

Monthly subscription
#30642025-01-06paid
LS

Lana Steiner

lana@untitledui.com

Monthly subscription
#30632025-01-05paid
DW

Demi Wilkinson

demi@untitledui.com

Monthly subscription
#30622025-01-05refunded
Candice Wu

Candice Wu

candice@untitledui.com

Monthly subscription
#30612025-01-05refunded
NC

Natali Craig

natali@untitledui.com

Monthly subscription
#30602025-01-04cancelled
Drew Cano

Drew Cano

drew@untitledui.com

Monthly subscription
#30592025-01-03paid
Orlando Diggs

Orlando Diggs

orlando@untitledui.com

Monthly subscription
#30582025-01-03paid
Andi Lane

Andi Lane

andi@untitledui.com

Monthly subscription
#30572025-01-03paid
Kate Morrison

Kate Morrison

kate@untitledui.com

Monthly subscription

Divider line 04

Files uploaded

File name
File size
Date uploaded
Last updated
Uploaded by

Tech requirements.pdf

200 KB

200 KBJan 4, 2025Jan 4, 2025Olivia Rhye

Dashboard screenshot.jpg

720 KB

720 KBJan 4, 2025Jan 4, 2025Phoenix Baker

Dashboard prototype recording.mp4

16 MB

16 MBJan 2, 2025Jan 2, 2025Lana Steiner

Dashboard prototype FINAL.fig

4.2 MB

4.2 MBJan 6, 2025Jan 6, 2025Demi Wilkinson

UX Design Guidelines.docx

400 KB

400 KBJan 8, 2025Jan 8, 2025Candice Wu

Dashboard interaction.aep

12 MB

12 MBJan 6, 2025Jan 6, 2025Natali Craig

Briefing call recording.mp3

18.6 MB

18.6 MBJan 4, 2025Jan 4, 2025Drew Cano

Alternating fills 04

Files uploaded

File name
File size
Date uploaded
Last updated
Uploaded by

Tech requirements.pdf

200 KB

200 KBJan 4, 2025Jan 4, 2025Olivia Rhye

Dashboard screenshot.jpg

720 KB

720 KBJan 4, 2025Jan 4, 2025Phoenix Baker

Dashboard prototype recording.mp4

16 MB

16 MBJan 2, 2025Jan 2, 2025Lana Steiner

Dashboard prototype FINAL.fig

4.2 MB

4.2 MBJan 6, 2025Jan 6, 2025Demi Wilkinson

UX Design Guidelines.docx

400 KB

400 KBJan 8, 2025Jan 8, 2025Candice Wu

Dashboard interaction.aep

12 MB

12 MBJan 6, 2025Jan 6, 2025Natali Craig

Briefing call recording.mp3

18.6 MB

18.6 MBJan 4, 2025Jan 4, 2025Drew Cano

No vendors found

Vendor movements

240 vendors

Keep track of vendor and their security ratings.

No vendors found

Your search “Stripe” did not match any vendors. Please try again or create add a new vendor.

Something went wrong

Team members

100 users

Something went wrong...

We had some trouble loading this page. Please refresh the page or get in touch for support.

No users found

Users

128 online

Keep track of vendor and their security ratings.

No users found

Your search did not match any users.

Add first integration

Integrations

Manage custom integrations and workflows.

Add your first integration

Connect the tools you use every day to automate workflows and keep your data in sync.

Invite first user

Users

Manage team members, external users, and their access.

Invite your first user

Add your team members and external users.

Offline state

My orders

You're offline

Please check your internet connection and try again. If the issue continues, contact support.

Candidates table

Candidates

3

People who applied this week.

Name
Role
Status
AK
Arun Kumar
Frontend DeveloperInterview
PS
Priya S
Data AnalystHired
RM
Rahul M
Backend DeveloperApplied

Props

<Table />

308 props · 1 for styling (highlighted)
PropTypeDefaultDescription
size"sm" | "md""md"
›307 more props from react-aria-components, @react-types/shared, react-stately, react, next(about, accessKey, align, aria-activedescendant…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
align"left" | "right" | "center"—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
bgcolorstring—
bordernumber—
cellPaddingstring | number—
cellSpacingstring | number—
childrenstring | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | null—The elements that make up the table. Includes the TableHeader, TableBody, Columns, and Rows.
classNameClassNameOrFunction<TableRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultExpandedKeysIterable<Key>—The initial expanded keys in the collection (uncontrolled).
defaultSelectedKeysIterable<Key> | "all"—The initial selected keys in the collection (uncontrolled).
defaultValuestring | number | readonly string[]—
dirstring—
disabledBehavior"all" | "selection"—Whether `disabledKeys` applies to all interactions, or only selection.
disabledKeysIterable<Key>—A list of row keys to disable.
disallowEmptySelectionboolean—Whether the collection allows empty selection.
dragAndDropHooksDragAndDropHooks—The drag and drop hooks returned by `useDragAndDrop` used to enable drag and drop behavior for
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
escapeKeyBehavior"none" | "clearSelection"—Whether pressing the escape key should clear selection in the table or not.
expandedKeysIterable<Key>—The currently expanded keys in the collection (controlled).
exportpartsstring—
frameboolean—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
keyboardNavigationBehavior"tab" | "arrow"—Whether keyboard navigation to focusable elements within the cells is
langstring—
noncestring—
onAbortReactEventHandler<HTMLTableElement>—
onAbortCaptureReactEventHandler<HTMLTableElement>—
onAnimationEndAnimationEventHandler<HTMLTableElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLTableElement>—
onAnimationIterationAnimationEventHandler<HTMLTableElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLTableElement>—
onAnimationStartAnimationEventHandler<HTMLTableElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLTableElement>—
onAuxClickMouseEventHandler<HTMLTableElement>—
onAuxClickCaptureMouseEventHandler<HTMLTableElement>—
onBeforeInputInputEventHandler<HTMLTableElement>—
onBeforeInputCaptureFormEventHandler<HTMLTableElement>—
onBeforeToggleToggleEventHandler<HTMLTableElement>—
onBlurFocusEventHandler<HTMLTableElement>—
onBlurCaptureFocusEventHandler<HTMLTableElement>—
onCanPlayReactEventHandler<HTMLTableElement>—
onCanPlayCaptureReactEventHandler<HTMLTableElement>—
onCanPlayThroughReactEventHandler<HTMLTableElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLTableElement>—
onChangeFormEventHandler<HTMLTableElement>—
onChangeCaptureFormEventHandler<HTMLTableElement>—
onClickMouseEventHandler<HTMLTableElement>—
onClickCaptureMouseEventHandler<HTMLTableElement>—
onCompositionEndCompositionEventHandler<HTMLTableElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLTableElement>—
onCompositionStartCompositionEventHandler<HTMLTableElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLTableElement>—
onCompositionUpdateCompositionEventHandler<HTMLTableElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLTableElement>—
onContextMenuMouseEventHandler<HTMLTableElement>—
onContextMenuCaptureMouseEventHandler<HTMLTableElement>—
onCopyClipboardEventHandler<HTMLTableElement>—
onCopyCaptureClipboardEventHandler<HTMLTableElement>—
onCutClipboardEventHandler<HTMLTableElement>—
onCutCaptureClipboardEventHandler<HTMLTableElement>—
onDoubleClickMouseEventHandler<HTMLTableElement>—
onDoubleClickCaptureMouseEventHandler<HTMLTableElement>—
onDragDragEventHandler<HTMLTableElement>—
onDragCaptureDragEventHandler<HTMLTableElement>—
onDragEndDragEventHandler<HTMLTableElement>—
onDragEndCaptureDragEventHandler<HTMLTableElement>—
onDragEnterDragEventHandler<HTMLTableElement>—
onDragEnterCaptureDragEventHandler<HTMLTableElement>—
onDragExitDragEventHandler<HTMLTableElement>—
onDragExitCaptureDragEventHandler<HTMLTableElement>—
onDragLeaveDragEventHandler<HTMLTableElement>—
onDragLeaveCaptureDragEventHandler<HTMLTableElement>—
onDragOverDragEventHandler<HTMLTableElement>—
onDragOverCaptureDragEventHandler<HTMLTableElement>—
onDragStartDragEventHandler<HTMLTableElement>—
onDragStartCaptureDragEventHandler<HTMLTableElement>—
onDropDragEventHandler<HTMLTableElement>—
onDropCaptureDragEventHandler<HTMLTableElement>—
onDurationChangeReactEventHandler<HTMLTableElement>—
onDurationChangeCaptureReactEventHandler<HTMLTableElement>—
onEmptiedReactEventHandler<HTMLTableElement>—
onEmptiedCaptureReactEventHandler<HTMLTableElement>—
onEncryptedReactEventHandler<HTMLTableElement>—
onEncryptedCaptureReactEventHandler<HTMLTableElement>—
onEndedReactEventHandler<HTMLTableElement>—
onEndedCaptureReactEventHandler<HTMLTableElement>—
onErrorReactEventHandler<HTMLTableElement>—
onErrorCaptureReactEventHandler<HTMLTableElement>—
onExpandedChange((keys: Set<Key>) => any)—Handler that is called when items are expanded or collapsed.
onFocusFocusEventHandler<HTMLTableElement>—
onFocusCaptureFocusEventHandler<HTMLTableElement>—
onGotPointerCapturePointerEventHandler<HTMLTableElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLTableElement>—
onInputFormEventHandler<HTMLTableElement>—
onInputCaptureFormEventHandler<HTMLTableElement>—
onInvalidFormEventHandler<HTMLTableElement>—
onInvalidCaptureFormEventHandler<HTMLTableElement>—
onKeyDownKeyboardEventHandler<HTMLTableElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLTableElement>—
onKeyPressKeyboardEventHandler<HTMLTableElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLTableElement>—
onKeyUpKeyboardEventHandler<HTMLTableElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLTableElement>—
onLoadReactEventHandler<HTMLTableElement>—
onLoadCaptureReactEventHandler<HTMLTableElement>—
onLoadedDataReactEventHandler<HTMLTableElement>—
onLoadedDataCaptureReactEventHandler<HTMLTableElement>—
onLoadedMetadataReactEventHandler<HTMLTableElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLTableElement>—
onLoadStartReactEventHandler<HTMLTableElement>—
onLoadStartCaptureReactEventHandler<HTMLTableElement>—
onLostPointerCapturePointerEventHandler<HTMLTableElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLTableElement>—
onMouseDownMouseEventHandler<HTMLTableElement>—
onMouseDownCaptureMouseEventHandler<HTMLTableElement>—
onMouseEnterMouseEventHandler<HTMLTableElement>—
onMouseLeaveMouseEventHandler<HTMLTableElement>—
onMouseMoveMouseEventHandler<HTMLTableElement>—
onMouseMoveCaptureMouseEventHandler<HTMLTableElement>—
onMouseOutMouseEventHandler<HTMLTableElement>—
onMouseOutCaptureMouseEventHandler<HTMLTableElement>—
onMouseOverMouseEventHandler<HTMLTableElement>—
onMouseOverCaptureMouseEventHandler<HTMLTableElement>—
onMouseUpMouseEventHandler<HTMLTableElement>—
onMouseUpCaptureMouseEventHandler<HTMLTableElement>—
onPasteClipboardEventHandler<HTMLTableElement>—
onPasteCaptureClipboardEventHandler<HTMLTableElement>—
onPauseReactEventHandler<HTMLTableElement>—
onPauseCaptureReactEventHandler<HTMLTableElement>—
onPlayReactEventHandler<HTMLTableElement>—
onPlayCaptureReactEventHandler<HTMLTableElement>—
onPlayingReactEventHandler<HTMLTableElement>—
onPlayingCaptureReactEventHandler<HTMLTableElement>—
onPointerCancelPointerEventHandler<HTMLTableElement>—
onPointerCancelCapturePointerEventHandler<HTMLTableElement>—
onPointerDownPointerEventHandler<HTMLTableElement>—
onPointerDownCapturePointerEventHandler<HTMLTableElement>—
onPointerEnterPointerEventHandler<HTMLTableElement>—
onPointerLeavePointerEventHandler<HTMLTableElement>—
onPointerMovePointerEventHandler<HTMLTableElement>—
onPointerMoveCapturePointerEventHandler<HTMLTableElement>—
onPointerOutPointerEventHandler<HTMLTableElement>—
onPointerOutCapturePointerEventHandler<HTMLTableElement>—
onPointerOverPointerEventHandler<HTMLTableElement>—
onPointerOverCapturePointerEventHandler<HTMLTableElement>—
onPointerUpPointerEventHandler<HTMLTableElement>—
onPointerUpCapturePointerEventHandler<HTMLTableElement>—
onProgressReactEventHandler<HTMLTableElement>—
onProgressCaptureReactEventHandler<HTMLTableElement>—
onRateChangeReactEventHandler<HTMLTableElement>—
onRateChangeCaptureReactEventHandler<HTMLTableElement>—
onResetFormEventHandler<HTMLTableElement>—
onResetCaptureFormEventHandler<HTMLTableElement>—
onRowAction((key: Key) => void)—Handler that is called when a user performs an action on the row.
onScrollUIEventHandler<HTMLTableElement>—
onScrollCaptureUIEventHandler<HTMLTableElement>—
onSeekedReactEventHandler<HTMLTableElement>—
onSeekedCaptureReactEventHandler<HTMLTableElement>—
onSeekingReactEventHandler<HTMLTableElement>—
onSeekingCaptureReactEventHandler<HTMLTableElement>—
onSelectReactEventHandler<HTMLTableElement>—
onSelectCaptureReactEventHandler<HTMLTableElement>—
onSelectionChange((keys: Selection) => void)—Handler that is called when the selection changes.
onSortChange((descriptor: SortDescriptor) => any)—Handler that is called when the sorted column or direction changes.
onStalledReactEventHandler<HTMLTableElement>—
onStalledCaptureReactEventHandler<HTMLTableElement>—
onSubmitFormEventHandler<HTMLTableElement>—
onSubmitCaptureFormEventHandler<HTMLTableElement>—
onSuspendReactEventHandler<HTMLTableElement>—
onSuspendCaptureReactEventHandler<HTMLTableElement>—
onTimeUpdateReactEventHandler<HTMLTableElement>—
onTimeUpdateCaptureReactEventHandler<HTMLTableElement>—
onToggleToggleEventHandler<HTMLTableElement>—
onTouchCancelTouchEventHandler<HTMLTableElement>—
onTouchCancelCaptureTouchEventHandler<HTMLTableElement>—
onTouchEndTouchEventHandler<HTMLTableElement>—
onTouchEndCaptureTouchEventHandler<HTMLTableElement>—
onTouchMoveTouchEventHandler<HTMLTableElement>—
onTouchMoveCaptureTouchEventHandler<HTMLTableElement>—
onTouchStartTouchEventHandler<HTMLTableElement>—
onTouchStartCaptureTouchEventHandler<HTMLTableElement>—
onTransitionCancelTransitionEventHandler<HTMLTableElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLTableElement>—
onTransitionEndTransitionEventHandler<HTMLTableElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLTableElement>—
onTransitionRunTransitionEventHandler<HTMLTableElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLTableElement>—
onTransitionStartTransitionEventHandler<HTMLTableElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLTableElement>—
onVolumeChangeReactEventHandler<HTMLTableElement>—
onVolumeChangeCaptureReactEventHandler<HTMLTableElement>—
onWaitingReactEventHandler<HTMLTableElement>—
onWaitingCaptureReactEventHandler<HTMLTableElement>—
onWheelWheelEventHandler<HTMLTableElement>—
onWheelCaptureWheelEventHandler<HTMLTableElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLTableElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLTableElement> | null—
relstring—
renderDOMRenderFunction<"div" | "table", TableRenderProps>—Overrides the default DOM element with a custom render function.
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
rules"none" | "all" | "rows" | "groups" | "columns"—
securitystring—
selectedKeysIterable<Key> | "all"—The currently selected keys in the collection (controlled).
selectionBehavior"replace" | "toggle"—How multiple selection should behave in the collection.
selectionMode"single" | "multiple" | "none"—The type of selection that is allowed in the collection.
shouldSelectOnPressUpboolean—Whether selection should occur on press up instead of press down.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
sortDescriptorSortDescriptor—The current sorted column and direction.
spellCheckboolean | "true" | "false"—
styleStyleOrFunction<TableRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
summarystring—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
tabIndexnumber—
titlestring—
translate"yes" | "no"—
treeColumnKey—The id of the column that displays hierarchical data.
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—
widthstring | number—

<Table.Header />

285 props · 1 for styling (highlighted)
PropTypeDefaultDescription
borderedboolean—
size"sm" | "md"—
›283 more props from react-aria-components, @react-types/shared, react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReact.ReactNode | ((item: T) => ReactElement)—A list of `Column(s)` or a function. If the latter, a list of columns must be provided using
classNameClassNameOrFunction<TableHeaderRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
colorstring—
columnsIterable<T>—A list of table columns.
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dependenciesreadonly any[]—Values that should invalidate the column cache when using dynamic collections.
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLTableSectionElement>—
onAbortCaptureReactEventHandler<HTMLTableSectionElement>—
onAnimationEndAnimationEventHandler<HTMLTableSectionElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLTableSectionElement>—
onAnimationIterationAnimationEventHandler<HTMLTableSectionElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLTableSectionElement>—
onAnimationStartAnimationEventHandler<HTMLTableSectionElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLTableSectionElement>—
onAuxClickMouseEventHandler<HTMLTableSectionElement>—
onAuxClickCaptureMouseEventHandler<HTMLTableSectionElement>—
onBeforeInputInputEventHandler<HTMLTableSectionElement>—
onBeforeInputCaptureFormEventHandler<HTMLTableSectionElement>—
onBeforeToggleToggleEventHandler<HTMLTableSectionElement>—
onBlurFocusEventHandler<HTMLTableSectionElement>—
onBlurCaptureFocusEventHandler<HTMLTableSectionElement>—
onCanPlayReactEventHandler<HTMLTableSectionElement>—
onCanPlayCaptureReactEventHandler<HTMLTableSectionElement>—
onCanPlayThroughReactEventHandler<HTMLTableSectionElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLTableSectionElement>—
onChangeFormEventHandler<HTMLTableSectionElement>—
onChangeCaptureFormEventHandler<HTMLTableSectionElement>—
onClickMouseEventHandler<HTMLTableSectionElement>—
onClickCaptureMouseEventHandler<HTMLTableSectionElement>—
onCompositionEndCompositionEventHandler<HTMLTableSectionElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLTableSectionElement>—
onCompositionStartCompositionEventHandler<HTMLTableSectionElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLTableSectionElement>—
onCompositionUpdateCompositionEventHandler<HTMLTableSectionElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLTableSectionElement>—
onContextMenuMouseEventHandler<HTMLTableSectionElement>—
onContextMenuCaptureMouseEventHandler<HTMLTableSectionElement>—
onCopyClipboardEventHandler<HTMLTableSectionElement>—
onCopyCaptureClipboardEventHandler<HTMLTableSectionElement>—
onCutClipboardEventHandler<HTMLTableSectionElement>—
onCutCaptureClipboardEventHandler<HTMLTableSectionElement>—
onDoubleClickMouseEventHandler<HTMLTableSectionElement>—
onDoubleClickCaptureMouseEventHandler<HTMLTableSectionElement>—
onDragDragEventHandler<HTMLTableSectionElement>—
onDragCaptureDragEventHandler<HTMLTableSectionElement>—
onDragEndDragEventHandler<HTMLTableSectionElement>—
onDragEndCaptureDragEventHandler<HTMLTableSectionElement>—
onDragEnterDragEventHandler<HTMLTableSectionElement>—
onDragEnterCaptureDragEventHandler<HTMLTableSectionElement>—
onDragExitDragEventHandler<HTMLTableSectionElement>—
onDragExitCaptureDragEventHandler<HTMLTableSectionElement>—
onDragLeaveDragEventHandler<HTMLTableSectionElement>—
onDragLeaveCaptureDragEventHandler<HTMLTableSectionElement>—
onDragOverDragEventHandler<HTMLTableSectionElement>—
onDragOverCaptureDragEventHandler<HTMLTableSectionElement>—
onDragStartDragEventHandler<HTMLTableSectionElement>—
onDragStartCaptureDragEventHandler<HTMLTableSectionElement>—
onDropDragEventHandler<HTMLTableSectionElement>—
onDropCaptureDragEventHandler<HTMLTableSectionElement>—
onDurationChangeReactEventHandler<HTMLTableSectionElement>—
onDurationChangeCaptureReactEventHandler<HTMLTableSectionElement>—
onEmptiedReactEventHandler<HTMLTableSectionElement>—
onEmptiedCaptureReactEventHandler<HTMLTableSectionElement>—
onEncryptedReactEventHandler<HTMLTableSectionElement>—
onEncryptedCaptureReactEventHandler<HTMLTableSectionElement>—
onEndedReactEventHandler<HTMLTableSectionElement>—
onEndedCaptureReactEventHandler<HTMLTableSectionElement>—
onErrorReactEventHandler<HTMLTableSectionElement>—
onErrorCaptureReactEventHandler<HTMLTableSectionElement>—
onFocusFocusEventHandler<HTMLTableSectionElement>—
onFocusCaptureFocusEventHandler<HTMLTableSectionElement>—
onGotPointerCapturePointerEventHandler<HTMLTableSectionElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLTableSectionElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onInputFormEventHandler<HTMLTableSectionElement>—
onInputCaptureFormEventHandler<HTMLTableSectionElement>—
onInvalidFormEventHandler<HTMLTableSectionElement>—
onInvalidCaptureFormEventHandler<HTMLTableSectionElement>—
onKeyDownKeyboardEventHandler<HTMLTableSectionElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLTableSectionElement>—
onKeyPressKeyboardEventHandler<HTMLTableSectionElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLTableSectionElement>—
onKeyUpKeyboardEventHandler<HTMLTableSectionElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLTableSectionElement>—
onLoadReactEventHandler<HTMLTableSectionElement>—
onLoadCaptureReactEventHandler<HTMLTableSectionElement>—
onLoadedDataReactEventHandler<HTMLTableSectionElement>—
onLoadedDataCaptureReactEventHandler<HTMLTableSectionElement>—
onLoadedMetadataReactEventHandler<HTMLTableSectionElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLTableSectionElement>—
onLoadStartReactEventHandler<HTMLTableSectionElement>—
onLoadStartCaptureReactEventHandler<HTMLTableSectionElement>—
onLostPointerCapturePointerEventHandler<HTMLTableSectionElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLTableSectionElement>—
onMouseDownMouseEventHandler<HTMLTableSectionElement>—
onMouseDownCaptureMouseEventHandler<HTMLTableSectionElement>—
onMouseEnterMouseEventHandler<HTMLTableSectionElement>—
onMouseLeaveMouseEventHandler<HTMLTableSectionElement>—
onMouseMoveMouseEventHandler<HTMLTableSectionElement>—
onMouseMoveCaptureMouseEventHandler<HTMLTableSectionElement>—
onMouseOutMouseEventHandler<HTMLTableSectionElement>—
onMouseOutCaptureMouseEventHandler<HTMLTableSectionElement>—
onMouseOverMouseEventHandler<HTMLTableSectionElement>—
onMouseOverCaptureMouseEventHandler<HTMLTableSectionElement>—
onMouseUpMouseEventHandler<HTMLTableSectionElement>—
onMouseUpCaptureMouseEventHandler<HTMLTableSectionElement>—
onPasteClipboardEventHandler<HTMLTableSectionElement>—
onPasteCaptureClipboardEventHandler<HTMLTableSectionElement>—
onPauseReactEventHandler<HTMLTableSectionElement>—
onPauseCaptureReactEventHandler<HTMLTableSectionElement>—
onPlayReactEventHandler<HTMLTableSectionElement>—
onPlayCaptureReactEventHandler<HTMLTableSectionElement>—
onPlayingReactEventHandler<HTMLTableSectionElement>—
onPlayingCaptureReactEventHandler<HTMLTableSectionElement>—
onPointerCancelPointerEventHandler<HTMLTableSectionElement>—
onPointerCancelCapturePointerEventHandler<HTMLTableSectionElement>—
onPointerDownPointerEventHandler<HTMLTableSectionElement>—
onPointerDownCapturePointerEventHandler<HTMLTableSectionElement>—
onPointerEnterPointerEventHandler<HTMLTableSectionElement>—
onPointerLeavePointerEventHandler<HTMLTableSectionElement>—
onPointerMovePointerEventHandler<HTMLTableSectionElement>—
onPointerMoveCapturePointerEventHandler<HTMLTableSectionElement>—
onPointerOutPointerEventHandler<HTMLTableSectionElement>—
onPointerOutCapturePointerEventHandler<HTMLTableSectionElement>—
onPointerOverPointerEventHandler<HTMLTableSectionElement>—
onPointerOverCapturePointerEventHandler<HTMLTableSectionElement>—
onPointerUpPointerEventHandler<HTMLTableSectionElement>—
onPointerUpCapturePointerEventHandler<HTMLTableSectionElement>—
onProgressReactEventHandler<HTMLTableSectionElement>—
onProgressCaptureReactEventHandler<HTMLTableSectionElement>—
onRateChangeReactEventHandler<HTMLTableSectionElement>—
onRateChangeCaptureReactEventHandler<HTMLTableSectionElement>—
onResetFormEventHandler<HTMLTableSectionElement>—
onResetCaptureFormEventHandler<HTMLTableSectionElement>—
onScrollUIEventHandler<HTMLTableSectionElement>—
onScrollCaptureUIEventHandler<HTMLTableSectionElement>—
onSeekedReactEventHandler<HTMLTableSectionElement>—
onSeekedCaptureReactEventHandler<HTMLTableSectionElement>—
onSeekingReactEventHandler<HTMLTableSectionElement>—
onSeekingCaptureReactEventHandler<HTMLTableSectionElement>—
onSelectReactEventHandler<HTMLTableSectionElement>—
onSelectCaptureReactEventHandler<HTMLTableSectionElement>—
onStalledReactEventHandler<HTMLTableSectionElement>—
onStalledCaptureReactEventHandler<HTMLTableSectionElement>—
onSubmitFormEventHandler<HTMLTableSectionElement>—
onSubmitCaptureFormEventHandler<HTMLTableSectionElement>—
onSuspendReactEventHandler<HTMLTableSectionElement>—
onSuspendCaptureReactEventHandler<HTMLTableSectionElement>—
onTimeUpdateReactEventHandler<HTMLTableSectionElement>—
onTimeUpdateCaptureReactEventHandler<HTMLTableSectionElement>—
onToggleToggleEventHandler<HTMLTableSectionElement>—
onTouchCancelTouchEventHandler<HTMLTableSectionElement>—
onTouchCancelCaptureTouchEventHandler<HTMLTableSectionElement>—
onTouchEndTouchEventHandler<HTMLTableSectionElement>—
onTouchEndCaptureTouchEventHandler<HTMLTableSectionElement>—
onTouchMoveTouchEventHandler<HTMLTableSectionElement>—
onTouchMoveCaptureTouchEventHandler<HTMLTableSectionElement>—
onTouchStartTouchEventHandler<HTMLTableSectionElement>—
onTouchStartCaptureTouchEventHandler<HTMLTableSectionElement>—
onTransitionCancelTransitionEventHandler<HTMLTableSectionElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLTableSectionElement>—
onTransitionEndTransitionEventHandler<HTMLTableSectionElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLTableSectionElement>—
onTransitionRunTransitionEventHandler<HTMLTableSectionElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLTableSectionElement>—
onTransitionStartTransitionEventHandler<HTMLTableSectionElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLTableSectionElement>—
onVolumeChangeReactEventHandler<HTMLTableSectionElement>—
onVolumeChangeCaptureReactEventHandler<HTMLTableSectionElement>—
onWaitingReactEventHandler<HTMLTableSectionElement>—
onWaitingCaptureReactEventHandler<HTMLTableSectionElement>—
onWheelWheelEventHandler<HTMLTableSectionElement>—
onWheelCaptureWheelEventHandler<HTMLTableSectionElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLTableSectionElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLTableSectionElement> | null—
relstring—
renderDOMRenderFunction<"div" | "thead", TableHeaderRenderProps>—Overrides the default DOM element with a custom render function.
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
spellCheckboolean | "true" | "false"—
styleStyleOrFunction<TableHeaderRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

<Table.Head />

295 props · 1 for styling (highlighted)
PropTypeDefaultDescription
labelstring—
tooltipstring—
›293 more props from react-aria-components, @react-types/shared, react, next(abbr, about, accessKey, align…)
PropTypeDefaultDescription
abbrstring—
aboutstring—
accessKeystring—
align"left" | "right" | "center" | "justify" | "char"—
allowsArrowNavigationboolean—Whether the column should support arrow key navigation even when the containing table uses tab
allowsSortingboolean—Whether the column allows sorting.
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReact.ReactNode | ((values: ColumnRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<ColumnRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
colorstring—
colSpannumber—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
defaultWidthColumnSize | null—The default width of the column. This prop only applies when the `<Table>` is wrapped in a
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
focusMode"cell" | "child"—Whether the column header or its first focusable child element should be focused when the
headersstring—
hiddenboolean—
idKey—The unique id of the column.
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
isRowHeaderboolean—Whether a column is a [row header](https://www.w3.org/TR/wai-aria-1.1/#rowheader) and should be
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
maxWidthColumnStaticSize | null—The maximum width of the column. This prop only applies when the `<Table>` is wrapped in a
minWidthColumnStaticSize | null—The minimum width of the column. This prop only applies when the `<Table>` is wrapped in a
noncestring—
onAbortReactEventHandler<HTMLTableCellElement>—
onAbortCaptureReactEventHandler<HTMLTableCellElement>—
onAnimationEndAnimationEventHandler<HTMLTableHeaderCellElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLTableHeaderCellElement>—
onAnimationIterationAnimationEventHandler<HTMLTableHeaderCellElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLTableHeaderCellElement>—
onAnimationStartAnimationEventHandler<HTMLTableHeaderCellElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLTableHeaderCellElement>—
onAuxClickMouseEventHandler<HTMLTableHeaderCellElement>—
onAuxClickCaptureMouseEventHandler<HTMLTableHeaderCellElement>—
onBeforeInputInputEventHandler<HTMLTableCellElement>—
onBeforeInputCaptureFormEventHandler<HTMLTableCellElement>—
onBeforeToggleToggleEventHandler<HTMLTableCellElement>—
onBlurFocusEventHandler<HTMLTableCellElement>—
onBlurCaptureFocusEventHandler<HTMLTableCellElement>—
onCanPlayReactEventHandler<HTMLTableCellElement>—
onCanPlayCaptureReactEventHandler<HTMLTableCellElement>—
onCanPlayThroughReactEventHandler<HTMLTableCellElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLTableCellElement>—
onChangeFormEventHandler<HTMLTableCellElement>—
onChangeCaptureFormEventHandler<HTMLTableCellElement>—
onClickMouseEventHandler<HTMLTableHeaderCellElement>—
onClickCaptureMouseEventHandler<HTMLTableHeaderCellElement>—
onCompositionEndCompositionEventHandler<HTMLTableCellElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLTableCellElement>—
onCompositionStartCompositionEventHandler<HTMLTableCellElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLTableCellElement>—
onCompositionUpdateCompositionEventHandler<HTMLTableCellElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLTableCellElement>—
onContextMenuMouseEventHandler<HTMLTableHeaderCellElement>—
onContextMenuCaptureMouseEventHandler<HTMLTableHeaderCellElement>—
onCopyClipboardEventHandler<HTMLTableCellElement>—
onCopyCaptureClipboardEventHandler<HTMLTableCellElement>—
onCutClipboardEventHandler<HTMLTableCellElement>—
onCutCaptureClipboardEventHandler<HTMLTableCellElement>—
onDoubleClickMouseEventHandler<HTMLTableHeaderCellElement>—
onDoubleClickCaptureMouseEventHandler<HTMLTableHeaderCellElement>—
onDragDragEventHandler<HTMLTableCellElement>—
onDragCaptureDragEventHandler<HTMLTableCellElement>—
onDragEndDragEventHandler<HTMLTableCellElement>—
onDragEndCaptureDragEventHandler<HTMLTableCellElement>—
onDragEnterDragEventHandler<HTMLTableCellElement>—
onDragEnterCaptureDragEventHandler<HTMLTableCellElement>—
onDragExitDragEventHandler<HTMLTableCellElement>—
onDragExitCaptureDragEventHandler<HTMLTableCellElement>—
onDragLeaveDragEventHandler<HTMLTableCellElement>—
onDragLeaveCaptureDragEventHandler<HTMLTableCellElement>—
onDragOverDragEventHandler<HTMLTableCellElement>—
onDragOverCaptureDragEventHandler<HTMLTableCellElement>—
onDragStartDragEventHandler<HTMLTableCellElement>—
onDragStartCaptureDragEventHandler<HTMLTableCellElement>—
onDropDragEventHandler<HTMLTableCellElement>—
onDropCaptureDragEventHandler<HTMLTableCellElement>—
onDurationChangeReactEventHandler<HTMLTableCellElement>—
onDurationChangeCaptureReactEventHandler<HTMLTableCellElement>—
onEmptiedReactEventHandler<HTMLTableCellElement>—
onEmptiedCaptureReactEventHandler<HTMLTableCellElement>—
onEncryptedReactEventHandler<HTMLTableCellElement>—
onEncryptedCaptureReactEventHandler<HTMLTableCellElement>—
onEndedReactEventHandler<HTMLTableCellElement>—
onEndedCaptureReactEventHandler<HTMLTableCellElement>—
onErrorReactEventHandler<HTMLTableCellElement>—
onErrorCaptureReactEventHandler<HTMLTableCellElement>—
onFocusFocusEventHandler<HTMLTableCellElement>—
onFocusCaptureFocusEventHandler<HTMLTableCellElement>—
onGotPointerCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onInputFormEventHandler<HTMLTableCellElement>—
onInputCaptureFormEventHandler<HTMLTableCellElement>—
onInvalidFormEventHandler<HTMLTableCellElement>—
onInvalidCaptureFormEventHandler<HTMLTableCellElement>—
onKeyDownKeyboardEventHandler<HTMLTableCellElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLTableCellElement>—
onKeyPressKeyboardEventHandler<HTMLTableCellElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLTableCellElement>—
onKeyUpKeyboardEventHandler<HTMLTableCellElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLTableCellElement>—
onLoadReactEventHandler<HTMLTableCellElement>—
onLoadCaptureReactEventHandler<HTMLTableCellElement>—
onLoadedDataReactEventHandler<HTMLTableCellElement>—
onLoadedDataCaptureReactEventHandler<HTMLTableCellElement>—
onLoadedMetadataReactEventHandler<HTMLTableCellElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLTableCellElement>—
onLoadStartReactEventHandler<HTMLTableCellElement>—
onLoadStartCaptureReactEventHandler<HTMLTableCellElement>—
onLostPointerCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onMouseDownMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseDownCaptureMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseEnterMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseLeaveMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseMoveMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseMoveCaptureMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseOutMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseOutCaptureMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseOverMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseOverCaptureMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseUpMouseEventHandler<HTMLTableHeaderCellElement>—
onMouseUpCaptureMouseEventHandler<HTMLTableHeaderCellElement>—
onPasteClipboardEventHandler<HTMLTableCellElement>—
onPasteCaptureClipboardEventHandler<HTMLTableCellElement>—
onPauseReactEventHandler<HTMLTableCellElement>—
onPauseCaptureReactEventHandler<HTMLTableCellElement>—
onPlayReactEventHandler<HTMLTableCellElement>—
onPlayCaptureReactEventHandler<HTMLTableCellElement>—
onPlayingReactEventHandler<HTMLTableCellElement>—
onPlayingCaptureReactEventHandler<HTMLTableCellElement>—
onPointerCancelPointerEventHandler<HTMLTableHeaderCellElement>—
onPointerCancelCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onPointerDownPointerEventHandler<HTMLTableHeaderCellElement>—
onPointerDownCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onPointerEnterPointerEventHandler<HTMLTableHeaderCellElement>—
onPointerLeavePointerEventHandler<HTMLTableHeaderCellElement>—
onPointerMovePointerEventHandler<HTMLTableHeaderCellElement>—
onPointerMoveCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onPointerOutPointerEventHandler<HTMLTableHeaderCellElement>—
onPointerOutCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onPointerOverPointerEventHandler<HTMLTableHeaderCellElement>—
onPointerOverCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onPointerUpPointerEventHandler<HTMLTableHeaderCellElement>—
onPointerUpCapturePointerEventHandler<HTMLTableHeaderCellElement>—
onProgressReactEventHandler<HTMLTableCellElement>—
onProgressCaptureReactEventHandler<HTMLTableCellElement>—
onRateChangeReactEventHandler<HTMLTableCellElement>—
onRateChangeCaptureReactEventHandler<HTMLTableCellElement>—
onResetFormEventHandler<HTMLTableCellElement>—
onResetCaptureFormEventHandler<HTMLTableCellElement>—
onScrollUIEventHandler<HTMLTableHeaderCellElement>—
onScrollCaptureUIEventHandler<HTMLTableHeaderCellElement>—
onSeekedReactEventHandler<HTMLTableCellElement>—
onSeekedCaptureReactEventHandler<HTMLTableCellElement>—
onSeekingReactEventHandler<HTMLTableCellElement>—
onSeekingCaptureReactEventHandler<HTMLTableCellElement>—
onSelectReactEventHandler<HTMLTableCellElement>—
onSelectCaptureReactEventHandler<HTMLTableCellElement>—
onStalledReactEventHandler<HTMLTableCellElement>—
onStalledCaptureReactEventHandler<HTMLTableCellElement>—
onSubmitFormEventHandler<HTMLTableCellElement>—
onSubmitCaptureFormEventHandler<HTMLTableCellElement>—
onSuspendReactEventHandler<HTMLTableCellElement>—
onSuspendCaptureReactEventHandler<HTMLTableCellElement>—
onTimeUpdateReactEventHandler<HTMLTableCellElement>—
onTimeUpdateCaptureReactEventHandler<HTMLTableCellElement>—
onToggleToggleEventHandler<HTMLTableCellElement>—
onTouchCancelTouchEventHandler<HTMLTableHeaderCellElement>—
onTouchCancelCaptureTouchEventHandler<HTMLTableHeaderCellElement>—
onTouchEndTouchEventHandler<HTMLTableHeaderCellElement>—
onTouchEndCaptureTouchEventHandler<HTMLTableHeaderCellElement>—
onTouchMoveTouchEventHandler<HTMLTableHeaderCellElement>—
onTouchMoveCaptureTouchEventHandler<HTMLTableHeaderCellElement>—
onTouchStartTouchEventHandler<HTMLTableHeaderCellElement>—
onTouchStartCaptureTouchEventHandler<HTMLTableHeaderCellElement>—
onTransitionCancelTransitionEventHandler<HTMLTableHeaderCellElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLTableHeaderCellElement>—
onTransitionEndTransitionEventHandler<HTMLTableHeaderCellElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLTableHeaderCellElement>—
onTransitionRunTransitionEventHandler<HTMLTableHeaderCellElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLTableHeaderCellElement>—
onTransitionStartTransitionEventHandler<HTMLTableHeaderCellElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLTableHeaderCellElement>—
onVolumeChangeReactEventHandler<HTMLTableCellElement>—
onVolumeChangeCaptureReactEventHandler<HTMLTableCellElement>—
onWaitingReactEventHandler<HTMLTableCellElement>—
onWaitingCaptureReactEventHandler<HTMLTableCellElement>—
onWheelWheelEventHandler<HTMLTableHeaderCellElement>—
onWheelCaptureWheelEventHandler<HTMLTableHeaderCellElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
relstring—
renderDOMRenderFunction<"div" | "th", ColumnRenderProps>—Overrides the default DOM element with a custom render function.
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
rowSpannumber—
scopestring—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleStyleOrFunction<ColumnRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
tabIndexnumber—
textValuestring—A string representation of the column's contents, used for accessibility announcements.
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—
widthColumnSize | null—The width of the column. This prop only applies when the `<Table>` is wrapped in a

<Table.Row />

303 props · 1 for styling (highlighted)
PropTypeDefaultDescription
highlightSelectedRowboolean—
size"sm" | "md"—
›301 more props from react-aria-components, @react-types/shared, react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReact.ReactNode | ((item: T) => ReactElement)—The cells within the row. Supports static items or a function for dynamic rendering.
classNameClassNameOrFunction<RowRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
colorstring—
columnsIterable<T>—A list of columns used when dynamically rendering cells.
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dependenciesreadonly any[]—Values that should invalidate the cell cache when using dynamic collections.
dirstring—
disabledBehavior"all" | "selection"—Whether `disabledKeys` applies to all interactions, or only selection.
downloadstring | boolean—Causes the browser to download the linked URL. A string may be provided to suggest a file name.
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hasChildItemsboolean—Whether this row has children, even if not loaded yet.
hiddenboolean—
hrefstring—A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).
hrefLangstring—Hints at the human language of the linked URL.
idKey—The unique id of the row.
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
isDisabledboolean—Whether the row is disabled.
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLTableRowElement>—
onAbortCaptureReactEventHandler<HTMLTableRowElement>—
onAction(() => void)—Handler that is called when a user performs an action on the row. The exact user event depends
onAnimationEndAnimationEventHandler<HTMLTableRowElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLTableRowElement>—
onAnimationIterationAnimationEventHandler<HTMLTableRowElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLTableRowElement>—
onAnimationStartAnimationEventHandler<HTMLTableRowElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLTableRowElement>—
onAuxClickMouseEventHandler<HTMLTableRowElement>—
onAuxClickCaptureMouseEventHandler<HTMLTableRowElement>—
onBeforeInputInputEventHandler<HTMLTableRowElement>—
onBeforeInputCaptureFormEventHandler<HTMLTableRowElement>—
onBeforeToggleToggleEventHandler<HTMLTableRowElement>—
onBlurFocusEventHandler<HTMLTableRowElement>—
onBlurCaptureFocusEventHandler<HTMLTableRowElement>—
onCanPlayReactEventHandler<HTMLTableRowElement>—
onCanPlayCaptureReactEventHandler<HTMLTableRowElement>—
onCanPlayThroughReactEventHandler<HTMLTableRowElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLTableRowElement>—
onChangeFormEventHandler<HTMLTableRowElement>—
onChangeCaptureFormEventHandler<HTMLTableRowElement>—
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLTableRowElement>—
onCompositionEndCompositionEventHandler<HTMLTableRowElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLTableRowElement>—
onCompositionStartCompositionEventHandler<HTMLTableRowElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLTableRowElement>—
onCompositionUpdateCompositionEventHandler<HTMLTableRowElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLTableRowElement>—
onContextMenuMouseEventHandler<HTMLTableRowElement>—
onContextMenuCaptureMouseEventHandler<HTMLTableRowElement>—
onCopyClipboardEventHandler<HTMLTableRowElement>—
onCopyCaptureClipboardEventHandler<HTMLTableRowElement>—
onCutClipboardEventHandler<HTMLTableRowElement>—
onCutCaptureClipboardEventHandler<HTMLTableRowElement>—
onDoubleClickMouseEventHandler<HTMLTableRowElement>—
onDoubleClickCaptureMouseEventHandler<HTMLTableRowElement>—
onDragDragEventHandler<HTMLTableRowElement>—
onDragCaptureDragEventHandler<HTMLTableRowElement>—
onDragEndDragEventHandler<HTMLTableRowElement>—
onDragEndCaptureDragEventHandler<HTMLTableRowElement>—
onDragEnterDragEventHandler<HTMLTableRowElement>—
onDragEnterCaptureDragEventHandler<HTMLTableRowElement>—
onDragExitDragEventHandler<HTMLTableRowElement>—
onDragExitCaptureDragEventHandler<HTMLTableRowElement>—
onDragLeaveDragEventHandler<HTMLTableRowElement>—
onDragLeaveCaptureDragEventHandler<HTMLTableRowElement>—
onDragOverDragEventHandler<HTMLTableRowElement>—
onDragOverCaptureDragEventHandler<HTMLTableRowElement>—
onDragStartDragEventHandler<HTMLTableRowElement>—
onDragStartCaptureDragEventHandler<HTMLTableRowElement>—
onDropDragEventHandler<HTMLTableRowElement>—
onDropCaptureDragEventHandler<HTMLTableRowElement>—
onDurationChangeReactEventHandler<HTMLTableRowElement>—
onDurationChangeCaptureReactEventHandler<HTMLTableRowElement>—
onEmptiedReactEventHandler<HTMLTableRowElement>—
onEmptiedCaptureReactEventHandler<HTMLTableRowElement>—
onEncryptedReactEventHandler<HTMLTableRowElement>—
onEncryptedCaptureReactEventHandler<HTMLTableRowElement>—
onEndedReactEventHandler<HTMLTableRowElement>—
onEndedCaptureReactEventHandler<HTMLTableRowElement>—
onErrorReactEventHandler<HTMLTableRowElement>—
onErrorCaptureReactEventHandler<HTMLTableRowElement>—
onFocusFocusEventHandler<HTMLTableRowElement>—
onFocusCaptureFocusEventHandler<HTMLTableRowElement>—
onGotPointerCapturePointerEventHandler<HTMLTableRowElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLTableRowElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onInputFormEventHandler<HTMLTableRowElement>—
onInputCaptureFormEventHandler<HTMLTableRowElement>—
onInvalidFormEventHandler<HTMLTableRowElement>—
onInvalidCaptureFormEventHandler<HTMLTableRowElement>—
onKeyDownKeyboardEventHandler<HTMLTableRowElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLTableRowElement>—
onKeyPressKeyboardEventHandler<HTMLTableRowElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLTableRowElement>—
onKeyUpKeyboardEventHandler<HTMLTableRowElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLTableRowElement>—
onLoadReactEventHandler<HTMLTableRowElement>—
onLoadCaptureReactEventHandler<HTMLTableRowElement>—
onLoadedDataReactEventHandler<HTMLTableRowElement>—
onLoadedDataCaptureReactEventHandler<HTMLTableRowElement>—
onLoadedMetadataReactEventHandler<HTMLTableRowElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLTableRowElement>—
onLoadStartReactEventHandler<HTMLTableRowElement>—
onLoadStartCaptureReactEventHandler<HTMLTableRowElement>—
onLostPointerCapturePointerEventHandler<HTMLTableRowElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLTableRowElement>—
onMouseDownMouseEventHandler<HTMLTableRowElement>—
onMouseDownCaptureMouseEventHandler<HTMLTableRowElement>—
onMouseEnterMouseEventHandler<HTMLTableRowElement>—
onMouseLeaveMouseEventHandler<HTMLTableRowElement>—
onMouseMoveMouseEventHandler<HTMLTableRowElement>—
onMouseMoveCaptureMouseEventHandler<HTMLTableRowElement>—
onMouseOutMouseEventHandler<HTMLTableRowElement>—
onMouseOutCaptureMouseEventHandler<HTMLTableRowElement>—
onMouseOverMouseEventHandler<HTMLTableRowElement>—
onMouseOverCaptureMouseEventHandler<HTMLTableRowElement>—
onMouseUpMouseEventHandler<HTMLTableRowElement>—
onMouseUpCaptureMouseEventHandler<HTMLTableRowElement>—
onPasteClipboardEventHandler<HTMLTableRowElement>—
onPasteCaptureClipboardEventHandler<HTMLTableRowElement>—
onPauseReactEventHandler<HTMLTableRowElement>—
onPauseCaptureReactEventHandler<HTMLTableRowElement>—
onPlayReactEventHandler<HTMLTableRowElement>—
onPlayCaptureReactEventHandler<HTMLTableRowElement>—
onPlayingReactEventHandler<HTMLTableRowElement>—
onPlayingCaptureReactEventHandler<HTMLTableRowElement>—
onPointerCancelPointerEventHandler<HTMLTableRowElement>—
onPointerCancelCapturePointerEventHandler<HTMLTableRowElement>—
onPointerDownPointerEventHandler<HTMLTableRowElement>—
onPointerDownCapturePointerEventHandler<HTMLTableRowElement>—
onPointerEnterPointerEventHandler<HTMLTableRowElement>—
onPointerLeavePointerEventHandler<HTMLTableRowElement>—
onPointerMovePointerEventHandler<HTMLTableRowElement>—
onPointerMoveCapturePointerEventHandler<HTMLTableRowElement>—
onPointerOutPointerEventHandler<HTMLTableRowElement>—
onPointerOutCapturePointerEventHandler<HTMLTableRowElement>—
onPointerOverPointerEventHandler<HTMLTableRowElement>—
onPointerOverCapturePointerEventHandler<HTMLTableRowElement>—
onPointerUpPointerEventHandler<HTMLTableRowElement>—
onPointerUpCapturePointerEventHandler<HTMLTableRowElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onProgressReactEventHandler<HTMLTableRowElement>—
onProgressCaptureReactEventHandler<HTMLTableRowElement>—
onRateChangeReactEventHandler<HTMLTableRowElement>—
onRateChangeCaptureReactEventHandler<HTMLTableRowElement>—
onResetFormEventHandler<HTMLTableRowElement>—
onResetCaptureFormEventHandler<HTMLTableRowElement>—
onScrollUIEventHandler<HTMLTableRowElement>—
onScrollCaptureUIEventHandler<HTMLTableRowElement>—
onSeekedReactEventHandler<HTMLTableRowElement>—
onSeekedCaptureReactEventHandler<HTMLTableRowElement>—
onSeekingReactEventHandler<HTMLTableRowElement>—
onSeekingCaptureReactEventHandler<HTMLTableRowElement>—
onSelectReactEventHandler<HTMLTableRowElement>—
onSelectCaptureReactEventHandler<HTMLTableRowElement>—
onStalledReactEventHandler<HTMLTableRowElement>—
onStalledCaptureReactEventHandler<HTMLTableRowElement>—
onSubmitFormEventHandler<HTMLTableRowElement>—
onSubmitCaptureFormEventHandler<HTMLTableRowElement>—
onSuspendReactEventHandler<HTMLTableRowElement>—
onSuspendCaptureReactEventHandler<HTMLTableRowElement>—
onTimeUpdateReactEventHandler<HTMLTableRowElement>—
onTimeUpdateCaptureReactEventHandler<HTMLTableRowElement>—
onToggleToggleEventHandler<HTMLTableRowElement>—
onTouchCancelTouchEventHandler<HTMLTableRowElement>—
onTouchCancelCaptureTouchEventHandler<HTMLTableRowElement>—
onTouchEndTouchEventHandler<HTMLTableRowElement>—
onTouchEndCaptureTouchEventHandler<HTMLTableRowElement>—
onTouchMoveTouchEventHandler<HTMLTableRowElement>—
onTouchMoveCaptureTouchEventHandler<HTMLTableRowElement>—
onTouchStartTouchEventHandler<HTMLTableRowElement>—
onTouchStartCaptureTouchEventHandler<HTMLTableRowElement>—
onTransitionCancelTransitionEventHandler<HTMLTableRowElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLTableRowElement>—
onTransitionEndTransitionEventHandler<HTMLTableRowElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLTableRowElement>—
onTransitionRunTransitionEventHandler<HTMLTableRowElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLTableRowElement>—
onTransitionStartTransitionEventHandler<HTMLTableRowElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLTableRowElement>—
onVolumeChangeReactEventHandler<HTMLTableRowElement>—
onVolumeChangeCaptureReactEventHandler<HTMLTableRowElement>—
onWaitingReactEventHandler<HTMLTableRowElement>—
onWaitingCaptureReactEventHandler<HTMLTableRowElement>—
onWheelWheelEventHandler<HTMLTableRowElement>—
onWheelCaptureWheelEventHandler<HTMLTableRowElement>—
partstring—
pingstring—A space-separated list of URLs to ping when the link is followed. See
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLTableRowElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLTableRowElement> | null—
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—How much of the referrer to send when following the link. See
relstring—The relationship between the linked resource and the current page. See
renderDOMRenderFunction<"div" | "tr", RowRenderProps>—Overrides the default DOM element with a custom render function.
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
routerOptionsundefined—Options for the configured client side router.
securitystring—
spellCheckboolean | "true" | "false"—
styleStyleOrFunction<RowRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
tabIndexnumber—
targetHTMLAttributeAnchorTarget—The target window for the link. See
textValuestring—A string representation of the row's contents, used for features like typeahead.
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
valueobject—The object value that this row represents. When using dynamic collections, this is set
vocabstring—

<Table.Cell />

292 props · 1 for styling (highlighted)
PropTypeDefaultDescription
refRef<HTMLTableCellElement>—
size"sm" | "md"—
›290 more props from react-aria-components, @react-types/shared, react, next(abbr, about, accessKey, align…)
PropTypeDefaultDescription
abbrstring—
aboutstring—
accessKeystring—
align"left" | "right" | "center" | "justify" | "char"—
allowsArrowNavigationboolean—Whether the cell should support arrow key navigation even when the containing table uses
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReact.ReactNode | ((values: CellRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode)—The children of the component. A function may be provided to alter the children based on
classNameClassNameOrFunction<CellRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
colorstring—
colSpannumber—Indicates how many columns the data cell spans.
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
focusMode"cell" | "child"—Whether the cell or its first focusable child element should be focused when the cell is
headersstring—
heightstring | number—
hiddenboolean—
idKey—The unique id of the cell.
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLTableCellElement>—
onAbortCaptureReactEventHandler<HTMLTableCellElement>—
onAnimationEndAnimationEventHandler<HTMLTableCellElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLTableCellElement>—
onAnimationIterationAnimationEventHandler<HTMLTableCellElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLTableCellElement>—
onAnimationStartAnimationEventHandler<HTMLTableCellElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLTableCellElement>—
onAuxClickMouseEventHandler<HTMLTableCellElement>—
onAuxClickCaptureMouseEventHandler<HTMLTableCellElement>—
onBeforeInputInputEventHandler<HTMLTableCellElement>—
onBeforeInputCaptureFormEventHandler<HTMLTableCellElement>—
onBeforeToggleToggleEventHandler<HTMLTableCellElement>—
onBlurFocusEventHandler<HTMLTableCellElement>—
onBlurCaptureFocusEventHandler<HTMLTableCellElement>—
onCanPlayReactEventHandler<HTMLTableCellElement>—
onCanPlayCaptureReactEventHandler<HTMLTableCellElement>—
onCanPlayThroughReactEventHandler<HTMLTableCellElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLTableCellElement>—
onChangeFormEventHandler<HTMLTableCellElement>—
onChangeCaptureFormEventHandler<HTMLTableCellElement>—
onClickMouseEventHandler<HTMLTableCellElement>—
onClickCaptureMouseEventHandler<HTMLTableCellElement>—
onCompositionEndCompositionEventHandler<HTMLTableCellElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLTableCellElement>—
onCompositionStartCompositionEventHandler<HTMLTableCellElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLTableCellElement>—
onCompositionUpdateCompositionEventHandler<HTMLTableCellElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLTableCellElement>—
onContextMenuMouseEventHandler<HTMLTableCellElement>—
onContextMenuCaptureMouseEventHandler<HTMLTableCellElement>—
onCopyClipboardEventHandler<HTMLTableCellElement>—
onCopyCaptureClipboardEventHandler<HTMLTableCellElement>—
onCutClipboardEventHandler<HTMLTableCellElement>—
onCutCaptureClipboardEventHandler<HTMLTableCellElement>—
onDoubleClickMouseEventHandler<HTMLTableCellElement>—
onDoubleClickCaptureMouseEventHandler<HTMLTableCellElement>—
onDragDragEventHandler<HTMLTableCellElement>—
onDragCaptureDragEventHandler<HTMLTableCellElement>—
onDragEndDragEventHandler<HTMLTableCellElement>—
onDragEndCaptureDragEventHandler<HTMLTableCellElement>—
onDragEnterDragEventHandler<HTMLTableCellElement>—
onDragEnterCaptureDragEventHandler<HTMLTableCellElement>—
onDragExitDragEventHandler<HTMLTableCellElement>—
onDragExitCaptureDragEventHandler<HTMLTableCellElement>—
onDragLeaveDragEventHandler<HTMLTableCellElement>—
onDragLeaveCaptureDragEventHandler<HTMLTableCellElement>—
onDragOverDragEventHandler<HTMLTableCellElement>—
onDragOverCaptureDragEventHandler<HTMLTableCellElement>—
onDragStartDragEventHandler<HTMLTableCellElement>—
onDragStartCaptureDragEventHandler<HTMLTableCellElement>—
onDropDragEventHandler<HTMLTableCellElement>—
onDropCaptureDragEventHandler<HTMLTableCellElement>—
onDurationChangeReactEventHandler<HTMLTableCellElement>—
onDurationChangeCaptureReactEventHandler<HTMLTableCellElement>—
onEmptiedReactEventHandler<HTMLTableCellElement>—
onEmptiedCaptureReactEventHandler<HTMLTableCellElement>—
onEncryptedReactEventHandler<HTMLTableCellElement>—
onEncryptedCaptureReactEventHandler<HTMLTableCellElement>—
onEndedReactEventHandler<HTMLTableCellElement>—
onEndedCaptureReactEventHandler<HTMLTableCellElement>—
onErrorReactEventHandler<HTMLTableCellElement>—
onErrorCaptureReactEventHandler<HTMLTableCellElement>—
onFocusFocusEventHandler<HTMLTableCellElement>—
onFocusCaptureFocusEventHandler<HTMLTableCellElement>—
onGotPointerCapturePointerEventHandler<HTMLTableCellElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLTableCellElement>—
onInputFormEventHandler<HTMLTableCellElement>—
onInputCaptureFormEventHandler<HTMLTableCellElement>—
onInvalidFormEventHandler<HTMLTableCellElement>—
onInvalidCaptureFormEventHandler<HTMLTableCellElement>—
onKeyDownKeyboardEventHandler<HTMLTableCellElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLTableCellElement>—
onKeyPressKeyboardEventHandler<HTMLTableCellElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLTableCellElement>—
onKeyUpKeyboardEventHandler<HTMLTableCellElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLTableCellElement>—
onLoadReactEventHandler<HTMLTableCellElement>—
onLoadCaptureReactEventHandler<HTMLTableCellElement>—
onLoadedDataReactEventHandler<HTMLTableCellElement>—
onLoadedDataCaptureReactEventHandler<HTMLTableCellElement>—
onLoadedMetadataReactEventHandler<HTMLTableCellElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLTableCellElement>—
onLoadStartReactEventHandler<HTMLTableCellElement>—
onLoadStartCaptureReactEventHandler<HTMLTableCellElement>—
onLostPointerCapturePointerEventHandler<HTMLTableCellElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLTableCellElement>—
onMouseDownMouseEventHandler<HTMLTableCellElement>—
onMouseDownCaptureMouseEventHandler<HTMLTableCellElement>—
onMouseEnterMouseEventHandler<HTMLTableCellElement>—
onMouseLeaveMouseEventHandler<HTMLTableCellElement>—
onMouseMoveMouseEventHandler<HTMLTableCellElement>—
onMouseMoveCaptureMouseEventHandler<HTMLTableCellElement>—
onMouseOutMouseEventHandler<HTMLTableCellElement>—
onMouseOutCaptureMouseEventHandler<HTMLTableCellElement>—
onMouseOverMouseEventHandler<HTMLTableCellElement>—
onMouseOverCaptureMouseEventHandler<HTMLTableCellElement>—
onMouseUpMouseEventHandler<HTMLTableCellElement>—
onMouseUpCaptureMouseEventHandler<HTMLTableCellElement>—
onPasteClipboardEventHandler<HTMLTableCellElement>—
onPasteCaptureClipboardEventHandler<HTMLTableCellElement>—
onPauseReactEventHandler<HTMLTableCellElement>—
onPauseCaptureReactEventHandler<HTMLTableCellElement>—
onPlayReactEventHandler<HTMLTableCellElement>—
onPlayCaptureReactEventHandler<HTMLTableCellElement>—
onPlayingReactEventHandler<HTMLTableCellElement>—
onPlayingCaptureReactEventHandler<HTMLTableCellElement>—
onPointerCancelPointerEventHandler<HTMLTableCellElement>—
onPointerCancelCapturePointerEventHandler<HTMLTableCellElement>—
onPointerDownPointerEventHandler<HTMLTableCellElement>—
onPointerDownCapturePointerEventHandler<HTMLTableCellElement>—
onPointerEnterPointerEventHandler<HTMLTableCellElement>—
onPointerLeavePointerEventHandler<HTMLTableCellElement>—
onPointerMovePointerEventHandler<HTMLTableCellElement>—
onPointerMoveCapturePointerEventHandler<HTMLTableCellElement>—
onPointerOutPointerEventHandler<HTMLTableCellElement>—
onPointerOutCapturePointerEventHandler<HTMLTableCellElement>—
onPointerOverPointerEventHandler<HTMLTableCellElement>—
onPointerOverCapturePointerEventHandler<HTMLTableCellElement>—
onPointerUpPointerEventHandler<HTMLTableCellElement>—
onPointerUpCapturePointerEventHandler<HTMLTableCellElement>—
onProgressReactEventHandler<HTMLTableCellElement>—
onProgressCaptureReactEventHandler<HTMLTableCellElement>—
onRateChangeReactEventHandler<HTMLTableCellElement>—
onRateChangeCaptureReactEventHandler<HTMLTableCellElement>—
onResetFormEventHandler<HTMLTableCellElement>—
onResetCaptureFormEventHandler<HTMLTableCellElement>—
onScrollUIEventHandler<HTMLTableCellElement>—
onScrollCaptureUIEventHandler<HTMLTableCellElement>—
onSeekedReactEventHandler<HTMLTableCellElement>—
onSeekedCaptureReactEventHandler<HTMLTableCellElement>—
onSeekingReactEventHandler<HTMLTableCellElement>—
onSeekingCaptureReactEventHandler<HTMLTableCellElement>—
onSelectReactEventHandler<HTMLTableCellElement>—
onSelectCaptureReactEventHandler<HTMLTableCellElement>—
onStalledReactEventHandler<HTMLTableCellElement>—
onStalledCaptureReactEventHandler<HTMLTableCellElement>—
onSubmitFormEventHandler<HTMLTableCellElement>—
onSubmitCaptureFormEventHandler<HTMLTableCellElement>—
onSuspendReactEventHandler<HTMLTableCellElement>—
onSuspendCaptureReactEventHandler<HTMLTableCellElement>—
onTimeUpdateReactEventHandler<HTMLTableCellElement>—
onTimeUpdateCaptureReactEventHandler<HTMLTableCellElement>—
onToggleToggleEventHandler<HTMLTableCellElement>—
onTouchCancelTouchEventHandler<HTMLTableCellElement>—
onTouchCancelCaptureTouchEventHandler<HTMLTableCellElement>—
onTouchEndTouchEventHandler<HTMLTableCellElement>—
onTouchEndCaptureTouchEventHandler<HTMLTableCellElement>—
onTouchMoveTouchEventHandler<HTMLTableCellElement>—
onTouchMoveCaptureTouchEventHandler<HTMLTableCellElement>—
onTouchStartTouchEventHandler<HTMLTableCellElement>—
onTouchStartCaptureTouchEventHandler<HTMLTableCellElement>—
onTransitionCancelTransitionEventHandler<HTMLTableCellElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLTableCellElement>—
onTransitionEndTransitionEventHandler<HTMLTableCellElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLTableCellElement>—
onTransitionRunTransitionEventHandler<HTMLTableCellElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLTableCellElement>—
onTransitionStartTransitionEventHandler<HTMLTableCellElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLTableCellElement>—
onVolumeChangeReactEventHandler<HTMLTableCellElement>—
onVolumeChangeCaptureReactEventHandler<HTMLTableCellElement>—
onWaitingReactEventHandler<HTMLTableCellElement>—
onWaitingCaptureReactEventHandler<HTMLTableCellElement>—
onWheelWheelEventHandler<HTMLTableCellElement>—
onWheelCaptureWheelEventHandler<HTMLTableCellElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
relstring—
renderDOMRenderFunction<"div" | "td", CellRenderProps>—Overrides the default DOM element with a custom render function.
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
rowSpannumber—
scopestring—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleStyleOrFunction<CellRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
tabIndexnumber—
textValuestring—A string representation of the cell's contents, used for features like typeahead.
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
valign"bottom" | "top" | "middle" | "baseline"—
vocabstring—
widthstring | number—

<TableCard.Root />

278 props · 1 for styling (highlighted)
PropTypeDefaultDescription
size"sm" | "md""md"
›277 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

<TableCard.Header />

5 props · 1 for styling (highlighted)
PropTypeDefaultDescription
title*string—The title of the table card header.
badgeReactNode—The badge displayed next to the title.
contentTrailingReactNode—The content displayed after the title and badge.
descriptionstring—The description of the table card header.
classNamestring—The class name of the table card header.

Progress steps

Show where someone is in a multi-step flow (sign-up, profile setup, applications). Same set as Untitled UI's progress steps.

Source: src/components/application/progress-steps/progress-steps.tsx

Icon centered

Your details

Name and email

Company details

Website and location

Invite your team

Start collaborating

Add your socials

Automatic sharing

Your details

Name and email

Company details

Website and location

Invite your team

Start collaborating

Add your socials

Automatic sharing

Icon centered with number

Your details

Name and email

2

Company details

Website and location

3

Invite your team

Start collaborating

4

Add your socials

Automatic sharing

Your details

Name and email

2

Company details

Website and location

3

Invite your team

Start collaborating

4

Add your socials

Automatic sharing

Featured icon centered

Your details

Name and email

Company details

Website and location

Invite your team

Start collaborating

Add your socials

Automatic sharing

Your details

Name and email

Company details

Website and location

Invite your team

Start collaborating

Add your socials

Automatic sharing

Icon with text

Your details

Please provide your name and email

Company details

A few details about your company

Invite your team

Start collaborating with your team

Add your socials

Share posts to your social accounts

Icon with number

Your details

Please provide your name and email

2

Company details

A few details about your company

3

Invite your team

Start collaborating with your team

4

Add your socials

Share posts to your social accounts

Featured icon with text

Your details

Please provide your name and email

Company details

A few details about your company

Invite your team

Start collaborating with your team

Add your socials

Share posts to your social accounts

Minimal icons

Step 1 of 4

Minimal icons connected

Text with line

Your details

Name and email

Company details

Website and location

Invite your team

Start collaborating

Add your socials

Automatic sharing

Your details

Name and email

Company details

Website and location

Invite your team

Start collaborating

Add your socials

Automatic sharing

Custom colors

Your details

Name and email

Company details

Website and location

Invite your team

Start collaborating

Add your socials

Automatic sharing

Your details

Name and email

Company details

Website and location

Invite your team

Start collaborating

Add your socials

Automatic sharing

Step 1 of 4

Your details

Name and email

Company details

Website and location

Invite your team

Start collaborating

Add your socials

Automatic sharing

Props

<Progress.IconsWithText />

7 props · 1 for styling (highlighted)
PropTypeDefaultDescription
items*ItemsType[]—The steps to render, in the order they are shown, each carrying its own status.
accentColorstring—Any CSS color for the brand-colored parts (markers, lines, current text), e.g. "#095E15".
connectorbooleantrueWhether the lines linking the steps are drawn at all.
orientation"horizontal" | "vertical""vertical"Whether the steps run across in a row or stack into a single column.
size"sm" | "md""sm"Scale of the step markers and their text.
type"number" | "icon" | "featured-icon""icon"Marker style used for every step: a dot-and-tick circle, a numbered circle, or a featured icon.
classNamestring—Additional CSS classes to apply to the wrapper.

<Progress.MinimalIcons />

6 props · 1 for styling (highlighted)
PropTypeDefaultDescription
items*ItemsType[]—The steps to render, in the order they are shown, each carrying its own status.
accentColorstring—Any CSS color for the brand-colored parts (markers, lines, current text), e.g. "#095E15".
orientation"horizontal" | "vertical""horizontal"Whether the markers run across in a row or stack into a single column.
size"sm" | "md""sm"Scale of the step markers and their text.
textbooleanfalsePrefix the markers with a "Step x of y" counter, where x is the number of complete items.
classNamestring—Additional CSS classes to apply to the wrapper.

<Progress.MinimalIconsConnected />

5 props · 1 for styling (highlighted)
PropTypeDefaultDescription
items*ItemsType[]—The steps to render, in the order they are shown, each carrying its own status.
accentColorstring—Any CSS color for the brand-colored parts (markers, lines, current text), e.g. "#095E15".
orientation"horizontal" | "vertical""horizontal"Whether the markers run across in a row or stack into a single column.
size"sm" | "md""sm"Scale of the step markers and their text.
classNamestring—Additional CSS classes to apply to the wrapper.

<Progress.TextWithLine />

5 props · 1 for styling (highlighted)
PropTypeDefaultDescription
items*ItemsType[]—The steps to render, in the order they are shown, each carrying its own status.
accentColorstring—Any CSS color for the brand-colored parts (markers, lines, current text), e.g. "#095E15".
orientation"horizontal" | "vertical""horizontal"Whether the steps run across in a row or stack into a single column.
size"sm" | "md""sm"Scale of the step markers and their text.
classNamestring—Additional CSS classes to apply to the wrapper.

<IconTop />

7 props
PropTypeDefaultDescription
description*string—Supporting line rendered directly beneath the title.
title*string—Bold label naming the step.
connectorboolean—Whether the line running from this step towards the next one is drawn.
iconIconType—Icon drawn inside the marker; required by the "featured-icon" type.
size"sm" | "md"—Scale of the step marker and its text.
status"incomplete" | "current" | "complete"—Where the step sits in the flow.
type"number" | "icon" | "featured-icon"—Marker style; read by Progress.IconsWithText to pick the step variant.

<IconLeft />

7 props
PropTypeDefaultDescription
description*string—Supporting line rendered directly beneath the title.
title*string—Bold label naming the step.
connectorboolean—Whether the line running from this step towards the next one is drawn.
iconIconType—Icon drawn inside the marker; required by the "featured-icon" type.
size"sm" | "md"—Scale of the step marker and its text.
status"incomplete" | "current" | "complete"—Where the step sits in the flow.
type"number" | "icon" | "featured-icon"—Marker style; read by Progress.IconsWithText to pick the step variant.

<IconOnly />

2 props
PropTypeDefaultDescription
size"sm" | "md""sm"
status"incomplete" | "current" | "complete""incomplete"

<TextLine />

8 props
PropTypeDefaultDescription
description*string—Supporting line rendered directly beneath the title.
title*string—Bold label naming the step.
connectorboolean—Whether the line running from this step towards the next one is drawn.
iconIconType—Icon drawn inside the marker; required by the "featured-icon" type.
orientation"horizontal" | "vertical""horizontal"
size"sm" | "md""sm"Scale of the step marker and its text.
status"incomplete" | "current" | "complete""incomplete"Where the step sits in the flow.
type"number" | "icon" | "featured-icon"—Marker style; read by Progress.IconsWithText to pick the step variant.

Paginations

Page controls for lists and tables.

Source: src/components/application/pagination/pagination.tsx

Page default

Page minimal center

Card default

Card minimal right aligned

Card minimal center aligned

Card minimal left aligned

Button group right aligned

Button group center aligned

Button group left aligned

Card advanced

Card advanced center

Pagination dot

Pagination line

Custom colors

Props

<Pagination.Root />

7 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The pagination parts to render, such as `Pagination.PrevTrigger`, `Pagination.Context` and `Pagination.NextTrigger`.
page*number—Current active page number
total*number—Total number of pages
onPageChange((page: number) => void)—Callback function that's called when the page changes with the new page number.
siblingCountnumber1Number of sibling pages to show on each side of the current page
styleCSSProperties—The style of the pagination root.
classNamestring—The class name of the pagination root.

<Pagination.PrevTrigger />

5 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode | ((props: TriggerRenderProps) => ReactNode)—The children of the trigger. Can be a render prop or a valid element.
ariaLabelstring—The aria label of the trigger.
asChildboolean—If true, the child element will be cloned and passed down the prop of the trigger.
styleCSSProperties—The style of the trigger.
classNamestring | ((args: { isDisabled: boolean; }) => string)—The class name of the trigger.

<Pagination.NextTrigger />

5 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode | ((props: TriggerRenderProps) => ReactNode)—The children of the trigger. Can be a render prop or a valid element.
ariaLabelstring—The aria label of the trigger.
asChildboolean—If true, the child element will be cloned and passed down the prop of the trigger.
styleCSSProperties—The style of the trigger.
classNamestring | ((args: { isDisabled: boolean; }) => string)—The class name of the trigger.

<Pagination.Item />

7 props · 1 for styling (highlighted)
PropTypeDefaultDescription
isCurrent*boolean—Whether the pagination item is the current page.
value*number—The value of the pagination item.
ariaLabelstring—The aria label of the pagination item.
asChildbooleanfalseIf true, the child element will be cloned and passed down the prop of the item.
childrenReactNode | ((props: PaginationItemRenderProps) => ReactNode)—The children of the pagination item. Can be a render prop or a valid element.
styleCSSProperties—The style object of the pagination item.
classNamestring | ((args: { isSelected: boolean; }) => string)—The class name of the pagination item.

<Pagination.Ellipsis />

3 props · 1 for styling (highlighted)
PropTypeDefaultDescription
childrenReactNode—The content rendered in place of the skipped pages, such as an ellipsis character. Hidden from assistive technology.
styleCSSProperties—The style of the ellipsis.
classNamestring | (() => string)—The class name of the ellipsis. Can be a function returning the class name.

<Pagination.Context />

1 props
PropTypeDefaultDescription
children*(pagination: PaginationContextType) => ReactNode—A render prop called with the pagination state (pages, current page, total and the page change handler).

<PaginationPageDefault />

8 props · 2 for styling (highlighted)
PropTypeDefaultDescription
onPageChange((page: number) => void)—Callback function that's called when the page changes with the new page number.
pagenumber1Current active page number
roundedboolean—Whether the pagination buttons are rounded.
siblingCountnumber—Number of sibling pages to show on each side of the current page
styleCSSProperties—The style of the pagination root.
totalnumber10Total number of pages
classNamestring—The class name of the pagination root.
selectedClassNamestring—Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white".

<PaginationPageMinimalCenter />

8 props · 2 for styling (highlighted)
PropTypeDefaultDescription
onPageChange((page: number) => void)—Callback function that's called when the page changes with the new page number.
pagenumber1Current active page number
roundedboolean—Whether the pagination buttons are rounded.
siblingCountnumber—Number of sibling pages to show on each side of the current page
styleCSSProperties—The style of the pagination root.
totalnumber10Total number of pages
classNamestring—The class name of the pagination root.
selectedClassNamestring—Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white".

<PaginationCardDefault />

8 props · 2 for styling (highlighted)
PropTypeDefaultDescription
onPageChange((page: number) => void)—Callback function that's called when the page changes with the new page number.
pagenumber1Current active page number
roundedboolean—Whether the pagination buttons are rounded.
siblingCountnumber—Number of sibling pages to show on each side of the current page
styleCSSProperties—The style of the pagination root.
totalnumber10Total number of pages
classNamestring—The class name of the pagination root.
selectedClassNamestring—Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white".

<PaginationCardMinimal />

7 props · 1 for styling (highlighted)
PropTypeDefaultDescription
align"left" | "right" | "center""left"The alignment of the pagination.
onPageChange((page: number) => void)—The function to call when the page changes.
onPageSizeChange((pageSize: number) => void)—The function to call when the page size changes.
pagenumber1The current page.
pageSizenumber10The number of items per page.
totalnumber10The total number of pages.
classNamestring—The class name of the pagination component.

<PaginationButtonGroup />

8 props · 2 for styling (highlighted)
PropTypeDefaultDescription
align"left" | "right" | "center""left"The alignment of the pagination.
onPageChange((page: number) => void)—Callback function that's called when the page changes with the new page number.
pagenumber1Current active page number
siblingCountnumber—Number of sibling pages to show on each side of the current page
styleCSSProperties—The style of the pagination root.
totalnumber10Total number of pages
classNamestring—The class name of the pagination root.
selectedClassNamestring—Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white".

<PaginationCardAdvanced />

8 props · 2 for styling (highlighted)
PropTypeDefaultDescription
align"center" | "space-between""space-between"The alignment of the pagination.
onPageChange((page: number) => void)—The function to call when the page changes.
onPageSizeChange((pageSize: number) => void)—The function to call when the page size changes.
pagenumber1The current page.
pageSizenumber10The number of items per page.
totalnumber10The total number of pages.
classNamestring—The class name of the pagination component.
selectedClassNamestring—Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white".

<PaginationDot />

9 props · 1 for styling (highlighted)
PropTypeDefaultDescription
page*number—Current active page number
total*number—Total number of pages
framedboolean—Whether the pagination is displayed in a card.
isBrandboolean—Whether the pagination uses brand colors.
onPageChange((page: number) => void)—Callback function that's called when the page changes with the new page number.
siblingCountnumber—Number of sibling pages to show on each side of the current page
size"md" | "lg""md"The size of the pagination dot.
styleCSSProperties—The style of the pagination root.
classNamestring—The class name of the pagination root.

<PaginationLine />

8 props · 1 for styling (highlighted)
PropTypeDefaultDescription
page*number—Current active page number
total*number—Total number of pages
framedboolean—Whether the pagination is displayed in a card.
onPageChange((page: number) => void)—Callback function that's called when the page changes with the new page number.
siblingCountnumber—Number of sibling pages to show on each side of the current page
size"md" | "lg""md"The size of the pagination line.
styleCSSProperties—The style of the pagination root.
classNamestring—The class name of the pagination root.

Activity gauges

Concentric rings for comparing a few progress values at once.

Source: src/components/application/charts/activity-gauge.tsx

Sizes

size="xs"
size="sm"
size="md"
size="lg"

Custom colors

Props

<ActivityGauge />

8 props · 2 for styling (highlighted)
PropTypeDefaultDescription
data*ActivityGaugeItem[]—Rings from the inside out. Each ring's color comes from its className.
legendbooleantrueShow the legend under the gauge.
maxnumber1000Value of a full ring.
size"xs" | "sm" | "md" | "lg""sm"
subtitlestring—Small text above the title, e.g. "Active users".
titlestring—Big number in the middle, e.g. "1,000".
classNamestring—
trackClassNamestring"fill-utility-neutral-100"Track color behind each ring, as a fill-* class.

Line & bar charts

Untitled UI's line and bar charts (Recharts). Each example has a colors map at the top for custom colors.

Source: src/components/application/charts/charts-base.tsx

PropValues
colors{ A: "text-[#095E15]", … } at the top of each example — any text-* class
Area / Bar / Line classNamethe series' text-* class; stroke / fill = "currentColor" follow it
activeDot / cursor classNameadd the series' text-* class so they match it
Legend content<ChartLegendContent /> (dots take each series' color)
Tooltip content<ChartTooltipContent /> · formatter / labelFormatter
Bar stackId / radiussame stackId = stacked · [6, 6, 0, 0] rounds the top

Line chart 01 · gradient area

Line chart 02 · dotted lines

Line chart 03 · striped fill

Line chart 04 · highlight vs neutral

Bar chart 01 · stacked

Bar chart 02 · bars + trend line

Bar chart 03 · thin bars + trend line

Empty states

What to show when a list or search has no results.

Source: src/components/application/empty-state/empty-state.tsx

No results

No jobs found

Try a different keyword or remove some filters.

Sizes

No jobs found · size="sm"

Try a different keyword or remove some filters.

No jobs found · size="md"

Try a different keyword or remove some filters.

No jobs found · size="lg"

Try a different keyword or remove some filters.

Background patterns

pattern="circle"

No saved jobs yet.

pattern="grid"

No saved jobs yet.

pattern="grid-check"

No saved jobs yet.

pattern="square"

No saved jobs yet.

pattern="none"

No saved jobs yet.

Icons, colors, illustrations, file icons

No resume uploaded

Upload a PDF so recruiters can find you.

You're all caught up

No new notifications right now.

Couldn't load applications

Check your connection and try again.

Profile incomplete

Add your skills to see matching jobs.

Illustration type="cloud"

Nothing here yet.

Illustration type="box"

Nothing here yet.

Illustration type="documents"

Nothing here yet.

Illustration type="credit-card"

Nothing here yet.

This folder is empty

Drag files here to add them.

No certificates

Upload course certificates as PDF.

Avatar headers (radius, row, grid)

No connections yet · AvatarRadius

Connect with classmates and mentors to grow your network.

No team members · AvatarRow

Invite recruiters to review candidates with you.

Join the community · AvatarGrid

Thousands of students are already sharing interview tips.

Props

<EmptyState />

279 props · 1 for styling (highlighted)
PropTypeDefaultDescription
size"sm" | "md" | "lg""lg"
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

<EmptyState.Header />

280 props · 1 for styling (highlighted)
PropTypeDefaultDescription
pattern"grid" | "none" | "circle" | "square" | "grid-check"—
patternSize"sm" | "md" | "lg"—
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
PropTypeDefaultDescription
aboutstring—
accessKeystring—
aria-activedescendantstring—Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicboolean | "true" | "false"—Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete"none" | "list" | "inline" | "both"—Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be
aria-braillelabelstring—Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionstring—Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyboolean | "true" | "false"—
aria-checkedboolean | "true" | "false" | "mixed"—Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountnumber—Defines the total number of columns in a table, grid, or treegrid.
aria-colindexnumber—Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextstring—Defines a human readable text alternative of aria-colindex.
aria-colspannumber—Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"—Indicates the element that represents the current item within a container or set of related elements.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-descriptionstring—Defines a string value that describes or annotates the current element.
aria-detailsstring—Identifies the element that provides a detailed, extended description for the object.
aria-disabledboolean | "true" | "false"—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect"link" | "none" | "copy" | "execute" | "move" | "popup"—Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessagestring—Identifies the element that provides an error message for the object.
aria-expandedboolean | "true" | "false"—Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtostring—Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion,
aria-grabbedboolean | "true" | "false"—Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"—Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenboolean | "true" | "false"—Indicates whether the element is exposed to an accessibility API.
aria-invalidboolean | "true" | "false" | "grammar" | "spelling"—Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsstring—Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-levelnumber—Defines the hierarchical level of an element within a structure.
aria-live"off" | "assertive" | "polite"—Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalboolean | "true" | "false"—Indicates whether an element is modal when displayed.
aria-multilineboolean | "true" | "false"—Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableboolean | "true" | "false"—Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation"horizontal" | "vertical"—Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship
aria-placeholderstring—Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value.
aria-posinsetnumber—Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedboolean | "true" | "false" | "mixed"—Indicates the current "pressed" state of toggle buttons.
aria-readonlyboolean | "true" | "false"—Indicates that the element is not editable, but is otherwise operable.
aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"—Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredboolean | "true" | "false"—Indicates that user input is required on the element before a form may be submitted.
aria-roledescriptionstring—Defines a human-readable, author-localized description for the role of an element.
aria-rowcountnumber—Defines the total number of rows in a table, grid, or treegrid.
aria-rowindexnumber—Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextstring—Defines a human readable text alternative of aria-rowindex.
aria-rowspannumber—Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedboolean | "true" | "false"—Indicates the current "selected" state of various widgets.
aria-setsizenumber—Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort"none" | "ascending" | "descending" | "other"—Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxnumber—Defines the maximum allowed value for a range widget.
aria-valueminnumber—Defines the minimum allowed value for a range widget.
aria-valuenownumber—Defines the current value for a range widget.
aria-valuetextstring—Defines the human readable text alternative of aria-valuenow for a range widget.
autoCapitalize(string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters"—
autoCorrectstring—
autoFocusboolean—
autoSavestring—
childrenReactNode—
classNamestring—
colorstring—
contentstring—
contentEditableboolean | "true" | "false" | "inherit" | "plaintext-only"—
contextMenustring—
dangerouslySetInnerHTML{ __html: string | TrustedHTML; }—
datatypestring—
defaultCheckedboolean—
defaultValuestring | number | readonly string[]—
dirstring—
draggableboolean | "true" | "false"—
enterKeyHint"search" | "enter" | "done" | "go" | "next" | "previous" | "send"—
exportpartsstring—
hiddenboolean—
idstring—
inertboolean—
inlistany—
inputMode"search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"—Hints at the type of data that might be entered by the user while editing the element or its contents
isstring—Specify that a standard HTML element should behave like a defined custom built-in element
itemIDstring—
itemPropstring—
itemRefstring—
itemScopeboolean—
itemTypestring—
langstring—
noncestring—
onAbortReactEventHandler<HTMLDivElement>—
onAbortCaptureReactEventHandler<HTMLDivElement>—
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onBeforeInputInputEventHandler<HTMLDivElement>—
onBeforeInputCaptureFormEventHandler<HTMLDivElement>—
onBeforeToggleToggleEventHandler<HTMLDivElement>—
onBlurFocusEventHandler<HTMLDivElement>—
onBlurCaptureFocusEventHandler<HTMLDivElement>—
onCanPlayReactEventHandler<HTMLDivElement>—
onCanPlayCaptureReactEventHandler<HTMLDivElement>—
onCanPlayThroughReactEventHandler<HTMLDivElement>—
onCanPlayThroughCaptureReactEventHandler<HTMLDivElement>—
onChangeFormEventHandler<HTMLDivElement>—
onChangeCaptureFormEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onCompositionEndCompositionEventHandler<HTMLDivElement>—
onCompositionEndCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionStartCompositionEventHandler<HTMLDivElement>—
onCompositionStartCaptureCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCompositionEventHandler<HTMLDivElement>—
onCompositionUpdateCaptureCompositionEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onCopyClipboardEventHandler<HTMLDivElement>—
onCopyCaptureClipboardEventHandler<HTMLDivElement>—
onCutClipboardEventHandler<HTMLDivElement>—
onCutCaptureClipboardEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onDragDragEventHandler<HTMLDivElement>—
onDragCaptureDragEventHandler<HTMLDivElement>—
onDragEndDragEventHandler<HTMLDivElement>—
onDragEndCaptureDragEventHandler<HTMLDivElement>—
onDragEnterDragEventHandler<HTMLDivElement>—
onDragEnterCaptureDragEventHandler<HTMLDivElement>—
onDragExitDragEventHandler<HTMLDivElement>—
onDragExitCaptureDragEventHandler<HTMLDivElement>—
onDragLeaveDragEventHandler<HTMLDivElement>—
onDragLeaveCaptureDragEventHandler<HTMLDivElement>—
onDragOverDragEventHandler<HTMLDivElement>—
onDragOverCaptureDragEventHandler<HTMLDivElement>—
onDragStartDragEventHandler<HTMLDivElement>—
onDragStartCaptureDragEventHandler<HTMLDivElement>—
onDropDragEventHandler<HTMLDivElement>—
onDropCaptureDragEventHandler<HTMLDivElement>—
onDurationChangeReactEventHandler<HTMLDivElement>—
onDurationChangeCaptureReactEventHandler<HTMLDivElement>—
onEmptiedReactEventHandler<HTMLDivElement>—
onEmptiedCaptureReactEventHandler<HTMLDivElement>—
onEncryptedReactEventHandler<HTMLDivElement>—
onEncryptedCaptureReactEventHandler<HTMLDivElement>—
onEndedReactEventHandler<HTMLDivElement>—
onEndedCaptureReactEventHandler<HTMLDivElement>—
onErrorReactEventHandler<HTMLDivElement>—
onErrorCaptureReactEventHandler<HTMLDivElement>—
onFocusFocusEventHandler<HTMLDivElement>—
onFocusCaptureFocusEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onInputFormEventHandler<HTMLDivElement>—
onInputCaptureFormEventHandler<HTMLDivElement>—
onInvalidFormEventHandler<HTMLDivElement>—
onInvalidCaptureFormEventHandler<HTMLDivElement>—
onKeyDownKeyboardEventHandler<HTMLDivElement>—
onKeyDownCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyPressKeyboardEventHandler<HTMLDivElement>—
onKeyPressCaptureKeyboardEventHandler<HTMLDivElement>—
onKeyUpKeyboardEventHandler<HTMLDivElement>—
onKeyUpCaptureKeyboardEventHandler<HTMLDivElement>—
onLoadReactEventHandler<HTMLDivElement>—
onLoadCaptureReactEventHandler<HTMLDivElement>—
onLoadedDataReactEventHandler<HTMLDivElement>—
onLoadedDataCaptureReactEventHandler<HTMLDivElement>—
onLoadedMetadataReactEventHandler<HTMLDivElement>—
onLoadedMetadataCaptureReactEventHandler<HTMLDivElement>—
onLoadStartReactEventHandler<HTMLDivElement>—
onLoadStartCaptureReactEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPasteClipboardEventHandler<HTMLDivElement>—
onPasteCaptureClipboardEventHandler<HTMLDivElement>—
onPauseReactEventHandler<HTMLDivElement>—
onPauseCaptureReactEventHandler<HTMLDivElement>—
onPlayReactEventHandler<HTMLDivElement>—
onPlayCaptureReactEventHandler<HTMLDivElement>—
onPlayingReactEventHandler<HTMLDivElement>—
onPlayingCaptureReactEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onProgressReactEventHandler<HTMLDivElement>—
onProgressCaptureReactEventHandler<HTMLDivElement>—
onRateChangeReactEventHandler<HTMLDivElement>—
onRateChangeCaptureReactEventHandler<HTMLDivElement>—
onResetFormEventHandler<HTMLDivElement>—
onResetCaptureFormEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSeekedReactEventHandler<HTMLDivElement>—
onSeekedCaptureReactEventHandler<HTMLDivElement>—
onSeekingReactEventHandler<HTMLDivElement>—
onSeekingCaptureReactEventHandler<HTMLDivElement>—
onSelectReactEventHandler<HTMLDivElement>—
onSelectCaptureReactEventHandler<HTMLDivElement>—
onStalledReactEventHandler<HTMLDivElement>—
onStalledCaptureReactEventHandler<HTMLDivElement>—
onSubmitFormEventHandler<HTMLDivElement>—
onSubmitCaptureFormEventHandler<HTMLDivElement>—
onSuspendReactEventHandler<HTMLDivElement>—
onSuspendCaptureReactEventHandler<HTMLDivElement>—
onTimeUpdateReactEventHandler<HTMLDivElement>—
onTimeUpdateCaptureReactEventHandler<HTMLDivElement>—
onToggleToggleEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onVolumeChangeReactEventHandler<HTMLDivElement>—
onVolumeChangeCaptureReactEventHandler<HTMLDivElement>—
onWaitingReactEventHandler<HTMLDivElement>—
onWaitingCaptureReactEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
partstring—
popover"" | "auto" | "manual" | "hint"—
popoverTargetstring—
popoverTargetAction"toggle" | "show" | "hide"—
prefixstring—
propertystring—
radioGroupstring—
ref((instance: HTMLDivElement | null) => void | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement> | null—
relstring—
resourcestring—
resultsnumber—
revstring—
roleAriaRole—
securitystring—
slotstring—
spellCheckboolean | "true" | "false"—
styleCSSProperties—
suppressContentEditableWarningboolean—
suppressHydrationWarningboolean—
tabIndexnumber—
titlestring—
translate"yes" | "no"—
twstring—Specify styles using Tailwind CSS classes. This feature is currently experimental.
typeofstring—
unselectable"off" | "on"—
vocabstring—

<EmptyState.FeaturedIcon />

7 props · 1 for styling (highlighted)
PropTypeDefaultDescription
color*"brand" | "gray" | "warning" | "error" | "success"—The semantic color used for the background, icon and border of the current theme. The `modern` and `modern-neue` themes are only styled for `gray`.
childrenReactNode—Extra content rendered inside the wrapper, alongside the icon.
iconReactNode | FC<{ className?: string; }>—The icon to display. Accepts a component reference or a rendered element.
refRef<HTMLDivElement>—A ref to the wrapper element.
size"sm" | "md" | "lg" | "xl"—Controls the dimensions of the wrapper and the icon inside it.
theme"light" | "dark" | "modern" | "gradient" | "outline" | "modern-neue"—The visual treatment of the icon container, from a subtle tinted circle to a solid, outlined or skeuomorphic surface.
classNamestring—The class name applied to the wrapper.

Tree views

Hierarchical lists (file trees, folders) with expand/collapse, cascading checkbox selection, connector lines and drag and drop.

Source: src/components/application/tree-view/tree-view.tsx

Simple sm

src
components
button.tsx
input.tsx
modal.tsx
package.json
README.md

Simple md

src
components
button.tsx
input.tsx
modal.tsx
package.json
README.md

Advanced

src3
components3
button.tsx
input.tsx
modal.tsx
package.json
README.md

Advanced sm

src
components
button.tsx
input.tsx
modal.tsx
package.json
README.md

Advanced md

src
components
button.tsx
input.tsx
modal.tsx
package.json
README.md

Props

<TreeView />

105 props · 1 for styling (highlighted)
PropTypeDefaultDescription
draggablebooleanfalseEnable built-in drag and drop. Pass `dragAndDropHooks` directly for full control instead.
onMove((e: { keys: Set<Key>; target: { key: Key; dropPosition: "before" | "after" | "on"; }; }) => void)—Called when items are moved (reparented) onto a different parent.
onReorder((e: { keys: Set<Key>; target: { key: Key; dropPosition: "before" | "after" | "on"; }; }) => void)—Called when items are reordered via drag and drop.
showConnectorsbooleanfalseShow vertical connector lines between parent and child items.
size"sm" | "md""sm"Size variant. Controls item padding and icon sizes.
›100 more props from react-aria-components, react-aria, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
PropTypeDefaultDescription
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-detailsstring—Identifies the element (or elements) that provide a detailed, extended description for the
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
autoFocusboolean | "first" | "last"—Whether to auto focus the gridlist or an option.
childrenReact.ReactNode | ((item: T) => ReactNode)—The contents of the collection.
classNameClassNameOrFunction<TreeRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
defaultExpandedKeysIterable<Key>—The initial expanded keys in the collection (uncontrolled).
defaultSelectedKeysIterable<Key> | "all"—The initial selected keys in the collection (uncontrolled).
dependenciesreadonly any[]—Values that should invalidate the item cache when using dynamic collections.
dirstring—
disabledBehavior"all" | "selection"—Whether `disabledKeys` applies to all interactions, or only selection.
disabledKeysIterable<Key>—The item keys that are disabled. These items cannot be selected, focused, or otherwise
disallowEmptySelectionboolean—Whether the collection allows empty selection.
dragAndDropHooksDragAndDropHooks<NoInfer<T>>—The drag and drop hooks returned by `useDragAndDrop` used to enable drag and drop behavior for
escapeKeyBehavior"none" | "clearSelection"—Whether pressing the escape key should clear selection in the grid list or not.
expandedKeysIterable<Key>—The currently expanded keys in the collection (controlled).
hiddenboolean—
idstring—The element's unique identifier. See
inertboolean—
itemsIterable<T>—Item objects in the collection.
keyboardNavigationBehavior"tab" | "arrow"—Whether keyboard navigation to focusable elements within grid list items is
langstring—
onAction((key: Key) => void)—Handler that is called when a user performs an action on an item. The exact user event depends
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClickMouseEventHandler<HTMLDivElement>—
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onExpandedChange((keys: Set<Key>) => any)—Handler that is called when items are expanded or collapsed.
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onSelectionChange((keys: Selection) => void)—Handler that is called when the selection changes.
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
renderDOMRenderFunction<"div", TreeRenderProps>—Overrides the default DOM element with a custom render function.
renderEmptyState((props: TreeEmptyStateRenderProps) => ReactNode)—Provides content to display when there are no items in the list.
selectedKeysIterable<Key> | "all"—The currently selected keys in the collection (controlled).
selectionBehavior"replace" | "toggle"—How multiple selection should behave in the tree.
selectionMode"single" | "multiple" | "none"—The type of selection that is allowed in the collection.
shouldSelectOnPressUpboolean—Whether selection should occur on press up instead of press down.
slotstring | null—A slot name for the component. Slots allow the component to receive props from a parent
styleStyleOrFunction<TreeRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
translate"yes" | "no"—

<TreeView.Item />

99 props · 1 for styling (highlighted)
PropTypeDefaultDescription
No props of its own — everything comes from react-aria-components, @react-types/shared, react-aria (below).
›99 more props from react-aria-components, @react-types/shared, react-aria(allowsArrowNavigation, aria-label, children, className…)
PropTypeDefaultDescription
allowsArrowNavigationboolean—Whether the row should support arrow key navigation even when the containing collection uses
aria-labelstring—An accessibility label for this tree item.
children*string | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | null—The content of the tree item along with any nested children. Supports static nested tree items
classNameClassNameOrFunction<TreeItemRenderProps>—The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the
dirstring—
downloadstring | boolean—Causes the browser to download the linked URL. A string may be provided to suggest a file name.
focusMode"row" | "child"—Whether the row or its first focusable child element should be focused when the row is
hasChildItemsboolean—Whether this item has children, even if not loaded yet.
hiddenboolean—
hrefstring—A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).
hrefLangstring—Hints at the human language of the linked URL.
idKey—The unique id of the tree row.
inertboolean—
isDisabledboolean—Whether the item is disabled.
langstring—
onAction(() => void)—Handler that is called when a user performs an action on this tree item. The exact user event
onAnimationEndAnimationEventHandler<HTMLDivElement>—
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationIterationAnimationEventHandler<HTMLDivElement>—
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement>—
onAnimationStartAnimationEventHandler<HTMLDivElement>—
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement>—
onAuxClickMouseEventHandler<HTMLDivElement>—
onAuxClickCaptureMouseEventHandler<HTMLDivElement>—
onClick((e: MouseEvent<FocusableElement>) => void)—**Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress`
onClickCaptureMouseEventHandler<HTMLDivElement>—
onContextMenuMouseEventHandler<HTMLDivElement>—
onContextMenuCaptureMouseEventHandler<HTMLDivElement>—
onDoubleClickMouseEventHandler<HTMLDivElement>—
onDoubleClickCaptureMouseEventHandler<HTMLDivElement>—
onGotPointerCapturePointerEventHandler<HTMLDivElement>—
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onHoverChange((isHovering: boolean) => void)—Handler that is called when the hover state changes.
onHoverEnd((e: HoverEvent) => void)—Handler that is called when a hover interaction ends.
onHoverStart((e: HoverEvent) => void)—Handler that is called when a hover interaction starts.
onLostPointerCapturePointerEventHandler<HTMLDivElement>—
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement>—
onMouseDownMouseEventHandler<HTMLDivElement>—
onMouseDownCaptureMouseEventHandler<HTMLDivElement>—
onMouseEnterMouseEventHandler<HTMLDivElement>—
onMouseLeaveMouseEventHandler<HTMLDivElement>—
onMouseMoveMouseEventHandler<HTMLDivElement>—
onMouseMoveCaptureMouseEventHandler<HTMLDivElement>—
onMouseOutMouseEventHandler<HTMLDivElement>—
onMouseOutCaptureMouseEventHandler<HTMLDivElement>—
onMouseOverMouseEventHandler<HTMLDivElement>—
onMouseOverCaptureMouseEventHandler<HTMLDivElement>—
onMouseUpMouseEventHandler<HTMLDivElement>—
onMouseUpCaptureMouseEventHandler<HTMLDivElement>—
onPointerCancelPointerEventHandler<HTMLDivElement>—
onPointerCancelCapturePointerEventHandler<HTMLDivElement>—
onPointerDownPointerEventHandler<HTMLDivElement>—
onPointerDownCapturePointerEventHandler<HTMLDivElement>—
onPointerEnterPointerEventHandler<HTMLDivElement>—
onPointerLeavePointerEventHandler<HTMLDivElement>—
onPointerMovePointerEventHandler<HTMLDivElement>—
onPointerMoveCapturePointerEventHandler<HTMLDivElement>—
onPointerOutPointerEventHandler<HTMLDivElement>—
onPointerOutCapturePointerEventHandler<HTMLDivElement>—
onPointerOverPointerEventHandler<HTMLDivElement>—
onPointerOverCapturePointerEventHandler<HTMLDivElement>—
onPointerUpPointerEventHandler<HTMLDivElement>—
onPointerUpCapturePointerEventHandler<HTMLDivElement>—
onPress((e: PressEvent) => void)—Handler that is called when the press is released over the target.
onPressChange((isPressed: boolean) => void)—Handler that is called when the press state changes.
onPressEnd((e: PressEvent) => void)—Handler that is called when a press interaction ends, either
onPressStart((e: PressEvent) => void)—Handler that is called when a press interaction starts.
onPressUp((e: PressEvent) => void)—Handler that is called when a press is released over the target, regardless of
onScrollUIEventHandler<HTMLDivElement>—
onScrollCaptureUIEventHandler<HTMLDivElement>—
onTouchCancelTouchEventHandler<HTMLDivElement>—
onTouchCancelCaptureTouchEventHandler<HTMLDivElement>—
onTouchEndTouchEventHandler<HTMLDivElement>—
onTouchEndCaptureTouchEventHandler<HTMLDivElement>—
onTouchMoveTouchEventHandler<HTMLDivElement>—
onTouchMoveCaptureTouchEventHandler<HTMLDivElement>—
onTouchStartTouchEventHandler<HTMLDivElement>—
onTouchStartCaptureTouchEventHandler<HTMLDivElement>—
onTransitionCancelTransitionEventHandler<HTMLDivElement>—
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionEndTransitionEventHandler<HTMLDivElement>—
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionRunTransitionEventHandler<HTMLDivElement>—
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement>—
onTransitionStartTransitionEventHandler<HTMLDivElement>—
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement>—
onWheelWheelEventHandler<HTMLDivElement>—
onWheelCaptureWheelEventHandler<HTMLDivElement>—
pingstring—A space-separated list of URLs to ping when the link is followed. See
referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"—How much of the referrer to send when following the link. See
relstring—The relationship between the linked resource and the current page. See
renderDOMRenderFunction<"div", TreeItemRenderProps>—Overrides the default DOM element with a custom render function.
routerOptionsundefined—Options for the configured client side router.
styleStyleOrFunction<TreeItemRenderProps>—The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the
suppressHydrationWarningboolean—A React-only flag that suppresses the warning React normally logs when an element's
targetHTMLAttributeAnchorTarget—The target window for the link. See
textValue*string—A string representation of the tree item's contents, used for features like typeahead.
translate"yes" | "no"—
valueobject—The object value that this tree item represents. When using dynamic collections, this is set

<TreeView.ItemContent />

4 props · 1 for styling (highlighted)
PropTypeDefaultDescription
children*ReactNode—The text label for the tree item.
actionReactNode—Trailing action element (e.g. drag handle or menu trigger).
iconReactNode | FC<{ className?: string; }>—Leading icon. Pass as component reference (e.g. `Folder`) or as element (e.g. `<Avatar />`).
classNamestring—Additional class name for the item row.

<TreeView.DropIndicator />

1 props
PropTypeDefaultDescription
target*RootDropTarget | ItemDropTarget—The drop position this indicator represents. Supplied by the tree's `renderDropIndicator` while a drag is in progress.