Implement IsToggled property in WinUI SwitchHandler (#719)

* Implement IsToggled property in WinUI SwitchHandler * - update to IsOn * - fix naming * - wire up switch toggle * - add tests * - ios skip * - fix Co-authored-by: Shane Neuville <[email protected]>
dotnet · Apr 15, 2021 · d1823cd · d1823cd
1 parent 9c1bdcb
commit d1823cd
Show file tree

Hide file tree

Showing 15 changed files with 108 additions and 33 deletions.
diff --git a/src/Compatibility/Core/src/AppHostBuilderExtensions.cs b/src/Compatibility/Core/src/AppHostBuilderExtensions.cs
@@ -15,18 +15,16 @@ public static class AppHostBuilderExtensions
 			typeof(Label),
 			typeof(CheckBox),
 			typeof(Entry),
-#if !WINDOWS
+			typeof(Switch),
+			typeof(Editor),
 			typeof(ActivityIndicator),
 			typeof(DatePicker),
-			typeof(Editor),
 			typeof(Picker),
 			typeof(ProgressBar),
 			typeof(SearchBar),
 			typeof(Slider),
 			typeof(Stepper),
-			typeof(Switch),
 			typeof(TimePicker),
-#endif
 		};
 
 		public static IAppHostBuilder UseFormsCompatibility(this IAppHostBuilder builder, bool registerRenderers = true)

diff --git a/src/Controls/src/Core/HandlerImpl/Switch.Impl.cs b/src/Controls/src/Core/HandlerImpl/Switch.Impl.cs
@@ -14,5 +14,11 @@ Color ISwitch.TrackColor
 				return null;
 			}
 		}
+
+		bool ISwitch.IsOn
+		{
+			get => IsToggled;
+			set => IsToggled = value;
+		}
 	}
 }
diff --git a/src/Core/src/Core/ISwitch.cs b/src/Core/src/Core/ISwitch.cs
@@ -10,7 +10,7 @@ public interface ISwitch : IView
 		/// <summary>
 		/// Gets or sets a Boolean value that indicates whether this Switch is toggled.
 		/// </summary>
-		bool IsToggled { get; set; }
+		bool IsOn { get; set; }
 
 		/// <summary>
 		/// Gets the Switch Track Color.

diff --git a/src/Core/src/Handlers/Switch/SwitchHandler.Android.cs b/src/Core/src/Handlers/Switch/SwitchHandler.Android.cs
@@ -53,9 +53,9 @@ public override Size GetDesiredSize(double widthConstraint, double heightConstra
 			return size;
 		}
 
-		public static void MapIsToggled(SwitchHandler handler, ISwitch view)
+		public static void MapIsOn(SwitchHandler handler, ISwitch view)
 		{
-			handler.NativeView?.UpdateIsToggled(view);
+			handler.NativeView?.UpdateIsOn(view);
 		}
 
 		public static void MapTrackColor(SwitchHandler handler, ISwitch view)
@@ -68,12 +68,12 @@ public static void MapThumbColor(SwitchHandler handler, ISwitch view)
 			handler.NativeView?.UpdateThumbColor(view, DefaultThumbColorStateList);
 		}
 
-		void OnCheckedChanged(bool isToggled)
+		void OnCheckedChanged(bool isOn)
 		{
 			if (VirtualView == null)
 				return;
 
-			VirtualView.IsToggled = isToggled;
+			VirtualView.IsOn = isOn;
 		}
 
 		class CheckedChangeListener : Java.Lang.Object, CompoundButton.IOnCheckedChangeListener

diff --git a/src/Core/src/Handlers/Switch/SwitchHandler.Standard.cs b/src/Core/src/Handlers/Switch/SwitchHandler.Standard.cs
@@ -6,7 +6,7 @@ public partial class SwitchHandler : ViewHandler<ISwitch, object>
 	{
 		protected override object CreateNativeView() => throw new NotImplementedException();
 
-		public static void MapIsToggled(SwitchHandler handler, ISwitch view) { }
+		public static void MapIsOn(SwitchHandler handler, ISwitch view) { }
 		public static void MapTrackColor(SwitchHandler handler, ISwitch view) { }
 		public static void MapThumbColor(SwitchHandler handler, ISwitch view) { }
 	}

diff --git a/src/Core/src/Handlers/Switch/SwitchHandler.Windows.cs b/src/Core/src/Handlers/Switch/SwitchHandler.Windows.cs
@@ -1,4 +1,3 @@
-using System;
 using Microsoft.UI.Xaml.Controls;
 
 namespace Microsoft.Maui.Handlers
