ColorArea
A two-dimensional color channel control in a color editing context.
Usage
import { ColorArea } from "@lenso/ui";"use client";
import { ColorArea } from "@lenso/ui";
export function ColorAreaBasic() { return ( <ColorArea aria-label="Color area" defaultValue="rgb(116, 52, 255)"> <ColorArea.Thumb /> </ColorArea> );}Examples
color area with dots
"use client";/** Adapted from HeroUI v3.2.6. Apache-2.0. */import { ColorArea } from "@lenso/ui";export function ColorAreaWithDots() { return ( <ColorArea aria-label="Color area" showDots defaultValue="hsl(200, 100%, 50%)"> <ColorArea.Thumb /> </ColorArea> );}color area space and channels
"use client";/** Adapted from HeroUI v3.2.6. Apache-2.0. Base UI owns the ordinary selects. */import { ColorArea, parseColor } from "@lenso/ui";import { useState } from "react";import * as stylex from "@stylexjs/stylex";import { styles } from "../color-picker/source.stylex";import { ColorDemoSelect } from "../color-picker/source";type Space = "rgb" | "hsl" | "hsb";type Channel = "hue" | "saturation" | "brightness" | "lightness" | "red" | "green" | "blue";const channelsBySpace: Record<Space, Channel[]> = { rgb: ["red", "green", "blue"], hsl: ["hue", "saturation", "lightness"], hsb: ["hue", "saturation", "brightness"],};export function ColorAreaSpaceAndChannels() { const [colorSpace, setColorSpace] = useState<Space>("hsb"); const [color, setColor] = useState(() => parseColor("hsb(219, 58%, 93%)")); const [xChannel, setXChannel] = useState<Channel>("saturation"); const [yChannel, setYChannel] = useState<Channel>("brightness"); function changeSpace(space: Space) { setColorSpace(space); setXChannel(space === "rgb" ? "blue" : "saturation"); setYChannel(space === "rgb" ? "green" : space === "hsl" ? "lightness" : "brightness"); } const channels = channelsBySpace[colorSpace]; return ( <div {...stylex.props(styles.centeredColumn)}> <div {...stylex.props(styles.controls)}> <ColorDemoSelect label="Color Space" value={colorSpace} options={["rgb", "hsl", "hsb"]} onChange={changeSpace} width={128} uppercase /> <ColorDemoSelect label="X Axis" value={xChannel} options={channels.filter((c) => c !== yChannel)} onChange={setXChannel} width={144} /> <ColorDemoSelect label="Y Axis" value={yChannel} options={channels.filter((c) => c !== xChannel)} onChange={setYChannel} width={144} /> </div> <ColorArea aria-label="Color area" colorSpace={colorSpace} value={color} xChannel={xChannel} yChannel={yChannel} onChange={setColor} > <ColorArea.Thumb /> </ColorArea> <div {...stylex.props(styles.row)}> <div {...stylex.props(styles.preview)} style={{ backgroundColor: color.toString("css") }} /> <code {...stylex.props(styles.code)}>{color.toString(colorSpace)}</code> </div> </div> );}color area disabled
"use client";/** Adapted from HeroUI v3.2.6. Apache-2.0. */import { ColorArea } from "@lenso/ui";export function ColorAreaDisabled() { return ( <ColorArea aria-label="Color area" isDisabled defaultValue="hsl(200, 100%, 50%)"> <ColorArea.Thumb /> </ColorArea> );}color area controlled
"use client";/** Adapted from HeroUI v3.2.6. Apache-2.0. */import { ColorArea, ColorSwatch, parseColor } from "@lenso/ui";import { useState } from "react";import * as stylex from "@stylexjs/stylex";import { styles } from "../color-picker/source.stylex";export function ColorAreaControlled() { const [color, setColor] = useState(parseColor("#9B80FF")); return ( <div {...stylex.props(styles.column)}> <ColorArea aria-label="Color area" colorSpace="rgb" value={color} xChannel="red" yChannel="green" onChange={setColor} > <ColorArea.Thumb /> </ColorArea> <div {...stylex.props(styles.row, styles.width300)}> <ColorSwatch color={color} size="md" /> <p {...stylex.props(styles.muted)}> Current color: <span {...stylex.props(styles.medium)}>{color.toString("hex")}</span> </p> </div> </div> );}color area render function
"use client";/** Adapted from HeroUI v3.2.6. Apache-2.0. Native RAC render state replaces DOM render interception. */import { ColorArea } from "@lenso/ui";export function RenderFunction() { return ( <ColorArea aria-label="Color area" defaultValue="rgb(116, 52, 255)" data-custom="slider"> {({ isDisabled }) => ( <ColorArea.Thumb data-custom="thumb" data-disabled={isDisabled || undefined} /> )} </ColorArea> );}color area custom styles
"use client";/** Adapted from HeroUI v3.2.6. Apache-2.0. */import { ColorArea } from "@lenso/ui";import { styles } from "../color-picker/source.stylex";export function CustomStyles() { return ( <ColorArea aria-label="Color area" xstyle={styles.areaCustom} defaultValue="rgb(116, 52, 255)"> <ColorArea.Thumb xstyle={styles.areaThumb} /> </ColorArea> );}API Reference
Generated from the local public TypeScript exports. Types and callback state follow the installed native contracts, not the historical HeroUI API.
Only literal defaults in the component's parameter declaration are shown. Other defaults may depend on context or the native component.
ColorAreaRoot
({ showDots, xstyle, ...props }: ColorAreaRootProps): JSX.Element
packages/react/src/components/color-area/color-area.tsx:15
react-aria-components/ColorArea
| Property | Type | Required | Local default | Description |
|---|---|---|---|---|
translate | undefined | "yes" | "no" | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:303 |
hidden | undefined | false | true | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:301 |
style | StyleOrFunction<ColorAreaRenderProps> | undefined | No | Not declared | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.node_modules/react-aria-components/dist/types/src/utils.d.ts:132 |
form | string | undefined | No | Not declared | The `<form>` element to associate the ColorArea with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form).node_modules/react-aria/dist/types/src/color/useColorArea.d.ts:20 |
slot | string | null | undefined | No | Not declared | A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.node_modules/react-aria-components/dist/types/src/utils.d.ts:172 |
dir | string | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:299 |
ref | Ref<HTMLDivElement> | undefined | No | Not declared | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).node_modules/@types/react/index.d.ts:301 |
defaultValue | string | Color | undefined | No | Not declared | The default value (uncontrolled).node_modules/@react-types/shared/src/inputs.d.ts:73 |
id | string | undefined | No | Not declared | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).node_modules/@react-types/shared/src/dom.d.ts:75 |
lang | string | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:300 |
inert | undefined | false | true | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:302 |
aria-describedby | string | undefined | No | Not declared | Identifies the element (or elements) that describes the object.node_modules/@react-types/shared/src/dom.d.ts:51 |
aria-details | string | undefined | No | Not declared | Identifies the element (or elements) that provide a detailed, extended description for the object.node_modules/@react-types/shared/src/dom.d.ts:57 |
aria-label | string | undefined | No | Not declared | Defines a string value that labels the current element.node_modules/@react-types/shared/src/dom.d.ts:41 |
aria-labelledby | string | undefined | No | Not declared | Identifies the element (or elements) that labels the current element.node_modules/@react-types/shared/src/dom.d.ts:46 |
children | ChildrenOrFunction<ColorAreaRenderProps> | No | Not declared | The children of the component. A function may be provided to alter the children based on component state.node_modules/react-aria-components/dist/types/src/utils.d.ts:142 |
onChange | ((value: Color) => void) | undefined | No | Not declared | Handler that is called when the value changes, as the user drags.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:17 |
onAuxClick | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:322 |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:323 |
onClick | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:320 |
onClickCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:321 |
onContextMenu | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:324 |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:325 |
onDoubleClick | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:326 |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:327 |
onMouseDown | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:328 |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:329 |
onMouseEnter | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:330 |
onMouseLeave | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:331 |
onMouseMove | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:332 |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:333 |
onMouseOut | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:334 |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:335 |
onMouseOver | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:336 |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:337 |
onMouseUp | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:338 |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:339 |
onTouchCancel | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:342 |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:343 |
onTouchEnd | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:344 |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:345 |
onTouchMove | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:346 |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:347 |
onTouchStart | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:348 |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:349 |
onPointerDown | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:352 |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:353 |
onPointerMove | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:354 |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:355 |
onPointerUp | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:356 |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:357 |
onPointerCancel | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:358 |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:359 |
onPointerEnter | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:360 |
onPointerLeave | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:361 |
onPointerOver | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:362 |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:363 |
onPointerOut | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:364 |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:365 |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:366 |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:367 |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:368 |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:369 |
onScroll | UIEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:372 |
onScrollCapture | UIEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:373 |
onWheel | WheelEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:376 |
onWheelCapture | WheelEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:377 |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:380 |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:381 |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:382 |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:383 |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:384 |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:385 |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:388 |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:389 |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:390 |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:391 |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:392 |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:393 |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:394 |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:395 |
value | string | Color | undefined | No | Not declared | The current value (controlled).node_modules/@react-types/shared/src/inputs.d.ts:71 |
render | DOMRenderFunction<"div", ColorAreaRenderProps> | undefined | No | Not declared | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.node_modules/react-aria-components/dist/types/src/utils.d.ts:208 |
isDisabled | undefined | false | true | No | Not declared | Whether the ColorArea is disabled.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:15 |
xName | string | undefined | No | Not declared | The name of the x channel input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).node_modules/react-aria/dist/types/src/color/useColorArea.d.ts:9 |
yName | string | undefined | No | Not declared | The name of the y channel input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).node_modules/react-aria/dist/types/src/color/useColorArea.d.ts:14 |
colorSpace | undefined | "rgb" | "hsl" | "hsb" | No | Not declared | The color space that the color area operates in. The `xChannel` and `yChannel` must be in this color space. If not provided, this defaults to the color space of the `color` or `defaultColor` value.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:9 |
xChannel | undefined | "hue" | "saturation" | "alpha" | "blue" | "green" | "red" | "brightness" | "lightness" | No | Not declared | Color channel for the horizontal axis.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:11 |
yChannel | undefined | "hue" | "saturation" | "alpha" | "blue" | "green" | "red" | "brightness" | "lightness" | No | Not declared | Color channel for the vertical axis.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:13 |
onChangeEnd | ((value: Color) => void) | undefined | No | Not declared | Handler that is called when the user stops dragging.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:19 |
xstyle | XStyle | No | Not declared | packages/react/src/utils/styled.tsx:7 |
data-slot | unknown | No | Not declared | packages/react/src/utils/styled.tsx:8 |
showDots | undefined | false | true | No | Not declared | packages/react/src/components/color-area/color-area.tsx:13 |
Callback state: ColorAreaRenderProps & { defaultStyle: CSSProperties; }
isDisabledbooleanstateColorAreaStatedefaultStyleCSSProperties
Callback state: ColorAreaRenderProps & { defaultChildren: ReactNode | undefined; }
isDisabledbooleanstateColorAreaStatedefaultChildrenReactNode
Callback state: ColorAreaRenderProps
isDisabledbooleanstateColorAreaState
ColorAreaThumb
({ xstyle, style, ...props }: StyleXProps<ColorThumbProps & RefAttributes<HTMLDivElement>>): ReactElement<any, string | JSXElementConstructor<any>>
packages/react/src/components/color-area/color-area.tsx:18
react-aria-components/ColorArea
| Property | Type | Required | Local default | Description |
|---|---|---|---|---|
translate | undefined | "yes" | "no" | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:303 |
hidden | undefined | false | true | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:301 |
style | StyleOrFunction<ColorThumbRenderProps> | undefined | No | Not declared | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.node_modules/react-aria-components/dist/types/src/utils.d.ts:132 |
dir | string | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:299 |
ref | Ref<HTMLDivElement> | undefined | No | Not declared | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).node_modules/@types/react/index.d.ts:301 |
lang | string | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:300 |
inert | undefined | false | true | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:302 |
children | ChildrenOrFunction<ColorThumbRenderProps> | No | Not declared | The children of the component. A function may be provided to alter the children based on component state.node_modules/react-aria-components/dist/types/src/utils.d.ts:142 |
onAuxClick | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:322 |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:323 |
onClick | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:320 |
onClickCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:321 |
onContextMenu | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:324 |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:325 |
onDoubleClick | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:326 |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:327 |
onMouseDown | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:328 |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:329 |
onMouseEnter | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:330 |
onMouseLeave | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:331 |
onMouseMove | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:332 |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:333 |
onMouseOut | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:334 |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:335 |
onMouseOver | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:336 |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:337 |
onMouseUp | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:338 |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:339 |
onTouchCancel | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:342 |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:343 |
onTouchEnd | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:344 |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:345 |
onTouchMove | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:346 |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:347 |
onTouchStart | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:348 |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:349 |
onPointerDown | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:352 |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:353 |
onPointerMove | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:354 |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:355 |
onPointerUp | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:356 |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:357 |
onPointerCancel | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:358 |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:359 |
onPointerEnter | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:360 |
onPointerLeave | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:361 |
onPointerOver | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:362 |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:363 |
onPointerOut | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:364 |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:365 |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:366 |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:367 |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:368 |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:369 |
onScroll | UIEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:372 |
onScrollCapture | UIEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:373 |
onWheel | WheelEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:376 |
onWheelCapture | WheelEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:377 |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:380 |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:381 |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:382 |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:383 |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:384 |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:385 |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:388 |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:389 |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:390 |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:391 |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:392 |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:393 |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:394 |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:395 |
render | DOMRenderFunction<"div", ColorThumbRenderProps> | undefined | No | Not declared | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.node_modules/react-aria-components/dist/types/src/utils.d.ts:208 |
onHoverStart | ((e: HoverEvent) => void) | undefined | No | Not declared | Handler that is called when a hover interaction starts.node_modules/@react-types/shared/src/events.d.ts:110 |
onHoverEnd | ((e: HoverEvent) => void) | undefined | No | Not declared | Handler that is called when a hover interaction ends.node_modules/@react-types/shared/src/events.d.ts:112 |
onHoverChange | ((isHovering: boolean) => void) | undefined | No | Not declared | Handler that is called when the hover state changes.node_modules/@react-types/shared/src/events.d.ts:114 |
xstyle | XStyle | No | Not declared | packages/react/src/utils/styled.tsx:7 |
data-slot | unknown | No | Not declared | packages/react/src/utils/styled.tsx:8 |
Callback state: ColorThumbRenderProps & { defaultStyle: CSSProperties; }
colorColorisDraggingbooleanisHoveredbooleanisFocusedbooleanisFocusVisiblebooleanisDisabledbooleandefaultStyleCSSProperties
Callback state: ColorThumbRenderProps & { defaultChildren: ReactNode | undefined; }
colorColorisDraggingbooleanisHoveredbooleanisFocusedbooleanisFocusVisiblebooleanisDisabledbooleandefaultChildrenReactNode
Callback state: ColorThumbRenderProps
colorColorisDraggingbooleanisHoveredbooleanisFocusedbooleanisFocusVisiblebooleanisDisabledboolean
ColorArea
({ showDots, xstyle, ...props }: ColorAreaRootProps): JSX.Element
packages/react/src/components/color-area/index.ts:7
ColorArea.Root, ColorArea.Thumb
| Property | Type | Required | Local default | Description |
|---|---|---|---|---|
translate | undefined | "yes" | "no" | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:303 |
hidden | undefined | false | true | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:301 |
style | StyleOrFunction<ColorAreaRenderProps> | undefined | No | Not declared | The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.node_modules/react-aria-components/dist/types/src/utils.d.ts:132 |
form | string | undefined | No | Not declared | The `<form>` element to associate the ColorArea with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form).node_modules/react-aria/dist/types/src/color/useColorArea.d.ts:20 |
slot | string | null | undefined | No | Not declared | A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.node_modules/react-aria-components/dist/types/src/utils.d.ts:172 |
dir | string | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:299 |
ref | Ref<HTMLDivElement> | undefined | No | Not declared | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).node_modules/@types/react/index.d.ts:301 |
defaultValue | string | Color | undefined | No | Not declared | The default value (uncontrolled).node_modules/@react-types/shared/src/inputs.d.ts:73 |
id | string | undefined | No | Not declared | The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).node_modules/@react-types/shared/src/dom.d.ts:75 |
lang | string | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:300 |
inert | undefined | false | true | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:302 |
aria-describedby | string | undefined | No | Not declared | Identifies the element (or elements) that describes the object.node_modules/@react-types/shared/src/dom.d.ts:51 |
aria-details | string | undefined | No | Not declared | Identifies the element (or elements) that provide a detailed, extended description for the object.node_modules/@react-types/shared/src/dom.d.ts:57 |
aria-label | string | undefined | No | Not declared | Defines a string value that labels the current element.node_modules/@react-types/shared/src/dom.d.ts:41 |
aria-labelledby | string | undefined | No | Not declared | Identifies the element (or elements) that labels the current element.node_modules/@react-types/shared/src/dom.d.ts:46 |
children | ChildrenOrFunction<ColorAreaRenderProps> | No | Not declared | The children of the component. A function may be provided to alter the children based on component state.node_modules/react-aria-components/dist/types/src/utils.d.ts:142 |
onChange | ((value: Color) => void) | undefined | No | Not declared | Handler that is called when the value changes, as the user drags.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:17 |
onAuxClick | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:322 |
onAuxClickCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:323 |
onClick | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:320 |
onClickCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:321 |
onContextMenu | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:324 |
onContextMenuCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:325 |
onDoubleClick | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:326 |
onDoubleClickCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:327 |
onMouseDown | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:328 |
onMouseDownCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:329 |
onMouseEnter | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:330 |
onMouseLeave | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:331 |
onMouseMove | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:332 |
onMouseMoveCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:333 |
onMouseOut | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:334 |
onMouseOutCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:335 |
onMouseOver | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:336 |
onMouseOverCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:337 |
onMouseUp | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:338 |
onMouseUpCapture | MouseEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:339 |
onTouchCancel | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:342 |
onTouchCancelCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:343 |
onTouchEnd | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:344 |
onTouchEndCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:345 |
onTouchMove | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:346 |
onTouchMoveCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:347 |
onTouchStart | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:348 |
onTouchStartCapture | TouchEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:349 |
onPointerDown | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:352 |
onPointerDownCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:353 |
onPointerMove | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:354 |
onPointerMoveCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:355 |
onPointerUp | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:356 |
onPointerUpCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:357 |
onPointerCancel | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:358 |
onPointerCancelCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:359 |
onPointerEnter | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:360 |
onPointerLeave | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:361 |
onPointerOver | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:362 |
onPointerOverCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:363 |
onPointerOut | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:364 |
onPointerOutCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:365 |
onGotPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:366 |
onGotPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:367 |
onLostPointerCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:368 |
onLostPointerCaptureCapture | PointerEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:369 |
onScroll | UIEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:372 |
onScrollCapture | UIEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:373 |
onWheel | WheelEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:376 |
onWheelCapture | WheelEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:377 |
onAnimationStart | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:380 |
onAnimationStartCapture | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:381 |
onAnimationEnd | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:382 |
onAnimationEndCapture | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:383 |
onAnimationIteration | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:384 |
onAnimationIterationCapture | AnimationEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:385 |
onTransitionCancel | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:388 |
onTransitionCancelCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:389 |
onTransitionEnd | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:390 |
onTransitionEndCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:391 |
onTransitionRun | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:392 |
onTransitionRunCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:393 |
onTransitionStart | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:394 |
onTransitionStartCapture | TransitionEventHandler<HTMLDivElement> | undefined | No | Not declared | node_modules/@react-types/shared/src/dom.d.ts:395 |
value | string | Color | undefined | No | Not declared | The current value (controlled).node_modules/@react-types/shared/src/inputs.d.ts:71 |
render | DOMRenderFunction<"div", ColorAreaRenderProps> | undefined | No | Not declared | Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.node_modules/react-aria-components/dist/types/src/utils.d.ts:208 |
isDisabled | undefined | false | true | No | Not declared | Whether the ColorArea is disabled.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:15 |
xName | string | undefined | No | Not declared | The name of the x channel input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).node_modules/react-aria/dist/types/src/color/useColorArea.d.ts:9 |
yName | string | undefined | No | Not declared | The name of the y channel input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).node_modules/react-aria/dist/types/src/color/useColorArea.d.ts:14 |
colorSpace | undefined | "rgb" | "hsl" | "hsb" | No | Not declared | The color space that the color area operates in. The `xChannel` and `yChannel` must be in this color space. If not provided, this defaults to the color space of the `color` or `defaultColor` value.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:9 |
xChannel | undefined | "hue" | "saturation" | "alpha" | "blue" | "green" | "red" | "brightness" | "lightness" | No | Not declared | Color channel for the horizontal axis.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:11 |
yChannel | undefined | "hue" | "saturation" | "alpha" | "blue" | "green" | "red" | "brightness" | "lightness" | No | Not declared | Color channel for the vertical axis.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:13 |
onChangeEnd | ((value: Color) => void) | undefined | No | Not declared | Handler that is called when the user stops dragging.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:19 |
xstyle | XStyle | No | Not declared | packages/react/src/utils/styled.tsx:7 |
data-slot | unknown | No | Not declared | packages/react/src/utils/styled.tsx:8 |
showDots | undefined | false | true | No | Not declared | packages/react/src/components/color-area/color-area.tsx:13 |
Callback state: ColorAreaRenderProps & { defaultStyle: CSSProperties; }
isDisabledbooleanstateColorAreaStatedefaultStyleCSSProperties
Callback state: ColorAreaRenderProps & { defaultChildren: ReactNode | undefined; }
isDisabledbooleanstateColorAreaStatedefaultChildrenReactNode
Callback state: ColorAreaRenderProps
isDisabledbooleanstateColorAreaState
Shared native HTML and ARIA properties
Parts with identical inherited property records share one complete table. Different native types remain separate.
Property set 1 (1)
Applies to: ColorAreaRoot, ColorAreaThumb, ColorArea
| Property | Type | Required | Local default | Description |
|---|---|---|---|---|
key | Key | null | undefined | No | Not declared | node_modules/@types/react/index.d.ts:259 |
HeroUI v3.2.6 is the visual and historical reference, not an API compatibility promise. HeroUI v3.2.6