sp-color-wheel
Attributes and Properties #
color
color
ColorValue
dir
dir
'ltr' | 'rtl'
disabled
disabled
boolean
false
focused
focused
boolean
false
label
label
string
'hue'
step
step
number
1
value
value
number
Slots #
gradient
Events #
change
Event
An alteration to the value of the Color Wheel has been committed by the user.
input
Event
The value of the Color Wheel has changed.
Description #
An <sp-color-wheel>
lets users visually change an individual channel of a color on a circular track.
Usage #
yarn add @spectrum-web-components/color-wheel
Import the side effectful registration of <sp-color-wheel>
via:
import '@spectrum-web-components/color-wheel/sp-color-wheel.js';
When looking to leverage the ColorWheel
base class as a type and/or for extension purposes, do so via:
import { ColorWheel } from '@spectrum-web-components/color-wheel';
Color Formatting #
When using the color elements, use el.color
to access the color
property, which should manage itself in the color format supplied. If you supply a color in rgb()
format, el.color
should return the color in rgb()
format, as well.
The current color formats supported are as follows:
- Hex3, Hex4, Hex6, Hex8
- HSV, HSVA
- HSL, HSLA
- RGB, RGBA
- Strings (eg "red", "blue")
Please note for the following formats: HSV, HSVA, HSL, HSLA When using the HSL or HSV formats, and a color's value (in HSV) is set to 0, or its luminosity (in HSL) is set to 0 or 1, the hue and saturation values may not be preserved by the element's color
property. This is detailed in the value
property is directly managed by the hue as represented in the interface.
Example #
<sp-color-wheel></sp-color-wheel>
Disabled #
A color wheel in a disabled state shows that an input exists, but is not available in that circumstance. This can be used to maintain layout continuity and communicate that the wheel may become available later.
<sp-color-wheel disabled></sp-color-wheel>
Variants #
Sized #
An <sp-color-wheel>
’s size can be customized appropriately for its context. By default, the size is size-2400 (192 px on desktop, 240 px on mobile).
<sp-color-wheel style="width: 300px; height: 300px;"></sp-color-wheel>