visual-debug v0.1.1

visual-debug

Quickly draw shapes on the viewport to visualise front-end problems.

Installation

npm i visual-debug

Usage

import * as visualDebug from 'visual-debug'

To draw a rectangle:

visualDebug.drawRect({
  x, // in pixels
  y, // in pixels
  width, // in pixels
  height, // in pixels
  color, // [Optional] Example: 'rgba(255, 255, 0, 1)'
  // If no color is provided, a random one is chosen
})

To draw a horizontal guide:

visualDebug.drawGuideHorizontal({
  y, // in pixels
  color, // [Optional] Example: 'rgba(255, 255, 0, 1)'
  // If no color is provided, a random one is chosen
})

To draw a vertical guide:

visualDebug.drawGuideVertical({
  x, // in pixels
  color, // [Optional] Example: 'rgba(255, 255, 0, 1)'
  // If no color is provided, a random one is chosen
})

To highlight a DOM element:

visualDebug.highlightElement({
  selector, // standard CSS selector as a string
  color, // [Optional] Example: 'rgba(255, 255, 0, 1)'
  // If no color is provided, a random one is chosen
})

To clear everything:

visualDebug.clear()