joshwnj/react-visibility-sensor

Improve examples

Open

#55 opened on Dec 15, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (2,300 stars) (198 forks)batch import
enhancementhelp wanted

Description

Now that we've got quite a few different options it would be great to make examples that cover all the bases.

Maybe a bunch of jsbin / codepen examples showing different combinations of options.

Maybe even an interactive demo where you can adjust / switch props and see how it changes behaviour.

Contributor guide

Tech stack
javascriptreacthtmlcss
Domain
frontenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
React basicsJavaScriptHTML/CSSCodePen/JSBin usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Review existing examples in the repository and check the issue comments for any prior discussions or suggestions. Create several CodePen/JSBin demos covering different combinations of options (e.g., partialVisibility, offset, scrollCheck). Consider building an interactive demo using React that lets users toggle props and see the effect in real time. The component's usage can be found in the README and source code at /src/index.js.