npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-image-extractor

v1.0.4

Published

A package to extract dominant colors from images in different formats

Downloads

25

Readme

react-image-extractor is a simple npm package for extracting prominent colors from an image. You can get colors in different formats such as RGB, HEX, and HSL. This is useful for generating color palettes or themes from images in web applications.

Installation

To install react-image-extractor, use npm or yarn:

npm install react-image-extractor

or

yarn add react-image-extractor

Usage

After installing, you can use getColors to extract colors from an image URL. Below are examples of how to use the function to get colors in RGB, HEX, and HSL formats.

Importing the Function

import { getColors } from 'react-image-extractor';

Example Code

const imageUrl = 'https://example.com/image.jpg';
const numberOfSwatches = 4;

// Get colors in RGB format
getColors(imageUrl, numberOfSwatches, 'rgb')
  .then((colors) => {
    console.log('RGB Colors:', colors);
  })
  .catch((error) => {
    console.error('Error:', error);
  });

// Get colors in HEX format
getColors(imageUrl, numberOfSwatches, 'hex')
  .then((colors) => {
    console.log('HEX Colors:', colors);
  })
  .catch((error) => {
    console.error('Error:', error);
  });

// Get colors in HSL format
getColors(imageUrl, numberOfSwatches, 'hsl')
  .then((colors) => {
    console.log('HSL Colors:', colors);
  })
  .catch((error) => {
    console.error('Error:', error);
  });

Parameters

  • imageUrl: The URL of the image you want to extract colors from.
  • numberOfSwatches: The number of prominent colors to extract from the image.
  • format: The format of the colors to return. Options are 'rgb', 'hex', or 'hsl'.

Return Value

The function returns a promise that resolves to an array of color values in the specified format.

Error Handling

In case of an error, such as an invalid URL or network issues, the promise will be rejected with an error message.

Contributing

Contributions are welcome! Please fork the Github repository and submit a pull request for any features, bug fixes, or enhancements. Make sure to follow the code style and add relevant tests.

License

This package is licensed under the MIT License.