Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/panoukos41/navigation
A project for key to view navigation using ReactiveUI while providing ViewModel creation and navigation aware interface.
https://github.com/panoukos41/navigation
android csharp dotnet mvvm netstandard reactiveui uwp wpf wui xamarin
Last synced: 26 days ago
JSON representation
A project for key to view navigation using ReactiveUI while providing ViewModel creation and navigation aware interface.
- Host: GitHub
- URL: https://github.com/panoukos41/navigation
- Owner: panoukos41
- License: mit
- Created: 2021-08-08T16:51:54.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-19T08:28:10.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T01:52:17.845Z (about 1 month ago)
- Topics: android, csharp, dotnet, mvvm, netstandard, reactiveui, uwp, wpf, wui, xamarin
- Language: C#
- Homepage:
- Size: 397 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Navigation
[](https://github.com/panoukos41/navigation/actions/workflows/release.yaml)
[](https://www.nuget.org/packages/P41.Navigation)
[](https://github.com/panoukos41/navigation/blob/main/LICENSE.md)
A project for key to view navigation using [ReactiveUI](https://github.com/reactiveui/ReactiveUI) and [Flurl](https://github.com/tmenier/Flurl).
## Platforms
| Platform | TFM |
|-------------------|--------------------------|
| .NET Standard 2.0 | netstandard2.0 |
| .NET 6.0 | net6.0 |
| .NET 6.0 Android | net6.0-android |
| .NET 6.0 WPF | net6.0-windows7.0 |
| .NET 6.0 WinUI | net6.0-windows10.0.19041 |
| UWP 16299 | uap10.0.19041 |
## Installation
> Replace `X` with the version you want!
### .NET CLI
```csharp
dotnet add package P41.Navigation --version X
```
### Package Reference
```csharp
```
## Getting Started
You get started by configuring the `NavigationHost` for a platform:
### UWP
```csharp
// Application (App.xaml.cs in sample)
services.AddSingleton(sp =>
new NavigationHost()
.Map("page1", static () => typeof(Page1))
.Map("page2/{}", static () => new Page2()) // {} means parameter.
.Map("page3", static () => typeof(Page3)));
// At the end of Application OnLaunched
Window.Current.Activate();
Services.Resolve().Navigate("page1/100");
```
### Android
```csharp
// Application (AndroidApp in sample)
services.AddSingleton(sp =>
new NavigationHost()
.Map("page1", static () => new Page1())
.Map("page2/{}", static () => new Page2()) // {} means parameter.
.Map("page3", static () => new Page3())
);
// Main Activity (Shell in sample) at the end of OnCreate
host.SetFragmentManager(SupportFragmentManager)
.SetFragmentContainerId(R.Id.MainContainer)
.Navigate("page1");
```
### All targets plus .NET 6.0 or .NET Standard 2.0
Then from your code you call navigation methods:
```csharp
// Shared ViewModel constructor
Navigate = ReactiveCommand.Create(page =>
{
this.Navigate(page);
});
GoBack = ReactiveCommand.Create(_ =>
{
this.GoBack());
}
```
You also register code to run on NavigatedTo and NavigatingFrom similar to ReactiveUI activation.
```csharp
this.WhenNavigated((Flurl.Url url, CompositeDisposable d) =>
{
});
```
When the ViewModel is being NavigatedFrom `Dispose()` is called on the `CompositeDisposable`.
There are also samples in the [samples](./samples) folder that you should see and try!
## Build
Install [Visual Studio 2022 Preview](https://visualstudio.microsoft.com/vs/preview) and [.NET 6.0](https://dotnet.microsoft.com/download/dotnet/6.0)
Clone the project and open the solution then you just build the whole solution or the specific `projects/solution folder` you want to build.
## Contribute
Contributions are welcome and appreciated, before you create a pull request please open a [GitHub Issue](https://github.com/panoukos41/navigation/issues/new) to discuss what needs changing and or fixing if the issue doesn't exist!