ngx-color
v10.1.0TypeScript
A Collection of Color Pickers from Sketch, Photoshop, Chrome & more
62.4K/weekUpdated 4 months agoMITUnpacked: 555.4 KB
Published by scttcper
npm install ngx-color
Angular Color
DEMO: https://ngx-color.vercel.app
- Component API
- Color
- onChange
- onChangeComplete
- Individual APIs
- Alpha
- Block
- Chrome
- Circle
- Compact
- Github
- Hue
- Material
- Photoshop
- Sketch
- Slider
- Swatches
- Twitter
- Shade
About
- 13 Different Pickers - Sketch, Photoshop, Chrome, Twitter and many more
- Make Your Own - Use the building block components to make your own
- This is a port of react-color
by casesandberg
Getting Started
Dependencies
Latest version available for each version of Angular
| ngx-color | Angular |
| --------- | --------- |
| 4.1.1 | 8.x |
| 5.1.4 | 9.x |
| 6.2.0 | 10.x 11.x |
| 7.3.3 | 12.x 13.x |
| 8.0.3 | 14.x 15.x |
| current | >= 16.x |
$3
``sh`
npm install ngx-color --save
$3
##### import
`ts
import { ColorSketchModule } from 'ngx-color/sketch';
@NgModule({
imports: [
ColorSketchModule, // added to imports
],
})
class YourModule {}
`
##### use
`html`
$3
`ts`
import { ColorAlphaModule } from 'ngx-color/alpha'; //
import { ColorBlockModule } from 'ngx-color/block'; //
import { ColorChromeModule } from 'ngx-color/chrome'; //
import { ColorCircleModule } from 'ngx-color/circle'; //
import { ColorCompactModule } from 'ngx-color/compact'; //
import { ColorGithubModule } from 'ngx-color/github'; //
import { ColorHueModule } from 'ngx-color/hue'; //
import { ColorMaterialModule } from 'ngx-color/material'; //
import { ColorPhotoshopModule } from 'ngx-color/photoshop'; //
import { ColorSketchModule } from 'ngx-color/sketch'; //
import { ColorSliderModule } from 'ngx-color/slider'; //
import { ColorSwatchesModule } from 'ngx-color/swatches'; //
import { ColorTwitterModule } from 'ngx-color/twitter'; //
import { ColorShadeModule } from 'ngx-color/shade'; //
Component API
Color
Color controls what color is active on the color picker. You can use this to
initialize the color picker with a particular color, or to keep it in sync with
the state of a parent component.
Color accepts either a string of a hex color '#333' or a object of rgb or hsl{ r: 51, g: 51, b: 51 }
values or { h: 0, s: 0, l: .10 }. Both rgb and hsla: 1
will also take a value for alpha. You can also use transparent.
`html`
In this case, the color picker will initialize with the color #fff. When thehandleChangeComplete
color is changed, will fire and set the new color to
state.
onChange
Pass a function to call every time the color is changed. Use this to store the
color in the state of a parent component or to make other transformations.
Keep in mind this is called on drag events that can happen quite frequently. If
you just need to get the color once use onChangeComplete.
`ts
import { Component } from '@angular/core';
import { ColorEvent } from 'ngx-color';
@Component({
selector: 'selector-name',
template: ,
})
export class NameComponent {
constructor() {}
handleChange($event: ColorEvent) {
console.log($event.color);
// color = {
// hex: '#333',
// rgb: {
// r: 51,
// g: 51,
// b: 51,
// a: 1,
// },
// hsl: {
// h: 0,
// s: 0,
// l: .20,
// a: 1,
// },
// }
}
}
`
onChangeComplete
Pass a function to call once a color change is complete.
Individual APIs
Some pickers have specific APIs that are unique to themselves:
$3
- width - String | Number, Pixel value for picker width. Default 316px
- height - String | Number, Pixel value for picker height. Default
- direction - String, or vertical. Default horizontal
$3
- width - string | number, Pixel value for picker width. Default 170px
- colors - Array of Strings, Color squares to display. Default
- triangle - String, Either or top. Default top
- onSwatchHover - (Output) An event handler for on the
s within this component. Gives the args (color, event)
$3
- disableAlpha - Bool, Remove alpha slider and options from picker. Default
false
$3
- width - String | number, Pixel value for picker width. Default 252px
- colors - Array of Strings, Color squares to display. Default
- circleSize - Number, Value for circle size. Default
- circleSpacing - Number, Value for spacing between circles. Default
- onSwatchHover - (Output) An event handler for on the
s within this component. Gives the args (color, event)
$3
- colors - Array of Strings, Color squares to display. Default ['#4D4D4D', '#999999', '#FFFFFF', '#F44E3B', '#FE9200', '#FCDC00', '#DBDF00', '#A4DD00', '#68CCCA', '#73D8FF', '#AEA1FF', '#FDA1FF', '#333333', '#808080', '#cccccc', '#D33115', '#E27300', '#FCC400', '#B0BC00', '#68BC00', '#16A5A5', '#009CE0', '#7B64FF', '#FA28FF', '#000000', '#666666', '#B3B3B3', '#9F0500', '#C45100', '#FB9E00', '#808900', '#194D33', '#0C797D', '#0062B1', '#653294', '#AB149E']
- onSwatchHover - (Output) An event handler for on the
s within this component. Gives the args (color, event)
$3
- width - string | number, Pixel value for picker width. Default 212px
- colors - Array of Strings, Color squares to display. Default
- triangle - String, Either , top-left or top-right. Defaulttop-left
- onSwatchHover - (Output) An event handler for on the
s within this component. Gives the args (color, event)
$3
- width - string | number, Pixel value for picker width. Default 316px
- height - string | number, Pixel value for picker height. Default
- direction - String Enum, or vertical. Default horizontal
$3
None
$3
- header - String, Title text. Default Color Picker
- onAccept - (Output), Callback for when accept is clicked.
- onCancel - (Output), Callback for when cancel is clicked.
$3
- disableAlpha - Bool, Remove alpha slider and options from picker. Default
false
- presetColors - Array of Strings or Objects, Hex strings for default colors
at bottom of picker. Default
> presetColors may also be described as an array of objects with
> and properties: [{ color: '#f00', title: 'red' }] or a combination200
> of both
- width - Number, Width of picker. Default
- onSwatchHover - An event handler for on the s(color, event)
within this component. Gives the args
$3
- pointer - React Component, Custom pointer component
$3
- width - string | number, Pixel value for picker width. Default 320
- height - string | number, Pixel value for picker height. Default
- colors - Array of Arrays of Strings, An array of color groups, each with
an array of colors
- onSwatchHover - (Output) An event handler for on the
s within this component. Gives the args (color, event)
$3
- width - string | number, Pixel value for picker width. Default 276px
- colors - Array of Strings, Color squares to display. Default
- triangle - String, Either , top-left or top-right. Defaulttop-left
- onSwatchHover - (Output) An event handler for on the
s within this component. Gives the args (color, event)
$3
- width - String | Number, Pixel value for picker width. Default 316px
- height - String | Number, Pixel value for picker height. Default
---