https://github.com/philipp2604/wpfnavigation

Region navigation for Wpf apps.
https://github.com/philipp2604/wpfnavigation

csharp mvvm navigation windows-desktop wpf wpf-navigation wpf-ui

Last synced: 2 months ago
JSON representation

Region navigation for Wpf apps.

• Host: GitHub
• URL: https://github.com/philipp2604/wpfnavigation
• Owner: philipp2604
• License: mit
• Created: 2024-08-14T04:42:55.000Z (4 months ago)
• Default Branch: master
• Last Pushed: 2024-10-08T17:44:20.000Z (3 months ago)
• Last Synced: 2024-10-10T14:04:43.843Z (2 months ago)
• Topics: csharp, mvvm, navigation, windows-desktop, wpf, wpf-navigation, wpf-ui
• Language: C#
• Homepage:
• Size: 118 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# WpfNavigation

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![build and test](https://github.com/philipp2604/WpfNavigation/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/philipp2604/WpfNavigation/actions/workflows/build-and-test.yml) ![GitHub Release](https://img.shields.io/github/v/release/philipp2604/WpfNavigation) [![NuGet Version](https://img.shields.io/nuget/v/philipp2604.WpfNavigation)](https://www.nuget.org/packages/philipp2604.WpfNavigation/)

## Description 

This library allows for simple adding of region navigation to WPF applications.

This means, you can navigate to different views (optionally with view models) in ContentControls.

## Download

You can acquire this library either directly via the NuGet package manager or by downloading it from the [NuGet Gallery](https://www.nuget.org/packages/philipp2604.WpfNavigation/).

## Quick Start

**I recommend having a look at the example project.**

1. Prepare your existing view by adding a `ContentControl` and registering it to the `RegionNavigationService` with a specific region key.

    - Registration of regions can be done by calling `RegionNavigationService.RegisterRegion(_YourRegionKey_, _YourContentControl_)`

    - Or by using the `NavigationService.NavigationRegion="_YourRegionKey_"` property inside the ContentControl's xaml.

2. Create the views that you want to navigate to.

3. Optionally, create view models for your views.

    - If needed, you can implement the `INavigationAware` interface in your view models, making them being notified when navigation occurs.

4. Register your views and view models to the `RegionContentService` with a specific content key.

    - Views-only are registered by calling `RegionContentService.RegisterContent<_YourViewType_>(_YourContentKey_)`.

    - If you want to register a view and a view model, you can call `RegionContentService.RegisterContent<_YourViewType_, _YourViewModelType_>(_YourContentKey_)`.

5. **Done!** You can now navigate to your views by simply calling `RegionNavigationService.Navigate(_YourRegionKey_, _YourContentKey_)`.

## Questions? Problems?

**Feel free to reach out!**

## Example screenshots

These screenshots show the example pages, included in the project.

![MainPage](./Screenshots/Screenshot1.PNG)

![MainPage](./Screenshots/Screenshot2.PNG)

## Ideas

* Add support for more Controls (Frames, ...).

* Add non-throwing methods, like 'TryNavigate'.

## Third Party Software / Packages

Please have a look at [THIRD-PARTY-LICENSES](./THIRD-PARTY-LICENSES.md) for all the awesome packages used in this library.

## License

This library is [MIT licensed](./LICENSE.txt).