@thednp/color-picker 0.0.2-alpha5 → 1.0.1

package/src/js/color-picker.js

@@ -1,4 +1,4 @@
-import { addListener, removeListener } from 'event-listener.js';
+import { addListener, removeListener } from '@thednp/event-listener/src/event-listener';
 
 import ariaDescription from 'shorter-js/src/strings/ariaDescription';
 import ariaSelected from 'shorter-js/src/strings/ariaSelected';
@@ -16,12 +16,12 @@ import focusinEvent from 'shorter-js/src/strings/focusinEvent';
 import mouseclickEvent from 'shorter-js/src/strings/mouseclickEvent';
 import keydownEvent from 'shorter-js/src/strings/keydownEvent';
 import changeEvent from 'shorter-js/src/strings/changeEvent';
-import touchstartEvent from 'shorter-js/src/strings/touchstartEvent';
+
 import touchmoveEvent from 'shorter-js/src/strings/touchmoveEvent';
-import touchendEvent from 'shorter-js/src/strings/touchendEvent';
-import mousedownEvent from 'shorter-js/src/strings/mousedownEvent';
-import mousemoveEvent from 'shorter-js/src/strings/mousemoveEvent';
-import mouseupEvent from 'shorter-js/src/strings/mouseupEvent';
+import pointerdownEvent from 'shorter-js/src/strings/pointerdownEvent';
+import pointermoveEvent from 'shorter-js/src/strings/pointermoveEvent';
+import pointerupEvent from 'shorter-js/src/strings/pointerupEvent';
+
 import scrollEvent from 'shorter-js/src/strings/scrollEvent';
 import keyupEvent from 'shorter-js/src/strings/keyupEvent';
 import resizeEvent from 'shorter-js/src/strings/resizeEvent';
@@ -29,7 +29,6 @@ import focusoutEvent from 'shorter-js/src/strings/focusoutEvent';
 
 import getDocument from 'shorter-js/src/get/getDocument';
 import getDocumentElement from 'shorter-js/src/get/getDocumentElement';
-import getWindow from 'shorter-js/src/get/getWindow';
 import getElementStyle from 'shorter-js/src/get/getElementStyle';
 import getUID from 'shorter-js/src/get/getUID';
 import getBoundingClientRect from 'shorter-js/src/get/getBoundingClientRect';
