This project might continue to get important security- and bug-related updates but its feature set is frozen, and it's highly unlikely that it'll get new features or enhancements.
The reason behind this decision is the way this tool has been build (monolithic, the core is one single file, everything is in plain JS etc.) which makes it incredible hard to maintain, tests become impossible at this stage without a complete rewrite, and the fun is gone at such a level of cramped complexity.
Personally I recommend building these UI-Related "widgets" directly into the app with the framework you're using which takes more time but in return gives you full power of how it should work and look like. Frameworks such as (p)react, vue and svelte will make it a breeze to develop such things within a day.
Update
This project will be archived at the end of 2021! After this there will be no more bug / security fixes or feature requests.
Themes
Classic
Monolith
Nano
Nano uses css-grid thus it won't work in older browsers.
Getting Started
Node
Note: The readme is always up-to-date with the latest commit. See Releases for installation instructions regarding to the latest version.
Install via npm:
$ npm install @simonwep/pickr
Install via yarn:
$ yarn add @simonwep/pickr
Include code and style:
// One of the following themesimport'@simonwep/pickr/dist/themes/classic.min.css';// 'classic' themeimport'@simonwep/pickr/dist/themes/monolith.min.css';// 'monolith' themeimport'@simonwep/pickr/dist/themes/nano.min.css';// 'nano' theme// Modern or es5 bundle (pay attention to the note below!)importPickrfrom'@simonwep/pickr';importPickrfrom'@simonwep/pickr/dist/pickr.es5.min';
Attention: The es5-bundle (e.g. legacy version) is quite big (around a triple of the modern bundle). Please take into consideration to use the modern version and add polyfills later to your final bundle! (Or better: give a hint to users that they should use the latest browsers). Browsers such as IE are not supported (at least not officially).
constpickr=newPickr({// Selector or element which will be replaced with the actual color-picker.// Can be a HTMLElement.el: '.color-picker',// Where the pickr-app should be added as child.container: 'body',// Which theme you want to use. Can be 'classic', 'monolith' or 'nano'theme: 'classic',// Nested scrolling is currently not supported and as this would be really sophisticated to add this// it's easier to set this to true which will hide pickr if the user scrolls the area behind it.closeOnScroll: false,// Custom class which gets added to the pcr-app. Can be used to apply custom styles.appClass: 'custom-class',// Don't replace 'el' Element with the pickr-button, instead use 'el' as a button.// If true, appendToBody will also be automatically true.useAsButton: false,// Size of gap between pickr (widget) and the corresponding reference (button) in pxpadding: 8,// If true pickr won't be floating, and instead will append after the in el resolved element.// It's possible to hide it via .hide() anyway.inline: false,// If true, pickr will be repositioned automatically on page scroll or window resize.// Can be set to false to make custom positioning easier.autoReposition: true,// Defines the direction in which the knobs of hue and opacity can be moved.// 'v' => opacity- and hue-slider can both only moved vertically.// 'hv' => opacity-slider can be moved horizontally and hue-slider vertically.// Can be used to apply custom layoutssliders: 'v',// Start state. If true 'disabled' will be added to the button's classlist.disabled: false,// If true, the user won't be able to adjust any opacity.// Opacity will be locked at 1 and the opacity slider will be removed.// The HSVaColor object also doesn't contain an alpha, so the toString() methods just// print HSV, HSL, RGB, HEX, etc.lockOpacity: false,// Precision of output string (only effective if components.interaction.input is true)outputPrecision: 0,// Defines change/save behavior:// - to keep current color in place until Save is pressed, set to `true`,// - to apply color to button and preview (save) in sync with each change// (from picker or palette), set to `false`.comparison: true,// Default color. If you're using a named color such as red, white ... set// a value for defaultRepresentation too as there is no button for named-colors.default: '#42445a',// Optional color swatches. When null, swatches are disabled.// Types are all those which can be produced by pickr e.g. hex(a), hsv(a), hsl(a), rgb(a), cmyk, and also CSS color names like 'magenta'.// Example: swatches: ['#F44336', '#E91E63', '#9C27B0', '#673AB7'],swatches: null,// Default color representation of the input/output textbox.// Valid options are `HEX`, `RGBA`, `HSVA`, `HSLA` and `CMYK`.defaultRepresentation: 'HEX',// Option to keep the color picker always visible.// You can still hide / show it via 'pickr.hide()' and 'pickr.show()'.// The save button keeps its functionality, so still fires the onSave event when clicked.showAlways: false,// Close pickr with a keypress.// Default is 'Escape'. Can be the event key or code.// (see: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key)closeWithKey: 'Escape',// Defines the position of the color-picker.// Any combinations of top, left, bottom or right with one of these optional modifiers: start, middle, end// Examples: top-start / right-end// If clipping occurs, the color picker will automatically choose its position.// Pickr uses https://github.com/Simonwep/nanopop as positioning-engine.position: 'bottom-middle',// Enables the ability to change numbers in an input field with the scroll-wheel.// To use it set the cursor on a position where a number is and scroll, use ctrl to make steps of fiveadjustableNumbers: true,// Show or hide specific components.// By default only the palette (and the save button) is visible.components: {// Defines if the palette itself should be visible.// Will be overwritten with true if preview, opacity or hue are truepalette: true,preview: true,// Display comparison between previous state and new coloropacity: true,// Display opacity sliderhue: true,// Display hue slider// show or hide components on the bottom interaction bar.interaction: {// Buttons, if you disable one but use the format in default: or setColor() - set the representation-type too!hex: false,// Display 'input/output format as hex' button (hexadecimal representation of the rgba value)rgba: false,// Display 'input/output format as rgba' button (red green blue and alpha)hsla: false,// Display 'input/output format as hsla' button (hue saturation lightness and alpha)hsva: false,// Display 'input/output format as hsva' button (hue saturation value and alpha)cmyk: false,// Display 'input/output format as cmyk' button (cyan mangenta yellow key )input: false,// Display input/output textbox which shows the selected color value.// the format of the input is determined by defaultRepresentation,// and can be changed by the user with the buttons set by hex, rgba, hsla, etc (above).cancel: false,// Display Cancel Button, resets the color to the previous stateclear: false,// Display Clear Button; same as cancel, but keeps the window opensave: false,// Display Save Button,},},// Translations, these are the default values.i18n: {// Strings visible in the UI'ui:dialog': 'color picker dialog','btn:toggle': 'toggle color picker dialog','btn:swatch': 'color swatch','btn:last-color': 'use previous color','btn:save': 'Save','btn:cancel': 'Cancel','btn:clear': 'Clear',// Strings used for aria-labels'aria:btn:save': 'save and close','aria:btn:cancel': 'cancel and close','aria:btn:clear': 'clear and close','aria:input': 'color input field','aria:palette': 'color selection area','aria:hue': 'hue selection slider','aria:opacity': 'selection slider'}});
To select the .pickr element you can use the custom >> shadow-dom-selector in el:
el: '.entry >> .innr .another >> .pickr'
Every ShadowRoot of the query-result behind a >> gets used in the next query selection. An alternative would be to provide the target-element itself as el.
The HSVaColor object
As default color representation is hsva (hue, saturation, value and alpha) used, but you can also convert it to other formats as listed below.
hsva.toHSVA() - Converts the object to a hsva array.
hsva.toHSLA() - Converts the object to a hsla array.
hsva.toRGBA() - Converts the object to a rgba array.
hsva.toHEXA() - Converts the object to a hexa-decimal array.
hsva.toCMYK() - Converts the object to a cmyk array.
hsva.clone() - Clones the color object.
The toString() is overridden, so you can get a color representation string.
hsva.toRGBA();// Returns [r, g, b, a]hsva.toRGBA().toString();// Returns rgba(r, g, b, a) with highest precisionhsva.toRGBA().toString(3);// Returns rgba(r, g, b, a), rounded to the third decimal
Methods
pickr.setHSVA(h:Number,s:Number,v:Number,a:Float, silent:Boolean) - Set an color, returns true if the color has been accepted.
pickr.setColor(str: :String | null, silent:Boolean):Boolean- Parses a string which represents a color (e.g. #fff, rgb(10, 156, 23)) or name e.g. 'magenta', returns true if the color has been accepted. null will clear the color.
If silent is true (Default is false), the button won't change the current color.
pickr.on(event:String, cb:Function):Pickr- Appends an event listener to the given corresponding event-name (see section Events).
pickr.off(event:String, cb:Function):Pickr- Removes an event listener from the given corresponding event-name (see section Events).
pickr.show():Pickr- Shows the color-picker.
pickr.hide():Pickr- Hides the color-picker.
pickr.disable():Pickr- Disables pickr and adds the disabled class to the button.
pickr.enable():Pickr- Enables pickr and removes the disabled class from the button.
pickr.isOpen():Pickr- Returns true if the color picker is currently open.
pickr.getRoot():Object- Returns the dom-tree of pickr as tree-structure.
pickr.getColor():HSVaColor- Returns the current HSVaColor object.
pickr.getSelectedColor():HSVaColor- Returns the currently applied color.
pickr.destroy() - Destroys all functionality.
pickr.destroyAndRemove() - Destroys all functionality and removes the pickr element including the button.
pickr.setColorRepresentation(type:String):Boolean- Change the current color-representation. Valid options are HEX, RGBA, HSVA, HSLA and CMYK, returns false if type was invalid.
pickr.getColorRepresentation():String- Returns the currently used color-representation (eg. HEXA, RGBA...)
pickr.applyColor(silent:Boolean):Pickr- Same as pressing the save button. If silent is true the onSave event won't be called.
pickr.addSwatch(color:String):Boolean- Adds a color to the swatch palette. Returns true if the color has been successful added to the palette.
pickr.removeSwatch(index:Number):Boolean- Removes a color from the swatch palette by its index, returns true if successful.
Static methods
Pickr
create(options:Object):Pickr- Creates a new instance.
Pickr.utils
once(element:HTMLElement, event:String, fn:Function[, options :Object]) - Attach an event handle which will be fired only once
resolveElement(val:String|HTMLElement) - Resolves a HTMLElement, supports >>> as shadow dom selector.
adjustableInputNumbers(el:InputElement, mapper:Function) - Creates the possibility to change the numbers in an inputfield via mouse scrolling. The mapper function takes three arguments: the matched number, an multiplier and the index of the match.
Use this utils carefully, it's not for sure that they will stay forever!
Static properties
version - The current version.
I18N_DEFAULTS - i18n default values.
DEFAULT_OPTIONS - Default options (Do not override this property itself, only change properties of it!).
FAQ
How do I initialize multiple pickr's? Can I access the instance via class or id?
No, you can't. You need to keep track of your instance variables - pickr is (not yet) a web-component. The best option would be to create new elements via document.createElement and directly pass it as el. example.
I want to use pickr in a form, how can I do that?
You can use useAsButton: true and pass a reference (or selector) of your input-element as el. Then you can update the input-element whenever a change was made. example.
I want to update options after mounting pickr, is that possible?
Unfortunately not. The core-code of this project is rather old (over 2 years), and I made it in my early js-days - the widget is not able to dynamically re-render itself in that way. You have to destroy and re-initialize it.
Contributing
If you want to open a issue, create a Pull Request or simply want to know how you can run it on your local machine, please read the Contributing guide.
I'm having problems getting it running in IE 11. What is the browser compatibility for this widget? So far I've had to Polyfill Object.assign. Next problem I'm having isSymbol is undefined. Is there a way to polyfill this?
Pickr-version: 0.2.4
Browser-version: Internet Explorer 11
Operating-system: Windows 8.1
So i would like to know if there is a chance that you could support input field or even provide a custom argument where i can link my input field to get the values updated.
At the moment it is only possible the reset the color to the current selected color in the themes Classic and Monolith, but not in the theme Nano.
If the current behavior is a bug, please provide the steps to reproduce and create a JSFiddle.
What is the expected behavior?
It would be great to be able to add a cancel button, similar to the cancel button in Spectrum color picker https://bgrins.github.io/spectrum/
When clicking this button it reset to the original selected color and close the dialog/overlay. It should of course be possible to customize/localize the button text as it is for the other buttons.
Your environment:
Pickr-version (see Pickr.version): 1.0.0-beta
Used Pickr-bundle (es5 or normal one): Normal
Browser-version: Version 75.0.3770.90
Operating-system: Windows 10
Hi,
I am running into situation in app where i am using pickr to apply colors to different curves.
problem is pickr should have
pickr.clear() function so that color`s value is empty string
clear() button click should apply value empty string , currently it is applying #0000 which is again a black color and there is no way of telling if it was cleared
there is no way of telling from }).on('hide', instance => { that hide was triggered from buttonclick, programatic call , clear button click etc
Selecting a color from the color swatches updates the input field color code and preview and highlight the selected color swatch, but the color swatch is not selected when re-open the color picker
If the current behavior is a bug, please provide the steps to reproduce and create a JSFiddle.
Can be reproduced here https://jsfiddle.net/Simonwep/qx2Lod6r/ and here https://simonwep.github.io/pickr/
Select a color from the color swatches. The color swatch is marked as selected with a border. When clicking save and re-open the color picker afterwards the selection is gone.
What is the expected behavior?
The color swatch should stay selected after re-open the color picker.
It would also be great if the color swatch was highlighted when manually enter a color code in the input field which match a color code of one of the color swatches, e.g. #3F51B5CC.
It seems the selection at the moment only is a focus state. If the selected color swatch has a class, it could e.g. have an "checkmark" inside the box to mark is as selected? (without using a library like font awesome it could use css, e.g. styled via :before pseudo element background image using svg: and https://iconmonstr.com/check-mark-1-svg/ so changing focus via tab still makes it clear which has focus and which is selected.
Your environment:
Version (see Pickr.version): 1.2.7
Used bundle (es5 or normal one): Normal
Used theme (default is classic): Classic
Browser-version: Version 76.0.3809.100
Operating-system: Windows 10
I'm not sure if it's a feature request or if it's actually meant to work with the shadow DOM, but Pickr currently has trouble working inside the shadow DOM.
What is the current behavior?
Named/default imports don't work. I kept getting the following error:
To fix it, I had to import the files as follows:
import '@simonwep/pickr/dist/pickr.min.js';
//Workaround for styles not being applied completely
import { PickrDefaultStyles } from './pickr-default-styles';
Getting the styles to work wasn't too much of a hassle. I use lit-element as my component library, which provides a handy CSS utility. I simply create a new file and wrap the CSS inside the following:
import { css } from 'lit-element';
export const PickrDefaultStyles = css`
//css goes here
`;
Although the files load correctly, Pickr.create doesn't work with selectors. You have to use actual DOM elements. No big deal, but this leads to the final error. Pickr crashes when calling replaceChild. Apparently parentElement doesn't exist or isn't accessible. Here's the error:
Finally, I replaced all instances of parentElement with parentNode and it works as expected. Kind of. Unfortunately, it doesn't respond to clicks or taps. Loading the css through the CDN in my index file makes it work. If I remove the mentioned CSS import, the pickr-button isn't styled correctly, so I have to load both instances of the stylesheet, once in my index file and the second inside the component.
In conclusion, to make it work I had to:
Import pickr without named/default imports
Import CSS through both CDN in my index file and inside component.
Use an actual DOM element in Pickr.create, not a selector.
Replace parentElement with parentNode inside the pickr js file.
Here's the JSFiddle containing the closest representation of my environment. I'm simulating the CSS import by creating a constant inside the component and treating that as if it had been imported. I also left the original Pickr element to demonstrate that the files have indeed been loaded.
Pickr-version (see Pickr.version): 0.4.11
Used Pickr-bundle (es5 or normal one): normal one
Browser-version: Chrome 73.0.3683.103
Operating-system: Windows 10
The width of the pickr is fixed at 28.5rem. When displaying only swatches it is rather wide. I would like the option to be able to customise the width.
Currently like this:
What is the expected behavior?
I would like to be able to set a narrower width like this:
Currently the picker crashes if setColor is called within the onChange event. And there is no way to trigger an event when the picker is closed/hidden, which makes it tricky to achieve the behaviour with the current setup.
When initiating the Color Picker without a default color and without color conversion interactions (e.g hex, rgba etc...), the following unwanted behavior occurs:
The result input (pcr-result) stays empty even after I assign a color in the color palette
The Color Palette is empty (without any color) before selecting a color, as you can see below:
The opacity and hue slider handles are unselected (without a fill)
Please provide the steps to reproduce and create a JSFiddle.
https://jsfiddle.net/4tvadnqp/
Bug reproduces in this link ^
What is the expected behavior?
The result input should change after I specify a color in the palette or in the swatches
The color palette should present a range of colors to pick from
I am using the plugin with the bootstrap 5 modal and when I click inside the input is not working, instead, the modal's X button is selected.
Here is an example of the issue https://codepen.io/s3739/pen/popxvJd
during Webpack process via npm run build are displayed deprecation warnings:
[DEP_WEBPACK_CHUNK_HAS_ENTRY_MODULE] DeprecationWarning: Chunk.hasEntryModule: Use new ChunkGraph API
[DEP_WEBPACK_CHUNK_ENTRY_MODULE] DeprecationWarning: Chunk.entryModule: Use new ChunkGraph API
[DEP_WEBPACK_MODULE_INDEX] DeprecationWarning: Module.index: Use new ModuleGraph API
Is their any way to add a custom template, Like on the pic given below.
The library is very good and customizable but the only things is to add a custom template.
Version (see Pickr.version): 1.8.2
Used bundle (es5 or normal one): Normal
Used theme (default is classic): Classic
Browser-version: Chrome 103.0.5060.66
Operating-system: Windows 10
We encounter a couple of security issues with pickr-1.8.2 as reported by gitub dependabot alerts. Any solution for this?
Samples
Inefficient Regular Expression Complexity in chalk/ansi-regex [High]
#31 opened 21 days ago • Detected in ansi-regex (npm)
Improper Verification of Cryptographic Signature in `node-forge` Moderate
#30 opened 21 days ago • Detected in node-forge (npm)
Improper Verification of Cryptographic Signature in node-forge [High]
#29 opened 21 days ago • Detected in node-forge (npm)
Improper Verification of Cryptographic Signature in node-forge [High]
#28 opened 21 days ago • Detected in node-forge (npm)
Uncontrolled Resource Consumption in ansi-html [High]
#27 opened 21 days ago • Detected in ansi-html (npm)
Open Redirect in node-forge [Moderate]
#26 opened 21 days ago • Detected in node-forge (npm)
Prototype Pollution in node-forge debug API. [Low]
#25 opened 21 days ago • Detected in node-forge (npm)
URL parsing in node-forge could lead to undesired behavior. [Low]
#24 opened 21 days ago • Detected in node-forge (npm)
json-schema is vulnerable to Prototype Pollution [Moderate]
#23 opened 21 days ago • Detected in json-schema (npm)
Please provide the steps to reproduce and create a JSFiddle.
github > Project page > Security > dependabot
What is the expected behavior?
As few messages as possible
Your environment:
Version (see Pickr.version): 1.8.2
Used bundle (es5 or normal one): normal
Used theme (default is classic): nano.min.css
Browser-version: Chrome 101.0.4951.67
Operating-system: Windows 10 and Linux
unconfirmed
opened by waj-vx 0
Releases(1.8.2)
1.8.2(Jun 27, 2021)
Fixes
Fix broken comparison option due to switch to css variables (#286).
Update: The browser-target for the ES5 bundle has been updated, it's still a WIP (see #210) but this should fix compatibility issues with older browsers. (bbc87c53326d9e66abda17d888e0e0699bdeaea7, bd9325e7bc7253ea2ad61acce919a6925722111a)
BOOTFLAT is an open source Flat UI KIT based on Bootstrap 3.3.0 CSS framework. It provides a faster, easier and less repetitive way for web developers to create elegant web apps.