Update `PlatformPlugin` to not call `setStatusBarColor`, `setNavigationBarColor`, `setNavigationBarDividerColor` when disabled (#180061)
fixes #165582
towards #165327 (see
https://discord.com/channels/608014603317936148/846507907876257822/1451187625116569660)
## Pre-launch Checklist
- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [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 `///`).
- [ ] 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].
**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
[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
---------
Co-authored-by: Camille Simon <43054281+camsim99@users.noreply.github.com>
Co-authored-by: Reid Baker <1063596+reidbaker@users.noreply.github.com>
diff --git a/engine/src/flutter/shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java b/engine/src/flutter/shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java
index cdd0ad3..8629b86 100644
--- a/engine/src/flutter/shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java
+++ b/engine/src/flutter/shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java
@@ -255,7 +255,7 @@
// `onSystemUiVisibilityChange` is received though.
//
// As such, post `platformChannel.systemChromeChanged` to the view handler to ensure
- // that downstream callbacks are trigged on the next frame.
+ // that downstream callbacks are triggered on the next frame.
decorView.post(
() -> {
if ((visibility & View.SYSTEM_UI_FLAG_FULLSCREEN) == 0) {
@@ -428,8 +428,10 @@
/**
* @deprecated This method is outdated because it calls {@code setStatusBarColor}, {@code
* setNavigationBarColor} and {@code setNavigationBarDividerColor}, which are deprecated in
- * Android 15 and above. Consider using the new WindowInsetsController or other Android 15+
- * APIs for system UI styling.
+ * Android 15 and above, meaning calls to this method will have no effect on those versions.
+ * Consider using the
+ * [WindowInsetsController](https://developer.android.com/reference/android/view/WindowInsetsController)
+ * or other Android 15+ APIs for system UI styling.
*/
@Deprecated
private void setSystemChromeSystemUIOverlayStyle(
@@ -477,7 +479,14 @@
}
if (systemChromeStyle.statusBarColor != null) {
- window.setStatusBarColor(systemChromeStyle.statusBarColor);
+ // setStatusBarColor has no effect on Android 15 and above, meaning calls to this method will
+ // have no effect on those versions.
+ // Consider using the
+ // [WindowInsetsController](https://developer.android.com/reference/android/view/WindowInsetsController)
+ // or other Android 15+ APIs for system UI styling.
+ if (Build.VERSION.SDK_INT < API_LEVELS.API_35) {
+ window.setStatusBarColor(systemChromeStyle.statusBarColor);
+ }
}
// You can't override the enforced contrast for a transparent status bar until SDK 29.
// This overrides the translucent scrim that may be placed behind the bar on SDK 29+ to ensure
@@ -511,12 +520,26 @@
}
if (systemChromeStyle.systemNavigationBarColor != null) {
- window.setNavigationBarColor(systemChromeStyle.systemNavigationBarColor);
+ // setNavigationBarColor has no effect on Android 15 and above, meaning calls to this method
+ // will have no effect on those versions.
+ // Consider using the
+ // [WindowInsetsController](https://developer.android.com/reference/android/view/WindowInsetsController)
+ // or other Android 15+ APIs for system UI styling.
+ if (Build.VERSION.SDK_INT < API_LEVELS.API_35) {
+ window.setNavigationBarColor(systemChromeStyle.systemNavigationBarColor);
+ }
}
}
// You can't change the color of the navigation bar divider color until SDK 28.
+
+ // setNavigationBarDividerColor has no effect on Android 15 and above, meaning calls to this
+ // method will have no effect on those versions.
+ // Consider using the
+ // [WindowInsetsController](https://developer.android.com/reference/android/view/WindowInsetsController)
+ // or other Android 15+ APIs for system UI styling.
if (systemChromeStyle.systemNavigationBarDividerColor != null
- && Build.VERSION.SDK_INT >= API_LEVELS.API_28) {
+ && Build.VERSION.SDK_INT >= API_LEVELS.API_28
+ && Build.VERSION.SDK_INT < API_LEVELS.API_35) {
window.setNavigationBarDividerColor(systemChromeStyle.systemNavigationBarDividerColor);
}
