ColorWheel
The props declared for ColorWheel, generated from the types @proyecto-viviana/ui ships.
Import
import { ColorWheel } from "@proyecto-viviana/ui";Props
| Prop | Type | Default | Description |
|---|---|---|---|
size | number | — | Diameter of the authored Spectrum control in pixels. |
styles | StylesProp | — | Spectrum-defined generated classes. |
UNSAFE_className | string | UnsafeClassName | — | Additional CSS class name. Use only as a last resort. |
UNSAFE_style | JSX.CSSProperties | — | Additional inline styles. Use only as a last resort. |
class | string | — | Backward-compatible class alias. Prefer UNSAFE_className for S2 parity. |
children | number | boolean | RenderedElement | ArrayElement | (string & {}) | Node | JSX.ArrayElement | ((renderProps: ColorWheelRenderProps) => JSX.Element) | — | The children of the component. solidaria-components |
slot | string | false | — | A slot name for the component. HTML `slot` may be `false` to omit. solidaria-components |
id | string | — | Element id for the hidden hue range input. solidaria |
onChange | (color: Color) => void | — | Handler called when the color changes. solidaria-components |
aria-describedby | string | — | ID of element that describes the wheel. solidaria |
aria-details | string | — | ID of element that provides detailed information about the wheel. solidaria |
aria-errormessage | string | — | ID of element that provides the error message. solidaria |
aria-label | string | — | Accessible label for the wheel. solidaria |
aria-labelledby | string | — | ID of element that labels the wheel. solidaria |
isDisabled | false | true | — | Whether the wheel is disabled. solidaria |
form | string | — | Associated form owner for the hidden hue range input. solidaria |
name | string | — | Name for the hidden hue range input. solidaria |
value | string | Color | — | The current color value (controlled). solidaria-components |
defaultValue | string | Color | — | The default color value (uncontrolled). solidaria-components |
onChangeEnd | (color: Color) => void | — | Handler called when dragging ends. solidaria-components |
outerRadius | number | — | Outer radius of the circular track in pixels. solidaria |
innerRadius | number | — | 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.