@freelanco/roller NPM

Roller - a gorgeous intro package

The package exports seven classes: Roller, Guide, Overlay, Popover, Focus, Hover and Tip.

Types

HighlightGroup - it is object that contains Overlay(optional), Focus and Popover(optional) instances and beforeInsert, afterRemove functions.
Position - 'top' | 'bottom' | 'left' | 'right' | 'auto' - position of created helper element according to element on the page.

API

Roller

If you want highlight single element on your page, use Roller:

const roller = new Roller({
  onOverLayClick(group) {
    // some code that may change state of group element or
    // make another job.
  }
})
roller.highlight({
  async beforeInsert(wait) {}, // executes before roller starts highlight element.
  new Overlay(/* options */),
  new Focus(/* options */),
  new Popover(/* options */),
  async afterRemove(wait) {}, // executes after roller ends highlight and removes above elements from DOM.
})

Constructor parameters:

options?: Object
- onOverlayClick?: (group: HighlightGroup, event: MouseEvent): void - this function defines what is need to be done on click on Overlay. By default it closes the whole group.

Methods:

highlight: (group: HighlightGroup) => Promise\<void> - highlights group.
unHighlight: (group: HighlightGroup) => Promise\<void> - hide group and remove its nodes from page.

Guide

For creating sequence of highlighting of elements you can use Guide.

const guide = new Guide({
  groups: [/* ... */], // This is array of groups of Overlay(optional), Focus and Popover with hooks. Group is the same as accept Roller.,
  overlay: new Overlay(), // This is global overlay for guide object. It can be overridden by overlay in group
  onDone() {
    // Invokes after last group will be highlighted.
  },
  onSkip() {
    // Invokes when user skips guide.
  }
})

After you create Guide, you must call configure() method of it. It is needed for define styles and text for controls:

guide.configure({
  skipButtonText: 'Skip', // default
  // ...
  skipButtonStyles: {
    // ...
  }
})
.start() // Starts guide.

Constructor parameters:

options: Object
- groups: HighlightGroup[],
- overlay?: Overlay,
- onDone?: () => void,
- onSkip?: () => void

Methods:

configure: (options?: GuideControllerOptions) => Guide:
- skipButtonText?: string,
- prevButtonText?: string,
- nextButtonText?: string,
- doneButtonText?: string,
- footerStyle?: { [string]: string | number },
- skipButtonStyle?: { [string]: string | number },
- prevButtonStyle?: { [string]: string | number },
- nextButtonStyle?: { [string]: string | number },
- doneButtonStyle?: { [string]: string | number }

All styles keys and value must be valid CSS properties, written in kebab-case.

start: () => void - starts guide.
move: (step: number) => void - move to specific step. You basically will not use it.
cancel: () => void - hide highlighted group.

Hover

This class is created for adding help text on hovering specific element on the page.

const h = new Hover({
  position: 'top',
  offset: 10, // pixels
  hoverStyles: {
    // styles
  },
  onHover: // Function that invokes on element hovering,
  content: 'Some text'
})

Constructor parameters:

options: Object
- position?: Position
- offset?: number - distance from element on the page to Hover element.
- hoverStyles?: { [string]: string | number }
- onHover?: (event: MouseEvent) => Promise\<void>
- content: string

Methods:

attachTo: (element: HTMLElement | string) => void - attach Hover instance to element on the page.
detach: () => void - remove Hover instance from the page and detach it from element.

Tip

This class represents tip on the page. It isn't attached to element on the page, but is positioned according to window.

const tip = new Tip({
  // Set position of the tip
  position: 'bottom-right' | 'top-left' | 'bottom-left' | 'center' | 'top-right'(default),
  tipStyles: { ... },
  descriptionStyles: { ... },
  closeButtonStyles: { ... },
  okButtonStyles: { ... },
  text: 'Some text here',
  okButtonText: 'OK', // default
  closeButtonText: 'Close', // default
  onClose(event) {
    // Invokes on closing tip
  },
  onOk(event) {
    // Invokes on clicking OK
  }
})

Focus

It is the main class that represent element that need to be highlighted. It receives options that must contain element property that represents CSS selector of element or HTMLElement itself:

const focus = new Focus('.some-class', {
  async beforeHighlight(node, wait) {
    // some code
    // node - DOM element that is highlighted.
    // `wait` asynchronous function is used if code must wait for some time
  },
  element: '.some-element', // Element that will be highlighted
  async afterHighlight(node, wait) {
    // some code
    // node - DOM element that is highlighted.
    // `wait` asynchronous function is used if code must wait for some time
  }
})
// or
const element = document.querySelector('.some-class')
if (element) {
  const focus = new Focus({ element })
}

Overlay

This class represents overlay on the page. You can set your own initial styles for it, end opacity and optional parameter isolateClickEvents:

const overlay = new Overlay({
  initialStyles: {
    'background-color': 'rgb(234, 54, 95)'
    // you must write valid CSS expressions in kebab-case
  },
  opacity: 0.75, // default
  isolateClickEvents: false // default. If `true` all events that is propagated inside of overlay will be isolated.
})

Popover

This class (if it is presented) represents explanation for highlighted element.

const popover = new Popover({
  position: 'auto', // default. Position of popover according to element.
  offset: '10px', // default. Distance of the popover from element.
  title: 'Some cool title', // Title of the explanation.
  description: 'Description' // Optional. Detailed description of the explanation.,
  styles: {
    // CSS valid styles in kebab-case.
  },
  isolateClickEvents: false // default. If `true` all events that is propagated inside of popover will be isolated.
})