GoogleChromeLabs/quicklink

Consider adding `rootMargin` to the Intersection Observer

Open

#14 opened on Dec 10, 2018

View on GitHubContributor guide
 (13 comments) (1 reaction) (0 assignees)JavaScript (426 forks)batch import
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (11,265 stars)
PR merge metrics
 (Avg merge 47d 12h) (4 merged PRs in 30d)

Description

Feedback from @surma:

I feel like by default you should add a rootMargin to the IO to trigger the load before something comes into the viewport.

So, rootMargin defaults to "0px 0px 0px 0px", meaning the intersection will be computed between the root element's unmodified bounds rectangle and the target's bounds. This change would be made to https://github.com/GoogleChromeLabs/quicklink/blob/master/src/index.mjs#L21

Contributor guide

Research direction
Modify the IntersectionObserver constructor call in src/index.mjs to accept an optional rootMargin parameter, defaulting to '0px 0px 0px 0px', and update the function signature and documentation accordingly.
Tech stack
javascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptIntersection Observer API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70