1.0.1 • Published 3 years ago

@jfraissenet/react-colors-picker v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

React Colors Picker Guide

Summary

You are a web developer and want, for example, to sell products with various colors. This components allows to modify your carousel pictures or to dynamically change any properties by simply clicking on the corresponding item. You just need to code your callback function.

Displays color circles

Allows callback onClick

Tunable component

alt text

Installation

How to intall it ?

npm install --save @jfraissenet/react-colors-picker

How to use it ?

import {ColorsPicker} from '@jfraissenet/react-colors-picker';

const pl=[{label:"color1", value:"#123456"},
          {label:"color2", value:"#eeeeee"},
          {label:"color3", value:"#123456"}, 
          {label:"color4", value:"#eeeeee"}]

function App() {
  return (
    <div>
      <ColorsPicker colors={pl} handle={handleOnClick}/>
    </div>
  );
}

function handleOnClick(colorItem) {
  alert(colorItem.label);
}

export default App;

label and value are mandatories.

Properties

The component is completelly tunable. It's possible to change shape, border, size of the items. You can allow the zoom when hovering over the circle or not

PropertiesTypesDefault valuesMandatoryComments
colorsArraynoneYesArray of colors objects {label: "Nom13, value:"#ffffff"}, ...
handleFunctionnoneYesCallback on click. It return the object sent
borderRadiusString20pxNoChange the shape. "0px" --> square. "20px" --> circle
borderString1px solid blackNoChange the design of the item's border
widthString28pxNoChange the item width
heightString28pxNoChange the item height
marginRightString10pxNoChange the right margin
marginBottomString4pxNochange the bottom margin
transformOnHoverBooleantrueNoWhen hovering on items, a scale transformation of 1.1 appears