Add TouchBehavior

.editorconfig

@@ -46,6 +46,12 @@ csharp_style_namespace_declarations = file_scoped:error
 # CS4014: Because this call is not awaited, execution of the current method continues before the call is completed
 dotnet_diagnostic.CS4014.severity = error
 
+# CS2012: ValueTask instances returned from member invocations are intended to be directly awaited. Attempts to consume a ValueTask multiple times or to directly access one's result before it's known to be completed may result in an exception or corruption. Ignoring such a ValueTask is likely an indication of a functional bug and may degrade performance.
+dotnet_diagnostic.CS2012.severity = error
+
+# CS1998 : This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.
+dotnet_diagnostic.CS1998.severity = error
+
 # Remove explicit default access modifiers
 dotnet_style_require_accessibility_modifiers = omit_if_default:error
 

samples/CommunityToolkit.Maui.Sample/AppShell.xaml.cs

@@ -46,6 +46,7 @@ public partial class AppShell : Shell
 		CreateViewModelMapping<SetFocusOnEntryCompletedBehaviorPage, SetFocusOnEntryCompletedBehaviorViewModel, BehaviorsGalleryPage, BehaviorsGalleryViewModel>(),
 		CreateViewModelMapping<StatusBarBehaviorPage, StatusBarBehaviorViewModel, BehaviorsGalleryPage, BehaviorsGalleryViewModel>(),
 		CreateViewModelMapping<TextValidationBehaviorPage, TextValidationBehaviorViewModel, BehaviorsGalleryPage, BehaviorsGalleryViewModel>(),
+		CreateViewModelMapping<TouchBehaviorPage, TouchBehaviorViewModel, BehaviorsGalleryPage, BehaviorsGalleryViewModel>(),
 		CreateViewModelMapping<UriValidationBehaviorPage, UriValidationBehaviorViewModel, BehaviorsGalleryPage, BehaviorsGalleryViewModel>(),
 		CreateViewModelMapping<UserStoppedTypingBehaviorPage, UserStoppedTypingBehaviorViewModel, BehaviorsGalleryPage, BehaviorsGalleryViewModel>(),
 

samples/CommunityToolkit.Maui.Sample/CommunityToolkit.Maui.Sample.csproj

@@ -42,7 +42,6 @@
 
     <!-- Images -->
     <MauiImage Include="Resources\Images\*" />
-    <MauiImage Update="Resources\Images\splash.svg" BaseSize="128,128" Color="#512BD4" Resize="false" />
 
     <!-- Raw Assets (also remove the "Resources\Raw" prefix) -->
     <MauiAsset Include="Resources\Raw\**" LogicalName="%(RecursiveDir)%(Filename)%(Extension)" />

samples/CommunityToolkit.Maui.Sample/MauiProgram.cs

@@ -119,10 +119,11 @@ static void RegisterViewsAndViewModels(in IServiceCollection services)
 		services.AddTransientWithShellRoute<RequiredStringValidationBehaviorPage, RequiredStringValidationBehaviorViewModel>();
 		services.AddTransientWithShellRoute<SelectAllTextBehaviorPage, SelectAllTextBehaviorViewModel>();
 		services.AddTransientWithShellRoute<SetFocusOnEntryCompletedBehaviorPage, SetFocusOnEntryCompletedBehaviorViewModel>();
+		services.AddTransientWithShellRoute<StatusBarBehaviorPage, StatusBarBehaviorViewModel>();
 		services.AddTransientWithShellRoute<TextValidationBehaviorPage, TextValidationBehaviorViewModel>();
+		services.AddTransientWithShellRoute<TouchBehaviorPage, TouchBehaviorViewModel>();
 		services.AddTransientWithShellRoute<UriValidationBehaviorPage, UriValidationBehaviorViewModel>();
 		services.AddTransientWithShellRoute<UserStoppedTypingBehaviorPage, UserStoppedTypingBehaviorViewModel>();
