spotlight-canvas

1.2.0 • Public • Published

spotlight-canvas

a simple canvas-based spotlight that can be used to highlight elements

Features:

  • a canvas that darkens the screen
  • spotlight areas based on circles or polygons
  • spotlight areas can be dynamically changed or cleared
  • the canvas includes fadeIn and fadeOut functions

Live Example

davidfig.github.io/spotlight/

Rationale

I needed a way to highlight elements in my UI.

Simple Example

var Spotlight = require('spotlight-canvas');
 
// create the scrollbox
var spotlight = new Spotlight();
 
// create a circle spotlight
spotlight.circle(100, 100, 200);
 

Installation

npm i spotlight-canvas

API Documentation

https://davidfig.github.io/spotlight/jsdoc/

license

MIT License
(c) 2018 YOPEY YOPEY LLC by David Figatner

Dependencies (1)

Dev Dependencies (5)

Package Sidebar

Install

npm i spotlight-canvas

Weekly Downloads

1

Version

1.2.0

License

MIT

Unpacked Size

60.7 kB

Total Files

8

Last publish

Collaborators

  • davidfig