sp-color-wheel

NPM 1.0.1

View Storybook

Try it on webcomponents.dev
Overview API Changelog

Description

An <sp-color-wheel> lets users visually change an individual channel of a color on a circular track.

Usage

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

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 TinyColor documentation. Seperately, the element's 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>

Attributes and Properties

Property Attribute Type Default Description color color ColorValue disabled disabled boolean false Disable this control. It will not receive focus or events focused focused boolean false label label string 'hue' 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

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 Wheel has been committed by the user. input Event The value of the Color Wheel has changed.

1.0.1 (2024-11-11)

Note: Version bump only for package @spectrum-web-components/color-wheel

1.0.0 (2024-10-31)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.49.0 (2024-10-15)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.48.1 (2024-10-01)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.48.0 (2024-09-17)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.47.2 (2024-09-03)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.47.1 (2024-08-27)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.47.0 (2024-08-20)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.46.0 (2024-08-08)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.45.0 (2024-07-30)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.44.0 (2024-07-15)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.43.0 (2024-06-11)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.42.5 (2024-05-24)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.42.4 (2024-05-14)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.42.3 (2024-05-01)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.42.2 (2024-04-03)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.42.1 (2024-04-02)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.42.0 (2024-03-19)

Features

  • asset: use core tokens (99e76f4)

0.41.2 (2024-03-05)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.41.1 (2024-02-22)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.41.0 (2024-02-13)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.40.5 (2024-02-05)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.40.4 (2024-01-29)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.40.3 (2024-01-11)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.40.2 (2023-12-18)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.40.1 (2023-12-05)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.40.0 (2023-11-16)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.39.4 (2023-11-02)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.39.3 (2023-10-18)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.39.2 (2023-10-13)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.39.1 (2023-10-06)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.39.0 (2023-09-25)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.38.0 (2023-09-05)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.37.0 (2023-08-18)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.36.0 (2023-08-18)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.35.0 (2023-07-31)

Bug Fixes

  • color-wheel: reorient reactively to "dir" changes (#3319) (6a9dcec)

0.34.0 (2023-07-11)

Bug Fixes

  • color-area,color-slider: color-area labeling, RTL support, vertical slider orientation(#3315) (ca2acda), closes #3313
  • color-slider,color-wheel: fix focused state #3278 (96b83f7)

0.33.2 (2023-06-14)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.33.0 (2023-06-08)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.32.0 (2023-06-01)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.31.0 (2023-05-17)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.30.0 (2023-05-03)

Bug Fixes

  • abstract "hasVisibleFocusInTree" functionality and return trigger focus after close (4f39f2c)
  • address westbrooks comments (634af60)
  • color-wheel: use correct focus events in test (f6f35ec)
  • ensure color wheel in not opinionated about saturation and lightness (8e0fd9c)
  • ensure streamingListener ends even if pointercancel not fired (74105f2)
  • expand support for maintaining hue and saturation across customization (fe18944)
  • include touch-action rule for draggable content (3f507e6)
  • key interaction handling no longer prevents "tab" presses (b542ce8)
  • leverage Color Controller to unify color interface across packages (fb71690)
  • manage "focused" across more contexts (9273c15)
  • normalize focus passing during and after pointer events (357931b)
  • prevent tabindex=-1 elements from placing focus on their host (1ac1293)
  • remove right click value setting (a44968d)
  • update colour slider (9acda67)
  • use hue normalized color in handle and allow focus (f9e1fa2)

Features

  • adopt DNA@7 base Spectrum CSS (e08cafd)
  • color-wheel: add color-wheel pattern (8b2a56d)
  • color-wheel: use core tokens (57159a2)
  • debug colour elements for a11y (7008f7c)
  • include all Dev Mode files in side effects (f70817c)
  • shared pkg versions, devmode define warning, registry-conflicts docs (6e49565)
  • update lit-* dependencies, wip (377f3c8)

0.5.2 (2023-04-24)

Bug Fixes

  • ensure streamingListener ends even if pointercancel not fired (74105f2)

0.5.1 (2023-04-05)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.5.0 (2023-03-22)

Features

  • color-wheel: use core tokens (57159a2)

0.4.9 (2023-02-08)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.4.8 (2023-01-23)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.4.7 (2023-01-09)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.4.6 (2022-12-08)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.4.5 (2022-11-21)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.4.4 (2022-11-14)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.4.3 (2022-10-28)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.4.2 (2022-10-17)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.4.1 (2022-10-10)

Bug Fixes

  • leverage Color Controller to unify color interface across packages (fb71690)

0.4.0 (2022-08-09)

Features

  • include all Dev Mode files in side effects (f70817c)

0.3.13 (2022-08-04)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.12 (2022-07-18)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.11 (2022-06-29)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.10 (2022-06-07)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.9 (2022-05-12)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.8 (2022-04-21)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.7 (2022-03-30)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.6 (2022-03-08)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.5 (2022-03-04)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.4 (2022-02-22)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.3 (2022-01-26)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.2 (2022-01-07)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.1 (2021-12-13)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.3.0 (2021-11-08)

Features

  • update lit-* dependencies, wip (377f3c8)

0.2.1 (2021-11-08)

Bug Fixes

  • abstract "hasVisibleFocusInTree" functionality and return trigger focus after close (4f39f2c)

0.2.0 (2021-11-02)

Features

  • adopt DNA@7 base Spectrum CSS (e08cafd)

0.1.13 (2021-10-12)

Bug Fixes

  • color-wheel: use correct focus events in test (f6f35ec)

0.1.12 (2021-09-20)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.1.11 (2021-09-13)

Bug Fixes

  • manage "focused" across more contexts (9273c15)

0.1.10 (2021-08-24)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.1.9 (2021-08-17)

Bug Fixes

  • key interaction handling no longer prevents "tab" presses (b542ce8)

0.1.8 (2021-07-22)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.1.7 (2021-07-01)

Bug Fixes

  • expand support for maintaining hue and saturation across customization (fe18944)
  • normalize focus passing during and after pointer events (357931b)

0.1.6 (2021-06-16)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.1.5 (2021-05-24)

Bug Fixes

  • prevent tabindex=-1 elements from placing focus on their host (1ac1293)

0.1.4 (2021-05-12)

Bug Fixes

  • include touch-action rule for draggable content (3f507e6)

0.1.3 (2021-04-09)

Bug Fixes

  • ensure color wheel in not opinionated about saturation and lightness (8e0fd9c)
  • use hue normalized color in handle and allow focus (f9e1fa2)

0.1.2 (2021-03-29)

Note: Version bump only for package @spectrum-web-components/color-wheel

0.1.1 (2021-03-22)

Bug Fixes

  • remove right click value setting (a44968d)

0.1.0 (2021-03-05)

Bug Fixes

  • address westbrooks comments (634af60)
  • update colour slider (9acda67)

Features

  • debug colour elements for a11y (7008f7c)
  • color-wheel: add color-wheel pattern (8b2a56d)