-		services.AddTransientWithShellRoute<StatusBarBehaviorPage, StatusBarBehaviorViewModel>();
 
 		// Add Converters Pages + ViewModels
 		services.AddTransientWithShellRoute<BoolToObjectConverterPage, BoolToObjectConverterViewModel>();

samples/CommunityToolkit.Maui.Sample/Pages/Behaviors/TouchBehaviorPage.xaml

@@ -0,0 +1,186 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<pages:BasePage
+    x:Class="CommunityToolkit.Maui.Sample.Pages.Behaviors.TouchBehaviorPage"
+    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
+    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
+    xmlns:mct="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
+    xmlns:pages="clr-namespace:CommunityToolkit.Maui.Sample.Pages"
+    xmlns:vm="clr-namespace:CommunityToolkit.Maui.Sample.ViewModels.Behaviors"
+    x:Name="Page"
+    x:DataType="vm:TouchBehaviorViewModel"
+    x:TypeArguments="vm:TouchBehaviorViewModel">
+
+    <ContentPage.Resources>
+        <ResourceDictionary>
+            <Style x:Key="SectionHeader" TargetType="Label">
+                <Setter Property="Margin" Value="0,16,0,6" />
+                <Setter Property="FontAttributes" Value="Bold" />
+                <Setter Property="HorizontalOptions" Value="Center" />
+                <Setter Property="FontSize" Value="Large" />
+            </Style>
+        </ResourceDictionary>
+    </ContentPage.Resources>
+
+    <ScrollView>
+        <VerticalStackLayout>
+
+            <Label HorizontalOptions="Center" HorizontalTextAlignment="Center"
+                   FontSize="Body"
+                   Text="{Binding TouchCount, StringFormat='Touches: {0}'}" />
+
+            <Label Style="{StaticResource SectionHeader}" Text="Image | Toggle" />
+            <Image HeightRequest="100" WidthRequest="100">
+                <Image.Behaviors>
+                    <mct:ImageTouchBehavior
+                        Command="{Binding Source={x:Reference Page}, Path=BindingContext.IncreaseTouchCountCommand}"
+                        DefaultImageSource="button.png"
+                        PressedImageSource="button_pressed.png" />
+                </Image.Behaviors>
+            </Image>
+
+            <Label Style="{StaticResource SectionHeader}" Text="Scale | Fade | Animated" />
+            <HorizontalStackLayout HorizontalOptions="CenterAndExpand" VerticalOptions="Center">
+                <HorizontalStackLayout.Behaviors>
+                    <mct:TouchBehavior
+                        DefaultAnimationDuration="250"
+                        DefaultAnimationEasing="{x:Static Easing.CubicInOut}"
+                        Command="{Binding Source={x:Reference Page}, Path=BindingContext.IncreaseTouchCountCommand}"
+                        PressedOpacity="0.6"
+                        PressedScale="0.8" />
+                </HorizontalStackLayout.Behaviors>
+
+                <ContentView
+                    HeightRequest="100"
+                    WidthRequest="10"
+                    BackgroundColor="Gold" />
+                <Label Text="The entire layout receives touches" VerticalOptions="Center" LineBreakMode="TailTruncation"/>
+                <ContentView
+                    HeightRequest="100"
+                    WidthRequest="10"
+                    BackgroundColor="Gold" />
+            </HorizontalStackLayout>
+
+            <Label Style="{StaticResource SectionHeader}" Text="Long Press | Hover" />
+
+            <Label
+                FontSize="Body"
+                HorizontalOptions="CenterAndExpand"
+                Text="{Binding LongPressCount, StringFormat='Long press count: {0}'}"
+                Margin="0,0,0,6" />
+            <HorizontalStackLayout
+                Padding="20"
+                Background="Black"
+                HorizontalOptions="CenterAndExpand">
+                <HorizontalStackLayout.Behaviors>
+                    <mct:TouchBehavior
+                        Command="{Binding Source={x:Reference Page}, Path=BindingContext.IncreaseTouchCountCommand}"
+                        HoveredBackgroundColor="{StaticResource Gray900}"
+                        HoveredScale="1.2"
+                        LongPressCommand="{Binding Source={x:Reference Page}, Path=BindingContext.IncreaseLongPressCountCommand}" />
+                </HorizontalStackLayout.Behaviors>
+                <Label
+                    FontSize="Large"
+                    Text="TITLE"
+                    TextColor="White"
+                    VerticalOptions="Start" />
+            </HorizontalStackLayout>
+
+            <Label Style="{StaticResource SectionHeader}" Text="Color | Rotation | Animated" />
+
+            <HorizontalStackLayout
+                Padding="20"
+                BackgroundColor="Gold"
+                HorizontalOptions="CenterAndExpand">
+
+                <HorizontalStackLayout.Behaviors>
+                    <mct:TouchBehavior
+                        DefaultAnimationDuration="500"
+                        Command="{Binding Source={x:Reference Page}, Path=BindingContext.IncreaseTouchCountCommand}"
+                        DefaultBackgroundColor="Gold"
+                        PressedBackgroundColor="Orange"
+                        PressedRotation="15" />
+
+                </HorizontalStackLayout.Behaviors>
+
+                <Label
+                    FontSize="Large"
+                    Text="TITLE"
+                    TextColor="White" />
+            </HorizontalStackLayout>
+
+            <Label Style="{StaticResource SectionHeader}" Text="Image | Native" />
+            <Border StrokeThickness="1">
+                <Image
+                    HeightRequest="100"
+                    Source="button.png"
+                    WidthRequest="100">
+                    <Image.Behaviors>
+                        <mct:TouchBehavior
+                            Command="{Binding Source={x:Reference Page}, Path=BindingContext.IncreaseTouchCountCommand}" />
+                    </Image.Behaviors>
+                </Image>
+            </Border>
+
+            <Label Style="{StaticResource SectionHeader}" Text="Nested effect" />
+
+            <ContentView
+                Padding="50"
+                Background="Yellow"
+                HeightRequest="200"
+                HorizontalOptions="Center"
+                WidthRequest="200">
+                <ContentView.Behaviors>
+                    <mct:TouchBehavior
+                        Command="{Binding Source={x:Reference Page}, Path=BindingContext.ParentClickedCommand}"/>
+                </ContentView.Behaviors>
+
+                <ContentView
+                    BackgroundColor="Red"
+                    HeightRequest="100"
+                    HorizontalOptions="Center"
+                    VerticalOptions="Center"
+                    WidthRequest="100">
+                    <ContentView.Behaviors>
+                        <mct:TouchBehavior
+                            Command="{Binding Source={x:Reference Page}, Path=BindingContext.ChildClickedCommand}" />
+                    </ContentView.Behaviors>
+                </ContentView>
+            </ContentView>
+
+            <Label Style="{StaticResource SectionHeader}" Text="Input transparency for nested layouts" />
+
+            <Border
+                Margin="20"
+                Padding="20,10"
+                BackgroundColor="Transparent"
+                StrokeShape="RoundRectangle, 10"
+                StrokeThickness="0">
+                <Border.Behaviors>
+                    <mct:TouchBehavior
+                        DefaultAnimationDuration="150"
+                        DefaultAnimationEasing="{x:Static Easing.CubicInOut}"
+                        Command="{Binding Source={x:Reference Page}, Path=BindingContext.IncreaseTouchCountCommand}"
+                        PressedBackgroundColor="LightGray"
+                        PressedOpacity="0.8"
+                        PressedScale="0.9"
+                        ShouldMakeChildrenInputTransparent="True" />
+                </Border.Behaviors>
+                <Grid
+                    BackgroundColor="Transparent"
+                    ColumnDefinitions="Auto, *"
+                    ColumnSpacing="10">
+                    <Ellipse
+                        BackgroundColor="#A4CF5B"
+                        HeightRequest="40"
+                        WidthRequest="40" />
+                    <VerticalStackLayout Grid.Column="1" VerticalOptions="Center">
+                        <Label FontSize="20" Text="Lorem Ipsum" />
+                        <Label FontSize="12"
+                               Text="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam gravida, sapien in volutpat ornare, magna dui condimentum dui, quis egestas tellus leo non nulla. Quisque sit amet neque dapibus, congue justo non, dapibus dolor." />
+                    </VerticalStackLayout>
+                </Grid>
+            </Border>
+        </VerticalStackLayout>
+    </ScrollView>
+</pages:BasePage>

