🎨 Get Palette

A simple JS library to get the dominant color or color palette of an image just by its URL.

---

❄️ Installation

First install the package using a package manager of your choice.

# using npm
npm install get-palette
# or pnpm
pnpm install get-palette
# or bun
bun add get-palette

🚀 Usage

import { getPalette, getColor } from "get-palette";

 // it will return an array of [r,g,b] values
const palette = await getPalette("https://source.unsplash.com/random?size=1920x1080");

// it will return a single dominant [r,g,b] value
const color = await getColor("https://source.unsplash.com/random?size=1920x1080");

🛠️ Configuration

getPalette(url, colorCount, quality)

Parameter	Type	Default	Description
url	string/URL	-	The URL of the image
colorCount	number	10	The number of colors to be returned
quality	number	10	Sampling quality of the image

getColor(url, quality)

Parameter	Type	Default	Description
url	string/URL	-	The URL of the image
quality	number	10	Sampling quality of the image

🏗️ How to contribute

🐛 Reporting Bugs

If you encounter any bugs, please report them in the Issues.

🎋 Adding new features

You need to first fork this repository and then clone it to your local machine.

git clone https://github.com/<your-username>/get-palette
cd get-palette

Now you need to create a new branch for your changes. For features, you may want to use feat/<feature-name> as the branch name.

git checkout -b feat/<feature-name>

Now you can make your changes. After you are done, you need to commit your changes.

git add .
git commit -m "feat: ✨ My Awesome feature"

We follow Conventional Commits for commit messages.

Now you need to push the changes to your forked repository.

git push origin feat/<feature-name>

Now you need to create a Pull Request to the original repository. And you are done!

We will review your changes and merge them if everything looks good.

💸 Sponsorship

If you find this package useful, please consider sponsoring me. This will help me spend more time on these projects.

📝 Credits

This Project is a modernized version of Color Thief.

Also it's dependencies like quantize and get-pixels has been also ported to modern JS syntax.

📜 License

This project is licensed under the MIT License.