@@ -7,13 +6,35 @@ public partial class SwitchHandler : ViewHandler<ISwitch, ToggleSwitch>
 	{
 		protected override ToggleSwitch CreateNativeView() => new ToggleSwitch();
 
-		[MissingMapper]
-		public static void MapIsToggled(SwitchHandler handler, ISwitch view) { }
+		public static void MapIsOn(SwitchHandler handler, ISwitch view)
+		{
+			handler.NativeView?.UpdateIsToggled(view);
+		}
 
 		[MissingMapper]
 		public static void MapTrackColor(SwitchHandler handler, ISwitch view) { }
 
 		[MissingMapper]
 		public static void MapThumbColor(SwitchHandler handler, ISwitch view) { }
+
+		protected override void DisconnectHandler(ToggleSwitch nativeView)
+		{
+			base.DisconnectHandler(nativeView);
+			nativeView.Toggled -= OnToggled;
+		}
+
+		protected override void ConnectHandler(ToggleSwitch nativeView)
+		{
+			base.ConnectHandler(nativeView);
+			nativeView.Toggled += OnToggled;
+		}
+
+		void OnToggled(object sender, UI.Xaml.RoutedEventArgs e)
+		{
+			if (VirtualView == null || NativeView == null)
+				return;
+
+			VirtualView.IsOn = NativeView.IsOn;
+		}
 	}
 }
diff --git a/src/Core/src/Handlers/Switch/SwitchHandler.cs b/src/Core/src/Handlers/Switch/SwitchHandler.cs
@@ -5,7 +5,7 @@ public partial class SwitchHandler
 	{
 		public static PropertyMapper<ISwitch, SwitchHandler> SwitchMapper = new PropertyMapper<ISwitch, SwitchHandler>(ViewHandler.ViewMapper)
 		{
-			[nameof(ISwitch.IsToggled)] = MapIsToggled,
+			[nameof(ISwitch.IsOn)] = MapIsOn,
 			[nameof(ISwitch.ThumbColor)] = MapThumbColor,
 			[nameof(ISwitch.TrackColor)] = MapTrackColor,
 		};

diff --git a/src/Core/src/Handlers/Switch/SwitchHandler.iOS.cs b/src/Core/src/Handlers/Switch/SwitchHandler.iOS.cs
@@ -32,9 +32,9 @@ protected override void SetupDefaults(UISwitch nativeView)
 			DefaultThumbColor = UISwitch.Appearance.ThumbTintColor;
 		}
 
-		public static void MapIsToggled(SwitchHandler handler, ISwitch view)
+		public static void MapIsOn(SwitchHandler handler, ISwitch view)
 		{
-			handler.NativeView?.UpdateIsToggled(view);
+			handler.NativeView?.UpdateIsOn(view);
 		}
 
 		public static void MapTrackColor(SwitchHandler handler, ISwitch view)
@@ -53,7 +53,7 @@ void OnControlValueChanged(object? sender, EventArgs e)
 				return;
 
 			if (NativeView != null)
-				VirtualView.IsToggled = NativeView.On;
+				VirtualView.IsOn = NativeView.On;
 		}
 	}
 }
