百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
F

FreshMvvm

> 编程语言
开源

FreshMvvm 是一款专为 Xamarin.Forms 设计的超轻量级 Mvvm 框架,旨在实现简单、灵活和易用。

589 stars0 点赞0 次浏览
访问官网GitHub

工具介绍

FreshMvvm 是一款专为 Xamarin.Forms 设计的超轻量级 Mvvm 框架,旨在实现简单、灵活和易用。

FreshMvvm.Maui

If you're looking for .NET MAUI version of FreshMvvm, aka FreshMvvm.Maui then please visit: https://github.com/XAM-Consulting/FreshMvvm.Maui

FreshMvvm for Xamarin.Forms

FreshMvvm is a super light Mvvm Framework designed specifically for Xamarin.Forms. It's designed to be Easy, Simple and Flexible.

How does it compare to other options?

  • It's super light and super simple
  • It's specifically designed for Xamarin.Forms
  • Designed to be easy to learn and develop (great when you are not ready for RxUI)
  • Uses a Convention over Configuration

Features

  • PageModel to PageModel Navigation
  • Automatic wiring of BindingContext
  • Automatic wiring of Page events (eg. appearing)
  • Basic methods (with values) on PageModel (init, reverseinit)
  • Built in IOC Container
  • PageModel Constructor Injection
  • Basic methods available in Model, like Alert
  • Built in Navigation types for SimpleNavigation, Tabbed and MasterDetail

Note Different to standard naming conventions, FreshMvvm uses Page and PageModel instead of View and ViewModel, this is inline with Xamarin.Forms using Pages Now we can use both the ViewModel naming conventions.

The Story

I (Michael Ridland) was part-way into a Xamarin Traditional application when Xamarin.Forms was released. I wanted to move the project onto Xamarin.Forms but on that project I was using MvvmCross. At that time MvvmCross had no support for Xamarin.Forms, so I had the option of 1) adapting MvvmCross, 2) finding an alternative or 3) rolling my own Mvvm. The best part about MvvmCross was it's two-way databinding to the native iOS/Android controls but since Xamarin.Forms already had the Databinding builtin, that wasn't useful and the size with MvvmCross was an overhead when I didn't require it. I also wasn't able to find an alternative that I could easily move to. So that I could keep it simple and flexible, I ended up rolling my own Mvvm.

It's grown up from this post on rolling your own Mvvm for Xamarin.Forms. I try hard to keep the simplicity of rolling your own Mvvm for Xamarin.Forms.

It was never a plan to create a framework but after presenting my Mvvm solution at a few events, I found many people wanted it and seemed to be really interested in it. Also considering I've been using this Framework in all my projects from the start of Xamarin.Forms I know that it works, so I created FreshMvvm and that's how it was born.

Conventions

This Framework, while simple, is also powerful and uses a Convention over Configuration style.

Note Different to standard naming conventions, FreshMvvm uses Page and PageModel instead of View and ViewModel, this is inline with Xamarin.Forms using Pages Now we can use both the ViewModel naming conventions.

  • A Page must have a corresponding PageModel, with naming important so a QuotePageModel must have a QuotePage The BindingContext on the page will be automatically set with the Model
  • A PageModel can have a Init method that takes a object
  • A PageModel can have a ReverseInit method that also take a object and is called when a model is poped with a object
  • PageModel can have dependancies automatically injected into the Constructor

Navigation

The Primary form of Navigation in FreshMvvm is PageModel to PageModel, this essentially means our views have no idea of Navigation.

So to Navigate between PageModels use:

csharp
await CoreMethods.PushPageModel(); // Pushes navigation stack
await CoreMethods.PushPageModel(null, true); // Pushes a Modal
await CoreMethods.PushPageModel (pm => pm.Quote = "Quote 23") // Pushes Navigation Stack and initializes the property 'Quote' with  value 'Quote 23'

The engine for Navigation in FreshMvvm is done via a simple interface, with methods for Push and Pop. Essentially these methods can control the Navigation of the application in any way they like.

csharp
public interface IFreshNavigationService
{
	Task PushPage(Page page, FreshBasePageModel model, bool modal = false);
	Task PopPage(bool modal = false);
}

Within the PushPage and PopPage you can do any type of navigation that you like, this can be anything from a simple navigation to a advanced nested navigation.

The Framework contains some built in Navigation containers for the different types of Navigation.

Basic Navigation - Built In
csharp
var page = FreshPageModelResolver.ResolvePageModel ();
var basicNavContainer = new FreshNavigationContainer (page);
MainPage = basicNavContainer;
Master Detail - Built In
csharp
var masterDetailNav = new FreshMasterDetailNavigationContainer ();
masterDetailNav.Init ("Menu");
masterDetailNav.AddPage ("Contacts", null);
masterDetailNav.AddPage ("Pages", null);
MainPage = masterDetailNav;
Tabbed Navigation - Built In
csharp
var tabbedNavigation = new FreshTabbedNavigationContainer ();
tabbedNavigation.AddTab ("Contacts", null);
tabbedNavigation.AddTab ("Pages", null);
MainPage = tabbedNavigation;
Implementing Custom Navigation

It's possible to setup any type of Navigation by implementing IFreshNavigationService.There's a sample of this in Sample Application named CustomImplementedNav.cs.

Sample Apps

  • Basic Navigation Sample
  • Tabbed Navigation Sample
  • MasterDetail Navigation Sample
  • Tabbed Navigation with MasterDetail Popover Sample (This is called the CustomImplementedNav in the Sample App)

Inversion of Control (IOC)

