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

aligned-react-colorful

v5.5.1-aligned0.0.2

Published

๐ŸŽจ A tiny (2,8 KB) color picker component for React and Preact apps. Fast, well-tested, dependency-free, mobile-friendly and accessible

Downloads

4

Readme

Features

  • ๐Ÿ—œ Small: Just 2,8 KB gzipped (13x lighter than react-color).
  • ๐ŸŒณ Tree-shakeable: Only the parts you use will be imported into your app's bundle.
  • ๐Ÿš€ Fast: Built with hooks and functional components only.
  • ๐Ÿ›ก Bulletproof: Written in strict TypeScript and has 100% test coverage.
  • ๐Ÿ—‚ Typed: Ships with types included
  • ๐Ÿ˜ Simple: The interface is straight forward and easy to use.
  • ๐Ÿ‘ซ Cross-browser: Works out-of-the-box for most browsers, regardless of version.
  • ๐Ÿ“ฒ Mobile-friendly: Supports mobile devices and touch screens.
  • ๐Ÿ’ฌ Accessible: Follows the WAI-ARIA guidelines to support users of assistive technologies.
  • ๐Ÿ’จ No dependencies

Live demos

Table of Contents

Getting Started

npm install react-colorful
import { HexColorPicker } from "react-colorful";

const YourComponent = () => {
  const [color, setColor] = useState("#aabbcc");
  return <HexColorPicker color={color} onChange={setColor} />;
};

Supported Color Models

We provide 12 additional color picker components for different color models, unless your app needs a HEX string as an input/output format.

Available pickers

| Import | Value example | | --------------------------- | ---------------------------------- | | { HexColorPicker } | "#ffffff" | | { RgbColorPicker } | { r: 255, g: 255, b: 255 } | | { RgbaColorPicker } | { r: 255, g: 255, b: 255, a: 1 } | | { RgbStringColorPicker } | "rgb(255, 255, 255)" | | { RgbaStringColorPicker } | "rgba(255, 255, 255, 1)" | | { HslColorPicker } | { h: 0, s: 0, l: 100 } | | { HslaColorPicker } | { h: 0, s: 0, l: 100, a: 1 } | | { HslStringColorPicker } | "hsl(0, 0%, 100%)" | | { HslaStringColorPicker } | "hsla(0, 0%, 100%, 1)" | | { HsvColorPicker } | { h: 0, s: 0, v: 100 } | | { HsvaColorPicker } | { h: 0, s: 0, v: 100, a: 1 } | | { HsvStringColorPicker } | "hsv(0, 0%, 100%)" | | { HsvaStringColorPicker } | "hsva(0, 0%, 100%, 1)" |

Code example

import { RgbColorPicker } from "react-colorful";

const YourComponent = () => {
  const [color, setColor] = useState({ r: 50, g: 100, b: 150 });
  return <RgbColorPicker color={color} onChange={setColor} />;
};

Live demo โ†’

Customization

The easiest way to tweak react-colorful is to create another stylesheet to override the default styles.

.your-component .react-colorful {
  height: 240px;
}
.your-component .react-colorful__saturation {
  border-radius: 4px 4px 0 0;
}
.your-component .react-colorful__hue {
  height: 40px;
  border-radius: 0 0 4px 4px;
}
.your-component .react-colorful__hue-pointer {
  width: 12px;
  height: inherit;
  border-radius: 0;
}

See examples โ†’

How to paste or type a color?

As you probably noticed the color picker itself does not include an input field, but do not worry if you need one. react-colorful is a modular library that allows you to build any picker you need. Since v2.1 we provide an additional component that works perfectly in pair with our color picker.

import { HexColorPicker, HexColorInput } from "react-colorful";

const YourComponent = () => {
  const [color, setColor] = useState("#aabbcc");
  return (
    <div>
      <HexColorPicker color={color} onChange={setColor} />
      <HexColorInput color={color} onChange={setColor} />
    </div>
  );
};

Live demo โ†’

| Property | Default | Description | | ---------- | ------- | -------------------------------------------- | | alpha | false | Allows #rgba and #rrggbbaa color formats | | prefixed | false | Enables # prefix displaying |

HexColorInput does not have any default styles, but it also accepts all properties that a regular input tag does (such as className, placeholder and autoFocus). That means you can place and modify this component as you like. Also, that allows you to combine the color picker and input in different ways:

<HexColorInput color={color} onChange={setColor} placeholder="Type a color" prefixed alpha />

Code Recipes

TypeScript Support

react-colorful supports TypeScript and ships with types in the library itself; no need for any other install.

While not only typing its own functions and variables, it can also help you type yours. Depending on the component you are using, you can also import the type that is associated with the component. For example, if you are using our HSL color picker component, you can also import the HSL type.

import { HslColorPicker, HslColor } from "react-colorful";

const myHslValue: HslColor = { h: 0, s: 0, l: 0 };

Take a look at Supported Color Models for more information about the types and color formats you may want to use.

Usage with Preact

react-colorful will work flawlessly with Preact out-of-the-box if you are using WMR, Preact-CLI, NextJS with Preact, or a few other tools/boilerplates thanks to aliasing.

If you are using another solution, please refer to the Aliasing React to Preact section of the Preact documentation.

react-colorful, like all other React + TS projects, can potentially cause issues in a Preact + TS application if you have the @types/react package installed, either as a direct dependency or a dependency of a dependency. For example, the Preact TS template comes with @types/enzyme which has @types/react as a dependency.

To fix this, create a declaration.d.ts file or add to your existing:

import React from "react";

declare global {
    namespace React {
        interface ReactElement {
            nodeName: any;
            attributes: any;
            children: any;
        }
    }
}

This will correct the types an allow you to use react-colorful along with many other React + TS libraries in your Preact + TS application.

Browser Support

It would be an easier task to list all of the browsers and versions that react-colorful does not support! We regularly test against browser versions going all the way back to 2013 and this includes IE11.

react-colorful works out-of-the-box for most browsers, regardless of version, and only requires an Object.assign polyfill be provided for full IE11 support.

Why react-colorful?

Today each dependency drags more dependencies and increases your projectโ€™s bundle size uncontrollably. But size is very important for everything that intends to work in a browser.

react-colorful is a simple color picker for those who care about their bundle size and client-side performance. It is fast and lightweight because:

  • has no dependencies (no risks in terms of vulnerabilities, no unexpected bundle size changes);
  • built with hooks and functional components only (no classes and polyfills for them);
  • ships only a minimal amount of manually optimized color conversion algorithms (while most of the popular pickers import entire color manipulation libraries that increase the bundle size by more than 10 KB and make your app slower).

To show you the problem that react-colorful is trying to solve, we have performed a simple benchmark (using bundlephobia.com) against popular React color picker libraries:

| Name | Bundle size | Bundle size (gzip) | Dependencies | | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | react-colorful | | | | | react-color | | | | | react-input-color | | | | | rc-color-picker | | | |

Projects using react-colorful

Backers and sponsors

Ports

Not using React or Preact? Not a problem! Check out the list of react-colorful ports adapted to your favourite framework or technology of choice:

If your port is not in the list, reach us out via GitHub issues.