Examples API

Attributes and Properties #

Property Attribute Type Default Description
autofocus autofocus boolean false When this control is rendered, focus it automatically
color color ColorValue
dir dir 'ltr' | 'rtl' 'ltr'
disabled disabled boolean false Disable this control. It will not receive focus or events
focused focused boolean false
label label string 'hue'
sliderHandlePosition sliderHandlePosition number 0
step step number 1
tabIndex tabIndex number The tab index to apply to this control. See general documentation about the tabindex HTML property
value value number
vertical vertical boolean false

Slots #

Name Description
gradient a custom gradient visually outlining the available color values

Events #

Name Type Description
change Event An alteration to the value of the Color Slider has been committed by the user.
input Event The value of the Color Slider has changed.

Description #

An <sp-color-slider> lets users visually change an individual channel of a color. The background of the <sp-color-slider> is a visual representation of the range of values a user can select from. This can represent color properties such as hues, color channel values (such as RGB or CMYK levels), or opacity. Currently, the slider only supports leveraging the hue property.

Usage #

See it on NPM! How big is this package in your project? Try it on webcomponents.dev

yarn add @spectrum-web-components/color-slider

Import the side effectful registration of <sp-color-slider> via:

import '@spectrum-web-components/color-slider/sp-color-slider.js';

When looking to leverage the ColorSlider base class as a type and/or for extension purposes, do so via:

import { ColorSlider } from '@spectrum-web-components/color-slider';

Color Formatting #

When using the color elements, use el.color to access the color property, which should manage itself in the colour 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
  • 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 TinyColor documentation. Seperately, the element's value property is directly managed by the hue as represented in the interface.

Default #


Vertical #

<sp-color-slider vertical></sp-color-slider>

Disabled #

<sp-color-slider disabled></sp-color-slider>