[iOS] Add Platform Specific features for PrefersStatusBarHidden/UIStatusBarAnimation #463

pauldipietro · 2016-10-16T06:20:36Z

Description of Change

This is a Platform Specific feature which enables setting the visibility of the iOS status bar on a per-view basis. See some examples below:

This is accomplished through the StatusBarHiddenMode and UIStatusBarAnimation enumerators, which contain the following values:

StatusBarHiddenMode.Default
StatusBarHiddenMode.True
StatusBarHiddenMode.False

UIStatusBarAnimation.None
UIStatusBarAnimation.Fade
UIStatusBarAnimation.Slide

Per Apple's documentation, since iOS 8 the prefersStatusBarHidden method returns true on vertically compact environments. This represents the StatusBarHiddenMode.Default value, while the latter two apply the respective values to both the vertical and landscape orientations. This can be set as follows, for example:

page.On<iOS>().PrefersStatusBarHidden(StatusBarHiddenMode.True)

As one might guess, the UIStatusBarAnimation values represent the three possible manners by which the status bar can enter or leave the view. If a Fade or Slide value is set, a 0.25 second animation of setNeedsStatusBarAppearanceUpdate will execute. That can be used like so:

page.On<iOS>().SetPreferredStatusBarUpdateAnimation(UIStatusBarAnimation.Fade)

Starting with the Page value on the Platform (which has been subsequently marked as internal in order for the PlatformRenderer to get at it), childViewControllerForStatusBarHidden is utilized to redirect the views down to PageRenderer as a baseline for setting the values on a per-view basis. An exception is that in a TabbedPage, setting the PrefersStatusBarHidden value directly on that page will update all of its contained pages.

As of this submission, tests can still be added, though they may be somewhat complex due to the need to check the status bar -- screenshots might be preferable.

Bugs Fixed

This was technically not a bug, per se, but was reported under https://bugzilla.xamarin.com/show_bug.cgi?id=44803.

API Changes

Added:

public static readonly BindableProperty PrefersStatusBarHiddenProperty
public static StatusBarHiddenMode GetPrefersStatusBarHidden(BindableObject element)
public static void SetPrefersStatusBarHidden(BindableObject element, StatusBarHiddenMode value)
public static StatusBarHiddenMode PrefersStatusBarHidden(this IPlatformElementConfiguration<iOS, FormsElement> config)
public static IPlatformElementConfiguration<iOS, FormsElement> SetPrefersStatusBarHidden(this IPlatformElementConfiguration<iOS, FormsElement> config, StatusBarHiddenMode value)
public static readonly BindableProperty PreferredStatusBarUpdateAnimationProperty
public static UIStatusBarAnimation GetPreferredStatusBarUpdateAnimation(BindableObject element)
public static void SetPreferredStatusBarUpdateAnimation(BindableObject element, UIStatusBarAnimation value)
public static UIStatusBarAnimation PreferredStatusBarUpdateAnimation(this IPlatformElementConfiguration<iOS, FormsElement> config)
public static IPlatformElementConfiguration<iOS, FormsElement> SetPreferredStatusBarUpdateAnimation(this IPlatformElementConfiguration<iOS, FormsElement> config, UIStatusBarAnimation value)

Changed:

Page page => internal Page Page { get; set; }

Behavioral Changes

N/A

PR Checklist

Has tests (if omitted, state reason in description)
Rebased on top of master at time of PR
Changes adhere to coding standard
Consolidate commits as makes sense

adrianknight89 · 2016-10-17T18:32:47Z

Xamarin.Forms.Platform.iOS/Renderers/PageRenderer.cs

+					return true;
+				case (StatusBarHiddenMode.False):
+					return false;
+				case (StatusBarHiddenMode.Default):


I think this line is unnecessary in switch default. I could see similar things in other switch blocks.

adrianknight89 · 2016-10-17T18:34:08Z

Xamarin.Forms.Platform.iOS/Renderers/PageRenderer.cs

+						if (Device.info.CurrentOrientation.IsLandscape())
+							return true;
+						else
+							return false;


This could be turned into a ternary statement.

StephaneDelcroix · 2016-10-20T20:21:21Z

Xamarin.Forms.Core/PlatformConfiguration/iOSSpecific/StatusBarHiddenMode.cs

+	{
+		Default,
+		True,
+		False


NULLABLE BOOL !!!

i like this API more so user understands that Default is default .. and not null ..

rmarinho · 2016-10-24T21:30:29Z

Needs rebase

…tusBarAnimation

pauldipietro · 2016-10-24T21:35:22Z

Rebased

rmarinho · 2016-10-25T13:23:14Z

@pauldipietro this is failing , please check the build logs. and make sure this builds ok :)

rmarinho · 2016-10-25T13:26:33Z

Xamarin.Forms.Platform.iOS/Renderers/PhoneMasterDetailRenderer.cs

 		}

