Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xamvvm/xamvvm
Simple MVVM (Model, ViewModel, View) Framework for .Net - Xamarin.Forms compatible
https://github.com/xamvvm/xamvvm
mvvm xamarin
Last synced: 30 days ago
JSON representation
Simple MVVM (Model, ViewModel, View) Framework for .Net - Xamarin.Forms compatible
- Host: GitHub
- URL: https://github.com/xamvvm/xamvvm
- Owner: xamvvm
- License: apache-2.0
- Created: 2015-09-08T15:21:43.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-10-18T13:38:31.000Z (about 2 years ago)
- Last Synced: 2024-09-27T09:38:10.460Z (3 months ago)
- Topics: mvvm, xamarin
- Language: C#
- Homepage:
- Size: 3.44 MB
- Stars: 122
- Watchers: 10
- Forks: 19
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-xamarin-forms - xamvvm ★120 - Xamarin.Forms compatible. (MVVM)
README
# 
# Simple, fast and lightweight MVVM Framework for Xamarin.Forms with fluent API [![AppVeyor][ci-img]][ci-link]
| Xamvvm.Core | Xamvvm.Forms | Xamvvm.Forms.RxUI | Xamvvm.Mock (Unit Tests) |
|:-------------------------------------:|:-------------------------------------:|:---------------------------------:|:---------------------------------:|
| [![NuGet][core-img]][core-link] | [![NuGet][forms-img]][forms-link] | [![NuGet][rx-img]][rx-link] | [![NuGet][mock-img]][mock-link] |
| [![NuGet][precore-img]][precore-link] | [![NuGet][preforms-img]][preforms-link] | [![NuGet][prerx-img]][prerx-link] | [![NuGet][premock-img]][premock-link] | |
## Features
- **Very Easy to use. Just mark your pages / models with empty interfaces `IBasePage` / `IBasePageModel`**
- **PageModel first oriented Navigation**
- **Automatic wiring of BindingContext (PageModels)**
- **Pages / PageModels caching** - more responsive UI experience!
- **You're not limited to any concrete implementation of Pages, PageModels**
- **Fluent style extensions methods to write less code**
- **Navigation inside `ContentView`**
- Helper classes with ready to use `INotifyPropertyChanged` implementation eg. `BasePageModel`
- Pages have override methods to respond / intercept navigation (eg. NavgationPushing, NavigationCanPush, etc.)
- Strongly typed classes / methods / messaging
- Dependency free ICommand implementation prevents multiple execution when previous execution not finished yet
## Getting Started
## Initialize the Framework
You have to create an instance of a IBaseFactory implementation and set it as the current factory to use
```C#
var factory = new XamvvmFormsFactory(this);
XamvvmCore.SetCurrentFactory(factory);
```
That's all :-)
The PageFactory will scan your assemblies at start up and link Pages and PageModels together according to the IBasePage definition on your Pages.
(You can also register your Pages manually if you want to. See Wiki)
## PageModel first navigation
All pushing and popping is always done from the PageModel and not from Pages
```C#
var pageToPush = this.GetPageFromCache();
await this.PushPageAsync(pageToPush);
// OR even shorter way:
this.PushPageFromCache();
```
You can pass an int action too that is executed on the Pagemodel before displaying the page
```C#
await this.PushPageAsync(pageToPush, (pm) => pm.Init("blue", Color.Blue));
// OR even shorter way:
var pageToPush = this.GetPageFromCache();
this.PushPageFromCache((pm) => pm.Init("blue", Color.Blue));
```
Popping is as easy
```C#
await this.PopPageAsync();
```
All a page has to do is derive from IBasePage with the PageModelType this Page should be linked to.For the above example calls the used classes would like this.
```C#
public partial class DetailPage : ContentPage, IBasePage
{
public DetailPage()
{
InitializeComponent();
}
}
```
```XML
```
```C#
public class DetailPageModel : BasePageModel
{
public void Init(string text, Color color)
{
Text = text;
Color = color;
}
public Color Color
{
get { return GetField(); }
set { SetField(value); }
}
public string Text
{
get { return GetField(); }
set { SetField(value); }
}
}
```
You don't have to inherit from BasePageModel it's just an included convinience class
Please look into the [Wiki](https://github.com/xamvvm/xamvvm/wiki) for Detailed Information
## Support
Please ask questions in [this issue](https://github.com/xamvvm/xamvvm/issues/16)
We also have a channel in the xamarin slack channel **#xamvvm** (invitation https://xamarinchat.herokuapp.com/)
## Example project
https://github.com/xamvvm/xamvvm/tree/master/examples
[ci-img]: https://img.shields.io/appveyor/ci/daniel-luberda/xamvvm.svg
[ci-link]: https://ci.appveyor.com/project/daniel-luberda/xamvvm
[core-img]: https://img.shields.io/nuget/v/Xamvvm.Core.svg
[core-link]: https://www.nuget.org/packages/Xamvvm.Core
[forms-img]: https://img.shields.io/nuget/v/Xamvvm.Forms.svg
[forms-link]: https://www.nuget.org/packages/Xamvvm.Forms
[rx-img]: https://img.shields.io/nuget/v/Xamvvm.Forms.RxUI.svg
[rx-link]: https://www.nuget.org/packages/Xamvvm.Forms.RxUI
[mock-img]: https://img.shields.io/nuget/v/Xamvvm.Mock.svg
[mock-link]: https://www.nuget.org/packages/Xamvvm.Mock
[precore-img]: https://img.shields.io/nuget/vpre/Xamvvm.Core.svg
[precore-link]: https://www.nuget.org/packages/Xamvvm.Core/prerelease
[preforms-img]: https://img.shields.io/nuget/vpre/Xamvvm.Forms.svg
[preforms-link]: https://www.nuget.org/packages/Xamvvm.Forms/prerelease
[prerx-img]: https://img.shields.io/nuget/vpre/Xamvvm.Forms.RxUI.svg
[prerx-link]: https://www.nuget.org/packages/Xamvvm.Forms.RxUI/prerelease
[premock-img]: https://img.shields.io/nuget/vpre/Xamvvm.Mock.svg
[premock-link]: https://www.nuget.org/packages/Xamvvm.Mock