Vapolia.MauiGesture 1.0.3

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Vapolia.MauiGesture --version 1.0.3
NuGet\Install-Package Vapolia.MauiGesture -Version 1.0.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Vapolia.MauiGesture" Version="1.0.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Vapolia.MauiGesture --version 1.0.3
#r "nuget: Vapolia.MauiGesture, 1.0.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Vapolia.MauiGesture as a Cake Addin
#addin nuget:?package=Vapolia.MauiGesture&version=1.0.3

// Install Vapolia.MauiGesture as a Cake Tool
#tool nuget:?package=Vapolia.MauiGesture&version=1.0.3

NuGet
NuGet
Nuget

Supported Platforms

iOS, Android, Windows, Mac

Maui Gesture Effects

Add "advanced" gestures to Maui. Available on all views. Most gesture commands include the event position.

    <Label Text="Click here" IsEnabled="True" ui:Gesture.TapCommand="{Binding OpenLinkCommand}" />

Or in code:

    var label = new Label();
    Gesture.SetTapCommand(label, new Command(() => { /*your code*/ }));

Quick start

Add the above nuget package to your Maui project
then add this line to your maui app builder:

using MauiGestures;
...
builder.UseAdvancedGestures();

The views on which the gesture is applied should have the property IsEnabled="True" and InputTransparent="False" which activates user interaction on them.

Examples

Add Gesture.TapCommand on any supported xaml view:

        <StackLayout ui:Gesture.TapCommand="{Binding OpenLinkCommand}">
            <Label Text="1.Tap this to open an url"  />
        </StackLayout>

Declare the corresponding namespace:

    <ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             ...
             xmlns:ui="clr-namespace:MauiGestures;assembly=MauiGestures">

And in the viewmodel:

 public Command OpenLinkCommand => new Command(() =>
 {
     //do something
 });

Supported Gestures

  • TapCommand (ICommand or Command<CommandParameter>) if CommandParameter is set (see below)
  • DoubleTapCommand (ICommand) or Command<CommandParameter>
  • PanCommand (ICommand) or Command<CommandParameter>
  • LongPressCommand (ICommand) or Command<CommandParameter>
  • TapPointCommand (ICommand or Command<PointEventArgs>) where point is the absolute tap position relative to the view
  • DoubleTapPoinCommand (ICommand or Command<PointEventArgs>) where point is the absolute double tap position relative to the view
  • PanPointCommand (ICommand or Command<PanEventArgs>) where point is the absolute position relative to the view
  • LongPressPointCommand (ICommand or Command<PointEventArgs>) where point is the absolute tap position relative to the view
  • SwipeLeftCommand (ICommand) or Command<CommandParameter>
  • SwipeRightCommand (ICommand) or Command<CommandParameter>
  • SwipeTopCommand (ICommand) or Command<CommandParameter>
  • SwipeBottomCommand (ICommand) or Command<CommandParameter>
  • PinchCommand (Command<PinchEventArgs>) where PinchEventArg contains StartingPoints, CurrentPoints, Center, Scale, RotationRadians, RotationDegrees, Status

Properties:

  • IsPanImmediate Set to true to receive the PanCommand or PanPointCommand event on touch down, instead of after a minimum move distance. Default to false.

If you define the CommandParameter property, some gestures will callback the command with this parameter's value.
Example:

<ContentPage x:Name="ThePage" ...>
    <CollectionView ...>
        <CollectionView.ItemTemplate>
            <DataTemplate>
                    <Grid
                      ui:Gesture.TapCommand="{Binding BindingContext.MyItemTappedCommand, Source={x:Reference ThePage}}"
                      ui:Gesture.CommandParameter="{Binding .}">
                        <Label Text="{Binding SomeText}" />
                    </Grid>
            </DataTemplate>
        </CollectionView.ItemTemplate>
    </CollectionView>
</ContentPage

Examples

Some commands in XAML

<StackLayout ui:Gesture.TapCommand="{Binding OpenCommand}" IsEnabled="True">
    <Label Text="1.Tap this text to open an url" />
</StackLayout>

<StackLayout ui:Gesture.DoubleTapPointCommand="{Binding OpenPointCommand}" IsEnabled="True">
    <Label Text="2.Double tap this text to open an url" />
</StackLayout>

<BoxView
    ui:Gesture.PanPointCommand="{Binding PanPointCommand}"
    HeightRequest="200" WidthRequest="300"
    InputTransparent="False"
    IsEnabled="True"
     />

In the viewmodel:

public ICommand OpenCommand => new Command(async () =>
{
   //...
});

public ICommand OpenPointCommand => new Command<Point>(point =>
{
    PanX = point.X;
    PanY = point.Y;
    //...
});

public ICommand PanPointCommand => new Command<PanEventArgs>(args =>
{
    var point = args.Point;
    PanX = point.X;
    PanY = point.Y;
    //...
});

Exemple on a Grid containing an horizontal slider (set value on tap)

//Tap anywhere to set value
Gesture.SetTapPointCommand(this, new Command<Point>(pt =>
{
    var delta = (pt.X - Padding.Left) / (Width - Padding.Left - Padding.Right);
    if(delta<0 || delta>1)
        return;
    Value = (int)Math.Round((Maximum - Minimum) * delta);
}));

Limitations

Only commands are supported (PR welcome for events). No .NET events. So you must use the MVVM pattern.

Swipe commands are not supported on Windows because of a curious bug (event not received). If you find it, notify me! PinchCommand is not supported (yet) on Windows. PR welcome.

If your command is not receiving events, make sure that:

  • you used the correct handler. Ie: the LongPressPointCommand should be new Command<Point>(pt => ...)
  • you set IsEnabled="True" and InputTransparent="False" on the element

Windows requires the fall creator update.

Alt

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-android34.0 is compatible.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-ios17.2 is compatible.  net8.0-maccatalyst was computed.  net8.0-maccatalyst17.2 is compatible.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net8.0-windows10.0.19041 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.4-ci8278984061 147 3/14/2024
1.0.4-ci8250011298 65 3/12/2024
1.0.3 148 3/6/2024
1.0.2 183 1/26/2024
1.0.1 82 1/25/2024
1.0.1-ci7653921426 51 1/25/2024
1.0.1-ci7653640065 61 1/25/2024
1.0.0-ci2501125632 1,961 6/15/2022
1.0.0-ci2495271423 129 6/14/2022
1.0.0-ci2495052041 122 6/14/2022

1.0.2: UseAdvancedGestures instead of AddAdvancedGestures
           1.0.1: net6 to net8
           1.0.0: MAUI initial version