samples/CommunityToolkit.Maui.Sample/Pages/Behaviors/TouchBehaviorPage.xaml.cs

@@ -0,0 +1,12 @@
+using CommunityToolkit.Maui.Sample.ViewModels.Behaviors;
+
+namespace CommunityToolkit.Maui.Sample.Pages.Behaviors;
+
+public partial class TouchBehaviorPage : BasePage<TouchBehaviorViewModel>
+{
+	public TouchBehaviorPage(TouchBehaviorViewModel viewModel)
+		: base(viewModel)
+	{
+		InitializeComponent();
+	}
+}

samples/CommunityToolkit.Maui.Sample/Pages/Essentials/SpeechToTextPage.xaml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8" ?>
 <pages:BasePage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
                 xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
                 xmlns:pages="clr-namespace:CommunityToolkit.Maui.Sample.Pages"

samples/CommunityToolkit.Maui.Sample/Pages/Views/Popup/PopupPositionPage.xaml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8" ?>
 <pages:BasePage x:Class="CommunityToolkit.Maui.Sample.Pages.Views.PopupPositionPage"
                 xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
                 xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"

samples/CommunityToolkit.Maui.Sample/Pages/Views/Popup/ShowPopupInOnAppearingPage.xaml.cs

@@ -1,4 +1,4 @@
-using CommunityToolkit.Maui.Sample.Models;
+using CommunityToolkit.Maui.Sample.Models;
 using CommunityToolkit.Maui.Sample.ViewModels.Views;
 using CommunityToolkit.Maui.Sample.Views.Popups;
 using CommunityToolkit.Maui.Views;

