# @the-/util-color

> Color utility for the-framework

Latest version **16.1.1** (published 2021-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @the-/util-color
pnpm add @the-/util-color
yarn add @the-/util-color
bun add @the-/util-color
```

## Health

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

Positive: no vulnerabilities; high maintenance score.

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

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 16.1.1 |
| Published | 2021-04-05 |
| First published | 2019-04-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 45.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | the, util |

## Links

- npm: https://www.npmjs.com/package/@the-/util-color
- Repository: https://github.com/the-labo/the
- Homepage: https://github.com/the-labo/the/tree/master/packages/util-color#readme
- Issues: https://github.com/the-labo/the#issues
- npm.io page: https://npm.io/package/@the-/util-color

## Dependencies (1)

- [acolor](https://npm.io/package/acolor.md) ^3.1.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 16.1.1 (latest) — 2021-04-05
- 16.1.0 — 2020-07-06
- 16.0.0 — 2020-07-06
- 15.5.2 — 2020-05-08
- 15.5.1 — 2020-04-22
- 15.4.12 — 2019-11-02
- 15.4.10 — 2019-09-11
- 15.4.0 — 2019-04-30
- 15.2.0 — 2019-04-01

## README

@the-/util-color
==========

<!---
This file is generated by @the-/templates. Do not update manually.
--->

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

[![npm Version][bd_npm_shield_url]][bd_npm_url]

[bd_repo_url]: https://github.com/the-labo/the
[bd_npm_url]: http://www.npmjs.org/package/@the-/util-color
[bd_npm_shield_url]: http://img.shields.io/npm/v/@the-/util-color.svg?style=flat

<!-- Badge End -->


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

Color utility for the-framework

<!-- Description End -->


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




<!-- Overview End -->


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

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

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

Installation
-----

```bash
$ npm install @the-/util-color --save
```


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

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

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

Usage
---------

```javascript
'use strict'

const { colorWithAlpha } = require('@the-/util-color')

async function tryExample() {
  console.log(colorWithAlpha('#AAA', 0.5)) // -> rgba(170, 170, 170, 0.5)
}

tryExample().catch((err) => console.error(err))

```


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


<!-- Sections Start -->

<a name="api"></a>

## API Guide


- global
  - [colorAsDarkened(color,options)](./doc/api/api.md#colorAsDarkened)
- module:@the-/util-color
  - [.colorWithAlpha(color,alpha)](./doc/api/api.md#module_@the-/util-color.colorWithAlpha)
  - [.colorWithText(text,options)](./doc/api/api.md#module_@the-/util-color.colorWithText)
  - [.rotatedColorsFor(base,options)](./doc/api/api.md#module_@the-/util-color.rotatedColorsFor)
  - [.textColorFor(backgroundColor,options)](./doc/api/api.md#module_@the-/util-color.textColorFor)

See [API Guide](./doc/api/api.md) for more detail


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

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

<!-- LICENSE End -->


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

Links
------

+ [THE Labo][the_labo_url]

[the_labo_url]: https://github.com/the-labo

<!-- Links End -->

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