feat(statusbar): Simple built-in status bar support #1523
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If you call scrollView on a UIView that does not have its own scrollView method, this hijack method will keep recursively calling itself until you run out of stack space. Try to guard against that by making sure that it's not getting called on the same instance multiple times. TODO: Think about thread safety, but in theory because this is view-related stuff it's only safe to run on the main thread.
This adds a background behind the status bar automatically when a page does not request to extend itself behind the status bar using a meta tag with `viewport-fit=cover`. It automatically shows and hides as the value of the viewport-fit option changes. On iOS 16.4 and newer, it will be coloured according to the meta `theme-color` tag, and a default colour can be set in the storyboard for a CDVViewController. We expose a very basic JS API hanging off the existing `window.statusbar` property that allows controlling the visibility (of the status bar contents entirely, not just of the background view) and overriding the background colour. The colour is determined as follows: 1. Any colour set explicitly with the JS API (if any) 2. Any colour pulled from the meta tag (iOS 16.4+, if any) 3. The default colour specified in the storyboard (if any) 4. The background colour specified in the storyboard (if any) 5. The default system background colour Efforts were made to ensure that this does not interfere with the existing CDVStatusBar plugin implementation (although maybe this can replace it for most common use cases), by making the display of this built-in conditional on not having the CDVStatusBar plugin installed.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1523 +/- ##
=======================================
Coverage 81.41% 81.41%
=======================================
Files 16 16
Lines 1862 1862
=======================================
Hits 1516 1516
Misses 346 346 ☔ View full report in Codecov by Sentry. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Platforms affected
iOS
Motivation and Context
Web content authors should have control over how the status bar is handled using the built-in web platform functionality for UI colouring and opting in to showing behind the status bar or not.
Description
This adds a background behind the status bar automatically when a page does not request to extend itself behind the status bar using a meta tag with
viewport-fit=cover. It automatically shows and hides as the value of the viewport-fit option changes.On iOS 16.4 and newer, it will be coloured according to the meta
theme-colortag, and a default colour can be set in the storyboard for a CDVViewController.We expose a very basic JS API hanging off the existing
window.statusbarproperty that allows controlling the visibility (of the status bar contents entirely, not just of the background view) and overriding the background colour.The colour is determined as follows:
Efforts were made to ensure that this does not interfere with the existing CDVStatusBar plugin implementation (although maybe this can replace it for most common use cases), by making the display of this built-in conditional on not having the CDVStatusBar plugin installed.
Remaining Work
StatusBarBackgroundColorpreference up to an XCAsset colorset in the template and set it in the Main.storyboard fileCDVStatusBarinstalled to make sure there are no conflictsTesting
Tested locally in an iPhone 16 Pro Max simulator.
Checklist