mdbassit / Coloris

A lightweight and elegant JavaScript color picker. Written in vanilla ES6, no dependencies. Accessible.
https://coloris.js.org/examples.html
MIT License
443 stars 58 forks source link

Feature Request: Add `setColor(string)` method #91

Closed melloware closed 1 year ago

melloware commented 1 year ago

Add a first class method to set the color of an instance similar to..

 /**
   * Sets the active color and fires all necessary events.
   * @param {string} [color] Color value to override the active color.
   * @param {HTMLelement} [target] the element setting the color on
   */
  function setColor(color, target) {
    currentEl = target;
    oldColor = currentEl.value;
    attachVirtualInstance(target);
    currentFormat = getColorFormatFromStr(color);
    updatePickerPosition();
    setColorFromStr(color);
    pickColor();
    if (oldColor !== color) {
       currentEl.dispatchEvent(new Event('change', { bubbles: true }));
    }
  }
mdbassit commented 1 year ago

When you say an instance, do you mean a specific input field or a group of fields that use the same Coloris instance?

melloware commented 1 year ago

Its the specific input I am trying to set the color for or "instance"

Coloris.setColor(newColor, input[0]);
melloware commented 1 year ago

Here is what I really do so it works for popup mode or inline mode.

/**
      * Sets the current color
      * @param {string} color the color to set
      */
    setColor: function(color) {
        if (!color) {
            return;
        }
        var newColor = color.toLowerCase();
        var input = this.popup ? this.input : this.jq.find('#clr-color-value');
        Coloris.setColor(newColor, input[0]);
    },
mdbassit commented 1 year ago
Coloris.setColor(newColor, input[0]);

I think a better and more efficient way is to just set the value of the target fields directly and then trigger an input (or change for #clr-color-value) event. You can replace the Coloris.setColor() method with this:

function setColor(color, target) {
  const colorValue = document.querySelector('#clr-color-value');
  // Color fields listen for an "input" events while the color value field
  // within the picker listens for a "change" event
  const event = target === colorValue ? 'change' : 'input';

  target.value = color;
  target.dispatchEvent(new Event(event, { bubbles: true }));
}
mdbassit commented 1 year ago

Here is what I really do so it works for popup mode or inline mode.

Or even better, here is a rewrite of your code above:

/**
  * Sets the current color
  * @param {string} color the color to set
  */
setColor: function(color) {
    if (!color) {
        return;
    }

    var newColor = color.toLowerCase();
    var input = this.popup ? this.input : this.jq.find('#clr-color-value');
    var event = this.popup ? 'input' : 'change';
    var target = input[0];

    target.value = color;
    target.dispatchEvent(new Event(event, { bubbles: true }));
},
melloware commented 1 year ago

This is pretty close. The only difference is with mine because our wrapper send AJAX events on change of color I need the change event fired for either popup or inline and your input method does not fire the change.

This was vital for us so the change event fires for inline or popup and ONLY fires if the color actually changes.

if (oldColor !== color) {
       currentEl.dispatchEvent(new Event('change', { bubbles: true }));
    }
mdbassit commented 1 year ago

How about this:

/**
  * Sets the current color
  * @param {string} color the color to set
  */
setColor: function(color) {
    if (!color) {
        return;
    }

    var newColor = color.toLowerCase();
    var input = this.popup ? this.input : this.jq.find('#clr-color-value');
    var target = input[0];
    var oldColor = target.value.toLowerCase();
    var triggerInputEvent = !!this.popup;

    if (color.toLowerCase() !== oldColor) {
        target.value = color;
        triggerInputEvent && target.dispatchEvent(new Event('input', { bubbles: true }));
        target.dispatchEvent(new Event('change', { bubbles: true }));
    }
},
melloware commented 1 year ago

This seems to work!

mdbassit commented 1 year ago

Should I close this then?