samples/CommunityToolkit.Maui.Sample/ViewModels/Behaviors/BehaviorsGalleryViewModel.cs

@@ -21,5 +21,9 @@ public class BehaviorsGalleryViewModel() : BaseGalleryViewModel(
 	SectionModel.Create<AnimationBehaviorViewModel>(nameof(AnimationBehavior), "Perform animation when a specified UI element event is triggered"),
 	SectionModel.Create<SelectAllTextBehaviorViewModel>(nameof(SelectAllTextBehavior), "Select all text inside the Entry or Editor control."),
 	SectionModel.Create<IconTintColorBehaviorViewModel>(nameof(IconTintColorBehavior), "Tint an icon with the selected color."),
-	SectionModel.Create<StatusBarBehaviorViewModel>(nameof(StatusBarBehavior), "Change the Status Bar color.")
-]);
+	SectionModel.Create<StatusBarBehaviorViewModel>(nameof(StatusBarBehavior), "Change the Status Bar color."),
+	SectionModel.Create<TouchBehaviorViewModel>(nameof(TouchBehavior),	"Alter a views appearance when responding to touch events (normal, pressed, hovered, long press).")
+])
+{
+
+}

samples/CommunityToolkit.Maui.Sample/ViewModels/Behaviors/TouchBehaviorViewModel.cs

