@simonwep/pickr
Advanced tools
Readme
â ď¸ Attention: 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:
// Style
import '/node_modules/@simonwep/pickr/dist/pickr.min.css';
// Modern browsers (see .browserslistrc)
import Pickr from '/node_modules/@simonwep/pickr/dist/pickr.min';
// ES5 Version
import Pickr from '/node_modules/@simonwep/pickr/dist/pickr.es5.min';
jsdelivr:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@simonwep/pickr/dist/pickr.min.css"/>
<script src="https://cdn.jsdelivr.net/npm/@simonwep/pickr/dist/pickr.min.js"></script>
<!-- OR -->
<script src="https://cdn.jsdelivr.net/npm/@simonwep/pickr/dist/pickr.es5.min.js"></script>
Be sure to load the pickr.min.js (or the es5 version) after pickr.min.css. Moreover the script tag doesn't work with the defer attribute.
// Simple example, see optional options for more configuration.
const pickr = Pickr.create({
el: '.color-picker',
components: {
// Main components
preview: true,
opacity: true,
hue: true,
// Input / output Options
interaction: {
hex: true,
rgba: true,
hsla: true,
hsva: true,
cmyk: true,
input: true,
clear: true,
save: true
}
}
});
Since version 0.4.x Pickr is event-driven. Use the on(event, cb) and off(event, cb) functions to bind / unbind eventlistener.
| Event | Description | Arguments |
|---|---|---|
init | Initialization done - pickr can be used | PickrInstance |
save | User clicked the save / clear button | HSVaColorObject | null, PickrInstance |
change | Color has changed (but not saved). Also fired on swatchselect | HSVaColorObject, PickrInstance |
swatchselect | User clicked one of the swatches | HSVaColorObject, PickrInstance |
Example:
pickr.on('init', (...args) => {
console.log('init', args);
}).on('save', (...args) => {
console.log('save', args);
}).on('change', (...args) => {
console.log('change', args);
}).on('swatchselect', (...args) => {
console.log('swatchselect', args);
});
const pickr = new Pickr({
// Selector or element which will be replaced with the actual color-picker.
// Can be a HTMLElement.
el: '.color-picker',
// Custom class wich gets added to the pickr-app. Can be used to apply custom styles.
appClass: 'custom-class',
// Using the 'el' Element as button, won't replace it with the pickr-button.
// If true, appendToBody will also be automatically true.
useAsButton: false,
// If true pickr won't be fixed and instead append after the in el resolved element.
// Setting this to true will also set showAlways to true. It's possible to hide it via .hide() anyway.
inline: false,
// Start state. If true 'disabled' will be added to the button's classlist.
disabled: false,
// If set to false it would directly apply the selected color on the button and preview.
comparison: true,
// Default color
default: 'fff',
// Optional color swatches. null by default which means it's disabled.
// Types are all these allowed which can be used in pickr e.g. hex, hsv(a), hsl(a), rgb(a), cmyk or a name like 'magenta'
swatches: ['#F44336', '#E91E63', '#9C27B0', '#673AB7'],
// Default color representation.
// 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 his functionality, so if
// you click it, it will fire the onSave event.
showAlways: false,
// Close pickr with this specific key.
// Default is 'Escape'. Can be the event key or code.
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.
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 five
adjustableNumbers: 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 true
palette: true,
preview: true, // Left side color comparison
opacity: true, // Opacity slider
hue: true, // Hue slider
// Bottom interaction bar, theoretically you could use 'true' as propery.
// But this would also hide the save-button.
interaction: {
hex: true, // hex option (hexadecimal representation of the rgba value)
rgba: true, // rgba option (red green blue and alpha)
hsla: true, // hsla option (hue saturation lightness and alpha)
hsva: true, // hsva option (hue saturation value and alpha)
cmyk: true, // cmyk option (cyan mangenta yellow key )
input: true, // input / output element
clear: true, // Clear button
save: true // Save button
},
},
// Button strings, brings the possibility to use a language other than English.
strings: {
save: 'Save', // Default for save button
clear: 'Clear' // Default for clear button
}
});
Example setup:
<div class="entry">
#shadow-root
<div class="innr">
<div class="another">
#shadow-root
<div class="pickr"></div>
</div>
</div>
</div>
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.
As default color representation is hsva (hue, saturation, value and alpha) used, but you can also convert it to other formats as listed below.
The toString() is overridden so you can get a color representaion string.
hsva.toRGBA(); // Returns [r, g, b, a]
hsva.toRGBA().toString(); // Returns rgba(r, g, b, a)
:Number,s:Number,v:Number,a:Float, silent:Boolean) - Set an color, returns true if the color has been accepted.:String, 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.
:String, cb:Function) - Appends an eventlistener to the given corresponding event-name (see section Events), returns the pickr instance so it can be chained.:String, cb:Function) - Removes an eventlistener from the given corresponding event-name (see section Events), returns the pickr instance so it can be chained.disabled class to the button, returns instance.disabled class from the button, returns instance.:HTMLElement - Returns the root DOM-Element of the color-picker.:HSVaColor - Returns the current HSVaColor object.:HSVaColor - Destroy's all functionality.:HSVaColor - Destroy's all functionality and removes the pickr element including the button.:String):Boolean - Change the current color-representation. Valid options are HEX, RGBA, HSVA, HSLA and CMYK, returns false if type was invalid.:Boolean) - Same as pressing the save button. If silent is true the onSave event won't be called.:String):Boolean - Adds a color to the swatch palette. Returns true if the color has been successful added to the palette.:Number) - Removes a color from the swatch palette by its index.Pickr
:Object):Pickr - Creates a new instance.Pickr.utils
:HTMLElement, event:String, fn:Function[, options :Object]) - Attach an event handle which will be fired only once:HTMLElement(s), events:String(s), fn:Function[, options :Object]) - Attach an event handler function.:HTMLElement(s), event:String(s), fn:Function[, options :Object]) - Remove an event handler.:String):HTMLElement - Creates an new HTML Element out of this string.:Event):[HTMLElement] - A polyfill for the event-path event propery.:HTMLElement, name:String) - Removes an attribute from a HTMLElement and returns the value.:String) - See inline doumentation.:InputElement, negative:Boolean) - Creates the possibility to change the numbers in an inputfield via mouse scrolling.:String, maxLength:Number, fillString = ' ') - String.prototype.padStart polyfill.Use this utils carefully, it's not for sure that they will stay forever!
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.
FAQs
Flat, Simple, Hackable Color-Picker.
The npm package @simonwep/pickr receives a total of 90,616 weekly downloads. As such, @simonwep/pickr popularity was classified as popular.
We found that @simonwep/pickr demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.
Security News
The NVD is facing a significant backlog with over 12,500 CVEs awaiting analysis, and more than 50% of known exploited vulnerabilities (KEVs) left unenriched since mid-February.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.