superscript

A library of miscellaneous JavaScript utilities

Contents:

1. Installation
2. Documentation
3. Coming soon
4. Contributing
5. Credits

1. Installation

On the browser

Any of these should work:

• Download the browserified version from GitHub and load it:
  <script src="superscript.js"></script>
• Load it via jsDelivr:
  <script src="https://cdn.jsdelivr.net/npm/supers/superscript.js"></script>
• Load it via Unpkg:
  <script src="https://unpkg.com/supers/superscript.js"></script>

On Node.js

$ npm i supers

const superscript = require('supers');

2. Documentation

Functions

• hold()
• debounce()
• Palette()

hold()

Invoke callback cb once with optional parameters args as soon as condition check is true, checking every interval ms (by default, 60 Hz ≈ 16.67 ms).

Kind: global function
Example

superscript.hold(check, cb, interval, ...args)

debounce()

https://davidwalsh.name/javascript-debounce-function

Kind: global function

Palette()

Create a palette of n evenly-distributed colours (n ≥ 2).

☞ Demo

Invoke get(i) on the resulting object to retrieve the ith colour in the palette (0 ≥ i < n): get(i, rbg = false)

Default options:

{
  "shuffle": false,
  "shades": "auto",
  "greys": "auto",
  "blackAndWhite": false
}

Then, invoke get(i) on the resulting object to retrieve the ith colour in the palette (0 ≥ i < n):

new superscript.palette(10).get(5);        // 65535
new superscript.palette(10).get(0, true);  // 'ff0000'

// Assume there's a pie chart with 4 slices. Let's assign colours to them:
const palette = new superscript.palette(4);
chart[0].css('color', '#' + palette.get(0, true));
chart[1].css('color', '#' + palette.get(1, true));
chart[2].css('color', '#' + palette.get(2, true));
chart[3].css('color', '#' + palette.get(3, true));

Kind: global function
Example

new superscript.Palette(n[, opts])

3. Coming soon

• cache()
• throttle()
• debounce() (based on David Walsh' code)

4. Contributing

npm clone https://github.com/tripu/superscript.git
cd superscript
npm i && npm run build

5. Credits

Copyright © 2017–2018 tripu ([email protected], https://tripu.info).

This project is licenced under the terms of the MIT licence.