+		public override UIViewController ChildViewControllerForStatusBarHidden()
+		{
+			return (UIViewController)Platform.GetRenderer(((MasterDetailPage)Element).Detail);


Are we sure there always a detail renderer at this time?
i wonder if while switching detail pages could have a case where the renderer isn't created yet for the Detail element, this will blow up with NRE.
Maybe add a check and return base if no renderer is there.

rmarinho · 2016-10-25T13:27:44Z

Xamarin.Forms.Platform.iOS/Renderers/TabletMasterDetailRenderer.cs

@@ -234,6 +235,11 @@ public override void WillRotate(UIInterfaceOrientation toInterfaceOrientation, d
 			base.WillRotate(toInterfaceOrientation, duration);
 		}

+		public override UIViewController ChildViewControllerForStatusBarHidden()
+		{
+			return (UIViewController)Platform.GetRenderer(((MasterDetailPage)Element).Detail);


same comment as above

rmarinho · 2016-10-25T13:29:34Z

Xamarin.Forms.Core/PlatformConfiguration/iOSSpecific/StatusBarHiddenMode.cs

+	{
+		Default,
+		True,
+		False


i like this API more so user understands that Default is default .. and not null ..

adrianknight89 · 2016-11-06T07:58:31Z

https://bugzilla.xamarin.com/show_bug.cgi?id=41535

dnfclas added the cla-required label Oct 16, 2016

pauldipietro added t/enhancement ➕ cla-not-required and removed cla-required labels Oct 16, 2016

adrianknight89 reviewed Oct 17, 2016

View reviewed changes

StephaneDelcroix reviewed Oct 20, 2016

View reviewed changes

jassmith assigned rmarinho and kingces95 Oct 20, 2016

[iOS] Add Platform Specific features for PrefersStatusBarHidden/UISta…

047e0d7

…tusBarAnimation

pauldipietro force-pushed the ios-ps-prefersstatusbarhidden branch from 097675c to edd0553 Compare October 24, 2016 21:35

rmarinho suggested changes Oct 25, 2016

View reviewed changes

rmarinho added the needs-changes label Oct 25, 2016

Update docs

30a46ad

pauldipietro force-pushed the ios-ps-prefersstatusbarhidden branch from edd0553 to 30a46ad Compare October 25, 2016 15:45

rmarinho approved these changes Nov 16, 2016

View reviewed changes

rmarinho removed the needs-changes label Nov 16, 2016

rmarinho merged commit 98235e0 into master Nov 16, 2016

steipete mentioned this pull request Jan 3, 2017

Support the default value of UIViewControllerBasedStatusBarAppearance (true) facebook/react-native#11710

Closed

samhouts mentioned this pull request Mar 24, 2017

[iOS] Prevent NRE when page is switched on Appearing #840

Merged

4 tasks

rmarinho deleted the ios-ps-prefersstatusbarhidden branch June 22, 2017 10:49

pauldipietro mentioned this pull request Nov 1, 2017

[iOS] Fixes for iOS11 #1238

Merged

4 tasks

pauldipietro mentioned this pull request Dec 12, 2017

[iOS] Redirect PreferredStatusBarStyle to the Child View Controller #1175

Merged

4 tasks

samhouts added this to the 2.3.4 milestone Jun 27, 2018

cpojer mentioned this pull request Feb 15, 2019

Support the default value of UIViewControllerBasedStatusBarAppearance (true) rnc-archive/react-native-statusbar#5

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[iOS] Add Platform Specific features for PrefersStatusBarHidden/UIStatusBarAnimation #463

[iOS] Add Platform Specific features for PrefersStatusBarHidden/UIStatusBarAnimation #463

pauldipietro commented Oct 16, 2016 •

edited by samhouts

Loading

adrianknight89 Oct 17, 2016 •

edited

Loading

adrianknight89 Oct 17, 2016

StephaneDelcroix Oct 20, 2016

rmarinho Oct 25, 2016

rmarinho commented Oct 24, 2016

pauldipietro commented Oct 24, 2016

rmarinho commented Oct 25, 2016

rmarinho Oct 25, 2016

rmarinho Oct 25, 2016

rmarinho Oct 25, 2016

adrianknight89 commented Nov 6, 2016

[iOS] Add Platform Specific features for PrefersStatusBarHidden/UIStatusBarAnimation #463

[iOS] Add Platform Specific features for PrefersStatusBarHidden/UIStatusBarAnimation #463

Conversation

pauldipietro commented Oct 16, 2016 • edited by samhouts Loading

Description of Change

Bugs Fixed

API Changes

Behavioral Changes

PR Checklist

adrianknight89 Oct 17, 2016 • edited Loading

Choose a reason for hiding this comment

adrianknight89 Oct 17, 2016

Choose a reason for hiding this comment

StephaneDelcroix Oct 20, 2016

Choose a reason for hiding this comment

rmarinho Oct 25, 2016

Choose a reason for hiding this comment

rmarinho commented Oct 24, 2016

pauldipietro commented Oct 24, 2016

rmarinho commented Oct 25, 2016

rmarinho Oct 25, 2016

Choose a reason for hiding this comment

rmarinho Oct 25, 2016

Choose a reason for hiding this comment

rmarinho Oct 25, 2016

Choose a reason for hiding this comment

adrianknight89 commented Nov 6, 2016

pauldipietro commented Oct 16, 2016 •

edited by samhouts

Loading

adrianknight89 Oct 17, 2016 •

edited

Loading