sindresorhus / sparkly

Generate sparklines ▁▂▃▅▂▇

Generate sparklines ▁▂▃▅▂▇

JavaScript port of spark.sh.

Some cool use-cases.

Install

npm install sparkly

Usage

import sparkly from 'sparkly';

sparkly([0, 3, 5, 8, 4, 3, 4, 10]);
//=> '▁▃▄▇▄▃▄█'

// Specifying anything other than finite numbers will cause holes
sparkly([0, 3, 5, '', 4, 3, 4, 10]);
//=> '▁▃▄ ▄▃▄█'

// Specifying an object with minimum and maximum options will change the sparkline range
sparkly([1, 2, 3, 4, 5], {minimum: 0, maximum: 10});
//=> '▁▂▃▄▄'

// Specifying a style option will change the sparkline color
sparkly([1, 2, 3, 4, 5, 6, 7, 8], {style: 'fire'});
// ↓

API

sparkly(numbers, options?)

numbers

Type: number[]

The numbers to create the sparkline from.

options

Type: object

minimum

Type: number

Minimum range.

maximum

Type: number

Maximum range.

style

Type: string
Values: 'fire'

Style for the sparklines.

Related

• sparkly-cli - CLI for this module

sparkly's Issues

Tweaks

• Use latest AVA version
• Use XO
• Update readme to ES2015 (var -> const)

sparkly 25 45 looks weird

$ sparkly 25 45
▁█
$ 

WTF?

In fact, all sparklines consisting of two figures where the second number has approximately twice the values of the first looks weird.

`min`/`max` options

To be able to do streaming sparklines.

holman/spark#70

API:

sparkly([10, 3, 5], {min: 1, max: 10});

CLI:

sparkly --min=1 --max=10 10 3 5

Windows CMD doesn't display sparklines, but missing character symbols instead

issue with fire style

~ ❯❯❯ replem sparkly
Installed into REPL context:
 - [email protected] as sparkly
> sparkly([0, 0, 0], { style: 'fire' })
'NaN\u001b[0mNaN\u001b[0mNaN\u001b[0m'
> sparkly([0, 1, 0], { style: 'fire' })
'\u001b[38;5;230m▁\u001b[0m\u001b[38;5;196m█\u001b[0m\u001b[38;5;230m▁\u001b[0m'
> sparkly([0, 0, 0])
''

output with all zeroes is weird

RE: Sparky: is there a document (or anything) that describes how the parameters work?

What I don't understand are;

When does the bar go below the baseline? Can I control it?
How can I control the width of the bars?
How can I control the color of the bars?
What are the 'built-in,' formats like 'Fire?'

Chris

Colored sparks

See holman/spark#88.

Extract cli to new repository

And tweak the cli a bit, like adding meow, etc.