-
Notifications
You must be signed in to change notification settings - Fork 22.5k
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
feat: Editorial review: Long animation frames API docs #33039
feat: Editorial review: Long animation frames API docs #33039
Conversation
…ngduration/index.md Co-authored-by: Barry Pollard <barrypollard@google.com>
files/en-us/web/api/performancelonganimationframetiming/scripts/index.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo - readonly => read-only
files/en-us/web/api/performancelonganimationframetiming/scripts/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/styleandlayoutstart/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/renderstart/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/firstuieventtimestamp/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/blockingduration/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/sourcecharposition/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/sourcefunctionname/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/windowattribution/index.md
Outdated
Show resolved
Hide resolved
This pull request has merge conflicts that must be resolved before it can be merged. |
files/en-us/web/api/performancelonganimationframetiming/blockingduration/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/blockingduration/index.md
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/firstuieventtimestamp/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/firstuieventtimestamp/index.md
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/index.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've looked at all the pages now except https://pr33039.content.dev.mdn.mozit.cloud/en-US/docs/Web/API/Performance_API/Long_animation_frame_timing. I'll be able to get to it tomorrow.
files/en-us/web/api/performancescripttiming/executionstart/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/forcedstyleandlayoutduration/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/invokertype/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/invokertype/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/windowattribution/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/windowattribution/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/windowattribution/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/executionstart/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/invokertype/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancescripttiming/forcedstyleandlayoutduration/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performancelonganimationframetiming/firstuieventtimestamp/index.md
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I've looked at all the pages in this PR now.
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
|
||
### Long Animation Frames API feature detection | ||
|
||
You can test whether the Long Animation Frames API is supported using {{domxref("PerformanceObserver.supportedEntryTypes")}}: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can test whether the Long Animation Frames API is supported using {{domxref("PerformanceObserver.supportedEntryTypes")}}: | |
You can test whether the Long Animation Frames API is supported using {{domxref("PerformanceObserver.supportedEntryTypes_static")}}: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this change is needed. The macro is already clever enough to resolve to the correct URL, and if you explicitly add this, it appears in the link text, which is not what we want (it's not part of the actual property name).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, the flaw does say it will redirect:
Explanation: /en-US/docs/Web/API/PerformanceObserver/supportedEntryTypes redirects to /en-US/docs/Web/API/PerformanceObserver/supportedEntryTypes_static
It also says that the flaw is fixable.
If you want, it could be updated to:
{{domxref("PerformanceObserver.supportedEntryTypes_static", "PerformanceObserver.supportedEntryTypes")}}
...the way it's been done on getEntriesByType.
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
…s/content into long-animation-frames-api
--- | ||
title: Long animation frame timing | ||
slug: Web/API/Performance_API/Long_animation_frame_timing | ||
page-type: web-api-overview |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be a guide
page-type? Elsewhere, we've used web-api-overview
on API landing pages
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lol, yup! That was a copy-paste error. Fixed now.
|
||
### Long Animation Frames API feature detection | ||
|
||
You can test whether the Long Animation Frames API is supported using {{domxref("PerformanceObserver.supportedEntryTypes")}}: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, the flaw does say it will redirect:
Explanation: /en-US/docs/Web/API/PerformanceObserver/supportedEntryTypes redirects to /en-US/docs/Web/API/PerformanceObserver/supportedEntryTypes_static
It also says that the flaw is fixable.
If you want, it could be updated to:
{{domxref("PerformanceObserver.supportedEntryTypes_static", "PerformanceObserver.supportedEntryTypes")}}
...the way it's been done on getEntriesByType.
## See also | ||
|
||
- [Optimize long tasks](https://web.dev/articles/optimize-long-tasks) on web.dev (2024) | ||
- [Where long tasks fall short](https://github.com/w3c/long-animation-frames#where-long-tasks-fall-short), Long Animation Frames API explainer (2024) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about:
- [Where long tasks fall short](https://github.com/w3c/long-animation-frames#where-long-tasks-fall-short), Long Animation Frames API explainer (2024) | |
- [Where long tasks fall short](https://github.com/w3c/long-animation-frames#where-long-tasks-fall-short) on W3C (2024) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I dunno; I would expect a link labeled "W3C" to go somewhere on W3.org.
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
observer.observe({ type: "long-animation-frame", buffered: true }); | ||
``` | ||
|
||
## Comparison with the Long Tasks API |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## Comparison with the Long Tasks API | |
## Comparing with the Long Tasks API |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, updated
|
||
## Comparison with the Long Tasks API | ||
|
||
The Long Animation Frames API was preceded by the [Long Tasks API](https://w3c.github.io/longtasks/) (see {{domxref("PerformanceLongTaskTiming")}}) — these specs both have a similar purpose and usage, exposing information on [long tasks](/en-US/docs/Glossary/Long_task) that block the main thread for 50ms or more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we mean the functionalities that these specs provide
The Long Animation Frames API was preceded by the [Long Tasks API](https://w3c.github.io/longtasks/) (see {{domxref("PerformanceLongTaskTiming")}}) — these specs both have a similar purpose and usage, exposing information on [long tasks](/en-US/docs/Glossary/Long_task) that block the main thread for 50ms or more. | |
The Long Animation Frames API was preceded by the [Long Tasks API](https://w3c.github.io/longtasks/) (see {{domxref("PerformanceLongTaskTiming")}}) — both the APIs have a similar purpose and usage, exposing information about [long tasks](/en-US/docs/Glossary/Long_task) that block the main thread for 50ms or more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
files/en-us/web/api/performance_api/long_animation_frame_timing/index.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for addressing all my comments, @chrisdavidmills! I'm leaving a +1 with just a few minor things for you to go over.
Appreciate your work on adding all these pages, thank you!
@dipikabh super awesome, thanks for another great review! That's everything addressed, so I should be able to merge soon. |
Description
#32937 contains the engineering technical review for my work on Long Animation Frames API docs, which has been completed and approved. Thank you to @tunetheweb and @noamr for your thorough and detailed review work.
This is a new PR based on the same branch, which is intended to contain the editorial review for the same work.
Background information
The Long Animation Frames API was released in Chrome 123. This PR adds docs for this API.
Specifically, it:
PerformanceLongAnimationFrameTiming
interface.PerformanceScriptTiming
interface.Motivation
Additional details
Related issues and pull requests