angular-radial-color-picker
Advanced tools
Readme
Great UX starts with two basic principles - ease of use and simplicity. Selecting a color should be as easy as moving a slider, clicking a checkbox or pressing a key just like other basic form elements behave.
This is a flexible and elegant material design color picker. Developed with mobile devices and keyboard usage in mind. Key features:
Color Picker on npm
npm install -S angular-radial-color-picker
And in your app:
import angular from 'angular';
import colorPicker from 'angular-radial-color-picker';
import 'angular-radial-color-picker/dist/css/color-picker.scss';
angular.module('app', [colorPicker]);
Depending on your build tool of choice you have to setup the appropriate Webpack loaders or Rollup plugins. The color picker was tested with the latest versions of sass-loader and rollup-plugin-postcss.
You can also use the minified sources directly:
<head>
<link href="https://unpkg.com/angular-radial-color-picker@latest/dist/css/color-picker.min.css" rel="stylesheet">
</head>
<body ng-app="app">
<color-picker></color-picker>
<script src="https://unpkg.com/angular@1.6.6/angular.min.js"></script>
<script src="https://unpkg.com/angular-radial-color-picker@latest/dist/color-picker.umd.min.js"></script>
<script>
angular.module('app', ['color.picker.core']);
</script>
</body>
<color-picker> component has several attributes, all of which are optional. See the example which uses all options.
| Options | Type | Default/Description |
|---|---|---|
color | Object | Object for initializing/changing the color of the picker. Defaults to red: {hue: 0, saturation: 100, luminosity: 50, alpha: 1}. |
on-select | Function | Callback which is triggered when a color is selected. |
on-color-change | Function | A function to invoke when color is changed (i.e. on rotation). |
mouse-scroll | Boolean | Use wheel (scroll) event to rotate. Defaults to false. |
scroll-sensitivity | Number | Amount of degrees to rotate the picker with keyboard and/or wheel. Defaults to 2 degrees. |
For maximum flexibility the component utilizes the pub/sub pattern. For easier communication a set of events are provided that can even programmatically open or close the picker without interacting with the UI. All events carry the current (selected) color in the event data payload.
| Name | Description |
|---|---|
color-picker.show | Fires when the color picker is about to show and before any animation is started. |
color-picker.shown | Fires when the color picker is shown and has finished animating. |
color-picker.selected | Fires when a color is selected via the middle selector. Event is fired right before hide. |
color-picker.hide | Fires when the color picker is about to hide and before any animation is started. |
color-picker.hidden | Fires when the color picker is hidden and has finished animating. |
color-picker.open | Programatically opens the color picker if it's not already opened. |
color-picker.close | Programatically closes the color picker if it's not already closed. |
Example:
// Assign the selected color to the ViewModel and log it to the console
$scope.$on('color-picker.selected', function(ev, color) {
vm.selectedColor = 'hsla(' + color.hue + ', ' + color.saturation + '%, ' + color.luminosity + '%, ' + color.alpha + ')';
console.log('Selected color:', color);
});
// The good'n'tested "poke-it-with-a-stick" method:
$scope.$emit('color-picker.open');
The color picker has a default width/height of 280px, but can also be sized via CSS. For example:
color-picker {
width: 350px;
height: 350px;
}
If you want a percentage based size you can use this neat little trick with 1:1 aspect ratio box of 40% width of the parent element:
color-picker {
height: 0;
width: 40%;
padding-bottom: 40%;
}
hsla(). How can I use other formats like rgba() or HEX?There's a service you can use - ColorPickerService. It has rgbToHsl() which can be used to map a color to the hsla() type that the color picker expects. There's also hslToHex(), hslToRgb() and rgbToHex() which can be used to convert the output of the color picker to other formats.
We suggest to add a custom slider for saturation and luminosity or use <input type="range">.
color-picker component uses $onChanges to detect changes of the color binding. When using <color-picker color="$ctrl.color"></color-picker> if you change a property of $ctrl.color object $onChanges is not triggered, because angular uses a shallow comparison. To properly update the color you'll have to create a new object with the new values. For example:
$ctrl.color.hue = 42; // won't work
// use the angular helper
$ctrl.color = angular.extend({}, $ctrl.color, { hue: 42 });
// or create the object manually
$ctrl.color = {
hue: 42,
luminosity: $ctrl.color.luminosity,
saturation: $ctrl.color.saturation,
alpha: $ctrl.color.alpha
};
// or use Stage-3 Object Spread properties
$ctrl.color = { ...$ctrl.color, hue: 42 };
// or use Object.assign
$ctrl.color = Object.assign({}, $ctrl.color, { hue: 42 });
[Violation] Added non-passive event listener to a scroll-blocking 'touchmove' event. warning in the console?touchmove is used with preventDefault() to block scrolling on mobile while rotating the color knob. Even the Web Incubator Community Group acknowledges that in some cases a passive event listener can't be used.
It's another non-passive event that could potentially introduce jank on scroll. To rotate the color knob, but stay on the same scrolling position the wheel event is blocked with preventDefault(). Thus, if you really want this feature for your users you'll have to explicitly add the mouse-scroll="true" attribute.
If you're interested in the project you can help out with feature requests, bugfixes, documentation improvements or any other helpful contributions. You can use the issue list of this repo for bug reports and feature requests and as well as for questions and support.
We are also particularly interested in projects you did with this plugin. If you have created something colorful and creative with the color picker and want to show it off send us a quick mail.
The project is using an adapted version of Angular's commit convention and commit messages should adhere to it.
FAQs
Angular-ready radial color picker with some sleek animations.
The npm package angular-radial-color-picker receives a total of 58 weekly downloads. As such, angular-radial-color-picker popularity was classified as not popular.
We found that angular-radial-color-picker demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.