# @saeris/isomorphic-vibrant

> A library for extracting prominent colors from an image anywhere you can run JavaScript!

Latest version **0.1.1** (published 2020-09-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @saeris/isomorphic-vibrant
pnpm add @saeris/isomorphic-vibrant
yarn add @saeris/isomorphic-vibrant
bun add @saeris/isomorphic-vibrant
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2020-09-13 |
| First published | 2020-09-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 243.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | saeris |
| Keywords | isomorphic, color detection |

## Links

- npm: https://www.npmjs.com/package/@saeris/isomorphic-vibrant
- Repository: https://github.com/saeris/isomorphic-vibrant
- npm.io page: https://npm.io/package/@saeris/isomorphic-vibrant

## Dependencies (2)

- [cross-fetch](https://npm.io/package/cross-fetch.md) ^3.0.6
- [@silvia-odwyer/photon-node](https://npm.io/package/@silvia-odwyer/photon-node.md) ^0.2.0

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

- 0.1.1 (latest) — 2020-09-13
- 0.1.0 — 2020-09-13

## README

<h1 align="center" style="display: block; text-align: center;">🎨 Isomorphic Vibrant</h1>
<p align="center"><a href="https://www.npmjs.org/package/@saeris/isomorphic-vibrant"><img src="https://badgen.net/npm/v/@saeris/isomorphic-vibrant" alt="npm version"></a><a href="https://bundlephobia.com/result?p=@saeris/isomorphic-vibrant"><img src="https://badgen.net/bundlephobia/minzip/@saeris/isomorphic-vibrant" alt="bundlephobia minified + gzip"><img src="https://badgen.net/bundlephobia/dependency-count/@saeris/isomorphic-vibrant" alt="bundlephobia dependency count"><img src="https://badgen.net/bundlephobia/tree-shaking/@saeris/isomorphic-vibrant" alt="bundlephobia tree-shaking support"></a><a href="https://travis-ci.com/saeris/isomorphic-vibrant"><img src="https://badgen.net/travis/saeris/isomorphic-vibrant" alt="travis status"></a><a href="https://codecov.io/gh/Saeris/isomorphic-vibrant"><img src="https://badgen.net/codecov/c/github/saeris/isomorphic-vibrant/master" alt="codecov coverage"/></a></p>
<p align="center">A library for extracting prominent colors from an image anywhere you can run JavaScript!</p>

---

## 🚧 Under Construction

> Warning: This library is still under construction! A pre-release version is available for testing only. Expect things to be broken. The below documentation is both incomplete and subject to change.

## 📦 Installation

```bash
npm install --save @saeris/isomorphic-vibrant
# or
yarn add @saeris/isomorphic-vibrant
```

## 🔧 Usage

```typescript
import { Vibrant } from "@saeris/isomorphic-vibrant"

const vibrant = new Vibrant(`url/to/image.png`, { colorCount: 64 })
console.log(await vibrant.getPalette())
```

## 📣 Acknowledgements

This library was forked from [node-vibrant](https://github.com/Vibrant-Colors/node-vibrant).

## 🥂 License

Released under the [MIT license](https://github.com/Saeris/isomorphic-vibrant/blob/master/LICENSE.md).

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