# acolor

> Color utility

Latest version **3.1.0** (published 2020-07-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install acolor
pnpm add acolor
yarn add acolor
bun add acolor
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.0 |
| Published | 2020-07-06 |
| First published | 2016-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 30.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | color |

## Links

- npm: https://www.npmjs.com/package/acolor
- Repository: https://github.com/a-labo/acolor
- Homepage: https://github.com/a-labo/acolor#readme
- Issues: https://github.com/a-labo/acolor/issues
- npm.io page: https://npm.io/package/acolor

## Dependencies (1)

- [color](https://npm.io/package/color.md) ^3.1.2

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 3.1.0 (latest) — 2020-07-06
- 3.0.1 — 2020-04-22
- 3.0.0 — 2018-12-21
- 2.0.1 — 2017-10-17
- 2.0.0 — 2017-09-08
- 1.2.0 — 2017-02-18
- 1.1.0 — 2016-08-31
- 1.0.0 — 2016-08-21

## README

acolor
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/a-labo/acolor
[bd_travis_url]: http://travis-ci.org/a-labo/acolor
[bd_travis_shield_url]: http://img.shields.io/travis/a-labo/acolor.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/a-labo/acolor
[bd_travis_com_shield_url]: https://api.travis-ci.com/a-labo/acolor.svg?token=
[bd_license_url]: https://github.com/a-labo/acolor/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/a-labo/acolor
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/a-labo/acolor.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/a-labo/acolor.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/a-labo/acolor
[bd_gemnasium_shield_url]: https://gemnasium.com/a-labo/acolor.svg
[bd_npm_url]: http://www.npmjs.org/package/acolor
[bd_npm_shield_url]: http://img.shields.io/npm/v/acolor.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Color utility

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install acolor --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const { rotate } = require('acolor')

console.log(rotate('#38E', 0.5))
```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Functions.md.hbs" Start -->

<a name="section-doc-guides-03-functions-md"></a>

Functions
---------

Available functions

| Signature | Description |
| ---- | ----------- |
| `alpha(color, Alpha) -> string` | Set alpha value |
| `darken(color, Amount) -> string` | Darken color |
| `isDark(color) -> boolean` | Detect dark or not |
| `isLight(color) -> boolean` | Detect light or not |
| `mix(color1, color2) -> string` | mix colors |
| `parse(-) -> Object` | Parse a color |
| `rotate(color, degree, options) -> string` | rotate color |


<!-- Section from "doc/guides/03.Functions.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/a-labo/acolor/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [a-labo][a_labo_url]

[a_labo_url]: https://github.com/a-labo

<!-- Links End -->

---
_Source: https://npm.io/package/acolor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._