Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Intersection Observer v2 delay and trackVisibility properties missing in Browser compatibility and are not described - plus no support in Firefox #19201

Closed
BearCooder opened this issue Aug 5, 2022 · 1 comment
Labels
area: Resize/Intersection Observer Content:WebAPI Web API docs document not written Missing document page effort: medium This task is a medium effort. help wanted If you know something about this topic, we would love your help!

Comments

@BearCooder
Copy link

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API

What specific section or headline is this issue about?

Intersection Observer API

What information was incorrect, unhelpful, or incomplete?

The information about the two additional properties is missing: delay and trackVisibility. Looking through the documentation its not mentioned anywhere and not mentioned in the Browser compatibility table. Chrome does support it but Firefox does not.

Intersection Observer v2 introduces the concept of tracking the actual "visibility" of a target element as a human being would define it. By setting an option in the IntersectionObserver constructor, intersecting IntersectionObserverEntry instances will then contain a new boolean field named isVisible. A true value for isVisible is a strong guarantee from the underlying implementation that the target element is completely unoccluded by other content and has no visual effects applied that would alter or distort its display on screen. In contrast, a false value means that the implementation cannot make that guarantee.

An important detail of the spec is that the implementation is permitted to report false negatives (that is, setting isVisible to false even when the target element is completely visible and unmodified). For performance or other reasons, browsers limit themselves to working with bounding boxes and rectilinear geometry; they don't try to achieve pixel-perfect results for modifications like border-radius.

That said, false positives are not permitted under any circumstances (that is, setting isVisible to true when the target element is not completely visible and unmodified).

The IntersectionObserver constructor now takes two additional configuration properties: delay and trackVisibility. The delay is a number indicating the minimum delay in milliseconds between notifications from the observer for a given target. The trackVisibility is a boolean indicating whether the observer will track changes in a target's visibility.

This information is from the following source

What did you expect to see?

I expect to see the properties mentioned and explained how they work with an example eventually. Like it always is on MDN. Plus to see it in the Browser compatibility table,

Do you have any supporting links, references, or citations?

Delay
TrackVisibility
isVisible

Do you have anything more you want to share?

No response

MDN metadata

Page report details
@github-actions github-actions bot added needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. Content:WebAPI Web API docs labels Aug 5, 2022
@BearCooder BearCooder changed the title ntersection Observer v2 delay and trackVisibility properties missing in Browser compatibility and are not described - plus no support in Firefox Intersection Observer v2 delay and trackVisibility properties missing in Browser compatibility and are not described - plus no support in Firefox Aug 5, 2022
@sideshowbarker sideshowbarker added help wanted If you know something about this topic, we would love your help! effort: medium This task is a medium effort. and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Aug 6, 2022
@Josh-Cena Josh-Cena added the document not written Missing document page label Sep 3, 2024
@Josh-Cena
Copy link
Member

Hi! We now have a centralized place to track missing documentation: https://openwebdocs.github.io/web-docs-backlog/all/ since it's currently only supported by Chrome, it's not being priotized. In any case, we are closing all missing documentation issues in favor of this central backlog.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Resize/Intersection Observer Content:WebAPI Web API docs document not written Missing document page effort: medium This task is a medium effort. help wanted If you know something about this topic, we would love your help!
Projects
None yet
Development

No branches or pull requests

3 participants