Skip to main content
PROYECTOVIVIANA

ColorWheel

The props declared for ColorWheel, generated from the types @proyecto-viviana/ui ships.

Import

import { ColorWheel } from "@proyecto-viviana/ui";

Props

Props for ColorWheel in @proyecto-viviana/ui
PropTypeDefaultDescription
sizenumber—Diameter of the authored Spectrum control in pixels.
stylesStylesProp—Spectrum-defined generated classes.
UNSAFE_classNamestring | UnsafeClassName—Additional CSS class name. Use only as a last resort.
UNSAFE_styleJSX.CSSProperties—Additional inline styles. Use only as a last resort.
classstring—Backward-compatible class alias. Prefer UNSAFE_className for S2 parity.
childrennumber | boolean | RenderedElement | ArrayElement | (string & {}) | Node | JSX.ArrayElement | ((renderProps: ColorWheelRenderProps) => JSX.Element)—The children of the component. solidaria-components
slotstring | false—A slot name for the component. HTML `slot` may be `false` to omit. solidaria-components
idstring—Element id for the hidden hue range input. solidaria
onChange(color: Color) => void—Handler called when the color changes. solidaria-components
aria-describedbystring—ID of element that describes the wheel. solidaria
aria-detailsstring—ID of element that provides detailed information about the wheel. solidaria
aria-errormessagestring—ID of element that provides the error message. solidaria
aria-labelstring—Accessible label for the wheel. solidaria
aria-labelledbystring—ID of element that labels the wheel. solidaria
isDisabledfalse | true—Whether the wheel is disabled. solidaria
formstring—Associated form owner for the hidden hue range input. solidaria
namestring—Name for the hidden hue range input. solidaria
valuestring | Color—The current color value (controlled). solidaria-components
defaultValuestring | Color—The default color value (uncontrolled). solidaria-components
onChangeEnd(color: Color) => void—Handler called when dragging ends. solidaria-components
outerRadiusnumber—Outer radius of the circular track in pixels. solidaria
innerRadiusnumber—Inner radius of the circular track in pixels. solidaria

Declared in packages/viviana-ui/src/color/index.tsx.

Props marked solidaria or solidaria-components come from the headless layer underneath and behave the same in both registers. Components that wrap a DOM element also accept that element's standard attributes, which are left out here on purpose — listing them would bury the props that are actually ours.