[CP-stable][Android] Reset system UI visibility flags when setting edge-to-edge mode#187276
Conversation
…mode (flutter#187207) Resets system UI visibility flags before setting edge-to-edge mode if requested. System UI visibility flags will be set if the developer requests a non-edge-to-edge `SystemUiMode`, which can (and does in practice) conflict with [laying out a window edge-to-edge](https://developer.android.com/develop/ui/views/layout/edge-to-edge-manually#lay-out-in-full-screen). This is why [the docs](https://developer.android.com/reference/androidx/core/view/WindowCompat#setDecorFitsSystemWindows(android.view.Window,boolean)) warn against setting system UI visibility flags altogether; see flutter#133074 for details. Fixes flutter#186723. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance. **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [AI contribution guidelines]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
|
@camsim99 please fill out the PR description above, afterwards the release team will review this request. |
|
This pull request was opened from and to a release candidate branch. This should only be done as part of the official Flutter release process. If you are attempting to make a regular contribution to the Flutter project, please close this PR and follow the instructions at Tree Hygiene for detailed instructions on contributing to Flutter. Reviewers: Use caution before merging pull requests to release branches. Ensure the proper procedure has been followed. |
There was a problem hiding this comment.
Code Review
This pull request updates PlatformPlugin.java to clear previously applied system UI visibility flags by setting the visibility to 0 when enabling edge-to-edge mode, and introduces a corresponding test in PlatformPluginTest.java. The review feedback suggests caching the window reference to avoid redundant calls and replacing the magic number 0 with the View.SYSTEM_UI_FLAG_VISIBLE constant in both the implementation and the test to improve readability.
| private void enableEdgeToEdge() { | ||
| // Clear previously applied system UI visibility flags to ensure that | ||
| // WindowInsetsControllerCompat can correctly configure the window. | ||
| activity.getWindow().getDecorView().setSystemUiVisibility(0); | ||
|
|
||
| WindowCompat.setDecorFitsSystemWindows(activity.getWindow(), false); | ||
| } |
There was a problem hiding this comment.
To improve readability and avoid redundant calls, consider caching activity.getWindow() in a local variable. Additionally, avoid using the magic number 0 for clearing system UI visibility flags; instead, use the Android SDK constant View.SYSTEM_UI_FLAG_VISIBLE to make the code self-documenting.
| private void enableEdgeToEdge() { | |
| // Clear previously applied system UI visibility flags to ensure that | |
| // WindowInsetsControllerCompat can correctly configure the window. | |
| activity.getWindow().getDecorView().setSystemUiVisibility(0); | |
| WindowCompat.setDecorFitsSystemWindows(activity.getWindow(), false); | |
| } | |
| private void enableEdgeToEdge() { | |
| final Window window = activity.getWindow(); | |
| // Clear previously applied system UI visibility flags to ensure that | |
| // WindowInsetsControllerCompat can correctly configure the window. | |
| window.getDecorView().setSystemUiVisibility(View.SYSTEM_UI_FLAG_VISIBLE); | |
| WindowCompat.setDecorFitsSystemWindows(window, false); | |
| } |
| platformPlugin.mPlatformMessageHandler.showSystemUiMode( | ||
| PlatformChannel.SystemUiMode.EDGE_TO_EDGE); | ||
|
|
||
| verify(fakeDecorView).setSystemUiVisibility(0); |
There was a problem hiding this comment.
df67bb3
into
flutter:flutter-3.44-candidate.0
This pull request is created by automatic cherry pick workflow
Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request.
Issue Link:
What is the link to the issue this cherry-pick is addressing?
#186723
Impact Description:
What is the impact (ex. visual jank on Samsung phones, app crash, cannot ship an iOS app)?
Does it impact development (ex. flutter doctor crashes when Android Studio is installed),
or the shipping of production apps (the app crashes on launch).
This information is for domain experts and release engineers to understand the consequences of saying yes or no to the cherry pick.
Apps cannot switch from any
SystemUiModeto edge-to-edge mode.Changelog Description:
Explain this cherry pick:
See best practices for examples.
[flutter/186723] When apps try to switch from any
SystemUiModeto edge-to-edge on Android, the system bars incorrectly remain invisible.Workaround:
Is there a workaround for this issue?
As per #186723 (comment), you can restore edge-to-edge manually.
Risk:
What is the risk level of this cherry-pick?
Test Coverage:
Are you confident that your fix is well-tested by automated tests?
Validation Steps:
What are the steps to validate that this fix works?
Run the sample app in #186723 (comment) and attempt switching between
immersiveStickymode andedge-to-edge.