Giter Club home page Giter Club logo

color-loader's Introduction

Color Loader

Build Status

A webpack loader that extracts the color palette of an image

Installation

$ npm install --save-dev color-loader file-loader

This loader depends on file-loader, so be sure to install that too if you don't have it already.

Usage

This loader supports JPEG, PNG, GIF, and SVG files and is designed to be a drop-in replacement for file-loader, in case you're already using that. The loader will output the path to the provided image file, along with information about the colors in the image.

import image, {color, colors} from 'color-loader!./path/to/image.jpg';
  • image is the image path generated by the file loader
  • color is the most dominant color in the image
  • colors is an array of the dominant colors in the image

You can use it in your webpack configuration, too! This means that all images that you import or require will always return the colors extracted from the image.

{
  // ...your awesome webpack config options
  module: {
    rules: [
      {
        test: /\.(jpg|png|gif|svg)$/,
        use: 'color-loader'
      }
    ]
  }
}

Options

You can pass along any options you would normally pass to file-loader.

Example

This image:

example image

Will result in these colors:

  • #3a4f25 #3a4f25
  • #b37a5d #b37a5d
  • #78993b #78993b
  • #839795 #839795
  • #8c472f #8c472f

You could use it in a React component like this:

import image, {color} from './example.png';

const Component = () => (
 <div
   style={{
     backgroundColor: color, // #3a4f25
     backgroundImage: image
   }}
 >
   <h1>They ate the Pokémon...</h1>
 </div>
);

And it might look something like this (results may vary):

example gif

color-loader's People

Contributors

trevorblades avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

lcsouzamenezes

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.