Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MassivePixel/YAXL.Redux
Predictable state container for Xamarin applications - Yet Another Xamarin Library
https://github.com/MassivePixel/YAXL.Redux
redux xamarin xamarin-library
Last synced: 3 months ago
JSON representation
Predictable state container for Xamarin applications - Yet Another Xamarin Library
- Host: GitHub
- URL: https://github.com/MassivePixel/YAXL.Redux
- Owner: MassivePixel
- License: mit
- Created: 2016-05-22T18:11:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-01-17T11:19:58.000Z (almost 6 years ago)
- Last Synced: 2024-08-02T18:03:58.410Z (3 months ago)
- Topics: redux, xamarin, xamarin-library
- Language: C#
- Size: 65.4 KB
- Stars: 19
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YAXL.Redux - Yet Another Xamarin Library | Redux
[](https://ci.appveyor.com/project/tpetrina/yaxl-redux)
[]()
[]()
## Intro
YAXL.Redux is a predictable state container for Xamarin and C# applications. It is a straightforward C# port of [redux](https://github.com/reactjs/redux) and aims at solving the exactly same problems.
Let's look at a concrete example:
### Actions using Types (POCO)
```csharp
// Actions are defined as actual types
public class IncrementAction {}
public class DecrementAction {}
public class SetCounterAction
{
public int Value { get; set; }
}
var counter = new Store((state, action) =>
{
if (action is IncrementAction)
return state + 1;
if (action is DecrementAction)
return state - 1;
if (action is SetCounterAction s)
return s.Value;
return state;
}, 0);
```
This creates a store that acts as a counter since it holds a single `int` value inside. Actions are handled by their type so it means:
* Class name is the action name
* The traditional `payload` is now defined as Public Properties inside the POCO
We can use it in our Xamarin app for consistent UI updates. If the UI is given as:
```xml
```
We would *connect* our store to our UI by projecting the necessary parts. Projection is done when the state is large and when a particular UI part only needs to know about a part of the entire app's state.
```csharp
public partial class CounterFormsPage : ContentPage
{
Store counter;
public CounterFormsPage()
{
InitializeComponent();
// counter creation ommitted
counter.Connect(mapStateToProps: state => new
{
count = state
}, propsChanged: props =>
{
CounterValue.Text = props.count.ToString();
});
}
private void Up_Clicked(object sender, EventArgs e) => counter.Dispatch(new IncrementAction());
private void Down_Clicked(object sender, EventArgs e) => counter.Dispatch(new DecrementAction());
private void SetTo42_Clicked(object sender, EventArgs e) => counter.Dispatch(new SetCounterAction { Value = 42 });
}
```
### Actions using string
Actions don't have to be defined as classes, they can be anything reducer can handle:
```csharp
var counter = new Store((state, action) =>
{
if (Equals(action, "+"))
return state + 1;
if (Equals(action, "-"))
return state - 1;
return state;
}, 0);
```
This creates a store that acts as a counter since it holds a single `int` value inside. It can handle two string based actions (actions can be any object) which serve as increment/decrement.
```csharp
public partial class CounterFormsPage : ContentPage
{
Store counter;
public CounterFormsPage()
{
InitializeComponent();
// counter creation ommitted
counter.Connect(mapStateToProps: state => new
{
count = state
}, propsChanged: props =>
{
CounterValue.Text = props.count.ToString();
});
}
private void Up_Clicked(object sender, EventArgs e) => counter.Dispatch("+");
private void Down_Clicked(object sender, EventArgs e) => counter.Dispatch("-");
}
```
## How to install?
Library can be built from sources or installed via NuGet.
PM> Install-Package YAXL.Redux -pre
## Little bit of extra reading
Blog posts about building this library:
1. [MVVM, data stores and Redux](https://www.massivepixel.co/old/20160523_MVVMAndRedux/)
2. [Implementing Redux in C#, Part 1](https://www.massivepixel.co/old/20160524_MVVMAndReduxPart2/)
## Similar libraries
1. [redux.NET](https://github.com/GuillaumeSalles/redux.NET)
2. [reducto](https://github.com/pshomov/reducto)
3. [ReduxSimple](https://github.com/Odonno/ReduxSimple)
## Pull requests and contributions
This is an open source project and we accept contributes. Please be mindful about style changes when submitting pull requests, we will reject those pull requests which are mostly style changes.
## License
YAXL.Redux is distributed under MIT licence