An advanced, composable, functional reactive model-view-viewmodel framework for all .NET platforms that is inspired by functional reactive programming. ReactiveUI allows you to abstract mutable state away from your user interfaces, express the idea around a feature in one readable place and improve the testability of your application.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github feature: automatically draft release notes (#1721) Aug 16, 2018
benchmarks housekeeping: Updated the version of MSBuild.Sdk.Extras to the latest… Nov 6, 2018
integrationtests housekeeping: Fixed analyzers breaking other solutions (#1823) Oct 26, 2018
samples Housekeeping: ReactiveDemo hack around VS xaml designer issue with in… Nov 14, 2018
script consolidate files Sep 13, 2018
snippets housekeeping: fix default values for snippet variables (#1562) Feb 19, 2018
src Updated android versions. Moved some of the directory.build.props fil… Nov 16, 2018
tools/nuget househeeping: resolve broken CI infrastructure (#1587) Apr 24, 2018
.editorconfig housekeeping: Added Code Analyzers (#1749) Oct 10, 2018
.gitattributes updated .gitignore/.gitattributes from latest at github/gitignore Jan 23, 2016
.gitignore feature: bring reactiveui.fody into the main project (#1503) Jun 10, 2018
.hgeol Merge (again). Jan 13, 2016
CODE_OF_CONDUCT.md housekeeping: move the code of conduct to the website (#1479) Sep 7, 2017
CONTRIBUTING.md fix: use netstandard 2.0 compatible version of splat (#1579) Apr 30, 2018
LICENSE feature: what if we were licensed under MIT? (#1602) (#1608) May 1, 2018
README.md housekeeping: Update shields.io downloads badge (#1838) Nov 15, 2018
SignPackages.json Update to sign service v2 (#1543) Nov 29, 2017
SignPackages.ps1 consolidate files Sep 13, 2018
azure-pipelines.yml Update azure-pipelines.yml Nov 8, 2018
build.cake Housekeeping: Allow explicit specification of VS and MSBuild path (#1821 Oct 17, 2018
build.cmd Migrate to VSTS (#1613) May 11, 2018
directory.build.props Updated android versions. Moved some of the directory.build.props fil… Nov 16, 2018
reactiveui.ruleset housekeeping: Added Code Analyzers (#1749) Oct 10, 2018
stylecop.json housekeeping: Added Code Analyzers (#1749) Oct 10, 2018
version.json refactor: Remove ReactiveCommand abstract class. (#1836) Nov 8, 2018

README.md

NuGet Stats Build Status Coverage Status #yourfirstpr FOSSA Status



What is ReactiveUI?

ReactiveUI is a composable, cross-platform model-view-viewmodel framework for all .NET platforms that is inspired by functional reactive programming which is a paradigm that allows you to abstract mutable state away from your user interfaces and express the idea around a feature in one readable place and improve the testability of your application.

🔨 Get Started 🛍 Install Packages 🎞 Watch Videos 🎓 View Samples 🎤 Discuss ReactiveUI

Introduction to Reactive Programming

Long ago, when computer programming first came to be, machines had to be programmed quite manually. If the technician entered the correct sequence of machine codes in the correct order, then the resulting program behavior would satisfy the business requirements. Instead of telling a computer how to do its job, which error-prone and relies too heavily on the infallibility of the programmer, why don't we just tell it what it's job is and let it figure the rest out?

ReactiveUI is inspired by the paradigm of Functional Reactive Programming, which allows you to model user input as a function that changes over time. This is super cool because it allows you to abstract mutable state away from your user interfaces and express the idea around a feature in one readable place whilst improving application testability. Reactive programming can look scary and complex at first glance, but the best way to describe reactive programming is to think of a spreadsheet:

  • Three cells, A, B, and C.
  • C is defined as the sum of A and B.
  • Whenever A or B changes, C reacts to update itself.

That's reactive programming: changes propagate throughout a system automatically. Welcome to the peanut butter and jelly of programming paradigms. For further information please watch the this video from the Xamarin Evolve conference - Why You Should Be Building Better Mobile Apps with Reactive Programming by Michael Stonis.

Packages Installation

Install the following packages to start building your own ReactiveUI app. Note: some of the platform-specific packages are required. This means your app won't perform as expected until you install the packages properly. See the Installation docs page for more info.

Target Platform Required ReactiveUI Packages Events Packages
Class library ReactiveUI None
Unit testing library ReactiveUI.Testing None
Universal Windows Platform ReactiveUI ReactiveUI.Events
Windows Presentation Foundation ReactiveUI.WPF ReactiveUI.Events.WPF
Windows Forms ReactiveUI.WinForms ReactiveUI.Events.WinForms
Xamarin.Forms library ReactiveUI.XamForms ReactiveUI.Events.XamForms
Xamarin.Android ReactiveUI.AndroidSupport ReactiveUI.Events
Xamarin.Mac ReactiveUI ReactiveUI.Events
Xamarin.iOS ReactiveUI ReactiveUI.Events
AvaloniaUI Avalonia.ReactiveUI None

A Compelling Example

Let’s say you have a text field, and whenever the user types something into it, you want to make a network request which searches for that query.

public interface ISearchViewModel
{
    string SearchQuery { get; set; }	 
    ReactiveCommand<string, IEnumerable<SearchResult>> Search { get; }
    IEnumerable<SearchResult> SearchResults { get; }
}

Define under what conditions a network request will be made

We're describing here, in a declarative way, the conditions in which the Search command is enabled. Now our Command IsEnabled is perfectly efficient, because we're only updating the UI in the scenario when it should change.

var canSearch = this.WhenAnyValue(x => x.SearchQuery, query => !string.IsNullOrWhiteSpace(query));

Make the network connection

ReactiveCommand has built-in support for background operations and guarantees that this block will only run exactly once at a time, and that the CanExecute will auto-disable and that property IsExecuting will be set accordingly whilst it is running.

Search = ReactiveCommand.CreateFromTask(_ => searchService.Search(this.SearchQuery), canSearch);

Update the user interface

ReactiveCommands are themselves IObservables, whose values are the results from the async method, guaranteed to arrive on the UI thread. We're going to take the list of search results that the background operation loaded, and turn them into our SearchResults property declared as ObservableAsPropertyHelper<T>.

_searchResults = Search.ToProperty(this, x => x.SearchResults);

Handling failures

Any exception thrown from the ReactiveCommand.CreateFromTask gets piped to the ThrownExceptions Observable. Subscribing to this allows you to handle errors on the UI thread.

Search.ThrownExceptions.Subscribe(error => { /* Handle exceptions. */ });

Throttling network requests and automatic search execution behaviour

Whenever the Search query changes, we're going to wait for one second of "dead airtime", then automatically invoke the subscribe command.

this.WhenAnyValue(x => x.SearchQuery)
    .Throttle(TimeSpan.FromSeconds(1), RxApp.MainThreadScheduler)
    .InvokeCommand(Search);

Binding our ViewModel to the platform-specific UI

ReactiveUI fully supports XAML markup bindings, but we have more to offer. ReactiveUI Bindings work on all platforms, including Xamarin Native and Windows Forms, and operate the same. Those bindings are strongly typed, and renaming a ViewModel property, or a control in the UI layout without updating the binding, the build will fail.

this.WhenActivated(cleanup => 
{
    this.Bind(ViewModel, x => x.SearchQuery, x => x.TextBox)
        .DisposeWith(cleanup);
    this.OneWayBind(ViewModel, x => x.SearchResults, x => x.ListView)
        .DisposeWith(cleanup);
    this.BindCommand(ViewModel, x => x.Search, x => x.Button)
        .DisposeWith(cleanup);
});

Support

If you have a question, please see if any discussions in our GitHub issues or Stack Overflow have already answered it.

If you want to discuss something or just need help, here is our Slack room where there are always individuals looking to help out!

If you are twitter savvy you can tweet #reactiveui with your question and someone should be able to reach out and help also.

If you have discovered a 🐜 or have a feature suggestion, feel free to create an issue on GitHub.

Contribute

ReactiveUI is developed under an OSI-approved open source license, making it freely usable and distributable, even for commercial use. Because of our Open Collective model for funding and transparency, we are able to funnel support and funds through to our contributors and community. We ❤ the people who are involved in this project, and we’d love to have you on board, especially if you are just getting started or have never contributed to open-source before.

So here's to you, lovely person who wants to join us — this is how you can support us:

We're also looking for people to assist with code reviews of ReactiveUI contributions. If you're experienced with any of the below technologies, you can join the team and receive notifications:

.NET Foundation

ReactiveUI is part of the .NET Foundation. Other projects that are associated with the foundation include the Microsoft .NET Compiler Platform ("Roslyn") as well as the Microsoft ASP.NET family of projects, Microsoft .NET Core & Xamarin Forms.

Core Team


Geoffrey Huntley

Sydney, Australia


Kent Boogaart

Adelaide, Australia


Olly Levett

London, United Kingdom


Paul Betts

San Francisco, USA


Brendan Forster

Melbourne, Australia


Oren Novotny

New York, USA


Glenn Watson

Washington, USA

Core Team

Learning Team

Android Team

Apple TV Team

Dot Net Core Team

Fody Team

iOS Team

Mac Team

Tizen Team

UWP Team

Web Assembly Team

WinForms Team

WPF Team

Xamarin Forms Team

Alumni

Sponsorship

The core team members, ReactiveUI contributors and contributors in the ecosystem do this open source work in their free time. If you use ReactiveUI a serious task, and you'd like us to invest more time on it, please donate. This project increases your income/productivity too. It makes development and applications faster and it reduces the required bandwidth.

This is how we use the donations:

  • Allow the core team to work on ReactiveUI
  • Thank contributors if they invested a large amount of time in contributing
  • Support projects in the ecosystem that are of great value for users
  • Support projects that are voted most (work in progress)
  • Infrastructure cost
  • Fees for money handling

Backers

Become a backer and get your image on our README on Github with a link to your site.

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site.