Chinook.BackButtonManager.Uno
1.0.0
See the version list below for details.
dotnet add package Chinook.BackButtonManager.Uno --version 1.0.0
NuGet\Install-Package Chinook.BackButtonManager.Uno -Version 1.0.0
<PackageReference Include="Chinook.BackButtonManager.Uno" Version="1.0.0" />
paket add Chinook.BackButtonManager.Uno --version 1.0.0
#r "nuget: Chinook.BackButtonManager.Uno, 1.0.0"
// Install Chinook.BackButtonManager.Uno as a Cake Addin #addin nuget:?package=Chinook.BackButtonManager.Uno&version=1.0.0 // Install Chinook.BackButtonManager.Uno as a Cake Tool #tool nuget:?package=Chinook.BackButtonManager.Uno&version=1.0.0
Chinook.BackButtonManager
The Chinook.BackButtonManager
packages provide recipes to ease the handling of back buttons in .Net applications. It was designed for MVVM applications, but should work with other patterns too.
Cornerstones
- Highly Extensible
- Everything is interface-based to easily allow more implementations.
- A single framework can't cover everything. Our architecture is designed in a way that allows you to extend this foundation to support more use-cases.
- Simple
- The recipes from these packages are ultra-simple but are still complete enough to support edge cases.
Getting Started
Uno projects
BackButtonManager is especially well-integrated with Uno. Here is how to use it in a project which includes the Uno platform:
Add a package reference to
Chinook.BackButtonManager.Uno
.Create a single instance of a
BackButtonManager
which you will use throughout your project.var manager = new BackButtonManager();
In your app's Startup, add the source that the manager uses to detect back button presses:
// This must be executed on the dispatcher var source = new SystemNavigationBackButtonSource(); manager.AddSource(source);
Add handlers for each action you want to take when the back button is pressed:
manager.AddHandler(new BackButtonHandler( name: "TODO handler name", canHandle: () => CanYourMethodBeCalled(), handle: async ct => await YourMethod(ct) ));
Other projects
If your project does not use Uno, you can certainly use BackButtonManager! Here's how:
Add a package reference to
Chinook.BackButtonManager
.Create a single instance of a
BackButtonManager
which you will use throughout your project.var manager = new BackButtonManager();
You will need to create a source which implements the
IBackButtonSource
interface. In your app's Startup, add this source so that BackButtonManager can use it to detect back button presses.var source = new MyBackButtonSource(); manager.AddSource(source);
Add handlers for each action you want to take when the back button is pressed:
manager.AddHandler(new BackButtonHandler( name: "TODO handler name", canHandle: () => CanYourMethodBeCalled(), handle: async ct => await YourMethod(ct) ));
Features
Create back button sources
Using IBackButtonSource
, you can implement a back button source. You can see that as an abstraction of a button. You could create sources for things like the following.
- The hardware back button on Android.
- The escape key from your keyboard.
- The back button from your mouse.
Once you have a back button source, simply add it to a IBackButtonManager
using AddSource
.
Create a source from SystemNavigationManager
This can be useful for UWP or Uno.UI applications. The source is based on the SystemNavigationManager.BackRequested
event.
// This must be executed on the dispatcher
var source = new SystemNavigationBackButtonSource();
Create a custom back button source
The interface IBackButtonSource
is very simple. You can implement your own sources easily.
Create back button handlers
Using IBackButtonHandler
, you can create the objects that react to back requests. Handlers can be added to (or removed from) a IBackButtonManager
at any point.
Create global handlers
That's one of the main use-case of this recipe. You likely want to create a default action to perform when a back is requested.
Here is some code showing how to setup a IBackButtonManager
with a default handler in a context using Microsoft.Extensions.DependencyInjection and Chinook.Navigation.
public static IServiceCollection AddDefaultBackHandler(this IServiceCollection services)
{
return services
.AddSingleton<IBackButtonManager>(s =>
{
var manager = new BackButtonManager();
var sectionsNavigator = s.GetRequiredService<ISectionsNavigator>();
manager.AddHandler(new BackButtonHandler(
name: "DefaultSectionsNavigatorHandler",
canHandle: () => sectionsNavigator.CanNavigateBackOrCloseModal(),
handle: async ct => await sectionsNavigator.NavigateBackOrCloseModal(ct)));
return manager;
});
}
Create temporary handlers
This can be useful when your page has advances states or secondary views. Imagine having a drawer or side menu. When that secondary view is active, it is likely that you want your back button to dismiss that secondary view rather than navigating to the previous page.
public MainPageViewModel(IBackButtonManager manager)
{
var customHandler = new BackButtonHandler("CustomBackHandler",
// The handler will only be invoked when the side panel is open.
canHandle: () => IsSidePanelOpen,
// Close the side panel when a back is requested.
handle: async ct => IsSidePanelOpen = false
);
var subscription = manager.RegisterHandler(customHandler);
// Automatically remove the handler when this page gets disposed.
this.AddDisposable(subscription);
}
public bool IsSidePanelOpen
{
get => this.Get<bool>(initialValue: false);
set => this.Set(value);
}
💡 This sample shows a ViewModel written using Chinook.DynamicMvvm.
Specify an handler's priority
It is possible to specify a priority when calling IBackButtonManager.AddHandler
. The highest priority handlers will be evaluated first.
Contributing
Please read CONTRIBUTING.md for details on the process for contributing to this project.
Be mindful of our Code of Conduct.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. monoandroid11.0 is compatible. monoandroid12.0 is compatible. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Universal Windows Platform | uap10.0.19041 is compatible. |
Xamarin.iOS | xamarinios was computed. xamarinios10 is compatible. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Chinook.BackButtonManager.Abstractions (>= 1.0.0)
- Uno.UI (>= 4.0.7)
-
MonoAndroid 11.0
- Chinook.BackButtonManager.Abstractions (>= 1.0.0)
- Uno.UI (>= 4.0.7)
-
MonoAndroid 12.0
- Chinook.BackButtonManager.Abstractions (>= 1.0.0)
- Uno.UI (>= 4.0.7)
-
UAP 10.0.19041
- Chinook.BackButtonManager.Abstractions (>= 1.0.0)
-
Xamarin.iOS 1.0
- Chinook.BackButtonManager.Abstractions (>= 1.0.0)
- Uno.UI (>= 4.0.7)
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.1.5-feature.Uno5Update.2 | 184 | 11/2/2023 |
1.1.4 | 531 | 10/17/2023 |
1.1.3 | 21,336 | 11/1/2022 |
1.1.2 | 1,150 | 10/12/2022 |
1.1.1 | 924 | 9/21/2022 |
1.1.0 | 152 | 9/16/2022 |
1.0.0 | 1,167 | 8/24/2022 |
0.5.3 | 461 | 8/24/2022 |
0.5.2 | 437 | 8/23/2022 |
0.5.1 | 444 | 8/23/2022 |
0.5.0-dev.33 | 55,180 | 5/18/2022 |
0.5.0-dev.31 | 167 | 5/3/2022 |
0.5.0-dev.29 | 4,480 | 3/31/2022 |
0.4.0-dev.27 | 285 | 3/15/2022 |
0.3.0-dev.22 | 61,344 | 3/16/2021 |
0.2.0-dev.17 | 1,589 | 12/17/2020 |
0.2.0-dev.15 | 952 | 10/30/2020 |
0.2.0-dev.13 | 12,253 | 8/13/2020 |
0.2.0-dev.11 | 273 | 8/13/2020 |
0.2.0-dev.9 | 1,104 | 6/26/2020 |