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
| Prop | Values |
|---|---|
className | root element: bg-*, text-*, ring-*, hover:bg-* |
ProgressBar progressClassName | the filled part of the bar |
ProgressBarCircle trackClassName / progressClassName | the rings — use stroke-* classes |
Input inputClassName / wrapperClassName | the input box and its wrapper |
TextArea textAreaClassName | the textarea itself |
Brand color everywhere | change --color-brand-* in src/styles/theme.css |
Colors through className
Colors as a prop (wrapper)
Actions
Dropdowns
Menus opened from a button or a ⋮ icon.
Source: src/components/base/dropdown/dropdown.tsx
Dropdown menus
Props
<Dropdown.Item />
106 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
addon | string | — | An addon to be displayed on the right side of the item. |
avatarUrl | string | — | Avatar URL to be displayed on the left side of the item. |
icon | FC<{ className?: string; }> | — | An icon to be displayed on the left side of the item. |
label | string | — | The label of the item to be displayed. |
selectionIndicator | "none" | "checkbox" | "radio" | "toggle" | "checkmark" | "checkmark" | The selection indicator to be displayed on the item. |
unstyled | boolean | — | If true, the item will not have any styles. |
›100 more props from react-aria-components, @react-types/shared(aria-label, children, className, dir…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-label | string | — | An accessibility label for this item. |
children | React.ReactNode | ((values: MenuItemRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<MenuItemRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dir | string | — | |
download | string | boolean | — | Causes the browser to download the linked URL. A string may be provided to suggest a file name. |
hidden | boolean | — | |
href | string | — | A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href). |
hrefLang | string | — | Hints at the human language of the linked URL. |
id | Key | — | The unique id of the item. |
inert | boolean | — | |
isDisabled | boolean | — | Whether the item is disabled. |
lang | string | — | |
onAction | (() => void) | — | Handler that is called when the item is selected. |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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` |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
ping | string | — | 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 |
rel | string | — | The relationship between the linked resource and the current page. See |
render | ((props: React.DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement> | React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, renderProps: MenuItemRenderProps) => ReactElement) | — | Overrides the default DOM element with a custom render function. |
routerOptions | undefined | — | Options for the configured client side router. |
shouldCloseOnSelect | boolean | — | Whether the menu should close when the menu item is selected. |
style | StyleOrFunction<MenuItemRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
target | HTMLAttributeAnchorTarget | — | The target window for the link. See |
textValue | string | — | A string representation of the item's contents, used for features like typeahead. |
translate | "yes" | "no" | — | |
value | object | — | The object value that this item represents. When using dynamic collections, this is set |
<Dropdown.Popover />
106 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| No props of its own — everything comes from react-aria-components, react-aria, react-stately, @react-types/shared (below). | |||
›106 more props from react-aria-components, react-aria, react-stately, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
arrowBoundaryOffset | number | — | The minimum distance the arrow's edge should be from the edge of the overlay element. |
arrowRef | RefObject<Element | null> | — | A ref for the popover arrow element. |
boundaryElement | Element | — | Element that that serves as the positioning boundary. |
children | React.ReactNode | ((values: PopoverRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<PopoverRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
containerPadding | number | — | The placement padding that should be applied between the element and its |
crossOffset | number | — | The additional offset applied along the cross axis between the element and its |
defaultOpen | boolean | — | Whether the overlay is open by default (uncontrolled). |
dir | string | — | |
getTargetRect | ((target: Element) => DOMRect | null | undefined) | — | Overrides the target element's bounding rectangle. Useful for positioning relative to |
hidden | boolean | — | |
inert | boolean | — | |
isEntering | boolean | — | Whether the popover is currently performing an entry animation. |
isExiting | boolean | — | Whether the popover is currently performing an exit animation. |
isKeyboardDismissDisabled | boolean | — | Whether pressing the escape key to close the popover should be disabled. |
isNonModal | boolean | — | Whether the popover is non-modal, i.e. elements outside the popover may be |
isOpen | boolean | — | Whether the overlay is open by default (controlled). |
lang | string | — | |
maxHeight | number | — | The maxHeight specified for the overlay element. |
offset | number | — | The additional offset applied along the main axis between the element and its |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBlurWithin | ((e: FocusEvent) => void) | — | Handler that is called when the target element and all descendants lose focus. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onFocusWithin | ((e: FocusEvent) => void) | — | Handler that is called when the target element or a descendant receives focus. |
onFocusWithinChange | ((isFocusWithin: boolean) => void) | — | Handler that is called when the the focus within state changes. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onOpenChange | ((isOpen: boolean) => void) | — | Handler that is called when the overlay's open state changes. |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<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" | — | The placement of the element with respect to its anchor element. |
render | DOMRenderFunction<"div", PopoverRenderProps> | — | Overrides the default DOM element with a custom render function. |
scrollRef | RefObject<Element | null> | — | A ref for the scrollable region within the overlay. |
shouldCloseOnInteractOutside | ((element: Element) => boolean) | — | When user interacts with the argument element outside of the popover ref, |
shouldFlip | boolean | — | Whether the element should flip its orientation (e.g. top to bottom or left to right) when |
shouldSkipAnimation | boolean | — | Whether the popover should appear and disappear without an entry or exit animation. This is |
shouldUpdatePosition | boolean | — | Whether the overlay should update its position automatically. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<PopoverRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
translate | "yes" | "no" | — | |
trigger | string | — | The name of the component that triggered the popover. This is reflected on the element |
triggerRef | RefObject<Element | null> | — | The ref for the element which the popover positions itself with respect to. |
UNSTABLE_portalContainer | Element | — | The container element in which the overlay portal will be placed. This may have unknown |
Forms
Inputs
Text fields with label, hint, icon, validation and controlled values.
Source: src/components/base/input/input.tsx
Label, hint, icon, states
Controlled value
Hello, …
Prefix and suffix
Sizes
Leading icon, dropdowns, text and button add-ons
₹
Password, card, date, number, tags, file
Custom colors
Props
<Input />
135 props · 5 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
groupRef | Ref<HTMLDivElement> | — | |
hideRequiredIndicator | boolean | — | Whether to hide required indicator from label |
hint | ReactNode | — | Helper text displayed below the input |
icon | ComponentType<HTMLAttributes<HTMLOrSVGElement>> | — | Icon component to display on the left side of the input. |
label | string | — | Label text for the input |
placeholder | string | — | Placeholder text. |
ref | Ref<HTMLInputElement> | — | |
shortcut | string | boolean | — | Keyboard shortcut to display. |
size | "sm" | "md" | "lg" | "md" | Input size. |
tooltip | string | — | Tooltip message on hover. |
iconClassName | string | — | Class name for the icon. |
inputClassName | string | — | Class name for the input. |
tooltipClassName | string | — | Class name for the tooltip. |
wrapperClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-activedescendant | string | — | 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-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-haspopup | boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog" | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoComplete | string | — | Describes the type of autocomplete functionality the input should provide if any. See |
autoCorrect | string | — | An attribute that takes as its value a space-separated string that describes what, if any, type |
autoFocus | boolean | — | Whether the element should receive focus on render. |
children | React.ReactNode | ((values: TextFieldRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<TextFieldRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultValue | string | — | The default value (uncontrolled). |
dir | string | — | |
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 |
excludeFromTabOrder | boolean | — | Whether to exclude the element from the sequential tab order. If true, |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
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 |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the value is invalid. |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
lang | string | — | |
maxLength | number | — | The maximum number of characters supported by the input. See |
minLength | number | — | The minimum number of characters required by the input. See |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | FormEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a text composition system completes or cancels the current text |
onCompositionStart | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a text composition system starts a new text composition session. |
onCompositionUpdate | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a new character is received in the current text composition |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user copies text. See |
onCut | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user cuts text. See |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user pastes text. See |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLInputElement> | — | Handler that is called when text in the input is selected. See |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
pattern | string | — | Regex pattern that the value of the input must match to be valid. See |
render | DOMRenderFunction<"div", TextFieldRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
spellCheck | string | — | An enumerated attribute that defines whether the element may be checked for spelling errors. |
style | StyleOrFunction<TextFieldRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | string | — | The current value (controlled). |
<InputGroup />
132 props · 5 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | — | The children of the input group (i.e `<InputBase />`) |
hideRequiredIndicator | boolean | — | Whether to hide the required indicator from the label. |
hint | ReactNode | — | Helper text displayed below the input |
label | string | — | Label text for the input |
leadingAddon | ReactNode | — | A leading addon that is displayed with visual separation from the input. |
prefix | string | — | A prefix text that is displayed in the same box as the input. |
size | "sm" | "md" | "lg" | "md" | Input size. |
trailingAddon | ReactNode | — | A trailing addon that is displayed with visual separation from the input. |
className | string | — | The class name to apply to the input group. |
iconClassName | string | — | Class name for the icon. |
inputClassName | string | — | Class name for the input. |
tooltipClassName | string | — | Class name for the tooltip. |
wrapperClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-activedescendant | string | — | 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-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-haspopup | boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog" | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoComplete | string | — | Describes the type of autocomplete functionality the input should provide if any. See |
autoCorrect | string | — | An attribute that takes as its value a space-separated string that describes what, if any, type |
autoFocus | boolean | — | Whether the element should receive focus on render. |
defaultValue | string | — | The default value (uncontrolled). |
dir | string | — | |
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 |
excludeFromTabOrder | boolean | — | Whether to exclude the element from the sequential tab order. If true, |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
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 |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the value is invalid. |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
lang | string | — | |
maxLength | number | — | The maximum number of characters supported by the input. See |
minLength | number | — | The minimum number of characters required by the input. See |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | FormEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a text composition system completes or cancels the current text |
onCompositionStart | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a text composition system starts a new text composition session. |
onCompositionUpdate | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a new character is received in the current text composition |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user copies text. See |
onCut | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user cuts text. See |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user pastes text. See |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLInputElement> | — | Handler that is called when text in the input is selected. See |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
pattern | string | — | Regex pattern that the value of the input must match to be valid. See |
render | DOMRenderFunction<"div", TextFieldRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
spellCheck | string | — | An enumerated attribute that defines whether the element may be checked for spelling errors. |
style | StyleOrFunction<TextFieldRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | string | — | The current value (controlled). |
<InputNumber />
125 props · 3 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
groupRef | Ref<HTMLDivElement> | — | |
hideRequiredIndicator | boolean | — | |
hint | ReactNode | — | Helper text displayed below the input |
label | string | — | Label text for the input |
orientation | "horizontal" | "vertical" | "vertical" | Orientation of buttons. |
placeholder | string | — | Placeholder text. |
ref | Ref<HTMLInputElement> | — | |
size | "sm" | "md" | "lg" | "md" | Input size. |
inputClassName | string | — | Class name for the input. |
wrapperClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoFocus | boolean | — | Whether the element should receive focus on render. |
children | React.ReactNode | ((values: NumberFieldRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<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' |
decrementAriaLabel | string | — | A custom aria-label for the decrement button. If not provided, the localized string "Decrement" |
defaultValue | number | — | The default value (uncontrolled). |
dir | string | — | |
form | string | — | The `<form>` element to associate the input with. |
formatOptions | Intl.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"` |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
incrementAriaLabel | string | — | A custom aria-label for the increment button. If not provided, the localized string "Increment" |
inert | boolean | — | |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the input value is invalid. |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
isWheelDisabled | boolean | — | Enables or disables changing the value with scroll. |
lang | string | — | |
maxValue | number | — | The largest value allowed for the input. |
minValue | number | — | The smallest value allowed for the input. |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | FormEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a text composition system completes or cancels the current text |
onCompositionStart | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a text composition system starts a new text composition session. |
onCompositionUpdate | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a new character is received in the current text composition |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user copies text. See |
onCut | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user cuts text. See |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user pastes text. See |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLInputElement> | — | Handler that is called when text in the input is selected. See |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
render | DOMRenderFunction<"div", NumberFieldRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
step | number | — | The amount that the input value changes with each increment or decrement "tick". |
style | StyleOrFunction<NumberFieldRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | number | — | The current value (controlled). |
<InputTags />
18 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
allowDuplicates | boolean | false | Whether to allow duplicate tag values. |
defaultValue | string[] | — | Default tags for uncontrolled mode. |
hideRequiredIndicator | boolean | — | Whether to hide the required indicator from the label. |
hint | ReactNode | — | Helper text displayed below the input. |
isDisabled | boolean | — | Whether the field is disabled. |
isInvalid | boolean | — | Whether the field is in an invalid/error state. |
isRequired | boolean | — | Whether the field is required. |
label | string | — | Label text displayed above the input. |
maxTags | number | — | 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. |
placeholder | string | — | Placeholder text for the input field. |
size | "sm" | "md" | "lg" | "md" | Input size variant. |
tooltip | string | — | Tooltip message displayed via a help icon inside the input. |
validate | ((value: string) => boolean) | — | Validation function for new tags. |
value | string[] | — | Controlled value: array of tag strings. |
className | string | — | Optional className for the outer container. |
<InputFile />
14 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
acceptedFileTypes | string[] | — | Specifies what mime type of files are allowed. |
allowsMultiple | boolean | — | Whether multiple files can be selected. |
buttonText | string | "Upload" | The text of the upload button. |
hideRequiredIndicator | boolean | — | Whether to hide the required indicator from the label. |
hint | ReactNode | — | Helper text displayed below the input. |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the input is invalid. |
isLoading | boolean | — | Whether the file is currently uploading. |
isRequired | boolean | — | Whether the input is required. |
label | string | — | Label text for the input. |
onChange | ((files: FileList | null) => void) | — | Handler when a user selects files. |
placeholder | string | "Choose a file" | Placeholder text displayed when no file is selected. |
size | "sm" | "md" | "lg" | "sm" | The size of the input. |
className | string | — | The class name for the root element. |
<AccentScope />
279 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
color* | string | — | Any CSS color for brand-colored parts inside (focus rings, selected states, primary buttons…), e.g. "#095E15". |
hoverColor | string | — | Hover color; defaults to a darker version of color. |
›277 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
Textarea
Multi-line text input.
Source: src/components/base/textarea/textarea.tsx
Textarea
Props
<TextArea />
133 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
cols | number | — | Visible width of textarea in columns. |
hideRequiredIndicator | boolean | — | Whether to hide required indicator from label. |
hint | string | number | bigint | boolean | React.ReactElement<any, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.ReactPortal | Promise<React.AwaitedReactNode> | null | — | Helper text displayed below the textarea |
label | string | — | Label text for the textarea |
placeholder | string | — | Placeholder text. |
ref | Ref<HTMLDivElement> | — | Ref for the textarea wrapper |
rows | number | — | Visible height of textarea in rows . |
showCount | boolean | — | Shows a character counter under the textarea, e.g. "120/500" when maxLength is set. |
size | "sm" | "md" | "md" | Textarea size. |
textAreaRef | Ref<HTMLTextAreaElement> | — | Ref for the textarea |
tooltip | string | — | Tooltip message displayed after the label. |
textAreaClassName | ClassNameOrFunction<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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-activedescendant | string | — | 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-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-haspopup | boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog" | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoComplete | string | — | Describes the type of autocomplete functionality the input should provide if any. See |
autoCorrect | string | — | An attribute that takes as its value a space-separated string that describes what, if any, type |
autoFocus | boolean | — | Whether the element should receive focus on render. |
children | React.ReactNode | ((values: TextFieldRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<TextFieldRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultValue | string | — | The default value (uncontrolled). |
dir | string | — | |
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 |
excludeFromTabOrder | boolean | — | Whether to exclude the element from the sequential tab order. If true, |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
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 |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the value is invalid. |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
lang | string | — | |
maxLength | number | — | The maximum number of characters supported by the input. See |
minLength | number | — | The minimum number of characters required by the input. See |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | FormEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a text composition system completes or cancels the current text |
onCompositionStart | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a text composition system starts a new text composition session. |
onCompositionUpdate | CompositionEventHandler<HTMLInputElement> | — | Handler that is called when a new character is received in the current text composition |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user copies text. See |
onCut | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user cuts text. See |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLInputElement> | — | Handler that is called when the user pastes text. See |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLInputElement> | — | Handler that is called when text in the input is selected. See |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
pattern | string | — | Regex pattern that the value of the input must match to be valid. See |
render | DOMRenderFunction<"div", TextFieldRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
spellCheck | string | — | An enumerated attribute that defines whether the element may be checked for spelling errors. |
style | StyleOrFunction<TextFieldRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | string | — | 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
Sizes
Common patterns (verify flow, masked PIN, error, disabled)
Custom colors
Props
<PinInput />
283 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
accentColor | string | — | Any CSS color for the focus ring, filled boxes, digits and caret, e.g. "#095E15". |
disabled | boolean | false | |
invalid | boolean | false | |
mask | boolean | false | Show • 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
<PinInput.Group />
316 props · 3 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
inputClassName | string | — |
›315 more props from react, input-otp, next(about, accept, accessKey, alt…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accept | string | — | |
accessKey | string | — | |
alt | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoComplete | HTMLInputAutoCompleteAttribute | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
capture | boolean | "user" | "environment" | — | |
checked | boolean | — | |
children | undefined | — | |
className | string | — | |
color | string | — | |
containerClassName | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
disabled | boolean | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
form | string | — | |
formAction | string | ((formData: FormData) => void | Promise<void>) | — | |
formEncType | string | — | |
formMethod | string | — | |
formNoValidate | boolean | — | |
formTarget | string | — | |
height | string | number | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
list | string | — | |
max | string | number | — | |
maxLength* | number | — | |
min | string | number | — | |
minLength | number | — | |
multiple | boolean | — | |
name | string | — | |
nonce | string | — | |
noScriptCSSFallback | string | null | — | |
onAbort | ReactEventHandler<HTMLInputElement> | — | |
onAbortCapture | ReactEventHandler<HTMLInputElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLInputElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLInputElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLInputElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLInputElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLInputElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLInputElement> | — | |
onAuxClick | MouseEventHandler<HTMLInputElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLInputElement> | — | |
onBeforeInput | InputEventHandler<HTMLInputElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLInputElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLInputElement> | — | |
onBlur | FocusEventHandler<HTMLInputElement> | — | |
onBlurCapture | FocusEventHandler<HTMLInputElement> | — | |
onCanPlay | ReactEventHandler<HTMLInputElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLInputElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLInputElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLInputElement> | — | |
onChange | ((newValue: string) => unknown) | — | |
onChangeCapture | FormEventHandler<HTMLInputElement> | — | |
onClick | MouseEventHandler<HTMLInputElement> | — | |
onClickCapture | MouseEventHandler<HTMLInputElement> | — | |
onComplete | ((...args: any[]) => unknown) | — | |
onCompositionEnd | CompositionEventHandler<HTMLInputElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLInputElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLInputElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLInputElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLInputElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLInputElement> | — | |
onContextMenu | MouseEventHandler<HTMLInputElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLInputElement> | — | |
onCopy | ClipboardEventHandler<HTMLInputElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLInputElement> | — | |
onCut | ClipboardEventHandler<HTMLInputElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLInputElement> | — | |
onDoubleClick | MouseEventHandler<HTMLInputElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLInputElement> | — | |
onDrag | DragEventHandler<HTMLInputElement> | — | |
onDragCapture | DragEventHandler<HTMLInputElement> | — | |
onDragEnd | DragEventHandler<HTMLInputElement> | — | |
onDragEndCapture | DragEventHandler<HTMLInputElement> | — | |
onDragEnter | DragEventHandler<HTMLInputElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLInputElement> | — | |
onDragExit | DragEventHandler<HTMLInputElement> | — | |
onDragExitCapture | DragEventHandler<HTMLInputElement> | — | |
onDragLeave | DragEventHandler<HTMLInputElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLInputElement> | — | |
onDragOver | DragEventHandler<HTMLInputElement> | — | |
onDragOverCapture | DragEventHandler<HTMLInputElement> | — | |
onDragStart | DragEventHandler<HTMLInputElement> | — | |
onDragStartCapture | DragEventHandler<HTMLInputElement> | — | |
onDrop | DragEventHandler<HTMLInputElement> | — | |
onDropCapture | DragEventHandler<HTMLInputElement> | — | |
onDurationChange | ReactEventHandler<HTMLInputElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLInputElement> | — | |
onEmptied | ReactEventHandler<HTMLInputElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLInputElement> | — | |
onEncrypted | ReactEventHandler<HTMLInputElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLInputElement> | — | |
onEnded | ReactEventHandler<HTMLInputElement> | — | |
onEndedCapture | ReactEventHandler<HTMLInputElement> | — | |
onError | ReactEventHandler<HTMLInputElement> | — | |
onErrorCapture | ReactEventHandler<HTMLInputElement> | — | |
onFocus | FocusEventHandler<HTMLInputElement> | — | |
onFocusCapture | FocusEventHandler<HTMLInputElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLInputElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLInputElement> | — | |
onInput | FormEventHandler<HTMLInputElement> | — | |
onInputCapture | FormEventHandler<HTMLInputElement> | — | |
onInvalid | FormEventHandler<HTMLInputElement> | — | |
onInvalidCapture | FormEventHandler<HTMLInputElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLInputElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLInputElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLInputElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLInputElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLInputElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLInputElement> | — | |
onLoad | ReactEventHandler<HTMLInputElement> | — | |
onLoadCapture | ReactEventHandler<HTMLInputElement> | — | |
onLoadedData | ReactEventHandler<HTMLInputElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLInputElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLInputElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLInputElement> | — | |
onLoadStart | ReactEventHandler<HTMLInputElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLInputElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLInputElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLInputElement> | — | |
onMouseDown | MouseEventHandler<HTMLInputElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLInputElement> | — | |
onMouseEnter | MouseEventHandler<HTMLInputElement> | — | |
onMouseLeave | MouseEventHandler<HTMLInputElement> | — | |
onMouseMove | MouseEventHandler<HTMLInputElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLInputElement> | — | |
onMouseOut | MouseEventHandler<HTMLInputElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLInputElement> | — | |
onMouseOver | MouseEventHandler<HTMLInputElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLInputElement> | — | |
onMouseUp | MouseEventHandler<HTMLInputElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLInputElement> | — | |
onPaste | ClipboardEventHandler<HTMLInputElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLInputElement> | — | |
onPause | ReactEventHandler<HTMLInputElement> | — | |
onPauseCapture | ReactEventHandler<HTMLInputElement> | — | |
onPlay | ReactEventHandler<HTMLInputElement> | — | |
onPlayCapture | ReactEventHandler<HTMLInputElement> | — | |
onPlaying | ReactEventHandler<HTMLInputElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLInputElement> | — | |
onPointerCancel | PointerEventHandler<HTMLInputElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLInputElement> | — | |
onPointerDown | PointerEventHandler<HTMLInputElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLInputElement> | — | |
onPointerEnter | PointerEventHandler<HTMLInputElement> | — | |
onPointerLeave | PointerEventHandler<HTMLInputElement> | — | |
onPointerMove | PointerEventHandler<HTMLInputElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLInputElement> | — | |
onPointerOut | PointerEventHandler<HTMLInputElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLInputElement> | — | |
onPointerOver | PointerEventHandler<HTMLInputElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLInputElement> | — | |
onPointerUp | PointerEventHandler<HTMLInputElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLInputElement> | — | |
onProgress | ReactEventHandler<HTMLInputElement> | — | |
onProgressCapture | ReactEventHandler<HTMLInputElement> | — | |
onRateChange | ReactEventHandler<HTMLInputElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLInputElement> | — | |
onReset | FormEventHandler<HTMLInputElement> | — | |
onResetCapture | FormEventHandler<HTMLInputElement> | — | |
onScroll | UIEventHandler<HTMLInputElement> | — | |
onScrollCapture | UIEventHandler<HTMLInputElement> | — | |
onSeeked | ReactEventHandler<HTMLInputElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLInputElement> | — | |
onSeeking | ReactEventHandler<HTMLInputElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLInputElement> | — | |
onSelect | ReactEventHandler<HTMLInputElement> | — | |
onSelectCapture | ReactEventHandler<HTMLInputElement> | — | |
onStalled | ReactEventHandler<HTMLInputElement> | — | |
onStalledCapture | ReactEventHandler<HTMLInputElement> | — | |
onSubmit | FormEventHandler<HTMLInputElement> | — | |
onSubmitCapture | FormEventHandler<HTMLInputElement> | — | |
onSuspend | ReactEventHandler<HTMLInputElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLInputElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLInputElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLInputElement> | — | |
onToggle | ToggleEventHandler<HTMLInputElement> | — | |
onTouchCancel | TouchEventHandler<HTMLInputElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLInputElement> | — | |
onTouchEnd | TouchEventHandler<HTMLInputElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLInputElement> | — | |
onTouchMove | TouchEventHandler<HTMLInputElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLInputElement> | — | |
onTouchStart | TouchEventHandler<HTMLInputElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLInputElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLInputElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLInputElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLInputElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLInputElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLInputElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLInputElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLInputElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLInputElement> | — | |
onVolumeChange | ReactEventHandler<HTMLInputElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLInputElement> | — | |
onWaiting | ReactEventHandler<HTMLInputElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLInputElement> | — | |
onWheel | WheelEventHandler<HTMLInputElement> | — | |
onWheelCapture | WheelEventHandler<HTMLInputElement> | — | |
part | string | — | |
pasteTransformer | ((pasted: string) => string) | — | |
pattern | string | — | |
placeholder | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
pushPasswordManagerStrategy | "none" | "increase-width" | — | |
radioGroup | string | — | |
readOnly | boolean | — | |
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 | — | |
rel | string | — | |
render | (props: RenderProps) => React.ReactNode | — | |
required | boolean | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
size | number | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
src | string | — | |
step | string | number | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
textAlign | "left" | "right" | "center" | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
type | HTMLInputTypeAttribute | — | |
typeof | string | — | |
unselectable | "off" | "on" | — | |
value | string | — | |
vocab | string | — | |
width | number | — |
<PinInput.Slot />
279 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
index* | number | — |
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
Select
Pick one option from a list, with optional search.
Source: src/components/base/select/select.tsx
Select and combobox
Props
<Select />
118 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | ((item: SelectItemType) => ReactNode) | — | The dropdown contents: either `Select.Item` elements, or a render function called with each entry of `items`. |
hideRequiredIndicator | boolean | — | Whether to hide the required indicator from the label. |
hint | string | — | Helper text displayed below the input. |
icon | ReactNode | 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. |
items | SelectItemType[] | — | The options to render in the dropdown. When `children` is a function it is called once per item to render it. |
label | string | — | Field label displayed above the input. |
size | "sm" | "md" | "lg" | "md" | The size of the component. |
tooltip | string | — | Tooltip text for the help icon next to the label. |
popoverClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
allowsEmptyCollection | boolean | — | Whether the select should be allowed to be open when the collection is empty. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoComplete | string | — | Describes the type of autocomplete functionality the input should provide if any. See |
autoFocus | boolean | — | Whether the element should receive focus on render. |
className | ClassNameOrFunction<SelectRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultOpen | boolean | — | Sets the default open state of the menu. |
defaultSelectedKey | Key | null | — | The initial selected key in the collection (uncontrolled). |
defaultValue | Key | null | — | The default value (uncontrolled). |
dir | string | — | |
disabledKeys | Iterable<Key> | — | The item keys that are disabled. These items cannot be selected, focused, or otherwise |
excludeFromTabOrder | boolean | — | Whether to exclude the element from the sequential tab order. If true, |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the input value is invalid. |
isOpen | boolean | — | Sets the open state of the menu. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
lang | string | — | |
name | string | — | The name of the input, used when submitting an HTML form. |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onOpenChange | ((isOpen: boolean) => void) | — | Method that is called when the open state of the menu changes. |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelectionChange | ((key: Key | null) => void) | — | Handler that is called when the selection changes. |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
placeholder | string | "Select" | Temporary text that occupies the select when it is empty. |
ref | LegacyRef<HTMLDivElement> | — | Allows getting a ref to the component instance. |
render | DOMRenderFunction<"div", SelectRenderProps> | — | Overrides the default DOM element with a custom render function. |
selectedKey | Key | null | — | The currently selected key in the collection (controlled). |
selectionMode | "single" | — | Whether single or multiple selection is enabled. |
shouldCloseOnSelect | boolean | — | Whether the Select should close when an item is selected. Defaults to true if selectionMode is |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<SelectRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | Key | null | — | The current value (controlled). |
<Select.Item />
107 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
id* | string | number | — | Unique identifier for the item. |
avatarUrl | string | — | Avatar image URL. |
icon | ReactNode | FC | — | Leading icon component or element. |
label | string | — | 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. |
supportingText | string | — | Secondary text displayed alongside the label. |
›100 more props from react-aria-components, @react-types/shared(aria-label, children, className, dir…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-label | string | — | An accessibility label for this item. |
children | React.ReactNode | ((values: ListBoxItemRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<ListBoxItemRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dir | string | — | |
download | string | boolean | — | Causes the browser to download the linked URL. A string may be provided to suggest a file name. |
hidden | boolean | — | |
href | string | — | A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href). |
hrefLang | string | — | Hints at the human language of the linked URL. |
inert | boolean | — | |
isDisabled | boolean | — | Whether the item is disabled. |
lang | string | — | |
onAction | (() => void) | — | Handler that is called when a user performs an action on the item. The exact user event depends |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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` |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
ping | string | — | 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 |
rel | string | — | 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. |
routerOptions | undefined | — | Options for the configured client side router. |
style | StyleOrFunction<ListBoxItemRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
target | HTMLAttributeAnchorTarget | — | The target window for the link. See |
textValue | string | — | A string representation of the item's contents, used for features like typeahead. |
translate | "yes" | "no" | — | |
value | SelectItemType | — | The object value that this item represents. When using dynamic collections, this is set |
<Select.ComboBox />
125 props · 3 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | ((item: SelectItemType) => ReactNode) | — | The dropdown contents: either `Select.Item` elements, or a render function called with each entry of `items`. |
hideRequiredIndicator | boolean | — | Whether to hide the required indicator from the label. |
hint | string | — | Helper text displayed below the input. |
icon | ReactNode | FC | — | Leading icon component displayed before the input. |
items | SelectItemType[] | — | The options to render in the dropdown. When `children` is a function it is called once per item to render it. |
label | string | — | Field label displayed above the input. |
placeholder | string | — | Placeholder text when no value is selected. |
shortcut | boolean | — | 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. |
tooltip | string | — | Tooltip text for the help icon next to the label. |
popoverClassName | string | — | Additional classes merged onto the dropdown popover, which is sized to match the input. |
shortcutClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
allowsCustomValue | boolean | — | Whether the ComboBox allows a non-item matching input value to be set. |
allowsEmptyCollection | boolean | — | Whether the combo box allows the menu to be open when the collection is empty. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoFocus | boolean | — | Whether the element should receive focus on render. |
className | ClassNameOrFunction<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. |
defaultInputValue | string | — | The default value of the ComboBox input (uncontrolled). |
defaultItems | Iterable<SelectItemType> | — | The list of ComboBox items (uncontrolled). |
defaultSelectedKey | Key | null | — | The initial selected key in the collection (uncontrolled). |
defaultValue | Key | null | — | The default value (uncontrolled). |
dir | string | — | |
disabledKeys | Iterable<Key> | — | The item keys that are disabled. These items cannot be selected, focused, or otherwise |
form | string | — | 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 |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
inputValue | string | — | The value of the ComboBox input (controlled). |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the input value is invalid. |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
lang | string | — | |
menuTrigger | "manual" | "input" | "focus" | — | The interaction required to display the ComboBox menu. |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<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 |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelectionChange | ((key: Key | null) => void) | — | Handler that is called when the selection changes. |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
ref | LegacyRef<HTMLDivElement> | — | Allows getting a ref to the component instance. |
render | DOMRenderFunction<"div", ComboBoxRenderProps> | — | Overrides the default DOM element with a custom render function. |
selectedKey | Key | null | — | The currently selected key in the collection (controlled). |
selectionMode | "single" | — | Whether single or multiple selection is enabled. |
shouldFocusWrap | boolean | — | Whether keyboard navigation is circular. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<ComboBoxRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | Key | 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)| Prop | Type | Default | Description |
|---|---|---|---|
hint | ReactNode | — | Supporting text rendered under the label. Clicks on it are stopped so reading the hint does not toggle the checkbox. |
label | ReactNode | — | 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. |
ref | Ref<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. |
selectedClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoFocus | boolean | — | Whether the element should receive focus on render. |
children | React.ReactNode | ((values: CheckboxRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<CheckboxRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultSelected | boolean | — | Whether the element should be selected (uncontrolled). |
dir | string | — | |
excludeFromTabOrder | boolean | — | Whether to exclude the element from the sequential tab order. If true, |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
inputRef | React.Ref<HTMLInputElement | null> | — | A ref for the HTML input element. |
isDisabled | boolean | — | Whether the input is disabled. |
isIndeterminate | boolean | — | Indeterminism is presentational only. |
isInvalid | boolean | — | Whether the input value is invalid. |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
isSelected | boolean | — | Whether the element should be selected (controlled). |
lang | string | — | |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLLabelElement> | — | |
onAuxClick | MouseEventHandler<HTMLLabelElement> | — | |
onAuxClickCapture | MouseEventHandler<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` |
onClickCapture | MouseEventHandler<HTMLLabelElement> | — | |
onContextMenu | MouseEventHandler<HTMLLabelElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLLabelElement> | — | |
onDoubleClick | MouseEventHandler<HTMLLabelElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLLabelElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLLabelElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | — | |
onMouseDown | MouseEventHandler<HTMLLabelElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLLabelElement> | — | |
onMouseEnter | MouseEventHandler<HTMLLabelElement> | — | |
onMouseLeave | MouseEventHandler<HTMLLabelElement> | — | |
onMouseMove | MouseEventHandler<HTMLLabelElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLLabelElement> | — | |
onMouseOut | MouseEventHandler<HTMLLabelElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLLabelElement> | — | |
onMouseOver | MouseEventHandler<HTMLLabelElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLLabelElement> | — | |
onMouseUp | MouseEventHandler<HTMLLabelElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLLabelElement> | — | |
onPointerCancel | PointerEventHandler<HTMLLabelElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerDown | PointerEventHandler<HTMLLabelElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerEnter | PointerEventHandler<HTMLLabelElement> | — | |
onPointerLeave | PointerEventHandler<HTMLLabelElement> | — | |
onPointerMove | PointerEventHandler<HTMLLabelElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerOut | PointerEventHandler<HTMLLabelElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerOver | PointerEventHandler<HTMLLabelElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerUp | PointerEventHandler<HTMLLabelElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onScroll | UIEventHandler<HTMLLabelElement> | — | |
onScrollCapture | UIEventHandler<HTMLLabelElement> | — | |
onTouchCancel | TouchEventHandler<HTMLLabelElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLLabelElement> | — | |
onTouchEnd | TouchEventHandler<HTMLLabelElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLLabelElement> | — | |
onTouchMove | TouchEventHandler<HTMLLabelElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLLabelElement> | — | |
onTouchStart | TouchEventHandler<HTMLLabelElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLLabelElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLLabelElement> | — | |
onWheel | WheelEventHandler<HTMLLabelElement> | — | |
onWheelCapture | WheelEventHandler<HTMLLabelElement> | — | |
render | DOMRenderFunction<"label", CheckboxRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<CheckboxRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | string | — | The value of the input element, used when submitting an HTML form. See |
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)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | — | |
accentColor | string | — | 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" | |
className | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
defaultValue | string | null | — | The default value (uncontrolled). |
dir | string | — | |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the input value is invalid. |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
lang | string | — | |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
orientation | "horizontal" | "vertical" | — | The axis the Radio Button(s) should align with. |
render | DOMRenderFunction<"div", RadioGroupRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<RadioGroupRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | string | null | — | The current value (controlled). |
<RadioCard />
8 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
title* | ReactNode | — | |
value* | string | — | |
children | ReactNode | — | Extra content under the description, e.g. links. |
description | ReactNode | — | |
isDisabled | boolean | — | |
leading | ReactNode | FC<{ className?: string; }> | — | Icon component (shown in a box), or any element such as an <Avatar /> or a payment icon. |
titleSuffix | ReactNode | — | Lighter text right after the title, e.g. "$10/month" or "@olivia". |
className | string | — |
<RadioPlanCard />
9 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
price* | ReactNode | — | |
title* | ReactNode | — | |
value* | string | — | |
badge | ReactNode | — | Shown top-right in the body, e.g. a <Badge />. |
description | ReactNode | — | |
icon | FC<{ className?: string; }> | — | Icon component shown in a box before the title. |
isDisabled | boolean | — | |
period | ReactNode | — | Text after the price, e.g. "per month". |
className | string | — |
Toggles
Switches for settings that apply immediately.
Source: src/components/base/toggle/toggle.tsx
Toggles
Props
<Toggle />
114 props · 3 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
hint | ReactNode | — | Supporting text rendered under the label. Clicks on it are stopped so reading the hint does not flip the toggle. |
iconOff | ReactNode | FC<{ className?: string; }> | — | Icon shown inside the knob while off, e.g. Sun. |
iconOn | ReactNode | FC<{ className?: string; }> | — | Icon shown inside the knob while on, e.g. Moon01. |
label | string | — | 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" | |
slim | boolean | — | Renders the compact toggle variant, with a shorter track and a bordered knob that overlaps its edges. |
selectedClassName | string | — | Track classes while on, e.g. "bg-gray-900 text-gray-900". text-* sets the "on" icon color. |
trackClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoFocus | boolean | — | Whether the element should receive focus on render. |
children | React.ReactNode | ((values: SwitchRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<SwitchRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultSelected | boolean | — | Whether the element should be selected (uncontrolled). |
dir | string | — | |
excludeFromTabOrder | boolean | — | Whether to exclude the element from the sequential tab order. If true, |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
inputRef | React.Ref<HTMLInputElement | null> | — | A ref for the HTML input element. |
isDisabled | boolean | — | Whether the input is disabled. |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isSelected | boolean | — | Whether the element should be selected (controlled). |
lang | string | — | |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLLabelElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLLabelElement> | — | |
onAuxClick | MouseEventHandler<HTMLLabelElement> | — | |
onAuxClickCapture | MouseEventHandler<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` |
onClickCapture | MouseEventHandler<HTMLLabelElement> | — | |
onContextMenu | MouseEventHandler<HTMLLabelElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLLabelElement> | — | |
onDoubleClick | MouseEventHandler<HTMLLabelElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLLabelElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLLabelElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLLabelElement> | — | |
onMouseDown | MouseEventHandler<HTMLLabelElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLLabelElement> | — | |
onMouseEnter | MouseEventHandler<HTMLLabelElement> | — | |
onMouseLeave | MouseEventHandler<HTMLLabelElement> | — | |
onMouseMove | MouseEventHandler<HTMLLabelElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLLabelElement> | — | |
onMouseOut | MouseEventHandler<HTMLLabelElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLLabelElement> | — | |
onMouseOver | MouseEventHandler<HTMLLabelElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLLabelElement> | — | |
onMouseUp | MouseEventHandler<HTMLLabelElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLLabelElement> | — | |
onPointerCancel | PointerEventHandler<HTMLLabelElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerDown | PointerEventHandler<HTMLLabelElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerEnter | PointerEventHandler<HTMLLabelElement> | — | |
onPointerLeave | PointerEventHandler<HTMLLabelElement> | — | |
onPointerMove | PointerEventHandler<HTMLLabelElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerOut | PointerEventHandler<HTMLLabelElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerOver | PointerEventHandler<HTMLLabelElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLLabelElement> | — | |
onPointerUp | PointerEventHandler<HTMLLabelElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onScroll | UIEventHandler<HTMLLabelElement> | — | |
onScrollCapture | UIEventHandler<HTMLLabelElement> | — | |
onTouchCancel | TouchEventHandler<HTMLLabelElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLLabelElement> | — | |
onTouchEnd | TouchEventHandler<HTMLLabelElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLLabelElement> | — | |
onTouchMove | TouchEventHandler<HTMLLabelElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLLabelElement> | — | |
onTouchStart | TouchEventHandler<HTMLLabelElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLLabelElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLLabelElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLLabelElement> | — | |
onWheel | WheelEventHandler<HTMLLabelElement> | — | |
onWheelCapture | WheelEventHandler<HTMLLabelElement> | — | |
render | DOMRenderFunction<"label", SwitchRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<SwitchRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
translate | "yes" | "no" | — | |
value | string | — | 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
Props
<Slider />
95 props · 4 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
labelFormatter | ((value: number) => string) | — | |
labelPosition | "bottom" | "default" | "top-floating" | "default" | |
fillClassName | string | — | Classes for the filled part of the track, e.g. "bg-[#095E15]". |
thumbClassName | string | — | Classes for the thumb, e.g. "ring-[#095E15]" (border) or "bg-[#095E15]" (fill). |
trackClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((values: SliderRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<SliderRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultValue | number | number[] | — | The default value (uncontrolled). |
dir | string | — | |
formatOptions | Intl.NumberFormatOptions | — | The display format of the value label. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDisabled | boolean | — | Whether the whole Slider is disabled. |
lang | string | — | |
maxValue | number | 100 | The slider's maximum value. |
minValue | number | 0 | The slider's minimum value. |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
orientation | "horizontal" | "vertical" | — | The orientation of the Slider. |
render | DOMRenderFunction<"div", SliderRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
step | number | — | The slider's step value. |
style | StyleOrFunction<SliderRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
translate | "yes" | "no" | — | |
value | number | number[] | — | The current value (controlled). |
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)| Prop | Type | Default | Description |
|---|---|---|---|
accentColor | string | — | Any CSS color for the selected day, range, today dot, focus ring and Apply button, e.g. "#095E15". |
accentHoverColor | string | — | 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. |
triggerClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoComplete | string | — | Describes the type of autocomplete functionality the input should provide if any. See |
autoFocus | boolean | — | Whether the element should receive focus on render. |
children | React.ReactNode | ((values: DatePickerRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<DatePickerRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultOpen | boolean | — | Whether the overlay is open by default (uncontrolled). |
defaultValue | DateValue | null | — | The default value (uncontrolled). |
dir | string | — | |
firstDayOfWeek | "sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | — | The day that starts the week. |
form | string | — | 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"` |
hidden | boolean | — | |
hideTimeZone | boolean | — | Whether to hide the time zone abbreviation. |
hourCycle | 12 | 24 | — | Whether to display the time in 12 or 24 hour format. By default, this is determined by the |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDateUnavailable | ((date: DateValue) => boolean) | — | Callback that is called for each date of the calendar. If it returns true, then the date is |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the input value is invalid. |
isOpen | boolean | — | Whether the overlay is open by default (controlled). |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
lang | string | — | |
maxValue | DateValue | null | — | The maximum allowed date that a user may select. |
minValue | DateValue | null | — | The minimum allowed date that a user may select. |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onOpenChange | ((isOpen: boolean) => void) | — | Handler that is called when the overlay's open state changes. |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
pageBehavior | "single" | "visible" | — | Controls the behavior of paging. Pagination either works by advancing the visible page by |
placeholderValue | DateValue | null | — | A placeholder date that influences the format of the placeholder shown when no value is |
render | DOMRenderFunction<"div", DatePickerRenderProps> | — | Overrides the default DOM element with a custom render function. |
shouldCloseOnSelect | boolean | (() => boolean) | — | Determines whether the date picker popover should close automatically when a date is selected. |
shouldForceLeadingZeros | boolean | — | Whether to always show leading zeros in the month, day, and hour fields. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<DatePickerRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | DateValue | null | — | The current value (controlled). |
<DateRangePicker />
119 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
accentColor | string | — | Any CSS color for the selected day, range, today dot, focus ring and Apply button, e.g. "#095E15". |
accentHoverColor | string | — | 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. |
triggerClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
allowsNonContiguousRanges | boolean | — | When combined with `isDateUnavailable`, determines whether non-contiguous ranges, |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoFocus | boolean | — | Whether the element should receive focus on render. |
children | React.ReactNode | ((values: DateRangePickerRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<DateRangePickerRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultOpen | boolean | — | Whether the overlay is open by default (uncontrolled). |
defaultValue | RangeValue<DateValue> | null | — | The default value (uncontrolled). |
dir | string | — | |
endName | string | — | 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. |
form | string | — | 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"` |
hidden | boolean | — | |
hideTimeZone | boolean | — | Whether to hide the time zone abbreviation. |
hourCycle | 12 | 24 | — | Whether to display the time in 12 or 24 hour format. By default, this is determined by the |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
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 |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the input value is invalid. |
isOpen | boolean | — | Whether the overlay is open by default (controlled). |
isReadOnly | boolean | — | Whether the input can be selected but not changed by the user. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
lang | string | — | |
maxValue | DateValue | null | — | The maximum allowed date that a user may select. |
minValue | DateValue | null | — | The minimum allowed date that a user may select. |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onOpenChange | ((isOpen: boolean) => void) | — | Handler that is called when the overlay's open state changes. |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
pageBehavior | "single" | "visible" | — | Controls the behavior of paging. Pagination either works by advancing the visible page by |
placeholderValue | DateValue | null | — | A placeholder date that influences the format of the placeholder shown when no value is |
render | DOMRenderFunction<"div", DateRangePickerRenderProps> | — | Overrides the default DOM element with a custom render function. |
shouldCloseOnSelect | boolean | (() => boolean) | — | Determines whether the date picker popover should close automatically when a date is selected. |
shouldForceLeadingZeros | boolean | — | Whether to always show leading zeros in the month, day, and hour fields. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
startName | string | — | The name of the start date input element, used when submitting an HTML form. See |
style | StyleOrFunction<DateRangePickerRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | RangeValue<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)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
className | string | — | 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
PDF or DOCX, up to 5 MB
Arun_Resume.pdf
178 KB
Complete
100%
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)| Prop | Type | Default | Description |
|---|---|---|---|
accentColor | string | — | Any CSS color for the drag ring, upload icon and "Click to upload" link, e.g. "#095E15". Inherited from FileUpload.Root. |
accept | string | — | Specifies the types of files that the server accepts. |
allowsMultiple | boolean | true | Allows multiple file uploads. |
hint | string | — | A hint text explaining what files can be dropped. |
isDisabled | boolean | — | Disables dropping or uploading files. |
maxSize | number | — | 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 |
className | string | — | The class name of the drop zone. |
<FileUpload.ListItemProgressBar />
9 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
name* | string | — | The name of the file. |
progress* | number | — | The upload progress of the file. |
size* | number | — | The size of the file. |
failed | boolean | — | 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. |
type | FileType | — | The type of the file. |
className | string | — | 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
Avatar with name
Phoenix Baker
phoenix@impacteers.com
Manikandan Arumugam
Frontend Developer
Props
<Avatar />
16 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
alt | string | — | The alternative text for the avatar image. |
badge | ReactNode | — | Display a badge (i.e. company logo). |
border | boolean | — | Display an outer border around the avatar. |
contrastBorder | boolean | — | Display an inner contrast border around the avatar image. |
count | number | — | Display a count badge. |
focusable | boolean | false | Whether the avatar should show a focus ring when the parent group is in focus. |
initials | string | — | The initials of the user to display if no image is available. |
placeholder | ReactNode | — | A placeholder to display if no image is available. |
placeholderIcon | FC<{ className?: string; }> | — | An icon to display if no image is available. |
rounded | boolean | true | Whether 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. |
src | string | 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. |
verified | boolean | — | Display a verified tick icon. |
className | string | — | The class name for the outer wrapper of the avatar. |
contentClassName | string | — | The class name for the main child of the avatar. |
<AvatarLabelGroup />
21 props · 5 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
size* | "sm" | "md" | "lg" | — | The dimensions of the avatar, which also scale the initials, placeholder icon and status indicator. |
subtitle* | ReactNode | — | |
title* | ReactNode | — | |
alt | string | — | The alternative text for the avatar image. |
badge | ReactNode | — | Display a badge (i.e. company logo). |
border | boolean | — | Display an outer border around the avatar. |
contrastBorder | boolean | — | Display an inner contrast border around the avatar image. |
count | number | — | Display a count badge. |
focusable | boolean | — | Whether the avatar should show a focus ring when the parent group is in focus. |
initials | string | — | The initials of the user to display if no image is available. |
placeholder | ReactNode | — | A placeholder to display if no image is available. |
placeholderIcon | FC<{ className?: string; }> | — | An icon to display if no image is available. |
rounded | boolean | — | Whether the avatar should be rounded. |
src | string | 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. |
verified | boolean | — | Display a verified tick icon. |
avatarClassName | string | — | |
className | string | — | The class name for the outer wrapper of the avatar. |
contentClassName | string | — | The class name for the main child of the avatar. |
subtitleClassName | string | — | Classes for the subtitle text. |
titleClassName | string | — | 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
Dot, icon, flag, removable
Custom text, background and border
Props
<Badge />
5 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
className | string | — | Root element: bg-*, text-*, ring-* (border) classes replace the badge colors. |
<BadgeWithDot />
6 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
addonClassName | string | — | The dot, e.g. "text-[#095E15]". |
className | string | — | Root element: bg-*, text-*, ring-* (border) classes replace the badge colors. |
<BadgeWithIcon />
8 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
iconLeading | IconComponentType | — | An icon component rendered before the label. Providing it also switches the badge to the tighter leading padding. |
iconTrailing | IconComponentType | — | 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. |
addonClassName | string | — | The leading/trailing icon, e.g. "text-[#095E15]". |
className | string | — | Root element: bg-*, text-*, ring-* (border) classes replace the badge colors. |
<BadgeWithFlag />
6 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
className | string | — | Root element: bg-*, text-*, ring-* (border) classes replace the badge colors. |
<BadgeWithButton />
9 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | — | The content shown before the button, usually a short text label. |
buttonLabel | string | — | 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`. |
icon | IconComponentType | CloseX | The icon component rendered inside the trailing button, typically a dismiss icon. |
onButtonClick | MouseEventHandler<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. |
addonClassName | string | — | The close (×) button, e.g. "text-[#095E15]". |
className | string | — | Root element: bg-*, text-*, ring-* (border) classes replace the badge colors. |
<BadgeIcon />
7 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
icon* | FunctionComponent<{ className?: string; strokeWidth?: string | number; }> | — | The icon component rendered as the sole content of the badge. |
children | ReactNode | — | 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. |
addonClassName | string | — | The icon, e.g. "text-[#095E15]". |
className | string | — | 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
Props
<BadgeGroup />
8 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
addonText* | string | — | |
color* | "brand" | "gray" | "warning" | "error" | "success" | "brand" | |
align | "leading" | "trailing" | "leading" | Alignment of the badge addon element. |
children | ReactNode | — | |
iconTrailing | ReactNode | FC<{ className?: string; }> | ArrowRight | |
size | "md" | "lg" | "md" | |
theme | "light" | "modern" | "light" | |
className | string | — |
Tooltips
Extra info on hover or focus.
Source: src/components/base/tooltip/tooltip.tsx
Tooltips
Props
<Tooltip />
99 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
title* | ReactNode | — | The title of the tooltip. |
arrow | boolean | false | Whether to show the arrow on the tooltip. |
delay | number | 300 | Delay in milliseconds before the tooltip is shown. |
description | ReactNode | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
arrowBoundaryOffset | number | — | 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 | — | |
className | ClassNameOrFunction<TooltipRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
closeDelay | number | 0 | The delay time for the tooltip to close. [See |
containerPadding | number | — | The placement padding that should be applied between the element and its |
crossOffset | number | — | The additional offset applied along the cross axis between the element and its |
defaultOpen | boolean | — | Whether the overlay is open by default (uncontrolled). |
dir | string | — | |
hidden | boolean | — | |
inert | boolean | — | |
isDisabled | boolean | — | Whether the tooltip should be disabled, independent from the trigger. |
isEntering | boolean | — | Whether the tooltip is currently performing an entry animation. |
isExiting | boolean | — | Whether the tooltip is currently performing an exit animation. |
isOpen | boolean | — | Whether the overlay is open by default (controlled). |
lang | string | — | |
offset | number | 6 | The additional offset applied along the main axis between the element and its |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onOpenChange | ((isOpen: boolean) => void) | — | Handler that is called when the overlay's open state changes. |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<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. |
render | DOMRenderFunction<"div", TooltipRenderProps> | — | Overrides the default DOM element with a custom render function. |
shouldCloseOnPress | boolean | — | Whether the tooltip should close when the trigger is pressed. |
shouldFlip | boolean | — | Whether the element should flip its orientation (e.g. top to bottom or left to right) when |
style | StyleOrFunction<TooltipRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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. |
triggerRef | RefObject<Element | null> | — | The ref for the element which the tooltip positions itself with respect to. |
UNSTABLE_portalContainer | Element | — | 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
Impacteers gradient (3 colors)
Score gauge (orange → green)
Props
<ProgressBar />
7 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
max | number | 100 | The maximum value of the progress bar. |
min | number | 0 | The minimum value of the progress bar. |
valueFormatter | ((value: number, valueInPercentage: number) => string | number) | — | Optional function to format the displayed value. |
className | string | — | Optional additional CSS class names for the progress bar container. |
progressClassName | string | — | Optional additional CSS class names for the progress bar indicator element. |
<ProgressBarCircle />
12 props · 5 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
size* | "xs" | "sm" | "md" | "lg" | "xxs" | — | |
value* | number | — | |
label | string | — | |
max | number | 100 | |
min | number | 0 | |
progressGradient | string[] | — | 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) | — | |
className | string | — | Outer wrapper. |
labelClassName | string | — | The label text. |
progressClassName | string | — | The filled part of the ring, e.g. "stroke-[#095E15]". Use stroke-* classes. |
trackClassName | string | — | The empty ring behind the progress, e.g. "stroke-gray-200". Use stroke-* classes. |
valueClassName | string | — | The percentage text. |
<ProgressBarHalfCircle />
12 props · 5 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
size* | "xs" | "sm" | "md" | "lg" | "xxs" | — | |
value* | number | — | |
label | string | — | |
max | number | 100 | |
min | number | 0 | |
progressGradient | string[] | — | 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) | — | |
className | string | — | Outer wrapper. |
labelClassName | string | — | The label text. |
progressClassName | string | — | The filled part of the ring, e.g. "stroke-[#095E15]". Use stroke-* classes. |
trackClassName | string | — | The empty ring behind the progress, e.g. "stroke-gray-200". Use stroke-* classes. |
valueClassName | string | — | The percentage text. |
Loading indicators
Spinners for loading and processing states.
Source: src/components/application/loading-indicator/loading-indicator.tsx
Spinners
Props
<LoadingIndicator />
7 props · 4 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
label | string | — | 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. |
className | string | — | Outer wrapper. |
labelClassName | string | — | The label text. |
spinnerClassName | string | — | Spinner color, e.g. "text-[#095E15]". Use text-* classes (works for every type). |
trackClassName | string | — | The faint ring behind the "line-simple" spinner, e.g. "text-gray-200". |
Featured icons
Icons in a tinted container, for cards, modals and empty states.
Source: src/components/foundations/featured-icon/featured-icon.tsx
Themes and colors
Props
<FeaturedIcon />
7 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
color* | "brand" | "gray" | "warning" | "error" | "success" | "brand" | 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`. |
children | ReactNode | — | Extra content rendered inside the wrapper, alongside the icon. |
icon | ReactNode | FC<{ className?: string; }> | — | The icon to display. Accepts a component reference or a rendered element. |
ref | Ref<HTMLDivElement> | — | A ref to the wrapper element. |
size | "sm" | "md" | "lg" | "xl" | "sm" | Controls the dimensions of the wrapper and the icon inside it. |
theme | "light" | "dark" | "modern" | "gradient" | "outline" | "modern-neue" | "light" | The visual treatment of the icon container, from a subtle tinted circle to a solid, outlined or skeuomorphic surface. |
className | string | — | The class name applied to the wrapper. |
Illustrations
Small illustrations for empty states.
Source: src/components/shared-assets/illustrations/
Illustrations
Props
<Illustration />
281 props · 3 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
type* | "box" | "cloud" | "documents" | "credit-card" | — | |
size | "sm" | "md" | "lg" | — | |
childrenClassName | string | — | |
svgClassName | string | — |
›277 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
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)| Prop | Type | Default | Description |
|---|---|---|---|
value* | string | — | The value to encode in the QR code. |
options | QRCodeStylingOptions | — | Additional options to customize the QR code. |
size | "md" | "lg" | "md" | The size of the QR code. |
className | string | — | 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
Sizes
Custom colors
Props
<RatingStars />
282 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
color | string | — | Any CSS color for the filled part of the stars, e.g. "#095E15". |
emptyColor | string | — | Any CSS color for the unfilled part of the stars, e.g. "#E8F3EA". |
rating | number | 5 | The rating to display. |
size | "xs" | "sm" | "md" | "lg" | "xl" | "md" | Star size: xs (12px) · sm (16px) · md (20px) · lg (24px) · xl (32px). |
stars | number | 5 | The number of stars to display. |
starClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
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
Video player md
Video player lg
Props
<VideoPlayer />
10 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
src* | string | — | The URL of the video. |
autoPlay | boolean | false | Whether the video should start playing as soon as it's ready. |
ref | Ref<VideoPlayerRef> | — | Ref to access imperative methods (play, pause, etc.). |
showThumbnailOverlay | boolean | — | Whether to show a semi-transparent overlay on top of the thumbnail image. |
size | "sm" | "md" | "lg" | "md" | Size of the video player. |
thumbnailAlt | string | — | Alt text for the thumbnail image. |
thumbnailUrl | string | — | URL of the thumbnail image to show before the video starts playing. |
type | string | "video/mp4" | The MIME type of the video. |
className | string | — | Class name for the player wrapper. |
thumbnailButtonClassName | string | — | 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| Prop | Type | Default | Description |
|---|---|---|---|
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. |
dismissLabel | string | "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)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
dismissLabel | string | "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. |
className | string | — | 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
Dual line
Background fill
Props
<ContentDivider />
3 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
className | string | — | 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

Carousel lg

Props
<Carousel.Root />
282 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
opts | Partial<OptionsType> | — | The options for the Embla carousel. |
orientation | "horizontal" | "vertical" | "horizontal" | The orientation of the carousel. |
plugins | CreatePluginType<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…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
<Carousel.Content />
279 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
overflowHidden | boolean | true | Whether to hide the overflow. |
className | string | — | The class name of the content. |
›277 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
<Carousel.Item />
278 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| No props of its own — everything comes from react, next (below). | |||
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
<Carousel.PrevTrigger />
5 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | ((props: TriggerRenderProps) => ReactNode) | — | The children of the trigger. Can be a render prop or a valid element. |
asChild | boolean | — | If true, the child element will be cloned and passed down the prop of the trigger. |
ref | Ref<HTMLButtonElement> | — | The ref of the trigger. |
style | CSSProperties | — | The style of the trigger. |
className | string | ((args: { isDisabled: boolean; }) => string) | — | The class name of the trigger. |
<Carousel.NextTrigger />
5 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | ((props: TriggerRenderProps) => ReactNode) | — | The children of the trigger. Can be a render prop or a valid element. |
asChild | boolean | — | If true, the child element will be cloned and passed down the prop of the trigger. |
ref | Ref<HTMLButtonElement> | — | The ref of the trigger. |
style | CSSProperties | — | The style of the trigger. |
className | string | ((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.
Image notification
We've just released a new feature
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquid pariatur, ipsum dolor.

Avatar notification
Drew Cano
2 mins agoHey Olivia, can you please review the latest design when you can?
Props
<IconNotification />
10 props| Prop | Type | Default | Description |
|---|---|---|---|
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. |
confirmLabel | string | — | Label for the primary action button. The button is only rendered when a label is provided. |
dismissLabel | string | "Dismiss" | Label for the secondary text button that triggers `onClose`. |
hideDismissLabel | boolean | — | Whether to hide the dismiss text button. The close icon button in the top-right corner is always rendered. |
icon | FC<{ 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. |
progress | number | — | 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| Prop | Type | Default | Description |
|---|---|---|---|
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. |
dismissLabel | string | "Dismiss" | Label for the secondary text button that triggers `onClose`. |
hideDismissLabel | boolean | — | Whether to hide the dismiss text button. The close icon button in the top-right corner is always rendered. |
icon | FC<{ 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| Prop | Type | Default | Description |
|---|---|---|---|
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. |
dismissLabel | string | "Dismiss" | Label for the secondary text button that triggers `onClose`. |
hideDismissLabel | boolean | — | 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
Without line number
Show more
With tabs
Props
<CodeSnippet />
283 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
language* | SupportedLanguages | SpecialLanguage | (string & Nothing) | — | The programming language of the code snippet. |
children | ReactNode | — | Pre-highlighted code nodes that were generated on the server. |
code | string | — | The code to be syntax highlighted. Can be provided in two ways: |
maxHeight | number | — | Maximum height (in px) before the "Show more" overlay appears. |
modern | boolean | true | Whether to show the modern shadow wrapper. |
onExpand | (() => void) | — | Callback fired when the expand button is clicked. |
showLineNumbers | boolean | true | Whether 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
<CodeSnippet.Tabs />
87 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((values: TabsRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<TabsRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultSelectedKey | Key | — | The initial selected keys in the collection (uncontrolled). |
dir | string | — | |
disabledKeys | Iterable<Key> | — | The item keys that are disabled. These items cannot be selected, focused, or otherwise |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDisabled | boolean | — | Whether the TabList is disabled. |
keyboardActivation | "manual" | "automatic" | — | Whether tabs are activated automatically on focus or manually. |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelectionChange | ((key: Key) => void) | — | Handler that is called when the selection changes. |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
orientation | "horizontal" | "vertical" | — | The orientation of the tabs. |
render | DOMRenderFunction<"div", TabsRenderProps> | — | Overrides the default DOM element with a custom render function. |
selectedKey | Key | — | The currently selected key in the collection (controlled). |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<TabsRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((item: T) => ReactNode) | — | The contents of the collection. |
className | ClassNameOrFunction<TabListRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dependencies | readonly any[] | — | Values that should invalidate the item cache when using dynamic collections. |
dir | string | — | |
hidden | boolean | — | |
inert | boolean | — | |
items | Iterable<T> | — | Item objects in the collection. |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
render | DOMRenderFunction<"div", TabListRenderProps> | — | Overrides the default DOM element with a custom render function. |
style | StyleOrFunction<TabListRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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)| Prop | Type | Default | Description |
|---|---|---|---|
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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
className | ClassNameOrFunction<TabRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dir | string | — | |
download | string | boolean | — | Causes the browser to download the linked URL. A string may be provided to suggest a file name. |
hidden | boolean | — | |
href | string | — | A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href). |
hrefLang | string | — | Hints at the human language of the linked URL. |
id | Key | — | The unique id of the tab. |
inert | boolean | — | |
isDisabled | boolean | — | Whether the tab is disabled. |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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` |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
ping | string | — | 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 |
rel | string | — | 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. |
routerOptions | undefined | — | Options for the configured client side router. |
style | StyleOrFunction<TabRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
target | HTMLAttributeAnchorTarget | — | The target window for the link. See |
translate | "yes" | "no" | — |
<CodeSnippet.TabPanel />
80 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((values: TabPanelRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<TabPanelRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dir | string | — | |
hidden | boolean | — | |
id | Key | — | The unique id of the tab. |
inert | boolean | — | |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
render | DOMRenderFunction<"div", TabPanelRenderProps> | — | Overrides the default DOM element with a custom render function. |
shouldForceMount | boolean | — | Whether to mount the tab panel in the DOM even when it is not currently selected. Inactive tab |
style | StyleOrFunction<TabPanelRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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
Transparency slider
Opacity
100%Palette picker
Palette
Props
<Provider />
5 props| Prop | Type | Default | Description |
|---|---|---|---|
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. |
defaultValue | string | Color | "#7F56D9" | Initial color value as a CSS string or React Aria Color object. |
onChange | ((color: Color) => void) | — | Called when the selected color changes. |
value | string | Color | — | Controlled color value as a CSS string or React Aria Color object. |
<ColorPicker.Dialog />
2 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children | string | 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. |
className | string | — | Additional class name for the card. Useful for overriding the default fixed width. |
<ColorPicker.Area />
91 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((values: ColorAreaRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<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 |
defaultValue | string | Color | — | The default value (uncontrolled). |
dir | string | — | |
form | string | — | The `<form>` element to associate the ColorArea with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDisabled | boolean | — | Whether the ColorArea is disabled. |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
render | DOMRenderFunction<"div", ColorAreaRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<ColorAreaRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
translate | "yes" | "no" | — | |
value | string | Color | — | The current value (controlled). |
xChannel | "blue" | "hue" | "saturation" | "brightness" | "lightness" | "red" | "green" | "alpha" | — | Color channel for the horizontal axis. |
xName | string | — | 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. |
yName | string | — | The name of the y channel input element, used when submitting an HTML form. See |
<ColorPicker.HueSlider />
89 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((values: ColorSliderRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<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. |
defaultValue | string | Color | — | The default value (uncontrolled). |
dir | string | — | |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDisabled | boolean | — | Whether the whole Slider is disabled. |
lang | string | — | |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
orientation | "horizontal" | "vertical" | — | The orientation of the Slider. |
render | DOMRenderFunction<"div", ColorSliderRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<ColorSliderRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
translate | "yes" | "no" | — | |
value | string | Color | — | The current value (controlled). |
<ColorPicker.AlphaSlider />
89 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((values: ColorSliderRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<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. |
defaultValue | string | Color | — | The default value (uncontrolled). |
dir | string | — | |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDisabled | boolean | — | Whether the whole Slider is disabled. |
lang | string | — | |
name | string | — | The name of the input element, used when submitting an HTML form. See |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
orientation | "horizontal" | "vertical" | — | The orientation of the Slider. |
render | DOMRenderFunction<"div", ColorSliderRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<ColorSliderRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
translate | "yes" | "no" | — | |
value | string | Color | — | The current value (controlled). |
<ColorPicker.EyeDropper />
120 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children | ReactNode | — | 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 |
iconLeading | ReactNode | FC<{ className?: string; }> | — | Icon component or element to show before the text |
iconTrailing | ReactNode | FC<{ className?: string; }> | — | Icon component or element to show after the text |
isDisabled | boolean | — | Disables the button and shows a disabled state |
isLoading | boolean | — | Shows a loading spinner and disables the button |
noTextPadding | boolean | — | Removes horizontal padding from the text content |
showTextWhileLoading | boolean | — | When true, keeps the text visible during loading state |
size | "xs" | "sm" | "md" | "lg" | "xl" | — | The size variant of the button |
className | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates whether this element represents the current item within a container or set of related |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-disabled | boolean | "true" | "false" | — | Indicates whether the element is disabled to users of assistive technology. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded |
aria-haspopup | boolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog" | — | Indicates the availability and type of interactive popup element, such as menu or dialog, that |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
autoFocus | boolean | — | Whether the element should receive focus on render. |
dir | string | — | |
excludeFromTabOrder | boolean | — | Whether to exclude the element from the sequential tab order. If true, |
form | string | — | The `<form>` element to associate the button with. |
formAction | string | ((formData: FormData) => void | Promise<void>) | — | The URL that processes the information submitted by the button. |
formEncType | string | — | Indicates how to encode the form data that is submitted. |
formMethod | string | — | Indicates the HTTP method used to submit the form. |
formNoValidate | boolean | — | Indicates that the form is not to be validated when it is submitted. |
formTarget | string | — | Overrides the target attribute of the button's form owner. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isPending | boolean | — | Whether the button is in a pending state. This disables press and hover events |
lang | string | — | |
name | string | — | Submitted as a pair with the button's value as part of the form data. |
onAnimationEnd | AnimationEventHandler<HTMLButtonElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLButtonElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLButtonElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLButtonElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLButtonElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLButtonElement> | — | |
onAuxClick | MouseEventHandler<HTMLButtonElement> | — | |
onAuxClickCapture | MouseEventHandler<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` |
onClickCapture | MouseEventHandler<HTMLButtonElement> | — | |
onContextMenu | MouseEventHandler<HTMLButtonElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLButtonElement> | — | |
onDoubleClick | MouseEventHandler<HTMLButtonElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLButtonElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLButtonElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLButtonElement> | — | |
onMouseDown | MouseEventHandler<HTMLButtonElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLButtonElement> | — | |
onMouseEnter | MouseEventHandler<HTMLButtonElement> | — | |
onMouseLeave | MouseEventHandler<HTMLButtonElement> | — | |
onMouseMove | MouseEventHandler<HTMLButtonElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLButtonElement> | — | |
onMouseOut | MouseEventHandler<HTMLButtonElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLButtonElement> | — | |
onMouseOver | MouseEventHandler<HTMLButtonElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLButtonElement> | — | |
onMouseUp | MouseEventHandler<HTMLButtonElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLButtonElement> | — | |
onPointerCancel | PointerEventHandler<HTMLButtonElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLButtonElement> | — | |
onPointerDown | PointerEventHandler<HTMLButtonElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLButtonElement> | — | |
onPointerEnter | PointerEventHandler<HTMLButtonElement> | — | |
onPointerLeave | PointerEventHandler<HTMLButtonElement> | — | |
onPointerMove | PointerEventHandler<HTMLButtonElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLButtonElement> | — | |
onPointerOut | PointerEventHandler<HTMLButtonElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLButtonElement> | — | |
onPointerOver | PointerEventHandler<HTMLButtonElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLButtonElement> | — | |
onPointerUp | PointerEventHandler<HTMLButtonElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onScroll | UIEventHandler<HTMLButtonElement> | — | |
onScrollCapture | UIEventHandler<HTMLButtonElement> | — | |
onTouchCancel | TouchEventHandler<HTMLButtonElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLButtonElement> | — | |
onTouchEnd | TouchEventHandler<HTMLButtonElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLButtonElement> | — | |
onTouchMove | TouchEventHandler<HTMLButtonElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLButtonElement> | — | |
onTouchStart | TouchEventHandler<HTMLButtonElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLButtonElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLButtonElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLButtonElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLButtonElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLButtonElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLButtonElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLButtonElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLButtonElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLButtonElement> | — | |
onWheel | WheelEventHandler<HTMLButtonElement> | — | |
onWheelCapture | WheelEventHandler<HTMLButtonElement> | — | |
preventFocusOnPress | boolean | — | Whether to prevent focus from moving to the button when pressing it. |
render | DOMRenderFunction<"button", ButtonRenderProps> | — | Overrides the default DOM element with a custom render function. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<ButtonRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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. |
value | string | — | The value associated with the button's name when it's submitted with the form data. |
<ColorPicker.ColorFormatSelect />
117 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
hideRequiredIndicator | boolean | — | Whether to hide the required indicator from the label. |
hint | string | — | Helper text displayed below the input. |
icon | ReactNode | 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. |
items | SelectItemType[] | — | The options to render in the dropdown. When `children` is a function it is called once per item to render it. |
label | string | — | Field label displayed above the input. |
size | "sm" | "md" | "lg" | — | The size of the component. |
tooltip | string | — | Tooltip text for the help icon next to the label. |
popoverClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
allowsEmptyCollection | boolean | — | Whether the select should be allowed to be open when the collection is empty. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoComplete | string | — | Describes the type of autocomplete functionality the input should provide if any. See |
autoFocus | boolean | — | Whether the element should receive focus on render. |
className | ClassNameOrFunction<SelectRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultOpen | boolean | — | Sets the default open state of the menu. |
defaultSelectedKey | Key | null | — | The initial selected key in the collection (uncontrolled). |
defaultValue | Key | null | — | The default value (uncontrolled). |
dir | string | — | |
disabledKeys | Iterable<Key> | — | The item keys that are disabled. These items cannot be selected, focused, or otherwise |
excludeFromTabOrder | boolean | — | Whether to exclude the element from the sequential tab order. If true, |
form | string | — | The `<form>` element to associate the input with. |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDisabled | boolean | — | Whether the input is disabled. |
isInvalid | boolean | — | Whether the input value is invalid. |
isOpen | boolean | — | Sets the open state of the menu. |
isRequired | boolean | — | Whether user input is required on the input before form submission. |
lang | string | — | |
name | string | — | The name of the input, used when submitting an HTML form. |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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. |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onOpenChange | ((isOpen: boolean) => void) | — | Method that is called when the open state of the menu changes. |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelectionChange | ((key: Key | null) => void) | — | Handler that is called when the selection changes. |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
placeholder | string | — | Temporary text that occupies the select when it is empty. |
ref | LegacyRef<HTMLDivElement> | — | Allows getting a ref to the component instance. |
render | DOMRenderFunction<"div", SelectRenderProps> | — | Overrides the default DOM element with a custom render function. |
selectedKey | Key | null | — | The currently selected key in the collection (controlled). |
selectionMode | "single" | — | Whether single or multiple selection is enabled. |
shouldCloseOnSelect | boolean | — | Whether the Select should close when an item is selected. Defaults to true if selectionMode is |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<SelectRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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 |
value | Key | null | — | The current value (controlled). |
<ColorPicker.SavedColors />
4 props| Prop | Type | Default | Description |
|---|---|---|---|
colors* | string[] | — | Array of CSS color strings or gradient strings to display as swatches. |
label | string | "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)| Prop | Type | Default | Description |
|---|---|---|---|
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…)
| Prop | Type | Default | Description |
|---|---|---|---|
children | React.ReactNode | ((values: ColorSwatchPickerItemRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<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. |
dir | string | — | |
hidden | boolean | — | |
inert | boolean | — | |
isDisabled | boolean | — | Whether the color swatch is disabled. |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | ((e: MouseEvent<FocusableElement>) => void) | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
render | DOMRenderFunction<"div", ColorSwatchPickerItemRenderProps> | — | Overrides the default DOM element with a custom render function. |
style | StyleOrFunction<ColorSwatchPickerItemRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
className | string | — | 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| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | — | The gradient picker parts that read and update the shared gradient state. |
defaultAngle | number | 135 | Initial gradient angle in degrees. |
defaultStops | GradientStop[] | — | 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
Message simple
Phoenix Baker Hey Olivia, can you please review the latest design when you can?
Message reactions
Phoenix Baker Hey Olivia, can you please review the latest design when you can?- ❤️
- 👌2
Message reply
Phoenix Baker Sure thing, I'll have a look today.
Awesome, thanks!
Message attachment
Phoenix Baker Latest design screenshot.jpg
1.2 MB
Message audio
Phoenix Baker 00:28
Message image
Phoenix Baker 
Latest design screenshot.jpg128 KB
Message link preview
Phoenix Baker
Message link minimal
Phoenix Baker
Message writing
Phoenix Baker
Props
<MessageItem />
281 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
showUserLabel | boolean | true | Whether 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLLIElement> | — | |
onAbortCapture | ReactEventHandler<HTMLLIElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLLIElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLLIElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLLIElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLLIElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLLIElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLLIElement> | — | |
onAuxClick | MouseEventHandler<HTMLLIElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLLIElement> | — | |
onBeforeInput | InputEventHandler<HTMLLIElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLLIElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLLIElement> | — | |
onBlur | FocusEventHandler<HTMLLIElement> | — | |
onBlurCapture | FocusEventHandler<HTMLLIElement> | — | |
onCanPlay | ReactEventHandler<HTMLLIElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLLIElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLLIElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLLIElement> | — | |
onChange | FormEventHandler<HTMLLIElement> | — | |
onChangeCapture | FormEventHandler<HTMLLIElement> | — | |
onClick | MouseEventHandler<HTMLLIElement> | — | |
onClickCapture | MouseEventHandler<HTMLLIElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLLIElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLLIElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLLIElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLLIElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLLIElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLLIElement> | — | |
onContextMenu | MouseEventHandler<HTMLLIElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLLIElement> | — | |
onCopy | ClipboardEventHandler<HTMLLIElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLLIElement> | — | |
onCut | ClipboardEventHandler<HTMLLIElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLLIElement> | — | |
onDoubleClick | MouseEventHandler<HTMLLIElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLLIElement> | — | |
onDrag | DragEventHandler<HTMLLIElement> | — | |
onDragCapture | DragEventHandler<HTMLLIElement> | — | |
onDragEnd | DragEventHandler<HTMLLIElement> | — | |
onDragEndCapture | DragEventHandler<HTMLLIElement> | — | |
onDragEnter | DragEventHandler<HTMLLIElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLLIElement> | — | |
onDragExit | DragEventHandler<HTMLLIElement> | — | |
onDragExitCapture | DragEventHandler<HTMLLIElement> | — | |
onDragLeave | DragEventHandler<HTMLLIElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLLIElement> | — | |
onDragOver | DragEventHandler<HTMLLIElement> | — | |
onDragOverCapture | DragEventHandler<HTMLLIElement> | — | |
onDragStart | DragEventHandler<HTMLLIElement> | — | |
onDragStartCapture | DragEventHandler<HTMLLIElement> | — | |
onDrop | DragEventHandler<HTMLLIElement> | — | |
onDropCapture | DragEventHandler<HTMLLIElement> | — | |
onDurationChange | ReactEventHandler<HTMLLIElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLLIElement> | — | |
onEmptied | ReactEventHandler<HTMLLIElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLLIElement> | — | |
onEncrypted | ReactEventHandler<HTMLLIElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLLIElement> | — | |
onEnded | ReactEventHandler<HTMLLIElement> | — | |
onEndedCapture | ReactEventHandler<HTMLLIElement> | — | |
onError | ReactEventHandler<HTMLLIElement> | — | |
onErrorCapture | ReactEventHandler<HTMLLIElement> | — | |
onFocus | FocusEventHandler<HTMLLIElement> | — | |
onFocusCapture | FocusEventHandler<HTMLLIElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLLIElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLLIElement> | — | |
onInput | FormEventHandler<HTMLLIElement> | — | |
onInputCapture | FormEventHandler<HTMLLIElement> | — | |
onInvalid | FormEventHandler<HTMLLIElement> | — | |
onInvalidCapture | FormEventHandler<HTMLLIElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLLIElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLLIElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLLIElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLLIElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLLIElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLLIElement> | — | |
onLoad | ReactEventHandler<HTMLLIElement> | — | |
onLoadCapture | ReactEventHandler<HTMLLIElement> | — | |
onLoadedData | ReactEventHandler<HTMLLIElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLLIElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLLIElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLLIElement> | — | |
onLoadStart | ReactEventHandler<HTMLLIElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLLIElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLLIElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLLIElement> | — | |
onMouseDown | MouseEventHandler<HTMLLIElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLLIElement> | — | |
onMouseEnter | MouseEventHandler<HTMLLIElement> | — | |
onMouseLeave | MouseEventHandler<HTMLLIElement> | — | |
onMouseMove | MouseEventHandler<HTMLLIElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLLIElement> | — | |
onMouseOut | MouseEventHandler<HTMLLIElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLLIElement> | — | |
onMouseOver | MouseEventHandler<HTMLLIElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLLIElement> | — | |
onMouseUp | MouseEventHandler<HTMLLIElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLLIElement> | — | |
onPaste | ClipboardEventHandler<HTMLLIElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLLIElement> | — | |
onPause | ReactEventHandler<HTMLLIElement> | — | |
onPauseCapture | ReactEventHandler<HTMLLIElement> | — | |
onPlay | ReactEventHandler<HTMLLIElement> | — | |
onPlayCapture | ReactEventHandler<HTMLLIElement> | — | |
onPlaying | ReactEventHandler<HTMLLIElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLLIElement> | — | |
onPointerCancel | PointerEventHandler<HTMLLIElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLLIElement> | — | |
onPointerDown | PointerEventHandler<HTMLLIElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLLIElement> | — | |
onPointerEnter | PointerEventHandler<HTMLLIElement> | — | |
onPointerLeave | PointerEventHandler<HTMLLIElement> | — | |
onPointerMove | PointerEventHandler<HTMLLIElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLLIElement> | — | |
onPointerOut | PointerEventHandler<HTMLLIElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLLIElement> | — | |
onPointerOver | PointerEventHandler<HTMLLIElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLLIElement> | — | |
onPointerUp | PointerEventHandler<HTMLLIElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLLIElement> | — | |
onProgress | ReactEventHandler<HTMLLIElement> | — | |
onProgressCapture | ReactEventHandler<HTMLLIElement> | — | |
onRateChange | ReactEventHandler<HTMLLIElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLLIElement> | — | |
onReset | FormEventHandler<HTMLLIElement> | — | |
onResetCapture | FormEventHandler<HTMLLIElement> | — | |
onScroll | UIEventHandler<HTMLLIElement> | — | |
onScrollCapture | UIEventHandler<HTMLLIElement> | — | |
onSeeked | ReactEventHandler<HTMLLIElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLLIElement> | — | |
onSeeking | ReactEventHandler<HTMLLIElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLLIElement> | — | |
onSelect | ReactEventHandler<HTMLLIElement> | — | |
onSelectCapture | ReactEventHandler<HTMLLIElement> | — | |
onStalled | ReactEventHandler<HTMLLIElement> | — | |
onStalledCapture | ReactEventHandler<HTMLLIElement> | — | |
onSubmit | FormEventHandler<HTMLLIElement> | — | |
onSubmitCapture | FormEventHandler<HTMLLIElement> | — | |
onSuspend | ReactEventHandler<HTMLLIElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLLIElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLLIElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLLIElement> | — | |
onToggle | ToggleEventHandler<HTMLLIElement> | — | |
onTouchCancel | TouchEventHandler<HTMLLIElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLLIElement> | — | |
onTouchEnd | TouchEventHandler<HTMLLIElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLLIElement> | — | |
onTouchMove | TouchEventHandler<HTMLLIElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLLIElement> | — | |
onTouchStart | TouchEventHandler<HTMLLIElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLLIElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLLIElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLLIElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLLIElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLLIElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLLIElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLLIElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLLIElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLLIElement> | — | |
onVolumeChange | ReactEventHandler<HTMLLIElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLLIElement> | — | |
onWaiting | ReactEventHandler<HTMLLIElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLLIElement> | — | |
onWheel | WheelEventHandler<HTMLLIElement> | — | |
onWheelCapture | WheelEventHandler<HTMLLIElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
value | string | number | readonly string[] | — | |
vocab | string | — |
<MessageStatus />
2 props| Prop | Type | Default | Description |
|---|---|---|---|
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". |
readAt | string | — | 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
Members
1,210
Active now
316
Simple actions
Total customers
2,420
Members
1,210
Active now
316
Metrics icon 01
Total customers
2,420
Members
1,210
Active now
316
Metrics icon actions 01
Total customers
2,420
Members
1,210
Active now
316
Metrics icon 02
Total customers
2,420
Members
1,210
Active now
316
Metrics icon actions 02
Total customers
2,420
Members
1,210
Active now
316
Metrics icon 03
Total customers
2,420
Members
1,210
Active now
316
Metrics icon actions 03
Total customers
2,420
Members
1,210
Active now
316
Metrics icon 04
Total customers
2,420
Members
1,210
Active now
316
Metrics icon actions 04
Total customers
2,420
Members
1,210
Active now
316
Chart 01
Total customers
2,420
Members
1,210
Active now
316
Chart actions 01
Total customers
2,420
Members
1,210
Active now
316
Chart 02
Total customers
2,420
Members
1,210
Active now
316
Chart actions 02
Total customers
2,420
Members
1,210
Active now
316
Chart 03
Total customers
2,420
Members
1,210
Active now
316
Chart actions 03
Total customers
2,420
Members
1,210
Active now
316
Chart 04
Total customers
2,420
Members
1,210
Active now
316
Chart actions 04
Total customers
2,420
Members
1,210
Active now
316
Props
<MetricsSimple />
7 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
change | string | — | The change amount rendered inside the indicator, such as "100%". |
footer | ReactNode | — | Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed. |
subtitle | string | "View 24 hours" | Label above the figure naming the metric or the period it covers. |
title | string | "2,000" | The metric's headline figure, rendered as the large display number. |
className | string | — | Additional CSS classes to apply to the card. |
<MetricsIcon01 />
4 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
footer | ReactNode | — | Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed. |
subtitle | string | "View 24 hours" | Label above the figure naming the metric or the period it covers. |
title | string | "2,000" | The metric's headline figure, rendered as the large display number. |
className | string | — | Additional CSS classes to apply to the card. |
<MetricsIcon02 />
4 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
footer | ReactNode | — | Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed. |
subtitle | string | "View 24 hours" | Heading shown next to the featured icon at the top of the card. |
title | string | "2,000" | The metric's headline figure, rendered as the large display number. |
className | string | — | Additional CSS classes to apply to the card. |
<MetricsIcon03 />
8 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
actions | boolean | true | Whether to render the actions dropdown button in the top-right corner of the card. |
change | string | "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. |
footer | ReactNode | — | Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed. |
icon | FC<{ className?: string; }> | TrendUp01 | Icon component rendered inside the featured icon block above the metric. |
subtitle | string | "View 24 hours" | Label above the figure naming the metric or the period it covers. |
title | string | "2,000" | The metric's headline figure, rendered as the large display number. |
className | string | — | Additional CSS classes to apply to the card. |
<MetricsIcon04 />
8 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
actions | boolean | true | Whether to render the actions dropdown button in the top-right corner of the card. |
change | string | "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. |
footer | ReactNode | — | Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed. |
icon | FC<{ className?: string; }> | TrendUp01 | Icon component rendered inside the featured icon block beside the metric. |
subtitle | string | "View 24 hours" | Label above the figure naming the metric or the period it covers. |
title | string | "2,000" | The metric's headline figure, rendered as the large display number. |
className | string | — | Additional CSS classes to apply to the card. |
<MetricsChart01 />
9 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
actions | boolean | true | Whether to render the actions dropdown button in the top-right corner of the card. |
change | string | "100%" | The change amount rendered inside the indicator, such as "100%". |
changeDescription | string | "vs last month" | Supporting text shown after the change indicator, typically the comparison period. |
chartData | { value: number; highlight?: boolean; }[] | lineData | Points plotted in the fixed-size area chart. Each entry's `value` is its height, and `highlight: true` draws a ringed dot on that point. |
footer | ReactNode | — | Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed. |
subtitle | string | "View 24 hours" | Heading shown at the top of the card, naming the metric or the period it covers. |
title | string | "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. |
className | string | — | Additional CSS classes to apply to the card. |
<MetricsChart02 />
7 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
change | string | "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. |
footer | ReactNode | — | Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed. |
icon | FC<{ className?: string; }> | Eye | Icon component rendered inside the featured icon beside the heading. |
subtitle | string | "View 24 hours" | Heading shown next to the featured icon at the top of the card. |
title | string | "2,000" | The metric's headline figure, rendered as the large display number. |
className | string | — | Additional CSS classes to apply to the card. |
<MetricsChart03 />
12 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
changeDescription | string | — | Supporting text shown after the change indicator, typically the comparison period. It is left out when empty. |
chartAreaFill | string | — | Fill for the area under the line, replacing the generated top-to-bottom gradient. |
chartColor | string | — | 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 |
chartCurveType | CurveType | — | Interpolation Recharts uses to draw the line between points. |
chartData | { value: number; }[] | lineData3 | Points plotted in the full-width area chart, where each entry's `value` is its height. |
footer | ReactNode | — | Content rendered in a right-aligned row below a divider. The row is left out entirely when nothing is passed. |
subtitle | string | "View 24 hours" | Label above the figure naming the metric or the period it covers. |
title | string | "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. |
className | string | — | Additional CSS classes to apply to the card. |
<MetricsChart04 />
12 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
changeDescription | string | — | Supporting text shown after the change indicator, typically the comparison period. It is left out when empty. |
chartAreaFill | string | — | Fill for the area under the line, replacing the generated top-to-bottom gradient. |
chartColor | string | "text-fg-success-secondary" | Text color class applied to the chart's line and to its gradient fill. |
chartCurveType | CurveType | — | Interpolation Recharts uses to draw the line between points. |
chartData | { value: number; }[] | lineData3 | Points plotted in the full-width area chart, where each entry's `value` is its height. |
footer | ReactNode | — | 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. |
className | string | — | Additional CSS classes to apply to the card. |
<MetricChangeIndicator />
4 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
value | string | — | The change amount rendered next to the arrow, such as "100%". |
className | string | — | 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
| Prop | Values |
|---|---|
Card wrapper | rounded-xl bg-primary shadow-xs ring-1 ring-secondary ring-inset p-4 sm:p-6 |
Actions | Button color="secondary" + primary, size="sm"; flex-col-reverse sm:flex-row |
Email field | Form + Input isRequired hideRequiredIndicator icon={Mail01} |
Receipt | FileIcon theme="light" dark:hidden + theme="dark" not-dark:hidden |
Actions

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.
$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
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@untitledui.com
Banner simple
Team members
Manage your team members and their account permissions here.
Banner avatar
Olivia Rhye
olivia@untitledui.com
Banner simple centered
Banner avatar centered
Custom colors
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)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
maxVisibleItems | number | 4 | The 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. |
className | string | — | Additional class name for the `nav` wrapper. |
<PageHeader />
14 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
title* | ReactNode | — | |
accentColor | string | — | Any CSS color for brand-colored parts (primary buttons, focus rings), e.g. "#095E15". |
actions | ReactNode | — | 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. |
banner | boolean | — | Show a cover banner above the header. |
breadcrumbs | BreadcrumbItem[] | — | |
centered | boolean | — | Center everything (best with a banner). |
description | ReactNode | — | |
divider | boolean | true | Bottom border under the header. |
onSearchChange | ((value: string) => void) | — | |
search | boolean | — | Show a search box with a ⌘K hint. |
searchPlaceholder | string | "Search" | |
bannerClassName | string | — | Banner classes, e.g. "bg-linear-to-b from-[#C7E9CB] to-[#F6FBF6]" or "bg-[url(/cover.jpg)] bg-cover". |
className | string | — |
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
Props
<Tabs />
88 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((values: TabsRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<TabsRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultSelectedKey | Key | — | The initial selected keys in the collection (uncontrolled). |
dir | string | — | |
disabledKeys | Iterable<Key> | — | The item keys that are disabled. These items cannot be selected, focused, or otherwise |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isDisabled | boolean | — | Whether the TabList is disabled. |
keyboardActivation | "manual" | "automatic" | — | Whether tabs are activated automatically on focus or manually. |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelectionChange | ((key: Key) => void) | — | Handler that is called when the selection changes. |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<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 | — | |
render | DOMRenderFunction<"div", TabsRenderProps> | — | Overrides the default DOM element with a custom render function. |
selectedKey | Key | — | The currently selected key in the collection (controlled). |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<TabsRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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)| Prop | Type | Default | Description |
|---|---|---|---|
fullWidth | boolean | — | Whether the tab list is full width. |
items | TabComponentProps[] | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((item: TabComponentProps) => ReactNode) | — | The contents of the collection. |
className | ClassNameOrFunction<TabListRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dependencies | readonly any[] | — | Values that should invalidate the item cache when using dynamic collections. |
dir | string | — | |
hidden | boolean | — | |
inert | boolean | — | |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
render | DOMRenderFunction<"div", TabListRenderProps> | — | Overrides the default DOM element with a custom render function. |
style | StyleOrFunction<TabListRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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)| Prop | Type | Default | Description |
|---|---|---|---|
badge | string | number | — | The badge displayed next to the label. |
children | ReactNode | ((props: AriaTabRenderProps) => ReactNode) | — | The children of the tab. |
icon | ReactNode | FC<{ className?: string; }> | — | Icon component or element to show before the text |
label | ReactNode | — | The label of the tab. |
›98 more props from react-aria-components, @react-types/shared(aria-describedby, aria-details, aria-label, aria-labelledby…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
className | ClassNameOrFunction<TabRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dir | string | — | |
download | string | boolean | — | Causes the browser to download the linked URL. A string may be provided to suggest a file name. |
hidden | boolean | — | |
href | string | — | A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href). |
hrefLang | string | — | Hints at the human language of the linked URL. |
id | Key | — | The unique id of the tab. |
inert | boolean | — | |
isDisabled | boolean | — | Whether the tab is disabled. |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<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` |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
ping | string | — | 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 |
rel | string | — | 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. |
routerOptions | undefined | — | Options for the configured client side router. |
style | StyleOrFunction<TabRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
target | HTMLAttributeAnchorTarget | — | The target window for the link. See |
translate | "yes" | "no" | — |
<Tabs.Panel />
81 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((values: TabPanelRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<TabPanelRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dir | string | — | |
hidden | boolean | — | |
id | Key | — | The unique id of the tab. |
inert | boolean | — | |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<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 | — | |
render | DOMRenderFunction<"div", TabPanelRenderProps> | — | Overrides the default DOM element with a custom render function. |
shouldForceMount | boolean | — | Whether to mount the tab panel in the DOM even when it is not currently selected. Inactive tab |
style | StyleOrFunction<TabPanelRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
children | React.ReactNode | ((values: ModalRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<ModalRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultOpen | boolean | — | Whether the overlay is open by default (uncontrolled). |
dir | string | — | |
hidden | boolean | — | |
inert | boolean | — | |
isDismissable | boolean | — | Whether to close the modal when the user interacts outside it. |
isEntering | boolean | — | Whether the modal is currently performing an entry animation. |
isExiting | boolean | — | Whether the modal is currently performing an exit animation. |
isKeyboardDismissDisabled | boolean | — | Whether pressing the escape key to close the modal should be disabled. |
isOpen | boolean | — | Whether the overlay is open by default (controlled). |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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 |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onOpenChange | ((isOpen: boolean) => void) | — | Handler that is called when the overlay's open state changes. |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
render | DOMRenderFunction<"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, |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<ModalRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
translate | "yes" | "no" | — | |
UNSTABLE_deferUntilEntered | boolean | — | Whether to wait until the entry animation completes before hiding content outside the modal |
UNSTABLE_overrideFocus | boolean | — | Whether to override the `focus()` method so it does not scroll the page. |
UNSTABLE_portalContainer | Element | — | The container element in which the overlay portal will be placed. This may have unknown |
<Modal />
88 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
children | React.ReactNode | ((values: ModalRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<ModalRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultOpen | boolean | — | Whether the overlay is open by default (uncontrolled). |
dir | string | — | |
hidden | boolean | — | |
inert | boolean | — | |
isDismissable | boolean | — | Whether to close the modal when the user interacts outside it. |
isEntering | boolean | — | Whether the modal is currently performing an entry animation. |
isExiting | boolean | — | Whether the modal is currently performing an exit animation. |
isKeyboardDismissDisabled | boolean | — | Whether pressing the escape key to close the modal should be disabled. |
isOpen | boolean | — | Whether the overlay is open by default (controlled). |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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 |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onOpenChange | ((isOpen: boolean) => void) | — | Handler that is called when the overlay's open state changes. |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
render | DOMRenderFunction<"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, |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<ModalRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
translate | "yes" | "no" | — | |
UNSTABLE_deferUntilEntered | boolean | — | Whether to wait until the entry animation completes before hiding content outside the modal |
UNSTABLE_overrideFocus | boolean | — | Whether to override the `focus()` method so it does not scroll the page. |
UNSTABLE_portalContainer | Element | — | The container element in which the overlay portal will be placed. This may have unknown |
<Dialog />
82 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
children | React.ReactNode | ((opts: DialogRenderProps) => ReactNode) | — | Children of the dialog. A function may be provided to access a function to close the dialog. |
className | string | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dir | string | — | |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
isEntering | boolean | — | Whether the dialog is currently performing an entry animation. Focus is not moved into the |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLElement> | — | |
onAuxClick | MouseEventHandler<HTMLElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLElement> | — | |
onClick | MouseEventHandler<HTMLElement> | — | |
onClickCapture | MouseEventHandler<HTMLElement> | — | |
onContextMenu | MouseEventHandler<HTMLElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLElement> | — | |
onDoubleClick | MouseEventHandler<HTMLElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLElement> | — | |
onMouseDown | MouseEventHandler<HTMLElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLElement> | — | |
onMouseEnter | MouseEventHandler<HTMLElement> | — | |
onMouseLeave | MouseEventHandler<HTMLElement> | — | |
onMouseMove | MouseEventHandler<HTMLElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLElement> | — | |
onMouseOut | MouseEventHandler<HTMLElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLElement> | — | |
onMouseOver | MouseEventHandler<HTMLElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLElement> | — | |
onMouseUp | MouseEventHandler<HTMLElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLElement> | — | |
onPointerCancel | PointerEventHandler<HTMLElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLElement> | — | |
onPointerDown | PointerEventHandler<HTMLElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLElement> | — | |
onPointerEnter | PointerEventHandler<HTMLElement> | — | |
onPointerLeave | PointerEventHandler<HTMLElement> | — | |
onPointerMove | PointerEventHandler<HTMLElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLElement> | — | |
onPointerOut | PointerEventHandler<HTMLElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLElement> | — | |
onPointerOver | PointerEventHandler<HTMLElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLElement> | — | |
onPointerUp | PointerEventHandler<HTMLElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLElement> | — | |
onScroll | UIEventHandler<HTMLElement> | — | |
onScrollCapture | UIEventHandler<HTMLElement> | — | |
onTouchCancel | TouchEventHandler<HTMLElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLElement> | — | |
onTouchEnd | TouchEventHandler<HTMLElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLElement> | — | |
onTouchMove | TouchEventHandler<HTMLElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLElement> | — | |
onTouchStart | TouchEventHandler<HTMLElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLElement> | — | |
onWheel | WheelEventHandler<HTMLElement> | — | |
onWheelCapture | WheelEventHandler<HTMLElement> | — | |
render | DOMRenderFunction<"section", undefined> | — | Overrides the default DOM element with a custom render function. |
role | "dialog" | "alertdialog" | — | The accessibility role for the dialog. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | React.CSSProperties | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
dialogClassName | string | — | 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
className | ClassNameOrFunction<ModalRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultOpen | boolean | — | Whether the overlay is open by default (uncontrolled). |
dir | string | — | |
hidden | boolean | — | |
inert | boolean | — | |
isDismissable | boolean | — | Whether to close the modal when the user interacts outside it. |
isEntering | boolean | — | Whether the modal is currently performing an entry animation. |
isExiting | boolean | — | Whether the modal is currently performing an exit animation. |
isKeyboardDismissDisabled | boolean | — | Whether pressing the escape key to close the modal should be disabled. |
isOpen | boolean | — | Whether the overlay is open by default (controlled). |
lang | string | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<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 |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onOpenChange | ((isOpen: boolean) => void) | — | Handler that is called when the overlay's open state changes. |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
ref | LegacyRef<HTMLDivElement> | — | Allows getting a ref to the component instance. |
render | DOMRenderFunction<"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, |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<ModalRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
translate | "yes" | "no" | — | |
UNSTABLE_deferUntilEntered | boolean | — | Whether to wait until the entry animation completes before hiding content outside the modal |
UNSTABLE_overrideFocus | boolean | — | Whether to override the `focus()` method so it does not scroll the page. |
UNSTABLE_portalContainer | Element | — | The container element in which the overlay portal will be placed. This may have unknown |
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 usersName | Status | Role | Email address | Teams | ||
|---|---|---|---|---|---|---|
Olivia Rhye @olivia | Active | Product Designer | olivia@untitledui.com | DesignProductMarketing+4 | ||
Phoenix Baker @phoenix | Active | Product Manager | phoenix@untitledui.com | DesignProductMarketing+4 | ||
Lana Steiner @lana | Active | Frontend Developer | lana@untitledui.com | DesignProductMarketing+2 | ||
Demi Wilkinson @demi | Active | Backend Developer | demi@untitledui.com | DesignProductMarketing+1 | ||
Candice Wu @candice | Active | Fullstack Developer | candice@untitledui.com | DesignProductMarketing+2 | ||
Natali Craig @natali | Active | UX Designer | natali@untitledui.com | DesignProductMarketing+2 | ||
Drew Cano @drew | Active | UX Copywriter | drew@untitledui.com | DesignProductMarketing+4 | ||
Orlando Diggs @orlando | Active | UI Designer | orlando@untitledui.com | DesignProductMarketing+4 | ||
Andi Lane @andi | Active | Product Manager | andi@untitledui.com | DesignProductMarketing+4 | ||
Kate Morrison @kate | Active | QA Engineer | kate@untitledui.com | DesignProductMarketing+2 |
Alternating fills 01
Team members
100 usersName | Status | Role | Email address | Teams | ||
|---|---|---|---|---|---|---|
Olivia Rhye @olivia | Active | Product Designer | olivia@untitledui.com | DesignProductMarketing+4 | ||
Phoenix Baker @phoenix | Active | Product Manager | phoenix@untitledui.com | DesignProductMarketing+4 | ||
Lana Steiner @lana | Active | Frontend Developer | lana@untitledui.com | DesignProductMarketing+2 | ||
Demi Wilkinson @demi | Active | Backend Developer | demi@untitledui.com | DesignProductMarketing+1 | ||
Candice Wu @candice | Active | Fullstack Developer | candice@untitledui.com | DesignProductMarketing+2 | ||
Natali Craig @natali | Active | UX Designer | natali@untitledui.com | DesignProductMarketing+2 | ||
Drew Cano @drew | Active | UX Copywriter | drew@untitledui.com | DesignProductMarketing+4 | ||
Orlando Diggs @orlando | Active | UI Designer | orlando@untitledui.com | DesignProductMarketing+4 | ||
Andi Lane @andi | Active | Product Manager | andi@untitledui.com | DesignProductMarketing+4 | ||
Kate Morrison @kate | Active | QA Engineer | kate@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 stack3dlab.com | Churned | Design software Super lightweight design app | +5 | 60% | |
![]() ContrastAI contrastai.com | Churned | Web app integrations Connect web apps seamlessly | +5 | 20% | |
![]() Ephemeral ephemeral.io | Customer | Content curating app Brings all your news into one place | +5 | 70% | |
![]() Warpspeed getwarpspeed.com | Customer | Data prediction AI and machine learning data | +5 | 30% | |
![]() CloudWatch cloudwatch.app | Customer | Productivity app Time management and productivity | +5 | 80% | |
![]() Convergence convergence.io | Customer | Sales CRM Web-based sales doc management | +5 | 10% | |
![]() Sisyphus sisyphus.com | Customer | Automation and workflow Time tracking, invoicing and expenses | +5 | 40% |
Alternating fills 02
Customers
These companies have purchased in the last 12 months.
Company | Status | About | Users | License use | |
|---|---|---|---|---|---|
![]() Stack3d Lab stack3dlab.com | Churned | Design software Super lightweight design app | +5 | 60% | |
![]() ContrastAI contrastai.com | Churned | Web app integrations Connect web apps seamlessly | +5 | 20% | |
![]() Ephemeral ephemeral.io | Customer | Content curating app Brings all your news into one place | +5 | 70% | |
![]() Warpspeed getwarpspeed.com | Customer | Data prediction AI and machine learning data | +5 | 30% | |
![]() CloudWatch cloudwatch.app | Customer | Productivity app Time management and productivity | +5 | 80% | |
![]() Convergence convergence.io | Customer | Sales CRM Web-based sales doc management | +5 | 10% | |
![]() Sisyphus sisyphus.com | Customer | Automation and workflow Time tracking, invoicing and expenses | +5 | 40% |
Divider line 03
Invoice | Date | Status | Customer | Purchase | ||
|---|---|---|---|---|---|---|
| #3066 | Jan 6, 2025 | paid | Olivia Rhye olivia@untitledui.com | Monthly subscription | ||
| #3065 | Jan 6, 2025 | paid | Phoenix Baker phoenix@untitledui.com | Monthly subscription | ||
| #3064 | Jan 6, 2025 | paid | LS Lana Steiner lana@untitledui.com | Monthly subscription | ||
| #3063 | Jan 5, 2025 | paid | DW Demi Wilkinson demi@untitledui.com | Monthly subscription | ||
| #3062 | Jan 5, 2025 | refunded | Candice Wu candice@untitledui.com | Monthly subscription | ||
| #3061 | Jan 5, 2025 | refunded | NC Natali Craig natali@untitledui.com | Monthly subscription | ||
| #3060 | Jan 4, 2025 | cancelled | Drew Cano drew@untitledui.com | Monthly subscription | ||
| #3059 | Jan 3, 2025 | paid | Orlando Diggs orlando@untitledui.com | Monthly subscription | ||
| #3058 | Jan 3, 2025 | paid | Andi Lane andi@untitledui.com | Monthly subscription | ||
| #3057 | Jan 3, 2025 | paid | Kate Morrison kate@untitledui.com | Monthly subscription |
Alternating fills 03
Invoice | Date | Status | Customer | Purchase | ||
|---|---|---|---|---|---|---|
| #3066 | 2025-01-06 | paid | Olivia Rhye olivia@untitledui.com | Monthly subscription | ||
| #3065 | 2025-01-06 | paid | Phoenix Baker phoenix@untitledui.com | Monthly subscription | ||
| #3064 | 2025-01-06 | paid | LS Lana Steiner lana@untitledui.com | Monthly subscription | ||
| #3063 | 2025-01-05 | paid | DW Demi Wilkinson demi@untitledui.com | Monthly subscription | ||
| #3062 | 2025-01-05 | refunded | Candice Wu candice@untitledui.com | Monthly subscription | ||
| #3061 | 2025-01-05 | refunded | NC Natali Craig natali@untitledui.com | Monthly subscription | ||
| #3060 | 2025-01-04 | cancelled | Drew Cano drew@untitledui.com | Monthly subscription | ||
| #3059 | 2025-01-03 | paid | Orlando Diggs orlando@untitledui.com | Monthly subscription | ||
| #3058 | 2025-01-03 | paid | Andi Lane andi@untitledui.com | Monthly subscription | ||
| #3057 | 2025-01-03 | paid | 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 KB | Jan 4, 2025 | Jan 4, 2025 | Olivia Rhye | ||
Dashboard screenshot.jpg 720 KB | 720 KB | Jan 4, 2025 | Jan 4, 2025 | Phoenix Baker | ||
Dashboard prototype recording.mp4 16 MB | 16 MB | Jan 2, 2025 | Jan 2, 2025 | Lana Steiner | ||
Dashboard prototype FINAL.fig 4.2 MB | 4.2 MB | Jan 6, 2025 | Jan 6, 2025 | Demi Wilkinson | ||
UX Design Guidelines.docx 400 KB | 400 KB | Jan 8, 2025 | Jan 8, 2025 | Candice Wu | ||
Dashboard interaction.aep 12 MB | 12 MB | Jan 6, 2025 | Jan 6, 2025 | Natali Craig | ||
Briefing call recording.mp3 18.6 MB | 18.6 MB | Jan 4, 2025 | Jan 4, 2025 | Drew Cano |
Alternating fills 04
Files uploaded
File name | File size | Date uploaded | Last updated | Uploaded by | ||
|---|---|---|---|---|---|---|
Tech requirements.pdf 200 KB | 200 KB | Jan 4, 2025 | Jan 4, 2025 | Olivia Rhye | ||
Dashboard screenshot.jpg 720 KB | 720 KB | Jan 4, 2025 | Jan 4, 2025 | Phoenix Baker | ||
Dashboard prototype recording.mp4 16 MB | 16 MB | Jan 2, 2025 | Jan 2, 2025 | Lana Steiner | ||
Dashboard prototype FINAL.fig 4.2 MB | 4.2 MB | Jan 6, 2025 | Jan 6, 2025 | Demi Wilkinson | ||
UX Design Guidelines.docx 400 KB | 400 KB | Jan 8, 2025 | Jan 8, 2025 | Candice Wu | ||
Dashboard interaction.aep 12 MB | 12 MB | Jan 6, 2025 | Jan 6, 2025 | Natali Craig | ||
Briefing call recording.mp3 18.6 MB | 18.6 MB | Jan 4, 2025 | Jan 4, 2025 | Drew Cano |
No vendors found
Vendor movements
240 vendorsKeep 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 usersSomething went wrong...
We had some trouble loading this page. Please refresh the page or get in touch for support.
No users found
Users
128 onlineKeep 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
3People who applied this week.
Name | Role | Status | |
|---|---|---|---|
AK | Frontend Developer | Interview | |
PS | Data Analyst | Hired | |
RM | Backend Developer | Applied |
Props
<Table />
308 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
size | "sm" | "md" | "md" |
›307 more props from react-aria-components, @react-types/shared, react-stately, react, next(about, accessKey, align, aria-activedescendant…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
align | "left" | "right" | "center" | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
bgcolor | string | — | |
border | number | — | |
cellPadding | string | number | — | |
cellSpacing | string | number | — | |
children | string | 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. |
className | ClassNameOrFunction<TableRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultExpandedKeys | Iterable<Key> | — | The initial expanded keys in the collection (uncontrolled). |
defaultSelectedKeys | Iterable<Key> | "all" | — | The initial selected keys in the collection (uncontrolled). |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
disabledBehavior | "all" | "selection" | — | Whether `disabledKeys` applies to all interactions, or only selection. |
disabledKeys | Iterable<Key> | — | A list of row keys to disable. |
disallowEmptySelection | boolean | — | Whether the collection allows empty selection. |
dragAndDropHooks | DragAndDropHooks | — | The drag and drop hooks returned by `useDragAndDrop` used to enable drag and drop behavior for |
draggable | boolean | "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. |
expandedKeys | Iterable<Key> | — | The currently expanded keys in the collection (controlled). |
exportparts | string | — | |
frame | boolean | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
keyboardNavigationBehavior | "tab" | "arrow" | — | Whether keyboard navigation to focusable elements within the cells is |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLTableElement> | — | |
onAbortCapture | ReactEventHandler<HTMLTableElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLTableElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLTableElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLTableElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLTableElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLTableElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLTableElement> | — | |
onAuxClick | MouseEventHandler<HTMLTableElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLTableElement> | — | |
onBeforeInput | InputEventHandler<HTMLTableElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLTableElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLTableElement> | — | |
onBlur | FocusEventHandler<HTMLTableElement> | — | |
onBlurCapture | FocusEventHandler<HTMLTableElement> | — | |
onCanPlay | ReactEventHandler<HTMLTableElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLTableElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLTableElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLTableElement> | — | |
onChange | FormEventHandler<HTMLTableElement> | — | |
onChangeCapture | FormEventHandler<HTMLTableElement> | — | |
onClick | MouseEventHandler<HTMLTableElement> | — | |
onClickCapture | MouseEventHandler<HTMLTableElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLTableElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLTableElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLTableElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLTableElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLTableElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLTableElement> | — | |
onContextMenu | MouseEventHandler<HTMLTableElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLTableElement> | — | |
onCopy | ClipboardEventHandler<HTMLTableElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLTableElement> | — | |
onCut | ClipboardEventHandler<HTMLTableElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLTableElement> | — | |
onDoubleClick | MouseEventHandler<HTMLTableElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLTableElement> | — | |
onDrag | DragEventHandler<HTMLTableElement> | — | |
onDragCapture | DragEventHandler<HTMLTableElement> | — | |
onDragEnd | DragEventHandler<HTMLTableElement> | — | |
onDragEndCapture | DragEventHandler<HTMLTableElement> | — | |
onDragEnter | DragEventHandler<HTMLTableElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLTableElement> | — | |
onDragExit | DragEventHandler<HTMLTableElement> | — | |
onDragExitCapture | DragEventHandler<HTMLTableElement> | — | |
onDragLeave | DragEventHandler<HTMLTableElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLTableElement> | — | |
onDragOver | DragEventHandler<HTMLTableElement> | — | |
onDragOverCapture | DragEventHandler<HTMLTableElement> | — | |
onDragStart | DragEventHandler<HTMLTableElement> | — | |
onDragStartCapture | DragEventHandler<HTMLTableElement> | — | |
onDrop | DragEventHandler<HTMLTableElement> | — | |
onDropCapture | DragEventHandler<HTMLTableElement> | — | |
onDurationChange | ReactEventHandler<HTMLTableElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLTableElement> | — | |
onEmptied | ReactEventHandler<HTMLTableElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLTableElement> | — | |
onEncrypted | ReactEventHandler<HTMLTableElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLTableElement> | — | |
onEnded | ReactEventHandler<HTMLTableElement> | — | |
onEndedCapture | ReactEventHandler<HTMLTableElement> | — | |
onError | ReactEventHandler<HTMLTableElement> | — | |
onErrorCapture | ReactEventHandler<HTMLTableElement> | — | |
onExpandedChange | ((keys: Set<Key>) => any) | — | Handler that is called when items are expanded or collapsed. |
onFocus | FocusEventHandler<HTMLTableElement> | — | |
onFocusCapture | FocusEventHandler<HTMLTableElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLTableElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLTableElement> | — | |
onInput | FormEventHandler<HTMLTableElement> | — | |
onInputCapture | FormEventHandler<HTMLTableElement> | — | |
onInvalid | FormEventHandler<HTMLTableElement> | — | |
onInvalidCapture | FormEventHandler<HTMLTableElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLTableElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLTableElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLTableElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLTableElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLTableElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLTableElement> | — | |
onLoad | ReactEventHandler<HTMLTableElement> | — | |
onLoadCapture | ReactEventHandler<HTMLTableElement> | — | |
onLoadedData | ReactEventHandler<HTMLTableElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLTableElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLTableElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLTableElement> | — | |
onLoadStart | ReactEventHandler<HTMLTableElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLTableElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLTableElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLTableElement> | — | |
onMouseDown | MouseEventHandler<HTMLTableElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLTableElement> | — | |
onMouseEnter | MouseEventHandler<HTMLTableElement> | — | |
onMouseLeave | MouseEventHandler<HTMLTableElement> | — | |
onMouseMove | MouseEventHandler<HTMLTableElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLTableElement> | — | |
onMouseOut | MouseEventHandler<HTMLTableElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLTableElement> | — | |
onMouseOver | MouseEventHandler<HTMLTableElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLTableElement> | — | |
onMouseUp | MouseEventHandler<HTMLTableElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLTableElement> | — | |
onPaste | ClipboardEventHandler<HTMLTableElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLTableElement> | — | |
onPause | ReactEventHandler<HTMLTableElement> | — | |
onPauseCapture | ReactEventHandler<HTMLTableElement> | — | |
onPlay | ReactEventHandler<HTMLTableElement> | — | |
onPlayCapture | ReactEventHandler<HTMLTableElement> | — | |
onPlaying | ReactEventHandler<HTMLTableElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLTableElement> | — | |
onPointerCancel | PointerEventHandler<HTMLTableElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLTableElement> | — | |
onPointerDown | PointerEventHandler<HTMLTableElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLTableElement> | — | |
onPointerEnter | PointerEventHandler<HTMLTableElement> | — | |
onPointerLeave | PointerEventHandler<HTMLTableElement> | — | |
onPointerMove | PointerEventHandler<HTMLTableElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLTableElement> | — | |
onPointerOut | PointerEventHandler<HTMLTableElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLTableElement> | — | |
onPointerOver | PointerEventHandler<HTMLTableElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLTableElement> | — | |
onPointerUp | PointerEventHandler<HTMLTableElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLTableElement> | — | |
onProgress | ReactEventHandler<HTMLTableElement> | — | |
onProgressCapture | ReactEventHandler<HTMLTableElement> | — | |
onRateChange | ReactEventHandler<HTMLTableElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLTableElement> | — | |
onReset | FormEventHandler<HTMLTableElement> | — | |
onResetCapture | FormEventHandler<HTMLTableElement> | — | |
onRowAction | ((key: Key) => void) | — | Handler that is called when a user performs an action on the row. |
onScroll | UIEventHandler<HTMLTableElement> | — | |
onScrollCapture | UIEventHandler<HTMLTableElement> | — | |
onSeeked | ReactEventHandler<HTMLTableElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLTableElement> | — | |
onSeeking | ReactEventHandler<HTMLTableElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLTableElement> | — | |
onSelect | ReactEventHandler<HTMLTableElement> | — | |
onSelectCapture | ReactEventHandler<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. |
onStalled | ReactEventHandler<HTMLTableElement> | — | |
onStalledCapture | ReactEventHandler<HTMLTableElement> | — | |
onSubmit | FormEventHandler<HTMLTableElement> | — | |
onSubmitCapture | FormEventHandler<HTMLTableElement> | — | |
onSuspend | ReactEventHandler<HTMLTableElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLTableElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLTableElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLTableElement> | — | |
onToggle | ToggleEventHandler<HTMLTableElement> | — | |
onTouchCancel | TouchEventHandler<HTMLTableElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLTableElement> | — | |
onTouchEnd | TouchEventHandler<HTMLTableElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLTableElement> | — | |
onTouchMove | TouchEventHandler<HTMLTableElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLTableElement> | — | |
onTouchStart | TouchEventHandler<HTMLTableElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLTableElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLTableElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLTableElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLTableElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLTableElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLTableElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLTableElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLTableElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLTableElement> | — | |
onVolumeChange | ReactEventHandler<HTMLTableElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLTableElement> | — | |
onWaiting | ReactEventHandler<HTMLTableElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLTableElement> | — | |
onWheel | WheelEventHandler<HTMLTableElement> | — | |
onWheelCapture | WheelEventHandler<HTMLTableElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
render | DOMRenderFunction<"div" | "table", TableRenderProps> | — | Overrides the default DOM element with a custom render function. |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
rules | "none" | "all" | "rows" | "groups" | "columns" | — | |
security | string | — | |
selectedKeys | Iterable<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. |
shouldSelectOnPressUp | boolean | — | Whether selection should occur on press up instead of press down. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
sortDescriptor | SortDescriptor | — | The current sorted column and direction. |
spellCheck | boolean | "true" | "false" | — | |
style | StyleOrFunction<TableRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
summary | string | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
treeColumn | Key | — | The id of the column that displays hierarchical data. |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — | |
width | string | number | — |
<Table.Header />
285 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
bordered | boolean | — | |
size | "sm" | "md" | — |
›283 more props from react-aria-components, @react-types/shared, react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | React.ReactNode | ((item: T) => ReactElement) | — | A list of `Column(s)` or a function. If the latter, a list of columns must be provided using |
className | ClassNameOrFunction<TableHeaderRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
color | string | — | |
columns | Iterable<T> | — | A list of table columns. |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dependencies | readonly any[] | — | Values that should invalidate the column cache when using dynamic collections. |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLTableSectionElement> | — | |
onAbortCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLTableSectionElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLTableSectionElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLTableSectionElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLTableSectionElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLTableSectionElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLTableSectionElement> | — | |
onAuxClick | MouseEventHandler<HTMLTableSectionElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLTableSectionElement> | — | |
onBeforeInput | InputEventHandler<HTMLTableSectionElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLTableSectionElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLTableSectionElement> | — | |
onBlur | FocusEventHandler<HTMLTableSectionElement> | — | |
onBlurCapture | FocusEventHandler<HTMLTableSectionElement> | — | |
onCanPlay | ReactEventHandler<HTMLTableSectionElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLTableSectionElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onChange | FormEventHandler<HTMLTableSectionElement> | — | |
onChangeCapture | FormEventHandler<HTMLTableSectionElement> | — | |
onClick | MouseEventHandler<HTMLTableSectionElement> | — | |
onClickCapture | MouseEventHandler<HTMLTableSectionElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLTableSectionElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLTableSectionElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLTableSectionElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLTableSectionElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLTableSectionElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLTableSectionElement> | — | |
onContextMenu | MouseEventHandler<HTMLTableSectionElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLTableSectionElement> | — | |
onCopy | ClipboardEventHandler<HTMLTableSectionElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLTableSectionElement> | — | |
onCut | ClipboardEventHandler<HTMLTableSectionElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLTableSectionElement> | — | |
onDoubleClick | MouseEventHandler<HTMLTableSectionElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLTableSectionElement> | — | |
onDrag | DragEventHandler<HTMLTableSectionElement> | — | |
onDragCapture | DragEventHandler<HTMLTableSectionElement> | — | |
onDragEnd | DragEventHandler<HTMLTableSectionElement> | — | |
onDragEndCapture | DragEventHandler<HTMLTableSectionElement> | — | |
onDragEnter | DragEventHandler<HTMLTableSectionElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLTableSectionElement> | — | |
onDragExit | DragEventHandler<HTMLTableSectionElement> | — | |
onDragExitCapture | DragEventHandler<HTMLTableSectionElement> | — | |
onDragLeave | DragEventHandler<HTMLTableSectionElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLTableSectionElement> | — | |
onDragOver | DragEventHandler<HTMLTableSectionElement> | — | |
onDragOverCapture | DragEventHandler<HTMLTableSectionElement> | — | |
onDragStart | DragEventHandler<HTMLTableSectionElement> | — | |
onDragStartCapture | DragEventHandler<HTMLTableSectionElement> | — | |
onDrop | DragEventHandler<HTMLTableSectionElement> | — | |
onDropCapture | DragEventHandler<HTMLTableSectionElement> | — | |
onDurationChange | ReactEventHandler<HTMLTableSectionElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onEmptied | ReactEventHandler<HTMLTableSectionElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onEncrypted | ReactEventHandler<HTMLTableSectionElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onEnded | ReactEventHandler<HTMLTableSectionElement> | — | |
onEndedCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onError | ReactEventHandler<HTMLTableSectionElement> | — | |
onErrorCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onFocus | FocusEventHandler<HTMLTableSectionElement> | — | |
onFocusCapture | FocusEventHandler<HTMLTableSectionElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLTableSectionElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onInput | FormEventHandler<HTMLTableSectionElement> | — | |
onInputCapture | FormEventHandler<HTMLTableSectionElement> | — | |
onInvalid | FormEventHandler<HTMLTableSectionElement> | — | |
onInvalidCapture | FormEventHandler<HTMLTableSectionElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLTableSectionElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLTableSectionElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLTableSectionElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLTableSectionElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLTableSectionElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLTableSectionElement> | — | |
onLoad | ReactEventHandler<HTMLTableSectionElement> | — | |
onLoadCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onLoadedData | ReactEventHandler<HTMLTableSectionElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLTableSectionElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onLoadStart | ReactEventHandler<HTMLTableSectionElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLTableSectionElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLTableSectionElement> | — | |
onMouseDown | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseEnter | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseLeave | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseMove | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseOut | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseOver | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseUp | MouseEventHandler<HTMLTableSectionElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLTableSectionElement> | — | |
onPaste | ClipboardEventHandler<HTMLTableSectionElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLTableSectionElement> | — | |
onPause | ReactEventHandler<HTMLTableSectionElement> | — | |
onPauseCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onPlay | ReactEventHandler<HTMLTableSectionElement> | — | |
onPlayCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onPlaying | ReactEventHandler<HTMLTableSectionElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onPointerCancel | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerDown | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerEnter | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerLeave | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerMove | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerOut | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerOver | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerUp | PointerEventHandler<HTMLTableSectionElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLTableSectionElement> | — | |
onProgress | ReactEventHandler<HTMLTableSectionElement> | — | |
onProgressCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onRateChange | ReactEventHandler<HTMLTableSectionElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onReset | FormEventHandler<HTMLTableSectionElement> | — | |
onResetCapture | FormEventHandler<HTMLTableSectionElement> | — | |
onScroll | UIEventHandler<HTMLTableSectionElement> | — | |
onScrollCapture | UIEventHandler<HTMLTableSectionElement> | — | |
onSeeked | ReactEventHandler<HTMLTableSectionElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onSeeking | ReactEventHandler<HTMLTableSectionElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onSelect | ReactEventHandler<HTMLTableSectionElement> | — | |
onSelectCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onStalled | ReactEventHandler<HTMLTableSectionElement> | — | |
onStalledCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onSubmit | FormEventHandler<HTMLTableSectionElement> | — | |
onSubmitCapture | FormEventHandler<HTMLTableSectionElement> | — | |
onSuspend | ReactEventHandler<HTMLTableSectionElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLTableSectionElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onToggle | ToggleEventHandler<HTMLTableSectionElement> | — | |
onTouchCancel | TouchEventHandler<HTMLTableSectionElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLTableSectionElement> | — | |
onTouchEnd | TouchEventHandler<HTMLTableSectionElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLTableSectionElement> | — | |
onTouchMove | TouchEventHandler<HTMLTableSectionElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLTableSectionElement> | — | |
onTouchStart | TouchEventHandler<HTMLTableSectionElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLTableSectionElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLTableSectionElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLTableSectionElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLTableSectionElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLTableSectionElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLTableSectionElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLTableSectionElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLTableSectionElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLTableSectionElement> | — | |
onVolumeChange | ReactEventHandler<HTMLTableSectionElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onWaiting | ReactEventHandler<HTMLTableSectionElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLTableSectionElement> | — | |
onWheel | WheelEventHandler<HTMLTableSectionElement> | — | |
onWheelCapture | WheelEventHandler<HTMLTableSectionElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
render | DOMRenderFunction<"div" | "thead", TableHeaderRenderProps> | — | Overrides the default DOM element with a custom render function. |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | StyleOrFunction<TableHeaderRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
<Table.Head />
295 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
label | string | — | |
tooltip | string | — |
›293 more props from react-aria-components, @react-types/shared, react, next(abbr, about, accessKey, align…)
| Prop | Type | Default | Description |
|---|---|---|---|
abbr | string | — | |
about | string | — | |
accessKey | string | — | |
align | "left" | "right" | "center" | "justify" | "char" | — | |
allowsArrowNavigation | boolean | — | Whether the column should support arrow key navigation even when the containing table uses tab |
allowsSorting | boolean | — | Whether the column allows sorting. |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | React.ReactNode | ((values: ColumnRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<ColumnRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
color | string | — | |
colSpan | number | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
defaultWidth | ColumnSize | null | — | The default width of the column. This prop only applies when the `<Table>` is wrapped in a |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
focusMode | "cell" | "child" | — | Whether the column header or its first focusable child element should be focused when the |
headers | string | — | |
hidden | boolean | — | |
id | Key | — | The unique id of the column. |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
isRowHeader | boolean | — | Whether a column is a [row header](https://www.w3.org/TR/wai-aria-1.1/#rowheader) and should be |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
maxWidth | ColumnStaticSize | null | — | The maximum width of the column. This prop only applies when the `<Table>` is wrapped in a |
minWidth | ColumnStaticSize | null | — | The minimum width of the column. This prop only applies when the `<Table>` is wrapped in a |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLTableCellElement> | — | |
onAbortCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLTableHeaderCellElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLTableHeaderCellElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLTableHeaderCellElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLTableHeaderCellElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLTableHeaderCellElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLTableHeaderCellElement> | — | |
onAuxClick | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onBeforeInput | InputEventHandler<HTMLTableCellElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLTableCellElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLTableCellElement> | — | |
onBlur | FocusEventHandler<HTMLTableCellElement> | — | |
onBlurCapture | FocusEventHandler<HTMLTableCellElement> | — | |
onCanPlay | ReactEventHandler<HTMLTableCellElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLTableCellElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onChange | FormEventHandler<HTMLTableCellElement> | — | |
onChangeCapture | FormEventHandler<HTMLTableCellElement> | — | |
onClick | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onClickCapture | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLTableCellElement> | — | |
onContextMenu | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onCopy | ClipboardEventHandler<HTMLTableCellElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLTableCellElement> | — | |
onCut | ClipboardEventHandler<HTMLTableCellElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLTableCellElement> | — | |
onDoubleClick | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onDrag | DragEventHandler<HTMLTableCellElement> | — | |
onDragCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragEnd | DragEventHandler<HTMLTableCellElement> | — | |
onDragEndCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragEnter | DragEventHandler<HTMLTableCellElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragExit | DragEventHandler<HTMLTableCellElement> | — | |
onDragExitCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragLeave | DragEventHandler<HTMLTableCellElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragOver | DragEventHandler<HTMLTableCellElement> | — | |
onDragOverCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragStart | DragEventHandler<HTMLTableCellElement> | — | |
onDragStartCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDrop | DragEventHandler<HTMLTableCellElement> | — | |
onDropCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDurationChange | ReactEventHandler<HTMLTableCellElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onEmptied | ReactEventHandler<HTMLTableCellElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onEncrypted | ReactEventHandler<HTMLTableCellElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onEnded | ReactEventHandler<HTMLTableCellElement> | — | |
onEndedCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onError | ReactEventHandler<HTMLTableCellElement> | — | |
onErrorCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onFocus | FocusEventHandler<HTMLTableCellElement> | — | |
onFocusCapture | FocusEventHandler<HTMLTableCellElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onInput | FormEventHandler<HTMLTableCellElement> | — | |
onInputCapture | FormEventHandler<HTMLTableCellElement> | — | |
onInvalid | FormEventHandler<HTMLTableCellElement> | — | |
onInvalidCapture | FormEventHandler<HTMLTableCellElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLTableCellElement> | — | |
onLoad | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadedData | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadStart | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseDown | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseEnter | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseLeave | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseMove | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseOut | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseOver | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseUp | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLTableHeaderCellElement> | — | |
onPaste | ClipboardEventHandler<HTMLTableCellElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLTableCellElement> | — | |
onPause | ReactEventHandler<HTMLTableCellElement> | — | |
onPauseCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onPlay | ReactEventHandler<HTMLTableCellElement> | — | |
onPlayCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onPlaying | ReactEventHandler<HTMLTableCellElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onPointerCancel | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerDown | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerEnter | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerLeave | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerMove | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerOut | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerOver | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerUp | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLTableHeaderCellElement> | — | |
onProgress | ReactEventHandler<HTMLTableCellElement> | — | |
onProgressCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onRateChange | ReactEventHandler<HTMLTableCellElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onReset | FormEventHandler<HTMLTableCellElement> | — | |
onResetCapture | FormEventHandler<HTMLTableCellElement> | — | |
onScroll | UIEventHandler<HTMLTableHeaderCellElement> | — | |
onScrollCapture | UIEventHandler<HTMLTableHeaderCellElement> | — | |
onSeeked | ReactEventHandler<HTMLTableCellElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onSeeking | ReactEventHandler<HTMLTableCellElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onSelect | ReactEventHandler<HTMLTableCellElement> | — | |
onSelectCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onStalled | ReactEventHandler<HTMLTableCellElement> | — | |
onStalledCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onSubmit | FormEventHandler<HTMLTableCellElement> | — | |
onSubmitCapture | FormEventHandler<HTMLTableCellElement> | — | |
onSuspend | ReactEventHandler<HTMLTableCellElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLTableCellElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onToggle | ToggleEventHandler<HTMLTableCellElement> | — | |
onTouchCancel | TouchEventHandler<HTMLTableHeaderCellElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLTableHeaderCellElement> | — | |
onTouchEnd | TouchEventHandler<HTMLTableHeaderCellElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLTableHeaderCellElement> | — | |
onTouchMove | TouchEventHandler<HTMLTableHeaderCellElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLTableHeaderCellElement> | — | |
onTouchStart | TouchEventHandler<HTMLTableHeaderCellElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLTableHeaderCellElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLTableHeaderCellElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLTableHeaderCellElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLTableHeaderCellElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLTableHeaderCellElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLTableHeaderCellElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLTableHeaderCellElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLTableHeaderCellElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLTableHeaderCellElement> | — | |
onVolumeChange | ReactEventHandler<HTMLTableCellElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onWaiting | ReactEventHandler<HTMLTableCellElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onWheel | WheelEventHandler<HTMLTableHeaderCellElement> | — | |
onWheelCapture | WheelEventHandler<HTMLTableHeaderCellElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
rel | string | — | |
render | DOMRenderFunction<"div" | "th", ColumnRenderProps> | — | Overrides the default DOM element with a custom render function. |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
rowSpan | number | — | |
scope | string | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | StyleOrFunction<ColumnRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
tabIndex | number | — | |
textValue | string | — | A string representation of the column's contents, used for accessibility announcements. |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — | |
width | ColumnSize | 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)| Prop | Type | Default | Description |
|---|---|---|---|
highlightSelectedRow | boolean | — | |
size | "sm" | "md" | — |
›301 more props from react-aria-components, @react-types/shared, react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | React.ReactNode | ((item: T) => ReactElement) | — | The cells within the row. Supports static items or a function for dynamic rendering. |
className | ClassNameOrFunction<RowRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
color | string | — | |
columns | Iterable<T> | — | A list of columns used when dynamically rendering cells. |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dependencies | readonly any[] | — | Values that should invalidate the cell cache when using dynamic collections. |
dir | string | — | |
disabledBehavior | "all" | "selection" | — | Whether `disabledKeys` applies to all interactions, or only selection. |
download | string | boolean | — | Causes the browser to download the linked URL. A string may be provided to suggest a file name. |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hasChildItems | boolean | — | Whether this row has children, even if not loaded yet. |
hidden | boolean | — | |
href | string | — | A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href). |
hrefLang | string | — | Hints at the human language of the linked URL. |
id | Key | — | The unique id of the row. |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
isDisabled | boolean | — | Whether the row is disabled. |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLTableRowElement> | — | |
onAbortCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onAction | (() => void) | — | Handler that is called when a user performs an action on the row. The exact user event depends |
onAnimationEnd | AnimationEventHandler<HTMLTableRowElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLTableRowElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLTableRowElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLTableRowElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLTableRowElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLTableRowElement> | — | |
onAuxClick | MouseEventHandler<HTMLTableRowElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLTableRowElement> | — | |
onBeforeInput | InputEventHandler<HTMLTableRowElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLTableRowElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLTableRowElement> | — | |
onBlur | FocusEventHandler<HTMLTableRowElement> | — | |
onBlurCapture | FocusEventHandler<HTMLTableRowElement> | — | |
onCanPlay | ReactEventHandler<HTMLTableRowElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLTableRowElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onChange | FormEventHandler<HTMLTableRowElement> | — | |
onChangeCapture | FormEventHandler<HTMLTableRowElement> | — | |
onClick | ((e: MouseEvent<FocusableElement>) => void) | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` |
onClickCapture | MouseEventHandler<HTMLTableRowElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLTableRowElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLTableRowElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLTableRowElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLTableRowElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLTableRowElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLTableRowElement> | — | |
onContextMenu | MouseEventHandler<HTMLTableRowElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLTableRowElement> | — | |
onCopy | ClipboardEventHandler<HTMLTableRowElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLTableRowElement> | — | |
onCut | ClipboardEventHandler<HTMLTableRowElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLTableRowElement> | — | |
onDoubleClick | MouseEventHandler<HTMLTableRowElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLTableRowElement> | — | |
onDrag | DragEventHandler<HTMLTableRowElement> | — | |
onDragCapture | DragEventHandler<HTMLTableRowElement> | — | |
onDragEnd | DragEventHandler<HTMLTableRowElement> | — | |
onDragEndCapture | DragEventHandler<HTMLTableRowElement> | — | |
onDragEnter | DragEventHandler<HTMLTableRowElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLTableRowElement> | — | |
onDragExit | DragEventHandler<HTMLTableRowElement> | — | |
onDragExitCapture | DragEventHandler<HTMLTableRowElement> | — | |
onDragLeave | DragEventHandler<HTMLTableRowElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLTableRowElement> | — | |
onDragOver | DragEventHandler<HTMLTableRowElement> | — | |
onDragOverCapture | DragEventHandler<HTMLTableRowElement> | — | |
onDragStart | DragEventHandler<HTMLTableRowElement> | — | |
onDragStartCapture | DragEventHandler<HTMLTableRowElement> | — | |
onDrop | DragEventHandler<HTMLTableRowElement> | — | |
onDropCapture | DragEventHandler<HTMLTableRowElement> | — | |
onDurationChange | ReactEventHandler<HTMLTableRowElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onEmptied | ReactEventHandler<HTMLTableRowElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onEncrypted | ReactEventHandler<HTMLTableRowElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onEnded | ReactEventHandler<HTMLTableRowElement> | — | |
onEndedCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onError | ReactEventHandler<HTMLTableRowElement> | — | |
onErrorCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onFocus | FocusEventHandler<HTMLTableRowElement> | — | |
onFocusCapture | FocusEventHandler<HTMLTableRowElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLTableRowElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onInput | FormEventHandler<HTMLTableRowElement> | — | |
onInputCapture | FormEventHandler<HTMLTableRowElement> | — | |
onInvalid | FormEventHandler<HTMLTableRowElement> | — | |
onInvalidCapture | FormEventHandler<HTMLTableRowElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLTableRowElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLTableRowElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLTableRowElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLTableRowElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLTableRowElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLTableRowElement> | — | |
onLoad | ReactEventHandler<HTMLTableRowElement> | — | |
onLoadCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onLoadedData | ReactEventHandler<HTMLTableRowElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLTableRowElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onLoadStart | ReactEventHandler<HTMLTableRowElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLTableRowElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLTableRowElement> | — | |
onMouseDown | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseEnter | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseLeave | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseMove | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseOut | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseOver | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseUp | MouseEventHandler<HTMLTableRowElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLTableRowElement> | — | |
onPaste | ClipboardEventHandler<HTMLTableRowElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLTableRowElement> | — | |
onPause | ReactEventHandler<HTMLTableRowElement> | — | |
onPauseCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onPlay | ReactEventHandler<HTMLTableRowElement> | — | |
onPlayCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onPlaying | ReactEventHandler<HTMLTableRowElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onPointerCancel | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerDown | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerEnter | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerLeave | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerMove | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerOut | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerOver | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerUp | PointerEventHandler<HTMLTableRowElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onProgress | ReactEventHandler<HTMLTableRowElement> | — | |
onProgressCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onRateChange | ReactEventHandler<HTMLTableRowElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onReset | FormEventHandler<HTMLTableRowElement> | — | |
onResetCapture | FormEventHandler<HTMLTableRowElement> | — | |
onScroll | UIEventHandler<HTMLTableRowElement> | — | |
onScrollCapture | UIEventHandler<HTMLTableRowElement> | — | |
onSeeked | ReactEventHandler<HTMLTableRowElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onSeeking | ReactEventHandler<HTMLTableRowElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onSelect | ReactEventHandler<HTMLTableRowElement> | — | |
onSelectCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onStalled | ReactEventHandler<HTMLTableRowElement> | — | |
onStalledCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onSubmit | FormEventHandler<HTMLTableRowElement> | — | |
onSubmitCapture | FormEventHandler<HTMLTableRowElement> | — | |
onSuspend | ReactEventHandler<HTMLTableRowElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLTableRowElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onToggle | ToggleEventHandler<HTMLTableRowElement> | — | |
onTouchCancel | TouchEventHandler<HTMLTableRowElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLTableRowElement> | — | |
onTouchEnd | TouchEventHandler<HTMLTableRowElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLTableRowElement> | — | |
onTouchMove | TouchEventHandler<HTMLTableRowElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLTableRowElement> | — | |
onTouchStart | TouchEventHandler<HTMLTableRowElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLTableRowElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLTableRowElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLTableRowElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLTableRowElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLTableRowElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLTableRowElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLTableRowElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLTableRowElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLTableRowElement> | — | |
onVolumeChange | ReactEventHandler<HTMLTableRowElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onWaiting | ReactEventHandler<HTMLTableRowElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLTableRowElement> | — | |
onWheel | WheelEventHandler<HTMLTableRowElement> | — | |
onWheelCapture | WheelEventHandler<HTMLTableRowElement> | — | |
part | string | — | |
ping | string | — | A space-separated list of URLs to ping when the link is followed. See |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 |
rel | string | — | The relationship between the linked resource and the current page. See |
render | DOMRenderFunction<"div" | "tr", RowRenderProps> | — | Overrides the default DOM element with a custom render function. |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
routerOptions | undefined | — | Options for the configured client side router. |
security | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | StyleOrFunction<RowRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
tabIndex | number | — | |
target | HTMLAttributeAnchorTarget | — | The target window for the link. See |
textValue | string | — | A string representation of the row's contents, used for features like typeahead. |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
value | object | — | The object value that this row represents. When using dynamic collections, this is set |
vocab | string | — |
<Table.Cell />
292 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
ref | Ref<HTMLTableCellElement> | — | |
size | "sm" | "md" | — |
›290 more props from react-aria-components, @react-types/shared, react, next(abbr, about, accessKey, align…)
| Prop | Type | Default | Description |
|---|---|---|---|
abbr | string | — | |
about | string | — | |
accessKey | string | — | |
align | "left" | "right" | "center" | "justify" | "char" | — | |
allowsArrowNavigation | boolean | — | Whether the cell should support arrow key navigation even when the containing table uses |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | React.ReactNode | ((values: CellRenderProps & { defaultChildren: ReactNode | undefined; }) => ReactNode) | — | The children of the component. A function may be provided to alter the children based on |
className | ClassNameOrFunction<CellRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
color | string | — | |
colSpan | number | — | Indicates how many columns the data cell spans. |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
focusMode | "cell" | "child" | — | Whether the cell or its first focusable child element should be focused when the cell is |
headers | string | — | |
height | string | number | — | |
hidden | boolean | — | |
id | Key | — | The unique id of the cell. |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLTableCellElement> | — | |
onAbortCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLTableCellElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLTableCellElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLTableCellElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLTableCellElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLTableCellElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLTableCellElement> | — | |
onAuxClick | MouseEventHandler<HTMLTableCellElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLTableCellElement> | — | |
onBeforeInput | InputEventHandler<HTMLTableCellElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLTableCellElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLTableCellElement> | — | |
onBlur | FocusEventHandler<HTMLTableCellElement> | — | |
onBlurCapture | FocusEventHandler<HTMLTableCellElement> | — | |
onCanPlay | ReactEventHandler<HTMLTableCellElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLTableCellElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onChange | FormEventHandler<HTMLTableCellElement> | — | |
onChangeCapture | FormEventHandler<HTMLTableCellElement> | — | |
onClick | MouseEventHandler<HTMLTableCellElement> | — | |
onClickCapture | MouseEventHandler<HTMLTableCellElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLTableCellElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLTableCellElement> | — | |
onContextMenu | MouseEventHandler<HTMLTableCellElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLTableCellElement> | — | |
onCopy | ClipboardEventHandler<HTMLTableCellElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLTableCellElement> | — | |
onCut | ClipboardEventHandler<HTMLTableCellElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLTableCellElement> | — | |
onDoubleClick | MouseEventHandler<HTMLTableCellElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLTableCellElement> | — | |
onDrag | DragEventHandler<HTMLTableCellElement> | — | |
onDragCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragEnd | DragEventHandler<HTMLTableCellElement> | — | |
onDragEndCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragEnter | DragEventHandler<HTMLTableCellElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragExit | DragEventHandler<HTMLTableCellElement> | — | |
onDragExitCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragLeave | DragEventHandler<HTMLTableCellElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragOver | DragEventHandler<HTMLTableCellElement> | — | |
onDragOverCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDragStart | DragEventHandler<HTMLTableCellElement> | — | |
onDragStartCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDrop | DragEventHandler<HTMLTableCellElement> | — | |
onDropCapture | DragEventHandler<HTMLTableCellElement> | — | |
onDurationChange | ReactEventHandler<HTMLTableCellElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onEmptied | ReactEventHandler<HTMLTableCellElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onEncrypted | ReactEventHandler<HTMLTableCellElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onEnded | ReactEventHandler<HTMLTableCellElement> | — | |
onEndedCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onError | ReactEventHandler<HTMLTableCellElement> | — | |
onErrorCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onFocus | FocusEventHandler<HTMLTableCellElement> | — | |
onFocusCapture | FocusEventHandler<HTMLTableCellElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onInput | FormEventHandler<HTMLTableCellElement> | — | |
onInputCapture | FormEventHandler<HTMLTableCellElement> | — | |
onInvalid | FormEventHandler<HTMLTableCellElement> | — | |
onInvalidCapture | FormEventHandler<HTMLTableCellElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLTableCellElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLTableCellElement> | — | |
onLoad | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadedData | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadStart | ReactEventHandler<HTMLTableCellElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onMouseDown | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseEnter | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseLeave | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseMove | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseOut | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseOver | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseUp | MouseEventHandler<HTMLTableCellElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLTableCellElement> | — | |
onPaste | ClipboardEventHandler<HTMLTableCellElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLTableCellElement> | — | |
onPause | ReactEventHandler<HTMLTableCellElement> | — | |
onPauseCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onPlay | ReactEventHandler<HTMLTableCellElement> | — | |
onPlayCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onPlaying | ReactEventHandler<HTMLTableCellElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onPointerCancel | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerDown | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerEnter | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerLeave | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerMove | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerOut | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerOver | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerUp | PointerEventHandler<HTMLTableCellElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLTableCellElement> | — | |
onProgress | ReactEventHandler<HTMLTableCellElement> | — | |
onProgressCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onRateChange | ReactEventHandler<HTMLTableCellElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onReset | FormEventHandler<HTMLTableCellElement> | — | |
onResetCapture | FormEventHandler<HTMLTableCellElement> | — | |
onScroll | UIEventHandler<HTMLTableCellElement> | — | |
onScrollCapture | UIEventHandler<HTMLTableCellElement> | — | |
onSeeked | ReactEventHandler<HTMLTableCellElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onSeeking | ReactEventHandler<HTMLTableCellElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onSelect | ReactEventHandler<HTMLTableCellElement> | — | |
onSelectCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onStalled | ReactEventHandler<HTMLTableCellElement> | — | |
onStalledCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onSubmit | FormEventHandler<HTMLTableCellElement> | — | |
onSubmitCapture | FormEventHandler<HTMLTableCellElement> | — | |
onSuspend | ReactEventHandler<HTMLTableCellElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLTableCellElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onToggle | ToggleEventHandler<HTMLTableCellElement> | — | |
onTouchCancel | TouchEventHandler<HTMLTableCellElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLTableCellElement> | — | |
onTouchEnd | TouchEventHandler<HTMLTableCellElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLTableCellElement> | — | |
onTouchMove | TouchEventHandler<HTMLTableCellElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLTableCellElement> | — | |
onTouchStart | TouchEventHandler<HTMLTableCellElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLTableCellElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLTableCellElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLTableCellElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLTableCellElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLTableCellElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLTableCellElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLTableCellElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLTableCellElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLTableCellElement> | — | |
onVolumeChange | ReactEventHandler<HTMLTableCellElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onWaiting | ReactEventHandler<HTMLTableCellElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLTableCellElement> | — | |
onWheel | WheelEventHandler<HTMLTableCellElement> | — | |
onWheelCapture | WheelEventHandler<HTMLTableCellElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
rel | string | — | |
render | DOMRenderFunction<"div" | "td", CellRenderProps> | — | Overrides the default DOM element with a custom render function. |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
rowSpan | number | — | |
scope | string | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | StyleOrFunction<CellRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
tabIndex | number | — | |
textValue | string | — | A string representation of the cell's contents, used for features like typeahead. |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
valign | "bottom" | "top" | "middle" | "baseline" | — | |
vocab | string | — | |
width | string | number | — |
<TableCard.Root />
278 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
size | "sm" | "md" | "md" |
›277 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
<TableCard.Header />
5 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
title* | string | — | The title of the table card header. |
badge | ReactNode | — | The badge displayed next to the title. |
contentTrailing | ReactNode | — | The content displayed after the title and badge. |
description | string | — | The description of the table card header. |
className | string | — | 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
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
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
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
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
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
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)| Prop | Type | Default | Description |
|---|---|---|---|
items* | ItemsType[] | — | The steps to render, in the order they are shown, each carrying its own status. |
accentColor | string | — | Any CSS color for the brand-colored parts (markers, lines, current text), e.g. "#095E15". |
connector | boolean | true | Whether 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. |
className | string | — | Additional CSS classes to apply to the wrapper. |
<Progress.MinimalIcons />
6 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
items* | ItemsType[] | — | The steps to render, in the order they are shown, each carrying its own status. |
accentColor | string | — | 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. |
text | boolean | false | Prefix the markers with a "Step x of y" counter, where x is the number of complete items. |
className | string | — | Additional CSS classes to apply to the wrapper. |
<Progress.MinimalIconsConnected />
5 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
items* | ItemsType[] | — | The steps to render, in the order they are shown, each carrying its own status. |
accentColor | string | — | 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. |
className | string | — | Additional CSS classes to apply to the wrapper. |
<Progress.TextWithLine />
5 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
items* | ItemsType[] | — | The steps to render, in the order they are shown, each carrying its own status. |
accentColor | string | — | 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. |
className | string | — | Additional CSS classes to apply to the wrapper. |
<IconTop />
7 props| Prop | Type | Default | Description |
|---|---|---|---|
description* | string | — | Supporting line rendered directly beneath the title. |
title* | string | — | Bold label naming the step. |
connector | boolean | — | Whether the line running from this step towards the next one is drawn. |
icon | IconType | — | 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| Prop | Type | Default | Description |
|---|---|---|---|
description* | string | — | Supporting line rendered directly beneath the title. |
title* | string | — | Bold label naming the step. |
connector | boolean | — | Whether the line running from this step towards the next one is drawn. |
icon | IconType | — | 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| Prop | Type | Default | Description |
|---|---|---|---|
size | "sm" | "md" | "sm" | |
status | "incomplete" | "current" | "complete" | "incomplete" |
<TextLine />
8 props| Prop | Type | Default | Description |
|---|---|---|---|
description* | string | — | Supporting line rendered directly beneath the title. |
title* | string | — | Bold label naming the step. |
connector | boolean | — | Whether the line running from this step towards the next one is drawn. |
icon | IconType | — | 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)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
siblingCount | number | 1 | Number of sibling pages to show on each side of the current page |
style | CSSProperties | — | The style of the pagination root. |
className | string | — | The class name of the pagination root. |
<Pagination.PrevTrigger />
5 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | ((props: TriggerRenderProps) => ReactNode) | — | The children of the trigger. Can be a render prop or a valid element. |
ariaLabel | string | — | The aria label of the trigger. |
asChild | boolean | — | If true, the child element will be cloned and passed down the prop of the trigger. |
style | CSSProperties | — | The style of the trigger. |
className | string | ((args: { isDisabled: boolean; }) => string) | — | The class name of the trigger. |
<Pagination.NextTrigger />
5 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | ((props: TriggerRenderProps) => ReactNode) | — | The children of the trigger. Can be a render prop or a valid element. |
ariaLabel | string | — | The aria label of the trigger. |
asChild | boolean | — | If true, the child element will be cloned and passed down the prop of the trigger. |
style | CSSProperties | — | The style of the trigger. |
className | string | ((args: { isDisabled: boolean; }) => string) | — | The class name of the trigger. |
<Pagination.Item />
7 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
isCurrent* | boolean | — | Whether the pagination item is the current page. |
value* | number | — | The value of the pagination item. |
ariaLabel | string | — | The aria label of the pagination item. |
asChild | boolean | false | If true, the child element will be cloned and passed down the prop of the item. |
children | ReactNode | ((props: PaginationItemRenderProps) => ReactNode) | — | The children of the pagination item. Can be a render prop or a valid element. |
style | CSSProperties | — | The style object of the pagination item. |
className | string | ((args: { isSelected: boolean; }) => string) | — | The class name of the pagination item. |
<Pagination.Ellipsis />
3 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children | ReactNode | — | The content rendered in place of the skipped pages, such as an ellipsis character. Hidden from assistive technology. |
style | CSSProperties | — | The style of the ellipsis. |
className | string | (() => string) | — | The class name of the ellipsis. Can be a function returning the class name. |
<Pagination.Context />
1 props| Prop | Type | Default | Description |
|---|---|---|---|
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)| Prop | Type | Default | Description |
|---|---|---|---|
onPageChange | ((page: number) => void) | — | Callback function that's called when the page changes with the new page number. |
page | number | 1 | Current active page number |
rounded | boolean | — | Whether the pagination buttons are rounded. |
siblingCount | number | — | Number of sibling pages to show on each side of the current page |
style | CSSProperties | — | The style of the pagination root. |
total | number | 10 | Total number of pages |
className | string | — | The class name of the pagination root. |
selectedClassName | string | — | Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white". |
<PaginationPageMinimalCenter />
8 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
onPageChange | ((page: number) => void) | — | Callback function that's called when the page changes with the new page number. |
page | number | 1 | Current active page number |
rounded | boolean | — | Whether the pagination buttons are rounded. |
siblingCount | number | — | Number of sibling pages to show on each side of the current page |
style | CSSProperties | — | The style of the pagination root. |
total | number | 10 | Total number of pages |
className | string | — | The class name of the pagination root. |
selectedClassName | string | — | Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white". |
<PaginationCardDefault />
8 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
onPageChange | ((page: number) => void) | — | Callback function that's called when the page changes with the new page number. |
page | number | 1 | Current active page number |
rounded | boolean | — | Whether the pagination buttons are rounded. |
siblingCount | number | — | Number of sibling pages to show on each side of the current page |
style | CSSProperties | — | The style of the pagination root. |
total | number | 10 | Total number of pages |
className | string | — | The class name of the pagination root. |
selectedClassName | string | — | Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white". |
<PaginationCardMinimal />
7 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
page | number | 1 | The current page. |
pageSize | number | 10 | The number of items per page. |
total | number | 10 | The total number of pages. |
className | string | — | The class name of the pagination component. |
<PaginationButtonGroup />
8 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
page | number | 1 | Current active page number |
siblingCount | number | — | Number of sibling pages to show on each side of the current page |
style | CSSProperties | — | The style of the pagination root. |
total | number | 10 | Total number of pages |
className | string | — | The class name of the pagination root. |
selectedClassName | string | — | Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white". |
<PaginationCardAdvanced />
8 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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. |
page | number | 1 | The current page. |
pageSize | number | 10 | The number of items per page. |
total | number | 10 | The total number of pages. |
className | string | — | The class name of the pagination component. |
selectedClassName | string | — | Classes for the current page, e.g. "bg-[#095E15] text-white hover:bg-[#074A11] hover:text-white". |
<PaginationDot />
9 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
page* | number | — | Current active page number |
total* | number | — | Total number of pages |
framed | boolean | — | Whether the pagination is displayed in a card. |
isBrand | boolean | — | Whether the pagination uses brand colors. |
onPageChange | ((page: number) => void) | — | Callback function that's called when the page changes with the new page number. |
siblingCount | number | — | Number of sibling pages to show on each side of the current page |
size | "md" | "lg" | "md" | The size of the pagination dot. |
style | CSSProperties | — | The style of the pagination root. |
className | string | — | The class name of the pagination root. |
<PaginationLine />
8 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
page* | number | — | Current active page number |
total* | number | — | Total number of pages |
framed | boolean | — | 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. |
siblingCount | number | — | Number of sibling pages to show on each side of the current page |
size | "md" | "lg" | "md" | The size of the pagination line. |
style | CSSProperties | — | The style of the pagination root. |
className | string | — | 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
Custom colors
Props
<ActivityGauge />
8 props · 2 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
data* | ActivityGaugeItem[] | — | Rings from the inside out. Each ring's color comes from its className. |
legend | boolean | true | Show the legend under the gauge. |
max | number | 1000 | Value of a full ring. |
size | "xs" | "sm" | "md" | "lg" | "sm" | |
subtitle | string | — | Small text above the title, e.g. "Active users". |
title | string | — | Big number in the middle, e.g. "1,000". |
className | string | — | |
trackClassName | string | "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
| Prop | Values |
|---|---|
colors | { A: "text-[#095E15]", … } at the top of each example — any text-* class |
Area / Bar / Line className | the series' text-* class; stroke / fill = "currentColor" follow it |
activeDot / cursor className | add the series' text-* class so they match it |
Legend content | <ChartLegendContent /> (dots take each series' color) |
Tooltip content | <ChartTooltipContent /> · formatter / labelFormatter |
Bar stackId / radius | same 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)| Prop | Type | Default | Description |
|---|---|---|---|
size | "sm" | "md" | "lg" | "lg" |
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
<EmptyState.Header />
280 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
pattern | "grid" | "none" | "circle" | "square" | "grid-check" | — | |
patternSize | "sm" | "md" | "lg" | — |
›278 more props from react, next(about, accessKey, aria-activedescendant, aria-atomic…)
| Prop | Type | Default | Description |
|---|---|---|---|
about | string | — | |
accessKey | string | — | |
aria-activedescendant | string | — | Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | boolean | "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-braillelabel | string | — | Defines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | — | Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | boolean | "true" | "false" | — | |
aria-checked | boolean | "true" | "false" | "mixed" | — | Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | — | Defines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | — | Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | — | Defines a human readable text alternative of aria-colindex. |
aria-colspan | number | — | Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | — | Identifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current | boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | — | Indicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-description | string | — | Defines a string value that describes or annotates the current element. |
aria-details | string | — | Identifies the element that provides a detailed, extended description for the object. |
aria-disabled | boolean | "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-errormessage | string | — | Identifies the element that provides an error message for the object. |
aria-expanded | boolean | "true" | "false" | — | Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | — | Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, |
aria-grabbed | boolean | "true" | "false" | — | Indicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup | boolean | "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-hidden | boolean | "true" | "false" | — | Indicates whether the element is exposed to an accessibility API. |
aria-invalid | boolean | "true" | "false" | "grammar" | "spelling" | — | Indicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | — | Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
aria-level | number | — | 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-modal | boolean | "true" | "false" | — | Indicates whether an element is modal when displayed. |
aria-multiline | boolean | "true" | "false" | — | Indicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | boolean | "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-owns | string | — | Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship |
aria-placeholder | string | — | Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. |
aria-posinset | number | — | 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-pressed | boolean | "true" | "false" | "mixed" | — | Indicates the current "pressed" state of toggle buttons. |
aria-readonly | boolean | "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-required | boolean | "true" | "false" | — | Indicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | — | Defines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | — | Defines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | — | Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | — | Defines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | — | Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | boolean | "true" | "false" | — | Indicates the current "selected" state of various widgets. |
aria-setsize | number | — | 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-valuemax | number | — | Defines the maximum allowed value for a range widget. |
aria-valuemin | number | — | Defines the minimum allowed value for a range widget. |
aria-valuenow | number | — | Defines the current value for a range widget. |
aria-valuetext | string | — | Defines the human readable text alternative of aria-valuenow for a range widget. |
autoCapitalize | (string & {}) | "off" | "none" | "on" | "sentences" | "words" | "characters" | — | |
autoCorrect | string | — | |
autoFocus | boolean | — | |
autoSave | string | — | |
children | ReactNode | — | |
className | string | — | |
color | string | — | |
content | string | — | |
contentEditable | boolean | "true" | "false" | "inherit" | "plaintext-only" | — | |
contextMenu | string | — | |
dangerouslySetInnerHTML | { __html: string | TrustedHTML; } | — | |
datatype | string | — | |
defaultChecked | boolean | — | |
defaultValue | string | number | readonly string[] | — | |
dir | string | — | |
draggable | boolean | "true" | "false" | — | |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | |
exportparts | string | — | |
hidden | boolean | — | |
id | string | — | |
inert | boolean | — | |
inlist | any | — | |
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 |
is | string | — | Specify that a standard HTML element should behave like a defined custom built-in element |
itemID | string | — | |
itemProp | string | — | |
itemRef | string | — | |
itemScope | boolean | — | |
itemType | string | — | |
lang | string | — | |
nonce | string | — | |
onAbort | ReactEventHandler<HTMLDivElement> | — | |
onAbortCapture | ReactEventHandler<HTMLDivElement> | — | |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onBeforeInput | InputEventHandler<HTMLDivElement> | — | |
onBeforeInputCapture | FormEventHandler<HTMLDivElement> | — | |
onBeforeToggle | ToggleEventHandler<HTMLDivElement> | — | |
onBlur | FocusEventHandler<HTMLDivElement> | — | |
onBlurCapture | FocusEventHandler<HTMLDivElement> | — | |
onCanPlay | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThrough | ReactEventHandler<HTMLDivElement> | — | |
onCanPlayThroughCapture | ReactEventHandler<HTMLDivElement> | — | |
onChange | FormEventHandler<HTMLDivElement> | — | |
onChangeCapture | FormEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onCompositionEnd | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionEndCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStart | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionStartCapture | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdate | CompositionEventHandler<HTMLDivElement> | — | |
onCompositionUpdateCapture | CompositionEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onCopy | ClipboardEventHandler<HTMLDivElement> | — | |
onCopyCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onCut | ClipboardEventHandler<HTMLDivElement> | — | |
onCutCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onDrag | DragEventHandler<HTMLDivElement> | — | |
onDragCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnd | DragEventHandler<HTMLDivElement> | — | |
onDragEndCapture | DragEventHandler<HTMLDivElement> | — | |
onDragEnter | DragEventHandler<HTMLDivElement> | — | |
onDragEnterCapture | DragEventHandler<HTMLDivElement> | — | |
onDragExit | DragEventHandler<HTMLDivElement> | — | |
onDragExitCapture | DragEventHandler<HTMLDivElement> | — | |
onDragLeave | DragEventHandler<HTMLDivElement> | — | |
onDragLeaveCapture | DragEventHandler<HTMLDivElement> | — | |
onDragOver | DragEventHandler<HTMLDivElement> | — | |
onDragOverCapture | DragEventHandler<HTMLDivElement> | — | |
onDragStart | DragEventHandler<HTMLDivElement> | — | |
onDragStartCapture | DragEventHandler<HTMLDivElement> | — | |
onDrop | DragEventHandler<HTMLDivElement> | — | |
onDropCapture | DragEventHandler<HTMLDivElement> | — | |
onDurationChange | ReactEventHandler<HTMLDivElement> | — | |
onDurationChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onEmptied | ReactEventHandler<HTMLDivElement> | — | |
onEmptiedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEncrypted | ReactEventHandler<HTMLDivElement> | — | |
onEncryptedCapture | ReactEventHandler<HTMLDivElement> | — | |
onEnded | ReactEventHandler<HTMLDivElement> | — | |
onEndedCapture | ReactEventHandler<HTMLDivElement> | — | |
onError | ReactEventHandler<HTMLDivElement> | — | |
onErrorCapture | ReactEventHandler<HTMLDivElement> | — | |
onFocus | FocusEventHandler<HTMLDivElement> | — | |
onFocusCapture | FocusEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onInput | FormEventHandler<HTMLDivElement> | — | |
onInputCapture | FormEventHandler<HTMLDivElement> | — | |
onInvalid | FormEventHandler<HTMLDivElement> | — | |
onInvalidCapture | FormEventHandler<HTMLDivElement> | — | |
onKeyDown | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyDownCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPress | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyPressCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUp | KeyboardEventHandler<HTMLDivElement> | — | |
onKeyUpCapture | KeyboardEventHandler<HTMLDivElement> | — | |
onLoad | ReactEventHandler<HTMLDivElement> | — | |
onLoadCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedData | ReactEventHandler<HTMLDivElement> | — | |
onLoadedDataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadata | ReactEventHandler<HTMLDivElement> | — | |
onLoadedMetadataCapture | ReactEventHandler<HTMLDivElement> | — | |
onLoadStart | ReactEventHandler<HTMLDivElement> | — | |
onLoadStartCapture | ReactEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPaste | ClipboardEventHandler<HTMLDivElement> | — | |
onPasteCapture | ClipboardEventHandler<HTMLDivElement> | — | |
onPause | ReactEventHandler<HTMLDivElement> | — | |
onPauseCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlay | ReactEventHandler<HTMLDivElement> | — | |
onPlayCapture | ReactEventHandler<HTMLDivElement> | — | |
onPlaying | ReactEventHandler<HTMLDivElement> | — | |
onPlayingCapture | ReactEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onProgress | ReactEventHandler<HTMLDivElement> | — | |
onProgressCapture | ReactEventHandler<HTMLDivElement> | — | |
onRateChange | ReactEventHandler<HTMLDivElement> | — | |
onRateChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onReset | FormEventHandler<HTMLDivElement> | — | |
onResetCapture | FormEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSeeked | ReactEventHandler<HTMLDivElement> | — | |
onSeekedCapture | ReactEventHandler<HTMLDivElement> | — | |
onSeeking | ReactEventHandler<HTMLDivElement> | — | |
onSeekingCapture | ReactEventHandler<HTMLDivElement> | — | |
onSelect | ReactEventHandler<HTMLDivElement> | — | |
onSelectCapture | ReactEventHandler<HTMLDivElement> | — | |
onStalled | ReactEventHandler<HTMLDivElement> | — | |
onStalledCapture | ReactEventHandler<HTMLDivElement> | — | |
onSubmit | FormEventHandler<HTMLDivElement> | — | |
onSubmitCapture | FormEventHandler<HTMLDivElement> | — | |
onSuspend | ReactEventHandler<HTMLDivElement> | — | |
onSuspendCapture | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdate | ReactEventHandler<HTMLDivElement> | — | |
onTimeUpdateCapture | ReactEventHandler<HTMLDivElement> | — | |
onToggle | ToggleEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onVolumeChange | ReactEventHandler<HTMLDivElement> | — | |
onVolumeChangeCapture | ReactEventHandler<HTMLDivElement> | — | |
onWaiting | ReactEventHandler<HTMLDivElement> | — | |
onWaitingCapture | ReactEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
part | string | — | |
popover | "" | "auto" | "manual" | "hint" | — | |
popoverTarget | string | — | |
popoverTargetAction | "toggle" | "show" | "hide" | — | |
prefix | string | — | |
property | string | — | |
radioGroup | string | — | |
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 | — | |
rel | string | — | |
resource | string | — | |
results | number | — | |
rev | string | — | |
role | AriaRole | — | |
security | string | — | |
slot | string | — | |
spellCheck | boolean | "true" | "false" | — | |
style | CSSProperties | — | |
suppressContentEditableWarning | boolean | — | |
suppressHydrationWarning | boolean | — | |
tabIndex | number | — | |
title | string | — | |
translate | "yes" | "no" | — | |
tw | string | — | Specify styles using Tailwind CSS classes. This feature is currently experimental. |
typeof | string | — | |
unselectable | "off" | "on" | — | |
vocab | string | — |
<EmptyState.FeaturedIcon />
7 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
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`. |
children | ReactNode | — | Extra content rendered inside the wrapper, alongside the icon. |
icon | ReactNode | FC<{ className?: string; }> | — | The icon to display. Accepts a component reference or a rendered element. |
ref | Ref<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. |
className | string | — | 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
Simple md
Advanced
Advanced sm
Advanced md
Props
<TreeView />
105 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
draggable | boolean | false | Enable 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. |
showConnectors | boolean | false | Show 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
aria-describedby | string | — | Identifies the element (or elements) that describes the object. |
aria-details | string | — | Identifies the element (or elements) that provide a detailed, extended description for the |
aria-label | string | — | Defines a string value that labels the current element. |
aria-labelledby | string | — | Identifies the element (or elements) that labels the current element. |
autoFocus | boolean | "first" | "last" | — | Whether to auto focus the gridlist or an option. |
children | React.ReactNode | ((item: T) => ReactNode) | — | The contents of the collection. |
className | ClassNameOrFunction<TreeRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
defaultExpandedKeys | Iterable<Key> | — | The initial expanded keys in the collection (uncontrolled). |
defaultSelectedKeys | Iterable<Key> | "all" | — | The initial selected keys in the collection (uncontrolled). |
dependencies | readonly any[] | — | Values that should invalidate the item cache when using dynamic collections. |
dir | string | — | |
disabledBehavior | "all" | "selection" | — | Whether `disabledKeys` applies to all interactions, or only selection. |
disabledKeys | Iterable<Key> | — | The item keys that are disabled. These items cannot be selected, focused, or otherwise |
disallowEmptySelection | boolean | — | Whether the collection allows empty selection. |
dragAndDropHooks | DragAndDropHooks<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. |
expandedKeys | Iterable<Key> | — | The currently expanded keys in the collection (controlled). |
hidden | boolean | — | |
id | string | — | The element's unique identifier. See |
inert | boolean | — | |
items | Iterable<T> | — | Item objects in the collection. |
keyboardNavigationBehavior | "tab" | "arrow" | — | Whether keyboard navigation to focusable elements within grid list items is |
lang | string | — | |
onAction | ((key: Key) => void) | — | Handler that is called when a user performs an action on an item. The exact user event depends |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | MouseEventHandler<HTMLDivElement> | — | |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onExpandedChange | ((keys: Set<Key>) => any) | — | Handler that is called when items are expanded or collapsed. |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | — | |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onSelectionChange | ((keys: Selection) => void) | — | Handler that is called when the selection changes. |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
render | DOMRenderFunction<"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. |
selectedKeys | Iterable<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. |
shouldSelectOnPressUp | boolean | — | Whether selection should occur on press up instead of press down. |
slot | string | null | — | A slot name for the component. Slots allow the component to receive props from a parent |
style | StyleOrFunction<TreeRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | 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)| Prop | Type | Default | Description |
|---|---|---|---|
| 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…)
| Prop | Type | Default | Description |
|---|---|---|---|
allowsArrowNavigation | boolean | — | Whether the row should support arrow key navigation even when the containing collection uses |
aria-label | string | — | 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 |
className | ClassNameOrFunction<TreeItemRenderProps> | — | The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the |
dir | string | — | |
download | string | 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 |
hasChildItems | boolean | — | Whether this item has children, even if not loaded yet. |
hidden | boolean | — | |
href | string | — | A URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href). |
hrefLang | string | — | Hints at the human language of the linked URL. |
id | Key | — | The unique id of the tree row. |
inert | boolean | — | |
isDisabled | boolean | — | Whether the item is disabled. |
lang | string | — | |
onAction | (() => void) | — | Handler that is called when a user performs an action on this tree item. The exact user event |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | — | |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | — | |
onAuxClick | MouseEventHandler<HTMLDivElement> | — | |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onClick | ((e: MouseEvent<FocusableElement>) => void) | — | **Not recommended – use `onPress` instead.** `onClick` is an alias for `onPress` |
onClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onContextMenu | MouseEventHandler<HTMLDivElement> | — | |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClick | MouseEventHandler<HTMLDivElement> | — | |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | — | |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onGotPointerCaptureCapture | PointerEventHandler<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. |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | — | |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | — | |
onMouseDown | MouseEventHandler<HTMLDivElement> | — | |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseEnter | MouseEventHandler<HTMLDivElement> | — | |
onMouseLeave | MouseEventHandler<HTMLDivElement> | — | |
onMouseMove | MouseEventHandler<HTMLDivElement> | — | |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOut | MouseEventHandler<HTMLDivElement> | — | |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseOver | MouseEventHandler<HTMLDivElement> | — | |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | — | |
onMouseUp | MouseEventHandler<HTMLDivElement> | — | |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | — | |
onPointerCancel | PointerEventHandler<HTMLDivElement> | — | |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerDown | PointerEventHandler<HTMLDivElement> | — | |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerEnter | PointerEventHandler<HTMLDivElement> | — | |
onPointerLeave | PointerEventHandler<HTMLDivElement> | — | |
onPointerMove | PointerEventHandler<HTMLDivElement> | — | |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOut | PointerEventHandler<HTMLDivElement> | — | |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerOver | PointerEventHandler<HTMLDivElement> | — | |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | — | |
onPointerUp | PointerEventHandler<HTMLDivElement> | — | |
onPointerUpCapture | PointerEventHandler<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 |
onScroll | UIEventHandler<HTMLDivElement> | — | |
onScrollCapture | UIEventHandler<HTMLDivElement> | — | |
onTouchCancel | TouchEventHandler<HTMLDivElement> | — | |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchEnd | TouchEventHandler<HTMLDivElement> | — | |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchMove | TouchEventHandler<HTMLDivElement> | — | |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | — | |
onTouchStart | TouchEventHandler<HTMLDivElement> | — | |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | — | |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | — | |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | — | |
onWheel | WheelEventHandler<HTMLDivElement> | — | |
onWheelCapture | WheelEventHandler<HTMLDivElement> | — | |
ping | string | — | 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 |
rel | string | — | The relationship between the linked resource and the current page. See |
render | DOMRenderFunction<"div", TreeItemRenderProps> | — | Overrides the default DOM element with a custom render function. |
routerOptions | undefined | — | Options for the configured client side router. |
style | StyleOrFunction<TreeItemRenderProps> | — | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the |
suppressHydrationWarning | boolean | — | A React-only flag that suppresses the warning React normally logs when an element's |
target | HTMLAttributeAnchorTarget | — | 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" | — | |
value | object | — | The object value that this tree item represents. When using dynamic collections, this is set |
<TreeView.ItemContent />
4 props · 1 for styling (highlighted)| Prop | Type | Default | Description |
|---|---|---|---|
children* | ReactNode | — | The text label for the tree item. |
action | ReactNode | — | Trailing action element (e.g. drag handle or menu trigger). |
icon | ReactNode | FC<{ className?: string; }> | — | Leading icon. Pass as component reference (e.g. `Folder`) or as element (e.g. `<Avatar />`). |
className | string | — | Additional class name for the item row. |
<TreeView.DropIndicator />
1 props| Prop | Type | Default | Description |
|---|---|---|---|
target* | RootDropTarget | ItemDropTarget | — | The drop position this indicator represents. Supplied by the tree's `renderDropIndicator` while a drag is in progress. |












Social buttons
Sign-in buttons with brand logos.
Source:
src/components/base/buttons/social-button.tsxSocial sign-in
Props
<SocialButton />
126 props · 1 for styling (highlighted)social*"google" | "facebook" | "apple" | "twitter" | "figma" | "dribble"childrenReactNodedisabledbooleanhrefstringisDisabledbooleansize"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…)
aria-controlsstringaria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"aria-describedbystringaria-detailsstringaria-disabledboolean | "true" | "false"aria-expandedboolean | "true" | "false"aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog"aria-labelstringaria-labelledbystringaria-pressedboolean | "true" | "false" | "mixed"autoFocusbooleandirstringdownloadstring | booleanexcludeFromTabOrderbooleanformstringformActionstring | ((formData: FormData) => void | Promise<void>)formEncTypestringformMethodstringformNoValidatebooleanformTargetstringhiddenbooleanhrefLangstringidstringinertbooleanisPendingbooleanlangstringnamestringonAnimationEndAnimationEventHandler<HTMLAnchorElement>onAnimationEndCaptureAnimationEventHandler<HTMLAnchorElement>onAnimationIterationAnimationEventHandler<HTMLAnchorElement>onAnimationIterationCaptureAnimationEventHandler<HTMLAnchorElement>onAnimationStartAnimationEventHandler<HTMLAnchorElement>onAnimationStartCaptureAnimationEventHandler<HTMLAnchorElement>onAuxClickMouseEventHandler<HTMLAnchorElement>onAuxClickCaptureMouseEventHandler<HTMLAnchorElement>onBlur((e: FocusEvent<Element, Element>) => void)onClick((e: MouseEvent<FocusableElement>) => void)onClickCaptureMouseEventHandler<HTMLAnchorElement>onContextMenuMouseEventHandler<HTMLAnchorElement>onContextMenuCaptureMouseEventHandler<HTMLAnchorElement>onDoubleClickMouseEventHandler<HTMLAnchorElement>onDoubleClickCaptureMouseEventHandler<HTMLAnchorElement>onFocus((e: FocusEvent<Element, Element>) => void)onFocusChange((isFocused: boolean) => void)onGotPointerCapturePointerEventHandler<HTMLAnchorElement>onGotPointerCaptureCapturePointerEventHandler<HTMLAnchorElement>onHoverChange((isHovering: boolean) => void)onHoverEnd((e: HoverEvent) => void)onHoverStart((e: HoverEvent) => void)onKeyDown((e: KeyboardEvent) => void)onKeyUp((e: KeyboardEvent) => void)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)onPressChange((isPressed: boolean) => void)onPressEnd((e: PressEvent) => void)onPressStart((e: PressEvent) => void)onPressUp((e: PressEvent) => void)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>pingstringpreventFocusOnPressbooleanrefLegacyRef<HTMLAnchorElement>referrerPolicy"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"relstringrender((props: React.DetailedHTMLProps<LinkWithRequiredHref, HTMLAnchorElement> | React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, renderProps: LinkRenderProps) => ReactElement)routerOptionsundefinedslotstring | nullstyleStyleOrFunction<LinkRenderProps>suppressHydrationWarningbooleantargetHTMLAttributeAnchorTargettranslate"yes" | "no"type"button" | "submit" | "reset"valuestring