Make it possible to define when the IconTintBehavior gets applied (#2304)

Co-authored-by: Shaun Lawrence <17139988+bijington@users.noreply.github.com>
Co-authored-by: Brandon Minnick <13558917+brminnick@users.noreply.github.com>
Co-authored-by: James Crutchley <ne0rmatrix@gmail.com>
Co-authored-by: Brandon Minnick <13558917+TheCodeTraveler@users.noreply.github.com>

Author: 3 people

src/CommunityToolkit.Maui/Behaviors/PlatformBehaviors/IconTintColor/IconTintColorBehavior.android.cs

@@ -20,8 +20,12 @@ protected override void OnAttachedTo(View bindable, AndroidView platformView)
 		base.OnAttachedTo(bindable, platformView);
 		nativeView = platformView;
 
-		ApplyTintColor(nativeView, TintColor);
+		if (ApplyOn is IconTintColorApplyOn.OnBehaviorAttachedTo)
+		{
+			ApplyTintColor(nativeView, TintColor);
+		}
 
+		bindable.Loaded += OnBindableLoaded;
 		bindable.PropertyChanged += OnElementPropertyChanged;
 		PropertyChanged += OnTintedImagePropertyChanged;
 	}
@@ -33,9 +37,20 @@ protected override void OnDetachedFrom(View bindable, AndroidView platformView)
 
 		ClearTintColor(platformView);
 
+		bindable.Loaded -= OnBindableLoaded;
 		bindable.PropertyChanged -= OnElementPropertyChanged;
 		PropertyChanged -= OnTintedImagePropertyChanged;
 	}
+	
+	void OnBindableLoaded(object? sender, EventArgs e)
+	{
+		if (ApplyOn is not IconTintColorApplyOn.OnViewLoaded)
+		{
+			return;
+		}
+		
+		ApplyTintColor(nativeView, TintColor);
+	}
 
 	static void ApplyTintColor(AndroidView? nativeView, Color? tintColor)
 	{

src/CommunityToolkit.Maui/Behaviors/PlatformBehaviors/IconTintColor/IconTintColorBehavior.macios.cs

@@ -30,8 +30,13 @@ protected override void OnViewPropertyChanged(View sender, PropertyChangedEventA
 	protected override void OnAttachedTo(View bindable, UIView platformView)
 	{
 		base.OnAttachedTo(bindable, platformView);
+		
+		bindable.Loaded += OnBindableLoaded;
 
-		ApplyTintColor(platformView, bindable, TintColor);
+		if (ApplyOn is IconTintColorApplyOn.OnBehaviorAttachedTo)
+		{
+			ApplyTintColor(platformView, bindable, TintColor);
+		}
 
 		PropertyChanged += (s, e) =>
 		{
@@ -46,9 +51,27 @@ protected override void OnAttachedTo(View bindable, UIView platformView)
 	protected override void OnDetachedFrom(View bindable, UIView platformView)
 	{
 		base.OnDetachedFrom(bindable, platformView);
+		
+		bindable.Loaded -= OnBindableLoaded;
 
 		ClearTintColor(platformView, bindable);
 	}
+	
+	void OnBindableLoaded(object? sender, EventArgs e)
+	{
+		if (ApplyOn is not IconTintColorApplyOn.OnViewLoaded)
+		{
+			return;
+		}
+
+		if (sender is not View view
+		    || view.Handler?.PlatformView is not UIView platformView)
+		{
+			return;
+		}
+		
+		ApplyTintColor(platformView, view, TintColor);
+	}
 
 	static void ClearTintColor(UIView platformView, View element)
 	{

src/CommunityToolkit.Maui/Behaviors/PlatformBehaviors/IconTintColor/IconTintColorBehavior.shared.cs

@@ -1,16 +1,47 @@
 namespace CommunityToolkit.Maui.Behaviors;
 
+/// <summary>
+/// When to apply the status bar color and style.
+/// </summary>
+public enum IconTintColorApplyOn
+{
+	/// <summary>
+	/// Apply color when the behavior has been attached to the view.
+	/// </summary>
+	OnBehaviorAttachedTo,
+
+	/// <summary>
+	/// Apply color when the view has been loaded.
+	/// </summary>
+	OnViewLoaded
+}
+
 /// <summary>
 /// A behavior that allows you to tint an icon with a specified <see cref="Color"/>.
 /// </summary>
 public partial class IconTintColorBehavior : BasePlatformBehavior<View>
 {
+	/// <summary>
+	/// <see cref="BindableProperty"/> that manages the ApplyOn property.
+	/// </summary>
+	public static readonly BindableProperty ApplyOnProperty =
+		BindableProperty.Create(nameof(ApplyOn), typeof(IconTintColorApplyOn), typeof(IconTintColorBehavior), IconTintColorApplyOn.OnBehaviorAttachedTo);
+	
 	/// <summary>
 	/// Attached Bindable Property for the <see cref="TintColor"/>.
 	/// </summary>
 	public static readonly BindableProperty TintColorProperty =
 		BindableProperty.Create(nameof(TintColor), typeof(Color), typeof(IconTintColorBehavior), default);
 
+	/// <summary>
+	/// When the status bar color should be applied.
+	/// </summary>
+	public IconTintColorApplyOn ApplyOn
+	{
+		get => (IconTintColorApplyOn)GetValue(ApplyOnProperty);
+		set => SetValue(ApplyOnProperty, value);
+	}
+	
 	/// <summary>
 	/// Property that represents the <see cref="Color"/> that Icon will be tinted.
 	/// </summary>

src/CommunityToolkit.Maui/Behaviors/PlatformBehaviors/IconTintColor/IconTintColorBehavior.windows.cs

@@ -25,8 +25,12 @@ protected override void OnAttachedTo(View bindable, FrameworkElement platformVie
 	{
 		base.OnAttachedTo(bindable, platformView);
 
-		ApplyTintColor(platformView, bindable, TintColor);
+		if (ApplyOn is IconTintColorApplyOn.OnBehaviorAttachedTo)
+		{
+			ApplyTintColor(platformView, bindable, TintColor);
+		}
 
+		bindable.Loaded += OnBindableLoaded;
 		bindable.PropertyChanged += OnElementPropertyChanged;
 		this.PropertyChanged += (s, e) =>
 		{
@@ -50,8 +54,25 @@ protected override void OnDetachedFrom(View bindable, FrameworkElement platformV
 		base.OnDetachedFrom(bindable, platformView);
 
 		bindable.PropertyChanged -= OnElementPropertyChanged;
+		bindable.Loaded -= OnBindableLoaded;
 		RemoveTintColor(platformView);
 	}
+	
+	void OnBindableLoaded(object? sender, EventArgs e)
+	{
+		if (ApplyOn is not IconTintColorApplyOn.OnViewLoaded)
+		{
+			return;
+		}
+		
+		if (sender is not View view
+		    || view.Handler?.PlatformView is not FrameworkElement platformView)
+		{
+			return;
+		}
+		
+		ApplyTintColor(platformView, view, TintColor);
+	}
 
 	static bool TryGetButtonImage(WButton button, [NotNullWhen(true)] out WImage? image)
 	{