This is a simple color picker based on the cool angular2-color-picker by Alberplz.
This documentation is for the latest 5/6.x.x version which requires Angular 5 or newer. For Angular 4 you need to use the latest 4.x.x version. Documentation for the 4.x.x can be found from here.
Example application | StackBlitz example
npm install
npm startcd example
npm install
npm startnpm link
cd example
npm link ngx-color-pickernpm install ngx-color-picker --saveimport { ColorPickerModule } from 'ngx-color-picker';
@NgModule({
...
imports: [
...
ColorPickerModule
]
})<input [(colorPicker)]="color" [style.background]="color"/>[disabled] // Disables opening of the color picker dialog.
[colorPicker] // The color to show in the color picker dialog.
[cpWidth] // Use this option to set color picker dialog width ('230px').
[cpHeight] // Use this option to force color picker dialog height ('auto').
[cpToggle] // Sets the default open / close state of the color picker (false).
[cpOutputFormat] // Output color format: 'hex', 'rgba', 'hsla' ('hex').
[cpAlphaChannel] // Alpha in output value: 'enabled', 'disabled', 'always' ('enabled').
[cpFallbackColor] // Is used when the color is not well-formed or is undefined ('#000').
[cpPosition] // Dialog position: 'right', 'left', 'top', 'bottom' ('right').
[cpPositionOffset] // Dialog offset percentage relative to the directive element (0%).
[cpPositionRelativeToArrow] // Dialog position is calculated relative to dialog arrow (false).
[cpPresetLabel] // Label text for the preset colors if any provided ('Preset colors').
[cpPresetColors] // Array of preset colors to show in the color picker dialog ([]).
[cpDisableInput] // Disables / hides the color input field from the dialog (false).
[cpDialogDisplay] // Dialog positioning mode: 'popup', 'inline' ('popup').
// popup: dialog is shown as popup (fixed positioning).
// inline: dialog is shown permanently (static positioning).
[cpIgnoredElements] // Array of HTML elements that will be ignored when clicked ([]).
[cpSaveClickOutside] // Save currently selected color when user clicks outside (true).
[cpOKButton] // Show an OK / Apply button which saves the color (false).
[cpOKButtonText] // Button label text shown inside the OK / Apply button ('OK').
[cpOKButtonClass] // Additional class for customizing the OK / Apply button ('').
[cpCancelButton] // Show a Cancel / Reset button which resets the color (false).
[cpCancelButtonText] // Button label text shown inside the Cancel / Reset button ('Cancel').
[cpCancelButtonClass] // Additional class for customizing the Cancel / Reset button ('').
[cpAddColorButton] // Show an Add Color button which add the color into preset (false).
[cpAddColorButtonText] // Button label text shown inside the Add Color button ('Add color').
[cpAddColorButtonClass] // Additional class for customizing the Add Color button ('').
[cpRemoveColorButtonClass] // Additional class for customizing the Remove Color button ('').
[cpMaxPresetColorsLength] // Use this option to set the max colors allowed in presets (null).
[cpPresetEmptyMessage] // Message for empty colors if any provided used ('No colors added').
[cpPresetEmptyMessageClass] // Additional class for customizing the empty colors message ('').
[cpUseRootViewContainer] // Create dialog component in the root view container (false).
// Note: The root component needs to have public viewContainerRef.
(colorPickerOpen) // Current color value, send when dialog is opened (value: string).
(colorPickerClose) // Current color value, send when dialog is closed (value: string).
(colorPickerChange) // Changed color value, send when color is changed (value: string).
(colorPickerCancel) // Color select canceled, send when Cancel button is pressed (void).
(colorPickerSelect) // Selected color value, send when OK button is pressed (value: string).
(cpToggleChange) // Status of the dialog, send when dialog is opened / closed (open: boolean).
(cpInputChange) // Input name and its value, send when user changes color through inputs
// ({input: string, value: number | string, color: string})
(cpSliderChange) // Slider name and its value, send when user changes color through slider
(cpSliderDragEnd) // Slider name and current color, send when slider dragging ends (mouseup,touchend)
(cpSliderDragStart) // Slider name and current color, send when slider dragging starts (mousedown,touchstart)
// ({slider: string, value: number | string, color: string})
(cpPresetColorsChange) // Preset colors, send when 'Add Color' button is pressed (value: array).openDialog() // Opens the color picker dialog if not already open.
closeDialog() // Closes the color picker dialog if not already closed.