Usage

Load structured palette data from various tools into Open Color format.

import {paletteReader, paletteWriter, oco2Object, oco2Vars} from 'palette2oco'

paletteReader(pathRoot).load(pathArray)
  .then(palette => palette.render(ocoPath))
  .then(oco => paletteWriter(destinationFile, oco))
  .catch(err => {
    console.error(err)
  })

Convert palette data from a variety of sources into Open Color .oco format.

Allows structured directories of pallette data to be converted into nested oco palette data.

Formats supported:
  • Sip (http://sipapp.io): Supports .sippalette and .json exports.

  • Abobe Swatch Exchange (ASE): Full support of RGB, CMYK and Lab colorspaces.

  • Vanilla JSON: File signature must match the following...

{
  "name" : "Palette name",
  "colors" : [
    {
      name: "Color name",
      red: (0.0 - 1.0 | 0 - 255)
      green: (0.0 - 1.0 | 0 - 255)
      blue: (0.0 - 1.0 | 0 - 255)
      alpha: (0.0 - 1.0 | 0 - 255)
    }
    ...
  ]
}

API

paletteReader → Reader

src/index.js

Read source data from an array of paths and return a Reader instance.

paletteReader(pathArray: Array<string>) → Reader
Parameters
pathArray (Array<string>) An Array of paths to load.
Returns
Reader: The Reader instance.

paletteWriter Promise

src/index.js

Write an Open Color format palette to the destination.

paletteWriter(destination: string, palette: OpenColor) → Promise
Parameters
destination (string) The destination path.
palette (OpenColor) The Open Color palette data.
Returns
Promise: A promise that resoves when file is saved.