npmpackage.info

Gathering detailed insights and metrics for react-colorful

Other packages similar to react-colorful

@noya-app/noya-colorpicker

0.1.13

This is derived from: https://github.com/omgovich/react-colorful

@amirhossein92/react-colorful

1.2.0

added gradient component into the react-colorful

@ui-schema/material-colorful

0.0.3

React color pickers as MUI widgets for UI-Schema - using react-colorful.

@armincerf/react-colorful

1.0.9

Fork of react-colorful with action buttons and toggles

Gathering detailed insights and metrics for react-colorful

react-colorful

🎨 A tiny (2,8 KB) color picker component for React and Preact apps

5.6.1

3,205

MIT

TypeScript

4.62 kB

517,576,574 2.9

Installations

npm install react-colorful

Score

88.3

Supply Chain

Quality

76.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

6

Total

117

Closed

15

Merged

96

Issues

Open

32

Total

102

Closed

70

Releases

v5.6 (Even better)

v5.6

Published on 10 Aug 2022

v5.5 (Multitouch)

v5.5

Published on 28 Sept 2021

v5.2 (Intelligent parsers)

v5.2

Published on 14 May 2021

v5 (Super easy to install)

v5.0

Published on 12 Feb 2021

v4.1 (Accessibility)

v4.1

Published on 25 Sept 2020

v4.0 (Alpha channel)

v4.0

Published on 14 Sept 2020

View all 15 releases

Developer

omgovich

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

Typescript Support

Yes

Node Version

14.18.2

NPM Version

6.14.15 Statistics

3,205 Stars

490 Commits

102 Forks

10 Watching

6 Branches

14 Contributors

Updated on 26 Nov 2024

Bundle Size

14.32 kB

Minified

4.62 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (58.16%)

JavaScript (38.2%)

CSS (3.64%)

Total Downloads

Cumulative downloads

Total Downloads

517,576,574

Last day

-4.8%

877,708

Compared to previous day

Last week

0.9%

4,526,933

Compared to previous week

Last month

0.9%

20,273,010

Compared to previous month

Last year

74.3%

217,935,423

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

react-colorful is a tiny color picker component for React and Preact apps.

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 straightforward 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

Getting Started

npm install react-colorful

1import { HexColorPicker } from "react-colorful";
2
3const YourComponent = () => {
4  const [color, setColor] = useState("#aabbcc");
5  return <HexColorPicker color={color} onChange={setColor} />;
6};

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.

How to use another color model

Available pickers

Import	Value example
`{ HexColorPicker }`	`"#ffffff"`
`{ HexAlphaColorPicker }`	`"#ffffff88"`
`{ 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

1import { RgbColorPicker } from "react-colorful";
2
3const YourComponent = () => {
4  const [color, setColor] = useState({ r: 50, g: 100, b: 150 });
5  return <RgbColorPicker color={color} onChange={setColor} />;
6};

Live demo →

Customization

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

1.your-component .react-colorful {
2  height: 240px;
3}
4.your-component .react-colorful__saturation {
5  border-radius: 4px 4px 0 0;
6}
7.your-component .react-colorful__hue {
8  height: 40px;
9  border-radius: 0 0 4px 4px;
10}
11.your-component .react-colorful__hue-pointer {
12  width: 12px;
13  height: inherit;
14  border-radius: 0;
15}

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.

How to use HexColorInput

1import { HexColorPicker, HexColorInput } from "react-colorful";
2
3const YourComponent = () => {
4  const [color, setColor] = useState("#aabbcc");
5  return (
6    <div>
7      <HexColorPicker color={color} onChange={setColor} />
8      <HexColorInput color={color} onChange={setColor} />
9    </div>
10  );
11};

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:

1<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.

How you can get the most from our TypeScript support

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.

1import { HslColorPicker, HslColor } from "react-colorful";
2
3const 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.

Preact + Typescript

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 and 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

Storybook — the most widely used open-source tool for developing UI components

Resume.io — online resume builder with over 9,400,000 users worldwide

Wireflow.co — free tool for creating modern user flow prototypes

MagicPattern.design — unique geometric pattern generator

Viewst.com — online tool for designing, creating and automating ad campaigns

Omatsuri.app — progressive web application with a lot of different frontend focused tools

Leva — open source extensible GUI panel made for React

Composable — online tool for creating custom vector illustrations

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:

vanilla-colorful — a react-colorful reimplementation in vanilla Custom Elements, generously ported by @web-padavan.
angular-colorful — a react-colorful rewritten for use with the Angular framework, lovingly ported by @fil0157.

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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

61 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-8mmm-9v2q-x3f9
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-876r-hj45-fw7g
Warn: Project is vulnerable to: GHSA-v63x-xc9j-hhvq
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-w5q7-3pr9-x44w
Warn: Project is vulnerable to: GHSA-3fjq-93xj-3f3f
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q

Score

2.9

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to react-colorful

Other packages similar to react-colorful

react-colorful

Installations

Score

Pull Requests

6

117

15

96

Issues

32

102

70

Releases

Developer

Developer Guide

CommonJS, ESM

Yes

14.18.2

6.14.15

Statistics

Bundle Size

14.32 kB

4.62 kB

Languages

Total Downloads

517,576,574

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

Dev Dependencies

Features

Live demos

Table of Contents

Getting Started

Supported Color Models

Available pickers

Code example

Customization

How to paste or type a color?

Code Recipes

TypeScript Support

Usage with Preact

Browser Support

Why react-colorful?

Projects using react-colorful

Backers and sponsors

Ports

10

10

10

4

0

0

0

0

0

0

0

0

0

2.9

/10