@thednp/color-picker 2.0.0-alpha8 → 2.0.0

package/package.json

@@ -1,114 +1,117 @@
-{
-  "name": "@thednp/color-picker",
-  "version": "2.0.0-alpha8",
-  "author": "thednp",
-  "license": "MIT",
-  "description": "🎨 Modern Color Picker Component",
-  "homepage": "http://thednp.github.io/color-picker",
-  "source": "./src/ts/index.ts",
-  "main": "./dist/js/color-picker.js",
-  "module": "./dist/js/color-picker.mjs",
-  "style": "./dist/css/color-picker.css",
-  "sass": "./src/scss/color-picker.scss",
-  "exports": {
-    ".": {
-      "require": "./dist/js/color-picker.cjs",
-      "import": "./dist/js/color-picker.mjs",
-      "types": "./dist/js/color-picker.d.ts"
-    },
-    "./dist/css/color-picker.css": {
-      "import": "./dist/css/color-picker.css",
-      "require": "./dist/css/color-picker.css"
-    },
-    "./dist/css/color-picker.rtl.css": {
-      "import": "./dist/css/color-picker.rtl.css",
-      "require": "./dist/css/color-picker.rtl.css"
-    },
-    "./src/scss/color-picker.scss": {
-      "import": "./src/scss/color-picker.scss",
-      "require": "./src/scss/color-picker.scss"
-    },
-    "./src/scss/color-picker.rtl.scss": {
-      "import": "./src/scss/color-picker.rtl.scss",
-      "require": "./src/scss/color-picker.rtl.scss"
-    }
-  },
-  "scripts": {
-    "pre-test": "npm run clean-coverage",
-    "test": "npm run pre-test && cypress run",
-    "cypress": "npm run pre-test && npx cypress open",
-    "clean-coverage": "rimraf coverage .nyc_output",
-    "coverage:report": "nyc report --reporter=lcov --reporter=json --reporter=text --reporter=json-summary",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "fix:ts": "eslint src --config .eslintrc.cjs --fix",
-    "lint:ts": "eslint src --config .eslintrc.cjs",
-    "fix:css": "stylelint --config .stylelintrc.json --fix scss \"src/scss/*.scss\"",
-    "lint:css": "stylelint --config .stylelintrc.json scss \"src/scss/*.scss\"",
-    "build": "npm run lint:ts && npm run build-vite && npm run dts",
-    "build-vite": "vite build && npm run docs",
-    "dev": "vite --open ./docs/index.html --port 8577",
-    "dts": "dts-bundle-generator --config ./dts.config.ts",
-    "docs": "ncp dist/js/color-picker.js docs/js/color-picker.js && ncp dist/js/color-picker.js.map docs/js/color-picker.js.map",
-    "copy": "npm-run-all --parallel copy-*",
-    "copy-css-cp": "ncp dist/css/color-picker.css docs/css/color-picker.css",
-    "copy-css-rtl": "ncp dist/css/color-picker.rtl.css docs/css/color-picker.rtl.css",
-    "compile": "npm run lint:css && npm-run-all --parallel compile-* && npm run copy",
-    "compile-scss": "node compile.js",
-    "compile-scss-min": "node compile.js MIN:true",
-    "compile-scss-rtl": "node compile.js MIN:false,DIR:rtl",
-    "compile-scss-rtl-min": "node compile.js MIN:true,DIR:rtl"
-  },
-  "bugs": {
-    "url": "https://github.com/thednp/color-picker/issues"
-  },
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/thednp/color-picker.git"
-  },
-  "keywords": [
-    "color",
-    "picker",
-    "color-picker",
-    "colorpicker",
-    "palette",
-    "color-palette",
-    "typescript"
-  ],
-  "dependencies": {
-    "@thednp/color": "^1.0.8",
-    "@thednp/event-listener": "^2.0.2",
-    "@thednp/shorty": "^2.0.0-alpha16"
-  },
-  "devDependencies": {
-    "@bahmutov/cypress-esbuild-preprocessor": "^2.2.0",
-    "@cypress/code-coverage": "^3.11.0",
-    "@types/istanbul-lib-instrument": "^1.7.4",
-    "@typescript-eslint/eslint-plugin": "^6.3.0",
-    "@typescript-eslint/parser": "^6.3.0",
-    "cypress": "^12.17.3",
-    "dts-bundle-generator": "^8.0.1",
-    "eslint": "^8.47.0",
-    "eslint-plugin-jsdoc": "^46.4.6",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-prettier": "^5.0.0",
-    "istanbul-lib-coverage": "^3.2.0",
-    "istanbul-lib-instrument": "^6.0.0",
-    "ncp": "^2.0.0",
-    "npm-run-all": "^4.1.5",
-    "nyc": "^15.1.0",
-    "prettier": "^3.0.1",
-    "rimraf": "^5.0.1",
-    "sass": "^1.65.1",
-    "stylelint": "^15.10.2",
-    "stylelint-config-standard": "^34.0.0",
-    "stylelint-config-standard-scss": "^10.0.0",
-    "stylelint-order": "^6.0.3",
-    "stylelint-scss": "^5.1.0",
-    "typescript": "^5.1.6",
-    "vite": "^4.4.9"
-  }
-}
+{
+  "name": "@thednp/color-picker",
+  "version": "2.0.0",
+  "author": "thednp",
+  "license": "MIT",
+  "description": "🎨 Modern Color Picker Component",
+  "homepage": "http://thednp.github.io/color-picker",
+  "source": "./src/ts/index.ts",
+  "main": "./dist/js/color-picker.js",
+  "module": "./dist/js/color-picker.mjs",
+  "style": "./dist/css/color-picker.css",
+  "sass": "./src/scss/color-picker.scss",
+  "exports": {
+    ".": {
+      "require": "./dist/js/color-picker.cjs",
+      "import": "./dist/js/color-picker.mjs",
+      "types": "./dist/js/color-picker.d.ts"
+    },
+    "./dist/css/color-picker.css": {
+      "import": "./dist/css/color-picker.css",
+      "require": "./dist/css/color-picker.css"
+    },
+    "./dist/css/color-picker.rtl.css": {
+      "import": "./dist/css/color-picker.rtl.css",
+      "require": "./dist/css/color-picker.rtl.css"
+    },
+    "./src/scss/color-picker.scss": {
+      "import": "./src/scss/color-picker.scss",
+      "require": "./src/scss/color-picker.scss"
+    },
+    "./src/scss/color-picker.rtl.scss": {
+      "import": "./src/scss/color-picker.rtl.scss",
+      "require": "./src/scss/color-picker.rtl.scss"
+    }
+  },
+  "bugs": {
+    "url": "https://github.com/thednp/color-picker/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thednp/color-picker.git"
+  },
+  "keywords": [
+    "color",
+    "picker",
+    "color-picker",
+    "colorpicker",
+    "palette",
+    "color-palette",
+    "typescript"
+  ],
+  "dependencies": {
+    "@thednp/color": "^1.0.9",
+    "@thednp/shorty": "2.0.3"
+  },
+  "devDependencies": {
+    "@bahmutov/cypress-esbuild-preprocessor": "^2.2.2",
+    "@cypress/code-coverage": "^3.12.44",
+    "@types/istanbul-lib-instrument": "^1.7.7",
+    "@types/node": "^22.2.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "cypress": "^13.13.2",
+    "dts-bundle-generator": "^9.5.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-jsdoc": "^46.10.1",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-prettier": "^5.2.1",
+    "istanbul-lib-coverage": "^3.2.2",
+    "istanbul-lib-instrument": "^6.0.3",
+    "ncp": "^2.0.0",
+    "npm-run-all": "^4.1.5",
+    "nyc": "^15.1.0",
+    "prettier": "^3.3.3",
+    "rimraf": "^5.0.10",
+    "sass": "^1.77.8",
+    "stylelint": "^15.11.0",
+    "stylelint-config-standard": "^34.0.0",
+    "stylelint-config-standard-scss": "^11.1.0",
+    "stylelint-order": "^6.0.4",
+    "stylelint-scss": "^5.3.2",
+    "typescript": "^5.5.4",
+    "vite": "^5.4.0"
+  },
+  "scripts": {
+    "pre-test": "pnpm clean-coverage",
+    "test": "pnpm pre-test && cypress run",
+    "cypress": "pnpm pre-test && npx cypress open",
+    "badges": "npx -p dependency-version-badge update-badge typescript cypress eslint prettier vite",
+    "clean-coverage": "rimraf coverage .nyc_output",
+    "coverage:report": "nyc report --reporter=lcov --reporter=json --reporter=text --reporter=json-summary",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "pnpm lint:ts && pnpm check:ts && pnpm lint:css",
+    "fix:ts": "eslint src --config .eslintrc.cjs --fix",
+    "lint:ts": "eslint src --config .eslintrc.cjs",
+    "check:ts": "tsc --noEmit",
+    "fix:css": "stylelint --config .stylelintrc.json --fix scss \"src/scss/*.scss\"",
+    "lint:css": "stylelint --config .stylelintrc.json scss \"src/scss/*.scss\"",
+    "build": "pnpm lint && pnpm build-vite && pnpm dts",
+    "build-vite": "vite build && pnpm docs",
+    "dev": "vite --open ./docs/dev.html --port 8577",
+    "dts": "dts-bundle-generator --config ./dts.config.ts",
+    "docs": "ncp dist/js/color-picker.js docs/js/color-picker.js && ncp dist/js/color-picker.js.map docs/js/color-picker.js.map",
+    "copy": "npm-run-all --parallel copy-*",
+    "copy-css-cp": "ncp dist/css/color-picker.css docs/css/color-picker.css",
+    "copy-css-rtl": "ncp dist/css/color-picker.rtl.css docs/css/color-picker.rtl.css",
+    "compile": "pnpm lint:css && npm-run-all --parallel compile-* && pnpm copy",
+    "compile-scss": "node compile.js",
+    "compile-scss-min": "node compile.js MIN:true",
+    "compile-scss-rtl": "node compile.js MIN:false,DIR:rtl",
+    "compile-scss-rtl-min": "node compile.js MIN:true,DIR:rtl"
+  }
+}

