Namespace Pollution Mechanism

    @mapbox/to-color

    2.0.0 • Public • Published

    @mapbox/to-color

    Procedurally generate a deterministic, perceptually distributed color palette.

    Build Status

    install

    npm install @mapbox/to-color

    Usage

    import toColor from '@mapbox/to-color'
    
    const color = new toColor('tmcw');
    
    // Or a number
    // const color = new toColor(1234);
    // Or with options
    // const color = new toColor('tmcw', { brightness: 0.25, saturation: 1.1 });
    
    const { hsl } = color.getColor();
    
    /*
    Returns
    
    {
      raw: [314, 97.95, 50.98],
      formatted: 'hsl(314, 97.95%, 50.98%)'
    }
    */
    
    const { hsl } = color.getColor();
    
    /*
    Returns
    
    {
      raw: [2, 78.26, 54],
      formatted: 'hsl(2, 78.26%, 54%)'
    }
    */

    Options

    Option Value Default Description
    brightness Number undefined Adjusts brightness percentage from the derived min/max range.
    saturation Number undefined Adjusts saturation percentage from the derived min/max range.

    Developing

    # Demo site
    npm install & npm start
    
    # Run tests
    npm run test

    Credit v2 is adapted from randomColor.

    Install

    npm i @mapbox/to-color

    DownloadsWeekly Downloads

    57

    Version

    2.0.0

    License

    ISC

    Unpacked Size

    55.5 kB

    Total Files

    14

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar