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

[IntersectionObserver] #295 V2: visibility detection #523

Merged
merged 5 commits into from
Jun 27, 2024

Conversation

szager-chromium
Copy link
Collaborator

@szager-chromium szager-chromium commented Mar 21, 2024

The V2 set of features adds visibility reporting, with detection of occlusion and visual effects (explainer, issue).


Preview | Diff

index.bs Outdated
: <dfn>isVisible</dfn>
::
True if {{IntersectionObserver/trackVisibility}} is <code>true</code>
and the <a>visibility</a> algorithm,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This implies the value false if trackVisibility is false, while later on the algorithm is specified to immediately returns true in that case. Of the two, false has a safer failure mode if someone thinks they're tracking visibility but they screwed up somewhere. Either way, the two parts of the spec need to agree.

Even better would be if isVisible were completely undefined if you had not enabled trackVisibility.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the purpose of feature detection, how about setting isVisible to null if trackVisibility is false? I think that's also more consistent with other IDL I have seen.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can't set a boolean to null, can you? Honest question -- I'm not sure what the WebIDL can express, nor what would be most consistent with similar APIs. This feels kind of off, but a permanent false when tracking isn't enabled wouldn't be terrible. The true specified in the algorithm below will lead to trouble.

Any thoughts, @annevk or @zcorpan?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not an IDL expert, but for the record chromium's IDL code generator allows null-able booleans. I wrote a chromium patch which would implement the behavior I proposed, and it works.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can have nullable booleans (the IDL of this PR does not do that btw), but generally it would be better to use an enum.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure an enum will work here, because we need two different values that will evaluate to false when cast to boolean.

If there are no objections, I'll just make it a permanent false when tracking isn't enabled. I think that's probably what we want from a developer ergonomics no-surprises point of view. Feature detection can always be done via IntersectionObserverEntry.prototype.hasOwnProperty('isVisible').

index.bs Outdated Show resolved Hide resolved
index.bs Outdated Show resolved Hide resolved
index.bs Outdated Show resolved Hide resolved
@szager-chromium
Copy link
Collaborator Author

Update the PR based on comments so far, PTAL.

@szager-chromium
Copy link
Collaborator Author

@dveditz, @emilio -- any other issues with the PR? I would like to get this approved and landed; thanks.

Copy link
Member

@dveditz dveditz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making these changes—looks good

@szager-chromium szager-chromium merged commit 027e2dd into w3c:main Jun 27, 2024
2 checks passed
github-actions bot added a commit that referenced this pull request Jun 27, 2024
SHA: 027e2dd
Reason: push, by szager-chromium

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
ddbeck added a commit to web-platform-dx/web-features that referenced this pull request Jun 28, 2024
foolip pushed a commit to web-platform-dx/web-features that referenced this pull request Jul 2, 2024
`intersection-observer-v2`: spec merged into the Intersection Observer spec

w3c/browser-specs#1210
w3c/IntersectionObserver#523

Co-authored-by: Daniel D. Beck <daniel@ddbeck.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants