Skip to content

felixboet/netlify-cms-widget-colorpicker

Repository files navigation

netlify-cms-widget-colorpicker

A color picker widget for Netlify CMS that supports HEX color codes, alpha channels via RGBA, color names and custom values.

-> check out the demo here

Install

As an npm package:

npm install --save netlify-cms-widget-colorpicker
import { ColorControl, ColorPreview } from "netlify-cms-widget-colorpicker"; CMS.registerWidget("color", ColorControl, ColorPreview);

How to use

Add to your Netlify CMS configuration:

fields: - { name: <fieldname>, label: <fieldlabel>, widget: color }

Configuration

Color Picker

The default color picker is the "chrome picker", you can change it via the options

fields: - { name: <fieldname>, label: <fieldlabel>, widget: color, picker: github }

The following options are available:

block chrome compact github sketch swatches twitter 

Preset Colors

for the block, compact, github, sketch, twitter picker, you can set the preset colors

colors: [ "#F44336", "#9C27B0", "#3F51B5", ...], 

for the swatches picker, you can set the preset colors as an array of color groups, each with an array of colors

colors: [ ["#FF8A80", "#FF5252", "#FF1744", "#D50000"], ["#FF80AB", "#FF4081", "#F50057", "#C51162"], ["#EA80FC", "#E040FB", "#D500F9", "#AA00FF"], ["#B388FF", "#7C4DFF", "#651FFF", "#6200EA"], ... ], 

Disable Alpha

for the chrome and sketch picker, you can disable the slider for the alpha value

disableAlpha: true 

To Do

Color Swatches / Presets can't be customized yet, will be added soon

Support

For help with this widget, open an issue

Development

Fork the repo, pull the code to your local computer and install dependencies:

npm install

To run a copy of Netlify CMS with the widget loaded for development, use the start script:

npm start

License

MIT Licensed. Copyright Felix Böttcher

Netlify Status

Based on the awesome react-color

About

a color picker widget for Netlify CMS, supports HEX color codes, RGBA, color names and custom values

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •