Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@saeris/isomorphic-vibrant

saeris8MIT0.1.1TypeScript support: included

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

isomorphic, color detection

readme

🎨 Isomorphic Vibrant

npm versionbundlephobia minified + gzipbundlephobia dependency countbundlephobia tree-shaking supporttravis statuscodecov coverage

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


🚧 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

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

🔧 Usage

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.

🥂 License

Released under the MIT license.