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.

Sign up for GitHub

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

WRR-387: Panels: Updated documentation for arranger #1752

Merged
merged 3 commits into from
Dec 19, 2024
Merged

WRR-387: Panels: Updated documentation for arranger #1752

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e5369d
WRR-387: Updated documentation for Panels arranger
vJIYEv Nov 18, 2024
203974b
Updated documentation
vJIYEv Dec 16, 2024
c3df2c8
review changes
vJIYEv Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions internal/Panels/Arrangers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,9 @@ const deferArrange = (config, keyframes, options) => {
/**
* Arranger that slides panels in from the right and out to the left.
*
* This arranger is visually same as {@link ui/ViewManager.SlideLeftArranger} when transition but uses transform percentages instead of pixel values.
Copy link
Contributor

Choose a reason for hiding this comment

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

It looks like ui/ViewManager.SlideLeftArranger already use percentages. So I think this comment should be revised.
If the visual is the same, what makes difference between SlideLeftArranger and BasicArranger?
I see BasicArranger uses deferArrange and offset. Please find more details about this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  1. offset values here don't affect animation (https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats)
  2. deferArrange was defined in PLAT-112222: Change BasicArranger to defer animation until idle #577 and it prevents skipping transition animations under system load. I updated the comments.

* Because BasicArranger is an optimized version of {@link ui/ViewManager.SlideLeftArranger}, {@link ui/ViewManager.SlideLeftArranger} can be written in documentation instead of BasicArranger in unavoidable case.
*
* @type {Arranger}
* @private
*/
Expand Down