splashy - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #golang #android #machine-learning #linux #docker #windows #cli #vue #pytorch #mcp

splashy

(★ 121)

Extract predominant and palette colors from an image URL or file buffer.

File Explorer

Download Latest Version (.zip)

- - cron.yml
  - main.yml
  - pull_request.yml
- dependabot.yml
- - image-1.jpg
  - image-2.jpg
  - image-3.png
  - image-4.png
- - colorthief-1.png
  - colorthief-2.png
  - colorthief-3.png
  - colorthief-4.png
  - node-vibrant-1.png
  - node-vibrant-2.png
  - node-vibrant-3.png
  - node-vibrant-4.png
  - splashy-1.png
  - splashy-2.png
  - splashy-3.png
  - splashy-4.png
- index.mjs
- package.json
- README.md
- yarn.lock
- logo.sketch
- index.js
- - w3c_home.avif
  - w3c_home.bmp
  - w3c_home.cur
  - w3c_home.dds
  - w3c_home.eps
  - w3c_home.gif
  - w3c_home.heic
  - w3c_home.heif
  - w3c_home.ico
  - w3c_home.jfif
  - w3c_home.jpg
  - w3c_home.mng
  - w3c_home.odd
  - w3c_home.pbm
  - w3c_home.pgm
  - w3c_home.png
  - w3c_home.pnm
  - w3c_home.ppm
  - w3c_home.ps
  - w3c_home.psd
  - w3c_home.qoi
  - w3c_home.raw
  - w3c_home.svg
  - w3c_home.tga
  - w3c_home.tiff
  - w3c_home.webp
  - w3c_home.xbm
  - w3c_home.xpm
- accuracy.js
- index.js
- supported-formats.json
- supported-formats.mjs
- util.js
- - logo.png
  - logo.svg
- components.json
- eslint.config.mjs
- next-env.d.ts
- next.config.ts
- package.json
- postcss.config.mjs
- tailwind.config.ts
- tsconfig.json
.editorconfig
.gitattributes
.gitignore
.npmignore
CHANGELOG.md
LICENSE
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/microlinkhq/splashy

Downloads the entire project code from GitHub to your computer.

cd splashy

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

$ npm install splashy --save

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  <img src="https://github.com/microlinkhq/cdn/raw/master/dist/logo/banner.png#gh-light-mode-only" alt="microlink logo">
  <img src="https://github.com/microlinkhq/cdn/raw/master/dist/logo/banner-dark.png#gh-dark-mode-only" alt="microlink logo">
  <br>
  <br>
</div>

![Last version](https://img.shields.io/github/tag/microlinkhq/splashy.svg?style=flat-square)
[![Coverage Status](https://img.shields.io/coveralls/microlinkhq/splashy.svg?style=flat-square)](https://coveralls.io/github/microlinkhq/splashy)
[![NPM Status](https://img.shields.io/npm/dm/splashy.svg?style=flat-square)](https://www.npmjs.org/package/splashy)

> Given an image, extract predominant & palette colors. [20+ image formats well tested](https://github.com/microlinkhq/splashy/tree/master/test/fixtures).

## Install

```bash
$ npm install splashy --save
```

## Usage

### From URL

```js
;(async () => {
  const splashy = require('splashy')
  const got = require('got')

const url = 'https://kikobeats.com/images/avatar.jpg'
  const { body } = await got(url, { responseType: 'buffer' })
  const palette = await splashy(body)

console.log(palette)
  // => [ '#941c1c', '#841c16', '#aa695e', '#ca866c', '#6c5444', '#cca4a4' ]
})()
```

### From Buffer

```js
;(async () => {
  const splashy = require('splashy')
  const path = require('path')
  const fs = require('fs')

const filepath = path.resolve(__dirname, 'avatar.jpg')
  const buffer = await fs.readFile(filepath)
  const palette = await splashy(buffer)

console.log(palette)
  // => [ '#941c1c', '#841c16', '#aa695e', '#ca866c', '#6c5444', '#cca4a4' ]
})()
```

## API

### splashy(input)

#### input

_Required_<br>
Type: [ImageSource](https://github.com/akfish/node-vibrant#imagesource)

The raw content for detecting the color information.

## Related

- [color-microservice](https://github.com/Kikobeats/color-microservice) – Get color information from any URL image microservice.
- [colorable-dominant](https://github.com/Kikobeats/colorable-dominant) – Create ARIA-compliant color themes based on a predominant color palette.

## License

**microlink-function** © [Microlink](https://microlink.io), released under the [MIT](https://github.com/microlink/microlink-function/blob/master/LICENSE.md) License.<br>

Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/microlink/microlink-function/contributors).

Special thanks to [Tim Carry](https://github.com/pixelastic) for writing the benchmark and [Lokesh Dhakar](https://github.com/lokesh) for the original code implementation.

> [microlink.io](https://microlink.io) · GitHub [microlinkhq](https://github.com/microlinkhq) · X [@microlinkhq](https://x.com/microlinkhq)