@gullerya/spotlight

Summary

spotlight let's you to visually highlight a chosen element; this is done by shading over the surrounding content

Main aspects:

• TODO

Support matrix: ₆₁₊ | ₆₀₊ | ₁₆₊

Last versions (full changelog is here)

• 1.3.1

  • Fixed Issue #1 - misposition of the inner fence on window resize

• 1.2.1

  • minor API bug fix - when moving to the same target we still need to reture Promise (resolved one)

• 1.2.0

  • added customizable transition duration
  • added API moveTo (same as setting the target, but returns Promise, resolved when finished)
  • close API also returns Promise, resolved when all done

Base API

spotlight library consists of a single entry-level API, allowing to create a spotlight-scene with a given parameters, applied to the DOM.

Additionally, some constant enumerators provided for convenience.

This component may then be further interacted via component's own APIs as described below, to change its appearance, flavor or spot target, and to be removed at the end of usage.

Each spotlight-scene is self-contained and isolated, therefore it is possible to create as many 'spotlights' as needed, even if in the real use-cases one would rarely need more than a single instance.

import:

Import the library and it's constants as in example below:

import { spotlight, SHAPES } from './dist/spotlight.min.js';

syntax:

Imported spotlight is a function syntaxed as below:

const slsElement = function spotlight(target[, container[, options]]) { ... }

parameters:

• target
  • a target element to place the spot over
  • MAY NOT be a document.body
• container [optional]
  • a container to shadow contents around the target
  • when provided, container MUST be an ancestor of the target
  • default container is document.body
• options [optional]
  • shape - see shape property definition of the spotlight-scene` API below
  • transition-duration - see transition-duration property definition of the spotlight-scene below

spotlight-scene component APIs

The base API outlined above serves as an entry point for the interop with the library.

The result of that function is the spotlight-scene component instance. It is already applied to the DOM, unless explicitly opted out via the options above.

This component may by further interacted via it's own APIs. Common use-case for this is to move smoothly the spotlight from one element to another, given that all of them are children of the same parent.

Another obvious need is to remove the spotlight-scene from the DOM when not needed anymore.

In all of the further APIs I'll use sls term to represent the concrete spotlight-scene instance that the properties and methods belong to.

properties:

• sls.container [DOM element] [read only]
  • returns the container element that the component was initialized with (see base API above)
  • container MAY NOT be changed
• sls.target [DOM element] - 'spotted' element
  • setting this property will move the 'spotlight' to another target
  • acceptible values are subject to the same constraints as in the main API
    • MUST be an element
    • MUST be a descendend of the container
• sls.shape [enum] - shape of the spotlight, defaults to circle
  • setting this property on a 'living' component will be immediatelly applied
  • acceptible values:
    • circle
    • oval
    • box
  • values better to be taken from the SHAPES enum, like SHAPES.circle
• transition-duration [number] - duration in millis of spotlight's transitions (move from target to target, shape change, etc); defaults to 333
  • setting this property will be effective from the next transition forth

methods:

• sls.close()
  • returns Promise, resolved when all done
  • removes the spotlight-scene component and performs all relevant cleanups
• sls.moveTo(targetElement)
  • returns Promise, resolved when move it finished
  • targetElement subject to the same constraints target property above

Typical usage example

The flow below exemplifies typical usage of the library:

const t1 = <... the element to be spotted>;
const t2 = <... another one>;
const t3 = <... another one>;

const sl = spotlight(t1);   //  the spotlight is shown now

...

sl.target = t2;             //  spotlight moved to a new target
sl.style.color = '#110';    //  color of the shade is adjusted...
sl.shape = SHAPES.oval;     //  ... and spot's shape too

...

sl.transitionDuration = 500;    //  slow it down a bit
sl.moveTo(t3)
    .then(() => console.log('spotlight moved, do something...'));

sl.close();