So that you don't need to include your own IOC container, FreshMvvm comes with a IOC container built in. It's using TinyIOC underneith, but with different naming to avoid conflicts.

To Register services in the container use Register:

csharp
FreshIOC.Container.Register();

To obtain a service use Resolve:

csharp
FreshIOC.Container.Resolve();

*This is also what drives constructor injection.

IOC Container Lifetime Registration Options

We now support a fluent API for setting the object lifetime of object inside the IOC Container.

csharp
// By default we register concrete types as 
// multi-instance, and interfaces as singletons
FreshIOC.Container.Register(); // Multi-instance
FreshIOC.Container.Register(); // Singleton 

// Fluent API allows us to change that behaviour
FreshIOC.Container.Register().AsSingleton(); // Singleton
FreshIOC.Container.Register().AsMultiInstance(); // Multi-instance

As you can see below the IFreshIOC interface methods return the IRegisterOptions interface.

csharp
public interface IFreshIOC
{
    object Resolve(Type resolveType);
    IRegisterOptions Register(RegisterType instance) where RegisterType : class;
    IRegisterOptions Register(RegisterType instance, string name) where RegisterType : class;
    ResolveType Resolve() where ResolveType : class;
    ResolveType Resolve(string name) where ResolveType : class;
    IRegisterOptions Register ()
        where RegisterType : class
        where RegisterImplementation : class, RegisterType;
}

The interface that's returned from the register methods is IRegisterOptions.

csharp
public interface IRegisterOptions
{
    IRegisterOptions AsSingleton();
    IRegisterOptions AsMultiInstance();
    IRegisterOptions WithWeakReference();
    IRegisterOptions WithStrongReference();
    IRegisterOptions UsingConstructor(Expression> constructor);
}

PageModel - Constructor Injection

When PageModels are pushed services that are in the IOC container can be pushed into the Constructor.

csharp
FreshIOC.Container.Register();

PageModel Important Methods

…

The CoreMethods

Each PageModel has a property called 'CoreMethods' which is automatically filled when a PageModel is pushed, it's the basic functions that most apps need like Alerts, Pushing, Poping etc.

csharp
public interface IPageModelCoreMethods
{
	Task DisplayAlert (string title, string message, string cancel);
	Task DisplayActionSheet (string title, string cancel, string destruction, params string[] buttons);
	Task DisplayAlert (string title, string message, string accept, string cancel);
	Task PushPageModel(object data, bool modal = false) where T : FreshBasePageModel;
	Task PopPageModel(bool modal = false);
	Task PopPageModel(object data, bool modal = false);
	Task PushPageModel() where T : FreshBasePageModel;
}

Page important methods

PageModel Init PropertyChanged

Sample PageModel

…

Multiple Navigation Services

It’s always been possible to do any type of navigation in FreshMvvm, with custom or advanced scenarios were done by implementing a custom navigation service. Even with this ability people found it a little hard to do advanced navigation scenarios in FreshMvvm. After I reviewed all the support questions that came in for FreshMvvm I found that the basic issue people had was they wanted to be able to use our built in navigation containers multiple times, two primary examples are 1) within a master detail having a navigation stack in a master and another in the detail 2) The ability to push modally with a new navigation container. In order to support both these scenarios I concluded that the FreshMvvm required the ability to have named NavigationServices so that we could support multiple NavigationService’s.

Using multiple navigation containers

Below we’re running two navigation stacks, in a single MasterDetail.

…

PushModally with new navigation stack

…

Switching out NavigationStacks on the Xamarin.Forms MainPage

There's some cases in Xamarin.Forms you might want to run multiple navigation stacks. A good example of this is when you have a navigation stack for the authentication and a stack for the primary area of your application.

To begin with we can setup some names for our navigation containers.

csharp
public class NavigationContainerNames
{
    public const string AuthenticationContainer = "AuthenticationContainer";
    public const string MainContainer = "MainContainer";
}

Then we can create our two navigation containers and assign to the MainPage.

csharp
var loginPage = FreshMvvm.FreshPageModelResolver.ResolvePageModel();
var loginContainer = new FreshNavigationContainer(loginPage, NavigationContainerNames.AuthenticationContainer);

var myPitchListViewContainer = new FreshTabbedNavigationContainer(NavigationContainerNames.MainContainer);

MainPage = loginContainer;

The Navigation Container will use the name passed as argument to register in this method

csharp
public FreshTabbedNavigationContainer(string navigationServiceName)
{
    NavigationServiceName = navigationServiceName;
    RegisterNavigation ();
}

protected void RegisterNavigation ()
{
    FreshIOC.Container.Register (this, NavigationServiceName);
}

Once we've set this up we can now switch out our navigation containers.

csharp
CoreMethods.SwitchOutRootNavigation(NavigationContainerNames.MainContainer);

That name will be resolved in this method to find the correct Navigation Container

csharp
public void SwitchOutRootNavigation (string navigationServiceName)
{
    IFreshNavigationService rootNavigation = FreshIOC.Container.Resolve (navigationServiceName);
}

Custom IOC Containers

The second major request for FreshMvvm 1.0 was to allow custom IOC containers. In the case that your application already has a container that you want to leverage.

Using a custom IOC container is very simple in that you only need to implement a single interface.

csharp
public interface IFreshIOC
{
    object Resolve(Type resolveType);
    void Register(RegisterType instance) where RegisterType : class;
    void Register(RegisterType instance, string name) where RegisterType : class;
    ResolveType Resolve() where ResolveType : class;
    ResolveType Resolve(string name) where ResolveType : class;
    void Register ()
        where RegisterType : class
        where Reg

Issues· 0 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

C#

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言