package/src/scss/color-picker.scss

@@ -205,8 +205,10 @@
 
 /* scrollable */
 .scrollable {
-  overflow-x: hidden;
-  overflow-y: auto;
+  overflow: hidden auto;
+
+  // overflow-x: hidden;
+  // overflow-y: auto;
   scrollbar-width: thin;
 }
 
@@ -299,7 +301,8 @@
   transition: var(--options-transition);
 }
 
-.color-options.scrollable:hover {
+// .color-options.scrollable:hover {
+.color-dropdown.menu:hover .scrollable {
   height: var(--grid-hover-height);
 }
 
@@ -321,7 +324,7 @@
   width: var(--grid-item-size);
   height: var(--grid-item-size);
   overflow: hidden;
-  text-indent: 2.1rem;
+  color: rgba(0,0,0,0%);
 
   &:active, &:focus {
     outline: none;
@@ -419,7 +422,7 @@
 
 /* visual control */
 .visual-control {
-  height: 150px;
+  height: 230px;
 
   /* important for mobile devices */
   touch-action: none;
@@ -427,7 +430,7 @@
 }
 
 .visual-control1 {
-  width: 150px;
+  width: 230px;
 }
 
 .visual-control2,
@@ -436,12 +439,7 @@
   cursor: ns-resize;
 }
 
-@media (width >= 578px) {
-  .visual-control { height: 230px; }
-  .visual-control1 { width: 230px; }
-}
-
-@media (width >= 1200px) {
+@media (width >= 980px) {
   .visual-control { height: 300px; }
   .visual-control1 { width: 300px; }
 }

package/src/ts/index.ts

@@ -1,5 +1,3 @@
-import { addListener, removeListener } from '@thednp/event-listener';
-
 import {
   ariaDescription,
   ariaSelected,
@@ -37,6 +35,7 @@ import {
   getDocumentElement,
   getDocument,
   ObjectAssign,
+  ObjectFromEntries,
   Data,
   getInstance,
   setElementStyle,
@@ -52,6 +51,8 @@ import {
   isArray,
   isString,
   getWindow,
+  on,
+  off,
 } from '@thednp/shorty';
 
 // ColorPicker Util
@@ -67,6 +68,7 @@ import setMarkup from './util/setMarkup';
 
 import ColorPickerOptions from './interface/colorPickerOptions';
 import ColorPickerLabels from './interface/colorPickerLabels';
+import type ColorNames from './interface/ColorNames';
 import { version } from '../../package.json';
 
 // ColorPicker GC
@@ -95,7 +97,7 @@ const initColorPicker = (element: HTMLInputElement) => new ColorPicker(element);
  * Add / remove `ColorPicker` main event listeners.
  */
 const toggleEvents = (self: ColorPicker, action?: boolean) => {
-  const fn = action ? addListener : removeListener;
+  const fn = action ? on : off;
   const { input, pickerToggle, menuToggle } = self;
 
   fn(input, focusinEvent, self.showPicker);
@@ -110,7 +112,7 @@ const toggleEvents = (self: ColorPicker, action?: boolean) => {
  * Add / remove `ColorPicker` event listeners active only when open.
  */
 const toggleEventsOnShown = (self: ColorPicker, action?: boolean) => {
-  const fn = action ? addListener : removeListener;
+  const fn = action ? on : off;
   const { input, colorMenu, parent } = self;
   const doc = getDocument(input);
   const win = getWindow(doc);
@@ -224,7 +226,7 @@ export default class ColorPicker {
     c2y: number;
     c3y: number;
   };
-  colorLabels: Record<string, string> = {};
+  colorLabels: ColorNames = ObjectFromEntries(colorNames.map(c => [c, c])) as ColorNames;
   colorKeywords: string[] | false;
   colorPresets: ColorPalette | string[] | false;
   componentLabels: ColorPickerLabels;
@@ -265,7 +267,7 @@ export default class ColorPicker {
       c2y: 0,
       c3y: 0,
     };
-    this.colorLabels = {};
+    // this.colorLabels = {};
     this.colorKeywords = false;
     this.colorPresets = false;
 
@@ -285,9 +287,7 @@ export default class ColorPicker {
     }
 
     // expose colour labels to all methods
-    colorNames.forEach((c, i) => {
-      this.colorLabels[c] = translatedColorLabels[i].trim();
-    });
+    ObjectAssign(this.colorLabels, ObjectFromEntries(translatedColorLabels.map((c, i) => [colorNames[i], c])));
 
     // update and expose component labels
     const tempComponentLabels =
@@ -521,9 +521,8 @@ export default class ColorPicker {
    * The `ColorPicker` *scroll* event listener when open.
    *
    * @param e
-   * @this {ColorPicker}
    */
-  handleScroll = (e: Event): void => {
+  handleScroll = (e: Event) => {
     const { activeElement } = getDocument(this.input);
 
     this.updateDropdownPosition();
@@ -543,7 +542,7 @@ export default class ColorPicker {
    *
    * @param e
    */
-  menuKeyHandler = (e: Event & { target: HTMLElement; code: string }) => {
+  menuKeyHandler = (e: KeyboardEvent & { target: HTMLElement }) => {
     const { target, code } = e;
     const { previousElementSibling, nextElementSibling, parentElement } = target;
     const isColorOptionsMenu = parentElement && hasClass(parentElement, 'color-options');
@@ -585,7 +584,7 @@ export default class ColorPicker {
    * @param e
    * @this {ColorPicker}
    */
-  menuClickHandler = (e: Event): void => {
+  menuClickHandler = (e: Event) => {
     const { target } = e;
     const { colorMenu } = this;
     const newOption = (getAttribute(target as HTMLElement, 'data-value') || '').trim();
@@ -630,7 +629,8 @@ export default class ColorPicker {
    *
    * @param e
    */
-  pointerDown = (e: Event & { target: HTMLElement; pageX: number; pageY: number }) => {
+  pointerDown = (e: PointerEvent & { target: HTMLElement }) => {
+    if (e.button !== 0) return;
     const { target, pageX, pageY } = e;
     const { colorMenu, visuals, controlKnobs } = this;
     const [v1, v2, v3] = visuals;
@@ -687,7 +687,7 @@ export default class ColorPicker {
    *
    * @param {PointerEvent} e
    */
-  pointerMove = (e: PointerEvent): void => {
+  pointerMove = (e: PointerEvent) => {
     const { dragElement, visuals } = this;
     const [v1, v2, v3] = visuals;
     const { pageX, pageY } = e;

package/src/ts/interface/ColorNames.ts

@@ -0,0 +1,20 @@
+export default interface ColorNames {
+  white: string;
+  black: string;
+  grey: string;
+  red: string;
+  orange: string;
+  brown: string;
+  gold: string;
+  olive: string;
+  yellow: string;
+  lime: string;
+  green: string;
+  teal: string;
+  cyan: string;
+  blue: string;
+  violet: string;
+  magenta: string;
+  pink: string;
+  [key: string]: string;
+}

package/src/ts/util/setMarkup.ts

@@ -36,13 +36,14 @@ const setMarkup = (self: ColorPicker) => {
   // set initial controls dimensions
   const formatString = format === 'hex' ? hexLabel : toUpperCase(format);
 
-  const pickerBtn = createElement({
+  const pickerBtn = createElement<HTMLButtonElement>({
     id: `picker-btn-${id}`,
     tagName: 'button',
+    type: 'button',
     className: 'picker-toggle btn-appearance',
     ariaExpanded: 'false',
     ariaHasPopup: 'true',
-  }) as HTMLElement;
+  }) as HTMLButtonElement;
 
   pickerBtn.append(
     createElement({
@@ -84,13 +85,14 @@ const setMarkup = (self: ColorPicker) => {
       presetsDropdown.append(getColorMenu(self, colorKeywords, 'color-defaults'));
     }
 
-    const presetsBtn = createElement({
+    const presetsBtn = createElement<HTMLButtonElement>({
       tagName: 'button',
+      type: 'button',
       className: 'menu-toggle btn-appearance',
       tabIndex: -1,
       ariaExpanded: 'false',
       ariaHasPopup: 'true',
-    }) as HTMLElement;
+    }) as HTMLButtonElement;
 
     const xmlns = encodeURI('http://www.w3.org/2000/svg');
     const presetsIcon = createElementNS(xmlns, {

package/tsconfig.json

@@ -2,7 +2,7 @@
   // https://janessagarrow.com/blog/typescript-and-esbuild/
  "compilerOptions": {
    "lib": ["DOM", "ESNext", "DOM.Iterable"],
-   "types": ["vite", "vite/client", "@thednp/shorty", "@thednp/event-listener", "@thednp/color"],
+  //  "types": ["vite", "vite/client", "@thednp/shorty", "@thednp/color"],
    "rootDir": "./",
    "baseUrl": "./",
    "module": "ESNext",

package/cypress/fixtures/getCEMarkup.js

@@ -1,29 +0,0 @@
-import ColorPickerElement from '../../src/js/color-picker-element';
-
-import getRandomInt from './getRandomInt';
-import testSample from './testSample';
-import FORMAT from './format';
-import colorNamesFrench from './colorNamesFrench';
-import componentLabelsFrench from './componentLabelsFrench';
-
-export default function getCEMarkup(body) {
-  const id = getRandomInt(0,9999);
-  const format = FORMAT[getRandomInt(0,3)];
-  const sample = testSample[getRandomInt(0,2)];
-  const value = sample[format];
-
-  // const cpe = document.createElement('color-picker');
-  const cpe = new ColorPickerElement();
-  cpe.setAttribute('data-id', `cpe-${format}-${id}`);
-  cpe.setAttribute('data-format', format);
-  cpe.setAttribute('data-value', value);
-  cpe.setAttribute('data-component-labels', JSON.stringify(componentLabelsFrench));
-  cpe.setAttribute('data-color-labels', colorNamesFrench);
-  cpe.setAttribute('data-color-keywords', 'red,gree,blue');
-  cpe.setAttribute('data-color-presets', '#330000,#990000,#ff0000,#ff6666,#ffcccc,#003333,#009999,#00ffff,#66ffff,#ccffff');
-
-  if (body) {
-    body.append(cpe);
-  }
-  return {value, id, format};
-}