react-see-through icon indicating copy to clipboard operation
react-see-through copied to clipboard

Draw attention to the important parts of your website

react-see-through

Table of Contents

  • Draw attention to the important parts of your website
    • Example
    • How is this different from a Modal?
  • Installation
  • Importing
  • Use Cases
  • Documentation/Examples
  • Future Plans

Draw attention to the important parts of your website

Example

Example * react-see-through is used here to create the black mask above everything except the tutorial (source)

How is this different from a Modal?

The black mask appears around existing elements on the page.

Installation

npm install --save react-see-through

or

yarn add react-see-through

Importing

To use the react-see-through component, you want to do:

import { SeeThrough } from 'react-see-through';

after installing.

Use Cases

  • Slack, Discord, and many other popular services use this type of effect for tutorials
    • This lets them direct users' attention to particular elements being introduced.

Resources

Documentation/Examples

GitHub

Future Plans

  • Allow interacting (click, hover, etc...) with the unmasked area
    • Make only certain areas interactable? - <Interactable> wrapper
  • Typescript definitions
  • Fade-out animation
  • Option to add padding
  • Better documentation styling