# complimentary-color

> Get the complementary color to any given color.

Latest version **1.0.0** (published 2024-03-11) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install complimentary-color
pnpm add complimentary-color
yarn add complimentary-color
bun add complimentary-color
```

## 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 | 1.0.0 |
| Published | 2024-03-11 |
| First published | 2024-03-11 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 18.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ansh Singh Sonkhia |
| Maintainers | anshsinghsonkhia |
| Keywords | complimentary, complimentary-color, color, color-convert, convert-color, color-conversion |

## Links

- npm: https://www.npmjs.com/package/complimentary-color
- Repository: https://github.com/AnshSinghSonkhia/complimentary-color
- Homepage: https://github.com/AnshSinghSonkhia/complimentary-color#readme
- Issues: https://github.com/AnshSinghSonkhia/complimentary-color/issues
- npm.io page: https://npm.io/package/complimentary-color

## Dependencies (1)

- [random-math](https://npm.io/package/random-math.md) ^1.0.5

## 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

- 1.0.0 (latest) — 2024-03-11

## README

# complimentary-color
Get the complementary color to any given color.

<code><img height="30" src="https://img.shields.io/badge/NPM-111111?style=for-the-badge&logo=npm&logoColor=#c63635"></code>
<code><img height="30" src="https://img.shields.io/badge/JavaScript-111111?style=for-the-badge&logo=javascript&logoColor=F7DF1E"></code>


# Installation

```shell
npm i complimentary-color
```

> for modern JavaScript projects using ESM:

```js
import compliColor from 'complimentary-color';
```

> Using traditional method for Node.js projects that follow the CommonJS module system:

```js
const compliColor = require('complimentary-color');
```

# Usage

- Get Complimentary Color in RGB

```js
console.log(compliColor.process("rgb(113,256,228)"));
// returns - rgb(256,113,141)
```

- Get Complimentary Color in HSL

```js
console.log(compliColor.process("hsl(120,50%,50%)"));
// returns - hsl(300,50.00%,50.00%)
```

- Get Complimentary Color in HEX

```js
console.log(compliColor.process("#ff00ff"));
// returns - #00ff0
```

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