Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngx-eco/angular-colorful
A tiny color picker component for modern Angular apps
https://github.com/ngx-eco/angular-colorful
angular color-picker typescript
Last synced: 24 days ago
JSON representation
A tiny color picker component for modern Angular apps
- Host: GitHub
- URL: https://github.com/ngx-eco/angular-colorful
- Owner: ngx-eco
- License: mit
- Created: 2020-09-27T18:34:14.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-06T14:21:32.000Z (6 months ago)
- Last Synced: 2024-11-11T21:54:15.218Z (about 1 month ago)
- Topics: angular, color-picker, typescript
- Language: TypeScript
- Homepage: https://angular-colorful.ru
- Size: 3.33 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-angular - angular-colorful - A tiny color picker component for modern Angular apps. (Table of contents / Third Party Components)
- fucking-awesome-angular - angular-colorful - A tiny color picker component for modern Angular apps. (Table of contents / Third Party Components)
- fucking-awesome-angular - angular-colorful - A tiny color picker component for modern Angular apps. (Table of contents / Third Party Components)
README
Angular-colorful is a tiny color picker component for modern Angular apps.
## Table of Contents
- [Features](#Features)
- [Demo](#Demo)
- [Quickstart](#Quickstart)
- [Usage](#Usage)
- [Supported color models](#Supported-color-models)
- [TypeScript support](#TypeScript-support)
- [Ports](#Ports)
- [Roadmap](#Roadmap)
- [Changelog](#Changelog)
- [Copyright](#Copyright)
- [MIT License](#MIT-License)
## Features
- **Small**: Just 2,6 KB (minified and gzipped). [Size Limit](https://github.com/ai/size-limit) controls the size.
- **Tree-shakeable**: Only the parts you use will be imported into your app's bundle.
- **Simple**: The interface is straight forward and easy to use.
- **Mobile-friendly**: Works well on mobile devices and touch screens.
- **No dependencies**
## Demo
- [Website](https://angular-colorful.ru/)
## Quickstart
**Install with [npm](https://www.npmjs.com):**
``` bash
npm install angular-colorful --save
```
**Install with [yarn](https://yarnpkg.com/):**
``` bash
yarn add angular-colorful
```
**Clone the repo:**
``` bash
git clone https://github.com/fil0157/angular-colorful.git
```
## Usage
### app.module.ts
```ts
import {NgModule} from '@angular/core';
import {BrowserModule} from '@angular/platform-browser';
import {AppComponent} from './app.component';
import {AngularColorfulModule} from 'angular-colorful';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
AngularColorfulModule,
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule {
}
```
### app.component.ts
```ts
import {Component} from '@angular/core';
import {RgbaColor} from 'angular-colorful';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.scss']
})
export class AppComponent {
color: RgbaColor = {r: 255, g: 255, b: 255};
colorChanged(color): void {
this.color = color;
}
}
```
### app.component.html
```html
```
## Supported color models
We provide 13 additional color picker components for different color models, unless your app needs a HEX string as an
input/output format.
How to use another color model
#### Available pickers
| Import | Value example |
|-----------------------------|------------------------------------|
| `{ HexColorPicker }` | `"#ffffff"` |
| `{ RgbColorPicker }` | `{ r: 255, g: 255, b: 255 }` |
| `{ RgbaColorPicker }` | `{ r: 255, g: 255, b: 255, a: 1 }` |
| `{ RgbStringColorPicker }` | `"rgb(255, 255, 255)"` |
| `{ RgbaStringColorPicker }` | `"rgba(255, 255, 255, 1)"` |
| `{ HslColorPicker }` | `{ h: 0, s: 0, l: 100 }` |
| `{ HslaColorPicker }` | `{ h: 0, s: 0, l: 100, a: 1 }` |
| `{ HslStringColorPicker }` | `"hsl(0, 0%, 100%)"` |
| `{ HslaStringColorPicker }` | `"hsla(0, 0%, 100%, 1)"` |
| `{ HsvColorPicker }` | `{ h: 0, s: 0, v: 100 }` |
| `{ HsvaColorPicker }` | `{ h: 0, s: 0, v: 100, a: 1 }` |
| `{ HsvStringColorPicker }` | `"hsv(0, 0%, 100%)"` |
| `{ HsvaStringColorPicker }` | `"hsva(0, 0%, 100%, 1)"` |
## TypeScript support
**angular-colorful** supports TypeScript and ships with types in the library itself; no need for any other install.
How you can get the most from our TypeScript support
While not only typing its own functions and variables, it can also help you type yours. Depending on the component you
are using, you can also import the type that is associated with the component. For example, if you are using our HSL
color picker component, you can also import the `HSL` type.
```ts
import {HslColorPicker, HslColor} from "angular-colorful";
const myHslValue: HslColor = {h: 0, s: 0, l: 0};
```
Take a look at [Supported Color Models](#supported-color-models) for more information about the types and color formats
you may want to use.
## Ports
Not using Angular? No problem! Angular-colorful ported from react-colorful. All the ported projects can be
viewed [here](https://github.com/omgovich/react-colorful#ports).
## Roadmap
- [x] Additional modules to support RGB, HSL and HSV color models
- [x] TypeScript support
- [x] Rewrite the codebase to TypeScript
- [x] Alpha channel support (RGBA, HSLA and HSVA color models)
- [ ] HEX input component
- [ ] Accessibility
## Changelog
For changelogs, check
out [the Releases section of angular-colorful](https://github.com/fil0157/angular-colorful/releases)
or the [CHANGELOG.md](CHANGELOG.md).
## Copyright
Code Copyright 2020 angular-colorful.
## MIT License
Copyright (c) 2020 angular-colorful
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.