Skip to content

Latest commit

 

History

History
executable file
·
124 lines (90 loc) · 5.02 KB

README.md

File metadata and controls

executable file
·
124 lines (90 loc) · 5.02 KB
Raw

ColorPicker

Coverage Status ci jsDeliver NPM Version typescript version vitest version vite version

The feature rich ColorPicker component for the modern web, sourced with TypeScript, Vitest tested, WAI-ARIA compliant and lots of goodies. In addition, it features its own version of TinyColor called simply Color.

ColorPicker can use existing colour palettes or generate custom ones via DATA API configuration. If you want to play, check out this codepen I've setup for you. Have fun!

image

Highlights

  • Accessibility Focus for WAI-ARIA compliance
  • TypeScript sourced code base
  • Framework agnostic and flexible design
  • Supporting HEX(a), RGB(a), HSL(a) and HWB, the last three also in CSS4 Color Module flavours
  • Supports keyboard and touch events
  • Automatic repositioning of the popup dropdown on show / window scroll
  • SCSS sources with minimal style required
  • Vitest tested
  • Right To Left Languages Supported
  • light footprint, 10kb in size when minified and gZipped

Install

pnpm install @thednp/color-picker
yarn add @thednp/color-picker
npm install @thednp/color-picker
deno add npm:@thednp/color-picker@latest

Wiki

For an in depth guide on all things ColorPicker, check out the wiki pages:

  • Home - the ColorPicker wiki home.
  • NPM - quick installation guide.
  • CDN Link - quick implementation guide.
  • Usage - an in-depth browser usage.
  • ES6+ - your usual quick ES6+ guide.
  • Node.js - is this a thing?

Browser Usage

Download the latest package. unpack and inspect the contents. You need to copy the color-picker.js and color-picker.css or their minified variations to your app assets folders as follows. Link the required CSS in your document <head> tag

<link href="../assets/css/color-picker.css" rel="stylesheet" />

Link the required JS in your document <body> tag, though it should work in the <head> as well

<script src="../assets/js/color-picker.js"></script>

Now you can initialize the function for your elements at the end of your <body> tag

<script>
  var myPicker = new ColorPicker('input.SELECTOR');
</script>

To use the DATA-API, you can provide for instance the data-format="hex", and other specific attributes like so:

<label for="myPicker">Color Label</label>
<div class="color-picker">
  <input
    id="myPicker"
    name="myPicker"
    data-function="color-picker"
    data-format="hex"
    data-color-presets="red,green,blue"
    class="color-preview"
    value="#069"
  />
</div>

The data-function="color-picker" attribute is useful for mass initialization, check this usage section of the wiki.

Initialize INPUT

import ColorPicker from '@thednp/color-picker';

const myPicker = new ColorPicker('#myPicker');

Thanks

License

ColorPicker is released under the MIT License.