@@ -80,7 +79,7 @@ const colorPickerDefaults = {
 // ColorPicker Static Methods
 // ==========================
 
-/** @type {CP.GetInstance<ColorPicker>} */
+/** @type {CP.GetInstance<ColorPicker, HTMLInputElement>} */
 const getColorPickerInstance = (element) => getInstance(element, colorPickerString);
 
 /** @type {CP.InitCallback<ColorPicker>} */
@@ -115,17 +114,12 @@ function toggleEventsOnShown(self, action) {
   const fn = action ? addListener : removeListener;
   const { input, colorMenu, parent } = self;
   const doc = getDocument(input);
-  const win = getWindow(input);
-  const pointerEvents = `on${touchstartEvent}` in doc
-    ? { down: touchstartEvent, move: touchmoveEvent, up: touchendEvent }
-    : { down: mousedownEvent, move: mousemoveEvent, up: mouseupEvent };
+  const win = doc.defaultView;
 
-  fn(self.controls, pointerEvents.down, self.pointerDown);
+  fn(self.controls, pointerdownEvent, self.pointerDown);
   self.controlKnobs.forEach((x) => fn(x, keydownEvent, self.handleKnobs));
 
-  // @ts-ignore -- this is `Window`
   fn(win, scrollEvent, self.handleScroll);
-  // @ts-ignore -- this is `Window`
   fn(win, resizeEvent, self.update);
 
   [input, ...self.inputs].forEach((x) => fn(x, changeEvent, self.changeHandler));
@@ -135,8 +129,8 @@ function toggleEventsOnShown(self, action) {
     fn(colorMenu, keydownEvent, self.menuKeyHandler);
   }
 
-  fn(doc, pointerEvents.move, self.pointerMove);
-  fn(doc, pointerEvents.up, self.pointerUp);
+  fn(doc, pointermoveEvent, self.pointerMove);
+  fn(doc, pointerupEvent, self.pointerUp);
   fn(parent, focusoutEvent, self.handleFocusOut);
   fn(doc, keyupEvent, self.handleDismiss);
 }
@@ -155,6 +149,7 @@ function firePickerChange(self) {
  * @returns {void}
  */
 function removePosition(element) {
+  /* istanbul ignore else */
   if (element) {
     ['bottom', 'top'].forEach((x) => removeClass(element, x));
   }
@@ -218,7 +213,6 @@ export default class ColorPicker {
   constructor(target, config) {
     const self = this;
     /** @type {HTMLInputElement} */
-    // @ts-ignore
     const input = querySelector(target);
 
     // invalidate
@@ -229,7 +223,6 @@ export default class ColorPicker {
     if (!parent) throw new TypeError('ColorPicker requires a specific markup to work.');
 
     /** @type {HTMLElement} */
-    // @ts-ignore
     self.parent = parent;
 
     /** @type {number} */
@@ -257,6 +250,7 @@ export default class ColorPicker {
     } = normalizeOptions(this.isCE ? parent : input, colorPickerDefaults, config || {});
 
     let translatedColorLabels = colorNames;
+    /* istanbul ignore else */
     if (colorLabels instanceof Array && colorLabels.length === 17) {
       translatedColorLabels = colorLabels;
     } else if (colorLabels && colorLabels.split(',').length === 17) {
@@ -273,7 +267,7 @@ export default class ColorPicker {
       ? JSON.parse(componentLabels) : componentLabels;
 
     /** @type {Record<string, string>} */
-    self.componentLabels = ObjectAssign(colorPickerLabels, tempComponentLabels);
+    self.componentLabels = ObjectAssign({ ...colorPickerLabels }, tempComponentLabels);
 
     /** @type {Color} */
     self.color = new Color(input.value || '#fff', format);
@@ -282,14 +276,14 @@ export default class ColorPicker {
     self.format = format;
 
     // set colour defaults
-    if (colorKeywords instanceof Array) {
+    if (colorKeywords instanceof Array && colorKeywords.length) {
       self.colorKeywords = colorKeywords;
     } else if (typeof colorKeywords === 'string' && colorKeywords.length) {
       self.colorKeywords = colorKeywords.split(',').map((x) => x.trim());
     }
 
     // set colour presets
-    if (colorPresets instanceof Array) {
+    if (colorPresets instanceof Array && colorPresets.length) {
       self.colorPresets = colorPresets;
     } else if (typeof colorPresets === 'string' && colorPresets.length) {
       if (isValidJSON(colorPresets)) {
@@ -322,26 +316,20 @@ export default class ColorPicker {
     const [colorPicker, colorMenu] = getElementsByClassName('color-dropdown', parent);
     // set main elements
     /** @type {HTMLElement} */
-    // @ts-ignore
     self.pickerToggle = querySelector('.picker-toggle', parent);
     /** @type {HTMLElement} */
-    // @ts-ignore
     self.menuToggle = querySelector('.menu-toggle', parent);
     /** @type {HTMLElement} */
-    // @ts-ignore
     self.colorPicker = colorPicker;
     /** @type {HTMLElement} */
-    // @ts-ignore
     self.colorMenu = colorMenu;
     /** @type {HTMLInputElement[]} */
-    // @ts-ignore
     self.inputs = [...getElementsByClassName('color-input', parent)];
     const [controls] = getElementsByClassName('color-controls', parent);
     self.controls = controls;
     /** @type {(HTMLElement | Element)[]} */
     self.controlKnobs = [...getElementsByClassName('knob', controls)];
     /** @type {(HTMLElement)[]} */
-    // @ts-ignore
     self.visuals = [...getElementsByClassName('visual-control', controls)];
 
     // update colour picker controls, inputs and visuals
@@ -420,6 +408,7 @@ export default class ColorPicker {
     let colorName;
 
     // determine color appearance
+    /* istanbul ignore else */
     if (lightness === 100 && saturation === 0) {
       colorName = colorLabels.white;
     } else if (lightness === 0) {
@@ -493,7 +482,6 @@ export default class ColorPicker {
    * @this {ColorPicker}
    */
   handleFocusOut({ relatedTarget }) {
-    // @ts-ignore
     if (relatedTarget && !this.parent.contains(relatedTarget)) {
       this.hide(true);
     }
@@ -520,13 +508,14 @@ export default class ColorPicker {
     const self = this;
     const { activeElement } = getDocument(self.input);
 
-    if ((e.type === touchmoveEvent && self.dragElement)
+    self.updateDropdownPosition();
+
+    /* istanbul ignore next */
+    if (([pointermoveEvent, touchmoveEvent].includes(e.type) && self.dragElement)
       || (activeElement && self.controlKnobs.includes(activeElement))) {
       e.stopPropagation();
       e.preventDefault();
     }
-
-    self.updateDropdownPosition();
   }
 
   /**
@@ -536,7 +525,6 @@ export default class ColorPicker {
    */
   menuKeyHandler(e) {
     const { target, code } = e;
-    // @ts-ignore
     const { previousElementSibling, nextElementSibling, parentElement } = target;
     const isColorOptionsMenu = parentElement && hasClass(parentElement, 'color-options');
     const allSiblings = [...parentElement.children];
@@ -575,20 +563,20 @@ export default class ColorPicker {
 
   /**
    * The `ColorPicker` click event listener for the colour menu presets / defaults.
-   * @param {Partial<Event>} e
+   * @param {Event} e
    * @this {ColorPicker}
    */
   menuClickHandler(e) {
     const self = this;
-    /** @type {*} */
     const { target } = e;
     const { colorMenu } = self;
     const newOption = (getAttribute(target, 'data-value') || '').trim();
     // invalidate for targets other than color options
     if (!newOption.length) return;
     const currentActive = querySelector('li.active', colorMenu);
-    let newColor = nonColors.includes(newOption) ? 'white' : newOption;
-    newColor = newOption === 'transparent' ? 'rgba(0,0,0,0)' : newOption;
+    let newColor = newOption;
+    newColor = nonColors.includes(newColor) ? 'white' : newColor;
+    newColor = newColor === 'transparent' ? 'rgba(0,0,0,0)' : newColor;
 
     const {
       r, g, b, a,
@@ -600,7 +588,9 @@ export default class ColorPicker {
 
     self.update();
 
+    /* istanbul ignore else */
     if (currentActive !== target) {
+      /* istanbul ignore else */
       if (currentActive) {
         removeClass(currentActive, 'active');
         removeAttribute(currentActive, ariaSelected);
@@ -618,15 +608,13 @@ export default class ColorPicker {
 
   /**
    * The `ColorPicker` *touchstart* / *mousedown* events listener for control knobs.
-   * @param {TouchEvent} e
+   * @param {PointerEvent} e
    * @this {ColorPicker}
    */
   pointerDown(e) {
     const self = this;
     /** @type {*} */
-    const {
-      type, target, touches, pageX, pageY,
-    } = e;
+    const { target, pageX, pageY } = e;
     const { colorMenu, visuals, controlKnobs } = self;
     const [v1, v2, v3] = visuals;
     const [c1, c2, c3] = controlKnobs;
@@ -634,11 +622,10 @@ export default class ColorPicker {
     const visual = controlKnobs.includes(target) ? target.previousElementSibling : target;
     const visualRect = getBoundingClientRect(visual);
     const html = getDocumentElement(v1);
-    const X = type === 'touchstart' ? touches[0].pageX : pageX;
-    const Y = type === 'touchstart' ? touches[0].pageY : pageY;
-    const offsetX = X - html.scrollLeft - visualRect.left;
-    const offsetY = Y - html.scrollTop - visualRect.top;
+    const offsetX = pageX - html.scrollLeft - visualRect.left;
+    const offsetY = pageY - html.scrollTop - visualRect.top;
 
+    /* istanbul ignore else */
     if (target === v1 || target === c1) {
       self.dragElement = visual;
       self.changeControl1(offsetX, offsetY);
@@ -662,7 +649,7 @@ export default class ColorPicker {
 
   /**
    * The `ColorPicker` *touchend* / *mouseup* events listener for control knobs.
-   * @param {TouchEvent} e
+   * @param {PointerEvent} e
    * @this {ColorPicker}
    */
   pointerUp({ target }) {
@@ -671,9 +658,8 @@ export default class ColorPicker {
     const doc = getDocument(parent);
     const currentOpen = querySelector(`${colorPickerParentSelector}.open`, doc) !== null;
     const selection = doc.getSelection();
-    // @ts-ignore
+
     if (!self.dragElement && !selection.toString().length
-      // @ts-ignore
       && !parent.contains(target)) {
       self.hide(currentOpen);
     }
@@ -683,25 +669,20 @@ export default class ColorPicker {
 
   /**
    * The `ColorPicker` *touchmove* / *mousemove* events listener for control knobs.
-   * @param {TouchEvent} e
+   * @param {PointerEvent} e
    */
   pointerMove(e) {
     const self = this;
     const { dragElement, visuals } = self;
     const [v1, v2, v3] = visuals;
-    const {
-      // @ts-ignore
-      type, touches, pageX, pageY,
-    } = e;
+    const { pageX, pageY } = e;
 
     if (!dragElement) return;
 
     const controlRect = getBoundingClientRect(dragElement);
     const win = getDocumentElement(v1);
-    const X = type === touchmoveEvent ? touches[0].pageX : pageX;
-    const Y = type === touchmoveEvent ? touches[0].pageY : pageY;
-    const offsetX = X - win.scrollLeft - controlRect.left;
-    const offsetY = Y - win.scrollTop - controlRect.top;
+    const offsetX = pageX - win.scrollLeft - controlRect.left;
+    const offsetY = pageY - win.scrollTop - controlRect.top;
 
     if (dragElement === v1) {
       self.changeControl1(offsetX, offsetY);
@@ -735,13 +716,16 @@ export default class ColorPicker {
     const currentKnob = controlKnobs.find((x) => x === activeElement);
     const yRatio = offsetHeight / 360;
 
+    /* istanbul ignore else */
     if (currentKnob) {
       let offsetX = 0;
       let offsetY = 0;
 
+      /* istanbul ignore else */
       if (target === c1) {
         const xRatio = offsetWidth / 100;
 
+        /* istanbul ignore else */
         if ([keyArrowLeft, keyArrowRight].includes(code)) {
           self.controlPositions.c1x += code === keyArrowRight ? xRatio : -xRatio;
         } else if ([keyArrowUp, keyArrowDown].includes(code)) {
@@ -787,6 +771,7 @@ export default class ColorPicker {
     const isNonColorValue = self.hasNonColor && nonColors.includes(currentValue);
     const alpha = i4 ? v4 : (1 - controlPositions.c3y / offsetHeight);
 
+    /* istanbul ignore else */
     if (activeElement === input || (activeElement && inputs.includes(activeElement))) {
       if (activeElement === input) {
         if (isNonColorValue) {
@@ -1101,6 +1086,7 @@ export default class ColorPicker {
     const hue = roundPart(hsl.h * 360);
     let newColor;
 
+    /* istanbul ignore else */
     if (format === 'hex') {
       newColor = self.color.toHexString(true);
       i1.value = self.hex;
@@ -1201,15 +1187,15 @@ export default class ColorPicker {
       const relatedBtn = openPicker ? pickerToggle : menuToggle;
       const animationDuration = openDropdown && getElementTransitionDuration(openDropdown);
 
-      // if (!self.isValid) {
       self.value = self.color.toString(true);
-      // }
 
+      /* istanbul ignore else */
       if (openDropdown) {
         removeClass(openDropdown, 'show');
         setAttribute(relatedBtn, ariaExpanded, 'false');
         setTimeout(() => {
           removePosition(openDropdown);
+          /* istanbul ignore else */
           if (!querySelector('.show', parent)) {
             removeClass(parent, 'open');
             toggleEventsOnShown(self);
@@ -1222,7 +1208,7 @@ export default class ColorPicker {
         focus(pickerToggle);
       }
       setAttribute(input, tabIndex, '-1');
-      if (menuToggle) {
+      if (relatedBtn === menuToggle) {
         setAttribute(menuToggle, tabIndex, '-1');
       }
     }

package/src/js/color.js

@@ -640,7 +640,7 @@ function inputToRGB(input) {
       format = 'hwb';
     }
     if (isValidCSSUnit(color.a)) {
-      a = color.a; // @ts-ignore -- `parseFloat` works with numbers too
+      a = color.a;
       a = isPercentage(`${a}`) || parseFloat(a) > 1 ? bound01(a, 100) : a;
     }
   }
@@ -651,9 +651,6 @@ function inputToRGB(input) {
   return {
     ok,
     format,
-    // r: Math.min(255, Math.max(rgb.r, 0)),
-    // g: Math.min(255, Math.max(rgb.g, 0)),
-    // b: Math.min(255, Math.max(rgb.b, 0)),
     r: rgb.r,
     g: rgb.g,
     b: rgb.b,

package/src/js/index.js

@@ -1,3 +1,8 @@
+/**
+ * A single import is required to add the `CP` namespace to `src` sources.
+ * @typedef {import("../../types/index")}
+ */
+
 import ColorPicker from './color-picker';
 
 export default ColorPicker;

package/src/js/util/getColorMenu.js

@@ -23,17 +23,16 @@ export default function getColorMenu(self, colorsSource, menuClass) {
   const isOptionsMenu = menuClass === 'color-options';
   const isPalette = colorsSource instanceof ColorPalette;
   const menuLabel = isOptionsMenu ? presetsLabel : defaultsLabel;
-  let colorsArray = isPalette ? colorsSource.colors : colorsSource;
-  colorsArray = colorsArray instanceof Array ? colorsArray : [];
+  const colorsArray = isPalette ? colorsSource.colors : colorsSource;
   const colorsCount = colorsArray.length;
   const { lightSteps } = isPalette ? colorsSource : { lightSteps: null };
-  const fit = lightSteps || [9, 10].find((x) => colorsCount > x * 2 && !(colorsCount % x)) || 5;
+  const fit = lightSteps || [9, 10].find((x) => colorsCount >= x * 2 && !(colorsCount % x)) || 5;
   const isMultiLine = isOptionsMenu && colorsCount > fit;
   let rowCountHover = 2;
-  rowCountHover = isMultiLine && colorsCount >= fit * 2 ? 3 : rowCountHover;
-  rowCountHover = colorsCount >= fit * 3 ? 4 : rowCountHover;
-  rowCountHover = colorsCount >= fit * 4 ? 5 : rowCountHover;
-  const rowCount = rowCountHover - (colorsCount < fit * 3 ? 1 : 2);
+  rowCountHover = isMultiLine && colorsCount > fit * 2 ? 3 : rowCountHover;
+  rowCountHover = isMultiLine && colorsCount > fit * 3 ? 4 : rowCountHover;
+  rowCountHover = isMultiLine && colorsCount > fit * 4 ? 5 : rowCountHover;
+  const rowCount = rowCountHover - (colorsCount <= fit * 3 ? 1 : 2);
   const isScrollable = isMultiLine && colorsCount > rowCount * fit;
   let finalClass = menuClass;
   finalClass += isScrollable ? ' scrollable' : '';
@@ -41,7 +40,7 @@ export default function getColorMenu(self, colorsSource, menuClass) {
   const gap = isMultiLine ? '1px' : '0.25rem';
   let optionSize = isMultiLine ? 1.75 : 2;
   optionSize = fit > 5 && isMultiLine ? 1.5 : optionSize;
-  const menuHeight = `${(rowCount || 1) * optionSize}rem`;
+  const menuHeight = `${rowCount * optionSize}rem`;
   const menuHeightHover = `calc(${rowCountHover} * ${optionSize}rem + ${rowCountHover - 1} * ${gap})`;
   /** @type {HTMLUListElement} */
   // @ts-ignore -- <UL> is an `HTMLElement`

package/src/js/util/setMarkup.js

@@ -17,7 +17,6 @@ import vHidden from './vHidden';
 import tabIndex from './tabindex';
 
 import Color from '../color';
-import ColorPalette from '../color-palette';
 
 /**
 * Generate HTML markup and update instance properties.
@@ -75,16 +74,14 @@ export default function setMarkup(self) {
     });
 
     // color presets
-    if ((colorPresets instanceof Array && colorPresets.length)
-      || (colorPresets instanceof ColorPalette && colorPresets.colors)) {
-      const presetsMenu = getColorMenu(self, colorPresets, 'color-options');
-      presetsDropdown.append(presetsMenu);
+    if (colorPresets) {
+      presetsDropdown.append(getColorMenu(self, colorPresets, 'color-options'));
     }
 
     // explicit defaults [reset, initial, inherit, transparent, currentColor]
+    // also custom defaults [default: #069, complementary: #930]
     if (colorKeywords && colorKeywords.length) {
-      const keywordsMenu = getColorMenu(self, colorKeywords, 'color-defaults');
-      presetsDropdown.append(keywordsMenu);
+      presetsDropdown.append(getColorMenu(self, colorKeywords, 'color-defaults'));
     }
 
     const presetsBtn = createElement({

package/src/js/util/toggleCEAttr.js

@@ -0,0 +1,70 @@
+import setAttribute from 'shorter-js/src/attr/setAttribute';
+import removeAttribute from 'shorter-js/src/attr/removeAttribute';
+import ObjectKeys from 'shorter-js/src/misc/ObjectKeys';
+
+import ColorPalette from '../color-palette';
+import colorNames from './colorNames';
+import colorPickerLabels from './colorPickerLabels';
+
+/**
+ * A small utility to toggle `ColorPickerElement` attributes
+ * when `connectedCallback` or `disconnectedCallback` methods
+ * are called and helps the instance keep its value and settings instact.
+ *
+ * @param {CP.ColorPickerElement} self ColorPickerElement instance
+ * @param {Function=} callback when `true`, attributes are added
+ *
+ * @example
+ * const attributes = [
+ *   // essentials
+ *   'value', 'format',
+ *   // presets menus
+ *   'color-presets', 'color-keywords',
+ *   // labels
+ *   'color-labels', 'component-labels',
+ * ];
+ */
+export default function toggleCEAttr(self, callback) {
+  if (callback) {
+    const { input, colorPicker } = self;
+
+    const {
+      value, format, colorPresets, colorKeywords, componentLabels, colorLabels,
+    } = colorPicker;
+
+    const { id, placeholder } = input;
+
+    setAttribute(self, 'data-id', id);
+    setAttribute(self, 'data-value', value);
+    setAttribute(self, 'data-format', format);
+    setAttribute(self, 'data-placeholder', placeholder);
+
+    if (ObjectKeys(colorPickerLabels).some((l) => colorPickerLabels[l] !== componentLabels[l])) {
+      setAttribute(self, 'data-component-labels', JSON.stringify(componentLabels));
+    }
+    if (!colorNames.every((c) => c === colorLabels[c])) {
+      setAttribute(self, 'data-color-labels', colorNames.map((n) => colorLabels[n]).join(','));
+    }
+    if (colorPresets instanceof ColorPalette) {
+      const { hue, hueSteps, lightSteps } = colorPresets;
+      setAttribute(self, 'data-color-presets', JSON.stringify({ hue, hueSteps, lightSteps }));
+    }
+    if (Array.isArray(colorPresets) && colorPresets.length) {
+      setAttribute(self, 'data-color-presets', colorPresets.join(','));
+    }
+    if (colorKeywords) {
+      setAttribute(self, 'data-color-keywords', colorKeywords.join(','));
+    }
+    setTimeout(callback, 0);
+  } else {
+    // keep id
+    // removeAttribute(self, 'data-id');
+    removeAttribute(self, 'data-value');
+    removeAttribute(self, 'data-format');
+    removeAttribute(self, 'data-placeholder');
+    removeAttribute(self, 'data-component-labels');
+    removeAttribute(self, 'data-color-labels');
+    removeAttribute(self, 'data-color-presets');
+    removeAttribute(self, 'data-color-keywords');
+  }
+}

package/src/js/util/version.js

@@ -1,4 +1,3 @@
-// @ts-ignore
 import { version } from '../../../package.json';
 
 const Version = version;

package/src/js/version.js

@@ -1,4 +1,3 @@
-// @ts-ignore
 import { version } from '../../package.json';
 
 const Version = version;

package/src/scss/_variables.scss

@@ -0,0 +1,7 @@
+$transparency-levels: (
+  15, 25, 33, 50, 75, 90
+);
+
+$dropdown-transition: transform .33s ease, opacity .33s ease;
+$btn-transition: box-shadow .33s ease, border .33s ease;
+$options-transition: height .33s ease;