electron-color-picker/README.md

# electron-color-picker

[![i:npm]][l:npm]
[![i:size]][l:size]
[![i:lint]][l:lint]
[![i:npm-dev]][l:npm]

Pick color from Desktop, suitable for use with Electron.

[i:npm]: https://img.shields.io/npm/v/electron-color-picker.svg?colorB=blue
[i:npm-dev]: https://img.shields.io/npm/v/electron-color-picker/dev.svg
[l:npm]: https://npm.im/electron-color-picker
[i:size]: https://packagephobia.now.sh/badge?p=electron-color-picker
[l:size]: https://packagephobia.now.sh/result?p=electron-color-picker
[i:lint]: https://img.shields.io/badge/code_style-standard_ES6+-yellow.svg
[l:lint]: https://standardjs.com

#### Note

On Windows & MacOS will use our native color-picker.

On Linux will use [SCROT][l:scrot] to get screenshot and pick color from it.
The idea is directly borrowed from package [desktop-screenshot][l:desktop-screenshot].

Error will be thrown:
- when try to start multiple color-picker.
- on unsupported platform.

#### Example

📁 [example/](example/)

basic implementation of using DOM Button
to trigger color picking
and pass result back through ipc

try example with:
```bash
cd example
npm install
npm start
```

#### Usage

first add this package to your project: 
```bash
npm install electron-color-picker
```

sample function `saveColorToClipboard()`:
```js
const { clipboard } = require('electron')
const { getColorHexRGB } = require('electron-color-picker')

const saveColorToClipboard = async () => {
  // color may be `#0099ff` or `` (pick cancelled with ESC)
  const color = await getColorHexRGB().catch((error) => {
    console.warn(`[ERROR] getColor`, error)
    return ''
  })

  console.log(`getColor: ${color}`)
  color && clipboard.writeText(color)
}
```

[l:scrot]: https://en.wikipedia.org/wiki/Scrot
[l:desktop-screenshot]: https://npm.im/desktop-screenshot