jspuij / Cortex.Net

State management like MobX for .NET and Blazor
https://jspuij.github.io/Cortex.Net.Docs
MIT License
81 stars 11 forks source link

Buy Me A Coffee

Cortex.Net

Cortex.Net

State management like MobX for .NET

NuGet installation

To install the main library, install the the Cortex.Net NuGet package. The main library allows you to compose observable reactive state yourself.

PM> Install-Package Cortex.Net

If you want to install the Blazor bindings, they are in a separate package:

Install the Cortex.Net.Blazor NuGet package:

PM> Install-Package Cortex.Net.Blazor

Add to FodyWeavers.xml

To make life easier Cortex.Net supports weaving to create transparent observable state. To do this you need to create a FodyWeavers.xml file and add it to your project. Add <Cortex.Net /> to FodyWeavers.xml

<Weavers>
  <Cortex.Net />
</Weavers>

Introduction

Cortex.Net is a library that makes state management simple and scalable by transparently applying functional reactive programming (TFRP). It is more or less a direct port of the excellent MobX library. As C# has Class-based inheritance versus the Prototype-based inheritance model of JavaScript, porting the library introduced some unique challenges. These are mostly solved by Weaving your library of state objects.

The philosophy behind Cortex.Net is very simple:

Anything that can be derived from the application state, should be derived. Automatically.

which includes the UI, data serialization, server communication, etc.

Blazor and Cortex.Net together are a powerful combination. Blazor renders the application state by providing mechanisms to translate it into a tree of renderable components. Cortex.Net provides the mechanism to store and update the application state that Blazor then uses.

Cortex.Net unidirectional flow

Both Blazor and Cortex.Net provide optimal and unique solutions to common problems in application development. Blazor provides mechanisms to optimally render UI by using a virtual DOM that reduces the number of costly DOM mutations. Cortex.Net provides mechanisms to optimally synchronize application state with your Blazor components by using a reactive virtual dependency state graph that is only updated when strictly needed and is never stale.

Documentation

Documentation for this project is available at https://jspuij.github.io/Cortex.Net.Docs.