Skip to content
Lenso UI

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

PropertyTypeRequiredLocal defaultDescription
translateundefined | "yes" | "no"NoNot declarednode_modules/@react-types/shared/src/dom.d.ts:303
hiddenundefined | false | trueNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:301
styleStyleOrFunction<ColorAreaRenderProps> | undefinedNoNot declaredThe 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
formstring | undefinedNoNot declaredThe `<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
slotstring | null | undefinedNoNot declaredA 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
dirstring | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:299
refRef<HTMLDivElement> | undefinedNoNot declaredAllows 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
defaultValuestring | Color | undefinedNoNot declaredThe default value (uncontrolled).node_modules/@react-types/shared/src/inputs.d.ts:73
idstring | undefinedNoNot declaredThe 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
langstring | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:300
inertundefined | false | trueNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:302
aria-describedbystring | undefinedNoNot declaredIdentifies the element (or elements) that describes the object.node_modules/@react-types/shared/src/dom.d.ts:51
aria-detailsstring | undefinedNoNot declaredIdentifies the element (or elements) that provide a detailed, extended description for the object.node_modules/@react-types/shared/src/dom.d.ts:57
aria-labelstring | undefinedNoNot declaredDefines a string value that labels the current element.node_modules/@react-types/shared/src/dom.d.ts:41
aria-labelledbystring | undefinedNoNot declaredIdentifies the element (or elements) that labels the current element.node_modules/@react-types/shared/src/dom.d.ts:46
childrenChildrenOrFunction<ColorAreaRenderProps>NoNot declaredThe 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) | undefinedNoNot declaredHandler that is called when the value changes, as the user drags.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:17
onAuxClickMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:322
onAuxClickCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:323
onClickMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:320
onClickCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:321
onContextMenuMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:324
onContextMenuCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:325
onDoubleClickMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:326
onDoubleClickCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:327
onMouseDownMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:328
onMouseDownCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:329
onMouseEnterMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:330
onMouseLeaveMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:331
onMouseMoveMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:332
onMouseMoveCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:333
onMouseOutMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:334
onMouseOutCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:335
onMouseOverMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:336
onMouseOverCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:337
onMouseUpMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:338
onMouseUpCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:339
onTouchCancelTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:342
onTouchCancelCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:343
onTouchEndTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:344
onTouchEndCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:345
onTouchMoveTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:346
onTouchMoveCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:347
onTouchStartTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:348
onTouchStartCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:349
onPointerDownPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:352
onPointerDownCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:353
onPointerMovePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:354
onPointerMoveCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:355
onPointerUpPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:356
onPointerUpCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:357
onPointerCancelPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:358
onPointerCancelCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:359
onPointerEnterPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:360
onPointerLeavePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:361
onPointerOverPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:362
onPointerOverCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:363
onPointerOutPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:364
onPointerOutCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:365
onGotPointerCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:366
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:367
onLostPointerCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:368
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:369
onScrollUIEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:372
onScrollCaptureUIEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:373
onWheelWheelEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:376
onWheelCaptureWheelEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:377
onAnimationStartAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:380
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:381
onAnimationEndAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:382
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:383
onAnimationIterationAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:384
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:385
onTransitionCancelTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:388
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:389
onTransitionEndTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:390
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:391
onTransitionRunTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:392
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:393
onTransitionStartTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:394
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:395
valuestring | Color | undefinedNoNot declaredThe current value (controlled).node_modules/@react-types/shared/src/inputs.d.ts:71
renderDOMRenderFunction<"div", ColorAreaRenderProps> | undefinedNoNot declaredOverrides 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
isDisabledundefined | false | trueNoNot declaredWhether the ColorArea is disabled.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:15
xNamestring | undefinedNoNot declaredThe 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
yNamestring | undefinedNoNot declaredThe 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
colorSpaceundefined | "rgb" | "hsl" | "hsb"NoNot declaredThe 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
xChannelundefined | "hue" | "saturation" | "alpha" | "blue" | "green" | "red" | "brightness" | "lightness"NoNot declaredColor channel for the horizontal axis.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:11
yChannelundefined | "hue" | "saturation" | "alpha" | "blue" | "green" | "red" | "brightness" | "lightness"NoNot declaredColor channel for the vertical axis.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:13
onChangeEnd((value: Color) => void) | undefinedNoNot declaredHandler that is called when the user stops dragging.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:19
xstyleXStyleNoNot declaredpackages/react/src/utils/styled.tsx:7
data-slotunknownNoNot declaredpackages/react/src/utils/styled.tsx:8
showDotsundefined | false | trueNoNot declaredpackages/react/src/components/color-area/color-area.tsx:13

Callback state: ColorAreaRenderProps & { defaultStyle: CSSProperties; }

isDisabled
boolean
state
ColorAreaState
defaultStyle
CSSProperties

Callback state: ColorAreaRenderProps & { defaultChildren: ReactNode | undefined; }

isDisabled
boolean
state
ColorAreaState
defaultChildren
ReactNode

Callback state: ColorAreaRenderProps

isDisabled
boolean
state
ColorAreaState

Native HTML and ARIA properties (1) โ€” Property set 1

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

PropertyTypeRequiredLocal defaultDescription
translateundefined | "yes" | "no"NoNot declarednode_modules/@react-types/shared/src/dom.d.ts:303
hiddenundefined | false | trueNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:301
styleStyleOrFunction<ColorThumbRenderProps> | undefinedNoNot declaredThe 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
dirstring | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:299
refRef<HTMLDivElement> | undefinedNoNot declaredAllows 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
langstring | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:300
inertundefined | false | trueNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:302
childrenChildrenOrFunction<ColorThumbRenderProps>NoNot declaredThe 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
onAuxClickMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:322
onAuxClickCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:323
onClickMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:320
onClickCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:321
onContextMenuMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:324
onContextMenuCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:325
onDoubleClickMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:326
onDoubleClickCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:327
onMouseDownMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:328
onMouseDownCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:329
onMouseEnterMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:330
onMouseLeaveMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:331
onMouseMoveMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:332
onMouseMoveCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:333
onMouseOutMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:334
onMouseOutCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:335
onMouseOverMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:336
onMouseOverCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:337
onMouseUpMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:338
onMouseUpCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:339
onTouchCancelTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:342
onTouchCancelCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:343
onTouchEndTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:344
onTouchEndCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:345
onTouchMoveTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:346
onTouchMoveCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:347
onTouchStartTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:348
onTouchStartCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:349
onPointerDownPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:352
onPointerDownCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:353
onPointerMovePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:354
onPointerMoveCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:355
onPointerUpPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:356
onPointerUpCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:357
onPointerCancelPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:358
onPointerCancelCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:359
onPointerEnterPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:360
onPointerLeavePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:361
onPointerOverPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:362
onPointerOverCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:363
onPointerOutPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:364
onPointerOutCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:365
onGotPointerCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:366
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:367
onLostPointerCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:368
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:369
onScrollUIEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:372
onScrollCaptureUIEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:373
onWheelWheelEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:376
onWheelCaptureWheelEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:377
onAnimationStartAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:380
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:381
onAnimationEndAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:382
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:383
onAnimationIterationAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:384
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:385
onTransitionCancelTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:388
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:389
onTransitionEndTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:390
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:391
onTransitionRunTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:392
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:393
onTransitionStartTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:394
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:395
renderDOMRenderFunction<"div", ColorThumbRenderProps> | undefinedNoNot declaredOverrides 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) | undefinedNoNot declaredHandler that is called when a hover interaction starts.node_modules/@react-types/shared/src/events.d.ts:110
onHoverEnd((e: HoverEvent) => void) | undefinedNoNot declaredHandler that is called when a hover interaction ends.node_modules/@react-types/shared/src/events.d.ts:112
onHoverChange((isHovering: boolean) => void) | undefinedNoNot declaredHandler that is called when the hover state changes.node_modules/@react-types/shared/src/events.d.ts:114
xstyleXStyleNoNot declaredpackages/react/src/utils/styled.tsx:7
data-slotunknownNoNot declaredpackages/react/src/utils/styled.tsx:8

Callback state: ColorThumbRenderProps & { defaultStyle: CSSProperties; }

color
Color
isDragging
boolean
isHovered
boolean
isFocused
boolean
isFocusVisible
boolean
isDisabled
boolean
defaultStyle
CSSProperties

Callback state: ColorThumbRenderProps & { defaultChildren: ReactNode | undefined; }

color
Color
isDragging
boolean
isHovered
boolean
isFocused
boolean
isFocusVisible
boolean
isDisabled
boolean
defaultChildren
ReactNode

Callback state: ColorThumbRenderProps

color
Color
isDragging
boolean
isHovered
boolean
isFocused
boolean
isFocusVisible
boolean
isDisabled
boolean

Native HTML and ARIA properties (1) โ€” Property set 1

ColorArea

({ showDots, xstyle, ...props }: ColorAreaRootProps): JSX.Element

packages/react/src/components/color-area/index.ts:7

ColorArea.Root, ColorArea.Thumb

PropertyTypeRequiredLocal defaultDescription
translateundefined | "yes" | "no"NoNot declarednode_modules/@react-types/shared/src/dom.d.ts:303
hiddenundefined | false | trueNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:301
styleStyleOrFunction<ColorAreaRenderProps> | undefinedNoNot declaredThe 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
formstring | undefinedNoNot declaredThe `<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
slotstring | null | undefinedNoNot declaredA 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
dirstring | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:299
refRef<HTMLDivElement> | undefinedNoNot declaredAllows 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
defaultValuestring | Color | undefinedNoNot declaredThe default value (uncontrolled).node_modules/@react-types/shared/src/inputs.d.ts:73
idstring | undefinedNoNot declaredThe 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
langstring | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:300
inertundefined | false | trueNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:302
aria-describedbystring | undefinedNoNot declaredIdentifies the element (or elements) that describes the object.node_modules/@react-types/shared/src/dom.d.ts:51
aria-detailsstring | undefinedNoNot declaredIdentifies the element (or elements) that provide a detailed, extended description for the object.node_modules/@react-types/shared/src/dom.d.ts:57
aria-labelstring | undefinedNoNot declaredDefines a string value that labels the current element.node_modules/@react-types/shared/src/dom.d.ts:41
aria-labelledbystring | undefinedNoNot declaredIdentifies the element (or elements) that labels the current element.node_modules/@react-types/shared/src/dom.d.ts:46
childrenChildrenOrFunction<ColorAreaRenderProps>NoNot declaredThe 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) | undefinedNoNot declaredHandler that is called when the value changes, as the user drags.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:17
onAuxClickMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:322
onAuxClickCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:323
onClickMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:320
onClickCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:321
onContextMenuMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:324
onContextMenuCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:325
onDoubleClickMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:326
onDoubleClickCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:327
onMouseDownMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:328
onMouseDownCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:329
onMouseEnterMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:330
onMouseLeaveMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:331
onMouseMoveMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:332
onMouseMoveCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:333
onMouseOutMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:334
onMouseOutCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:335
onMouseOverMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:336
onMouseOverCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:337
onMouseUpMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:338
onMouseUpCaptureMouseEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:339
onTouchCancelTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:342
onTouchCancelCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:343
onTouchEndTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:344
onTouchEndCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:345
onTouchMoveTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:346
onTouchMoveCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:347
onTouchStartTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:348
onTouchStartCaptureTouchEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:349
onPointerDownPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:352
onPointerDownCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:353
onPointerMovePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:354
onPointerMoveCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:355
onPointerUpPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:356
onPointerUpCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:357
onPointerCancelPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:358
onPointerCancelCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:359
onPointerEnterPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:360
onPointerLeavePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:361
onPointerOverPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:362
onPointerOverCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:363
onPointerOutPointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:364
onPointerOutCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:365
onGotPointerCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:366
onGotPointerCaptureCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:367
onLostPointerCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:368
onLostPointerCaptureCapturePointerEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:369
onScrollUIEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:372
onScrollCaptureUIEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:373
onWheelWheelEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:376
onWheelCaptureWheelEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:377
onAnimationStartAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:380
onAnimationStartCaptureAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:381
onAnimationEndAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:382
onAnimationEndCaptureAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:383
onAnimationIterationAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:384
onAnimationIterationCaptureAnimationEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:385
onTransitionCancelTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:388
onTransitionCancelCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:389
onTransitionEndTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:390
onTransitionEndCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:391
onTransitionRunTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:392
onTransitionRunCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:393
onTransitionStartTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:394
onTransitionStartCaptureTransitionEventHandler<HTMLDivElement> | undefinedNoNot declarednode_modules/@react-types/shared/src/dom.d.ts:395
valuestring | Color | undefinedNoNot declaredThe current value (controlled).node_modules/@react-types/shared/src/inputs.d.ts:71
renderDOMRenderFunction<"div", ColorAreaRenderProps> | undefinedNoNot declaredOverrides 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
isDisabledundefined | false | trueNoNot declaredWhether the ColorArea is disabled.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:15
xNamestring | undefinedNoNot declaredThe 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
yNamestring | undefinedNoNot declaredThe 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
colorSpaceundefined | "rgb" | "hsl" | "hsb"NoNot declaredThe 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
xChannelundefined | "hue" | "saturation" | "alpha" | "blue" | "green" | "red" | "brightness" | "lightness"NoNot declaredColor channel for the horizontal axis.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:11
yChannelundefined | "hue" | "saturation" | "alpha" | "blue" | "green" | "red" | "brightness" | "lightness"NoNot declaredColor channel for the vertical axis.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:13
onChangeEnd((value: Color) => void) | undefinedNoNot declaredHandler that is called when the user stops dragging.node_modules/react-stately/dist/types/src/color/useColorAreaState.d.ts:19
xstyleXStyleNoNot declaredpackages/react/src/utils/styled.tsx:7
data-slotunknownNoNot declaredpackages/react/src/utils/styled.tsx:8
showDotsundefined | false | trueNoNot declaredpackages/react/src/components/color-area/color-area.tsx:13

Callback state: ColorAreaRenderProps & { defaultStyle: CSSProperties; }

isDisabled
boolean
state
ColorAreaState
defaultStyle
CSSProperties

Callback state: ColorAreaRenderProps & { defaultChildren: ReactNode | undefined; }

isDisabled
boolean
state
ColorAreaState
defaultChildren
ReactNode

Callback state: ColorAreaRenderProps

isDisabled
boolean
state
ColorAreaState

Native HTML and ARIA properties (1) โ€” Property set 1

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

PropertyTypeRequiredLocal defaultDescription
keyKey | null | undefinedNoNot declarednode_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