diff --git a/src/Core/src/Platform/Android/SwitchExtensions.cs b/src/Core/src/Platform/Android/SwitchExtensions.cs
@@ -9,8 +9,8 @@ namespace Microsoft.Maui
 {
 	public static class SwitchExtensions
 	{
-		public static void UpdateIsToggled(this ASwitch aSwitch, ISwitch view) =>
-			aSwitch.Checked = view.IsToggled;
+		public static void UpdateIsOn(this ASwitch aSwitch, ISwitch view) =>
+			aSwitch.Checked = view.IsOn;
 
 		public static void UpdateTrackColor(this ASwitch aSwitch, ISwitch view, ColorStateList? defaultTrackColor)
 		{

diff --git a/src/Core/src/Platform/Windows/SwitchExtensions.cs b/src/Core/src/Platform/Windows/SwitchExtensions.cs
@@ -0,0 +1,12 @@
+using Microsoft.UI.Xaml.Controls;
+
+namespace Microsoft.Maui
+{
+	public static class SwitchExtensions
+	{
+		public static void UpdateIsToggled(this ToggleSwitch toggleSwitch, ISwitch view)
+		{
+			toggleSwitch.IsOn = view.IsOn;
+		}
+	}
+}
diff --git a/src/Core/src/Platform/iOS/SwitchExtensions.cs b/src/Core/src/Platform/iOS/SwitchExtensions.cs
@@ -5,9 +5,9 @@ namespace Microsoft.Maui
 {
 	public static class SwitchExtensions
 	{
-		public static void UpdateIsToggled(this UISwitch uiSwitch, ISwitch view)
+		public static void UpdateIsOn(this UISwitch uiSwitch, ISwitch view)
 		{
-			uiSwitch.SetState(view.IsToggled, true);
+			uiSwitch.SetState(view.IsOn, true);
 		}
 
 		public static void UpdateTrackColor(this UISwitch uiSwitch, ISwitch view, UIColor? defaultOnTrackColor, UIColor? defaultOffTrackColor)

diff --git a/src/Core/tests/DeviceTests/Handlers/Switch/SwitchHandlerTests.Android.cs b/src/Core/tests/DeviceTests/Handlers/Switch/SwitchHandlerTests.Android.cs
@@ -9,10 +9,13 @@ namespace Microsoft.Maui.DeviceTests
 {
 	public partial class SwitchHandlerTests
 	{
+		void SetIsOn(SwitchHandler switchHandler, bool value) =>
+			GetNativeSwitch(switchHandler).Checked = value;
+
 		ASwitch GetNativeSwitch(SwitchHandler switchHandler) =>
 			(ASwitch)switchHandler.NativeView;
 
-		bool GetNativeIsChecked(SwitchHandler switchHandler) =>
+		bool GetNativeIsOn(SwitchHandler switchHandler) =>
 			GetNativeSwitch(switchHandler).Checked;
 
 		Task ValidateTrackColor(ISwitch switchStub, Color color, Action action = null) =>

diff --git a/src/Core/tests/DeviceTests/Handlers/Switch/SwitchHandlerTests.cs b/src/Core/tests/DeviceTests/Handlers/Switch/SwitchHandlerTests.cs
@@ -15,10 +15,10 @@ public async Task IsToggledInitializesCorrectly()
 		{
 			var switchStub = new SwitchStub()
 			{
-				IsToggled = true
+				IsOn = true
 			};
 
-			await ValidatePropertyInitValue(switchStub, () => switchStub.IsToggled, GetNativeIsChecked, switchStub.IsToggled);
+			await ValidatePropertyInitValue(switchStub, () => switchStub.IsOn, GetNativeIsOn, switchStub.IsOn);
 		}
 
 		[Theory(DisplayName = "Track Color Initializes Correctly")]
@@ -28,7 +28,7 @@ public async Task TrackColorInitializesCorrectly(bool isToggled)
 		{
 			var switchStub = new SwitchStub()
 			{
-				IsToggled = isToggled,
+				IsOn = isToggled,
 				TrackColor = Colors.Red
 			};
 
@@ -40,7 +40,7 @@ public async Task TrackColorUpdatesCorrectly()
 		{
 			var switchStub = new SwitchStub()
 			{
-				IsToggled = true
+				IsOn = true
 			};
 
 			await ValidateTrackColor(switchStub, Colors.Red, () => switchStub.TrackColor = Colors.Red);
@@ -51,7 +51,7 @@ public async Task ThumbColorInitializesCorrectly()
 		{
 			var switchStub = new SwitchStub()
 			{
-				IsToggled = true,
+				IsOn = true,
 				ThumbColor = Colors.Blue
 			};
 
@@ -63,10 +63,33 @@ public async Task ThumbColorUpdatesCorrectly()
 		{
 			var switchStub = new SwitchStub()
 			{
-				IsToggled = true
+				IsOn = true
 			};
 
 			await ValidateThumbColor(switchStub, Colors.Red, () => switchStub.ThumbColor = Colors.Red);
 		}
+
+		[Fact(DisplayName = "Updating Native Is On property updates Virtual View"
+#if __IOS__
+			  ,Skip = "iOS doesn't throw ValueChanged events when changing property via code."
+#endif
+			)]
+		public async Task NativeIsOnPropagatesToVirtual()
+		{
+			var switchStub = new SwitchStub()
+			{
+				IsOn = false
+			};
+
+			bool isOn = false;
+			switchStub.IsOnDelegate += () =>
+			{
+				isOn = switchStub.IsOn;
+			};
+
+			await SetValueAsync(switchStub, true, SetIsOn);
+
+			Assert.True(isOn);
+		}
 	}
 }
diff --git a/src/Core/tests/DeviceTests/Handlers/Switch/SwitchHandlerTests.iOS.cs b/src/Core/tests/DeviceTests/Handlers/Switch/SwitchHandlerTests.iOS.cs
@@ -12,7 +12,11 @@ public partial class SwitchHandlerTests
 		UISwitch GetNativeSwitch(SwitchHandler switchHandler) =>
 			(UISwitch)switchHandler.NativeView;
 
-		bool GetNativeIsChecked(SwitchHandler switchHandler) =>
+		// This will not fire a ValueChanged event on native
+		void SetIsOn(SwitchHandler switchHandler, bool value) =>
+			switchHandler.NativeView.SetState(value, true);
+
+		bool GetNativeIsOn(SwitchHandler switchHandler) =>
 		  GetNativeSwitch(switchHandler).On;
 
 		async Task ValidateTrackColor(ISwitch switchStub, Color color, Action action = null)

diff --git a/src/Core/tests/DeviceTests/Stubs/SwitchStub.cs b/src/Core/tests/DeviceTests/Stubs/SwitchStub.cs
@@ -5,11 +5,21 @@ namespace Microsoft.Maui.DeviceTests.Stubs
 {
 	public partial class SwitchStub : StubBase, ISwitch
 	{
-		public Action ToggledDelegate;
+		public Action IsOnDelegate;
 		Color _thumbColor;
 		Color _trackColor;
+		bool _isOn;
+
+		public bool IsOn
+		{
+			get => _isOn;
+			set
+			{
+				SetProperty(ref _isOn, value);
+				IsOnDelegate?.Invoke();
+			}
+		}
 
-		public bool IsToggled { get; set; }
 		public Color TrackColor
 		{
 			get => _trackColor;
@@ -21,7 +31,5 @@ public Color ThumbColor
 			get => _thumbColor;
 			set => SetProperty(ref _thumbColor, value);
 		}
-
-		public void Toggled() => ToggledDelegate?.Invoke();
 	}
 }