@@ -0,0 +1,33 @@
+using CommunityToolkit.Mvvm.ComponentModel;
+using CommunityToolkit.Mvvm.Input;
+
+namespace CommunityToolkit.Maui.Sample.ViewModels.Behaviors;
+
+public partial class TouchBehaviorViewModel : BaseViewModel
+{
+	[ObservableProperty]
+	int touchCount, longPressCount;
+
+	static Task DisplayAlert(string title, CancellationToken token)
+		=> Shell.Current.DisplayAlert(title, null, "Ok").WaitAsync(token);
+
+	[RelayCommand]
+	static Task ParentClicked(CancellationToken token) 
+		=> DisplayAlert("Parent Clicked", token);
+
+	[RelayCommand]
+	static Task ChildClicked(CancellationToken token) 
+		=> DisplayAlert("Child Clicked", token);
+
+	[RelayCommand]
+	void IncreaseTouchCount()
+	{
+		TouchCount++;
+	}
+
+	[RelayCommand]
+	void IncreaseLongPressCount()
+	{
+		LongPressCount++;
+	}
+}

samples/CommunityToolkit.Maui.Sample/Views/Popups/XamlBindingPopup.xaml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8" ?>
 <mct:Popup xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
            xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
            x:Class="CommunityToolkit.Maui.Sample.Views.Popups.XamlBindingPopup"

src/CommunityToolkit.Maui.Core/Handlers/Popup/PopUpHandler.windows.cs

@@ -1,4 +1,4 @@
-using CommunityToolkit.Maui.Core.Extensions;
+using CommunityToolkit.Maui.Core.Extensions;
 using CommunityToolkit.Maui.Core.Views;
 using Microsoft.Maui.Handlers;
 using Microsoft.Maui.Platform;

src/CommunityToolkit.Maui.Core/Primitives/Defaults/ImageTouchBehaviorDefaults.shared.cs

@@ -0,0 +1,51 @@
+using System.ComponentModel;
+
+namespace CommunityToolkit.Maui.Core;
+
+/// <summary>
+/// Default Values for ImageTouchBehavior/>
+/// </summary>
+public static class ImageTouchBehaviorDefaults
+{
+	/// <summary>
+	/// Default Value for TouchBehavior <see cref="DefaultBackgroundImageSource"/>
+	/// </summary>
+	[EditorBrowsable(EditorBrowsableState.Never)]
+	public const object? DefaultBackgroundImageSource = null;
+
+	/// <summary>
+	/// Default Value for TouchBehavior <see cref="HoveredBackgroundImageSource"/>
+	/// </summary>
+	[EditorBrowsable(EditorBrowsableState.Never)]
+	public const object? HoveredBackgroundImageSource = null;
+
+	/// <summary>
+	/// Default Value for TouchBehavior <see cref="PressedBackgroundImageSource"/>
+	/// </summary>
+	[EditorBrowsable(EditorBrowsableState.Never)]
+	public const object? PressedBackgroundImageSource = null;
+
+	/// <summary>
+	/// Default Value for TouchBehavior <see cref="DefaultBackgroundImageAspect"/>
+	/// </summary>
+	[EditorBrowsable(EditorBrowsableState.Never)]
+	public const Aspect DefaultBackgroundImageAspect = Aspect.AspectFit;
+
+	/// <summary>
+	/// Default Value for TouchBehavior <see cref="HoveredBackgroundImageAspect"/>
+	/// </summary>
+	[EditorBrowsable(EditorBrowsableState.Never)]
+	public const Aspect HoveredBackgroundImageAspect = Aspect.AspectFit;
+
+	/// <summary>
+	/// Default Value for TouchBehavior <see cref="PressedBackgroundImageAspect"/>
+	/// </summary>
+	[EditorBrowsable(EditorBrowsableState.Never)]
+	public const Aspect PressedBackgroundImageAspect = Aspect.AspectFit;
+
+	/// <summary>
+	/// Default Value for TouchBehavior <see cref="ShouldSetImageOnAnimationEnd"/>
+	/// </summary>
+	[EditorBrowsable(EditorBrowsableState.Never)]
+	public const bool ShouldSetImageOnAnimationEnd = false;
+}