Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grofit/bindingsrx
A 2 way binding system for unity using unirx
https://github.com/grofit/bindingsrx
bindings csharp rx unirx unity unity-ui unity3d
Last synced: 17 days ago
JSON representation
A 2 way binding system for unity using unirx
- Host: GitHub
- URL: https://github.com/grofit/bindingsrx
- Owner: grofit
- License: mit
- Created: 2017-03-08T09:04:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-03T19:40:33.000Z (5 months ago)
- Last Synced: 2024-10-10T11:10:58.305Z (about 1 month ago)
- Topics: bindings, csharp, rx, unirx, unity, unity-ui, unity3d
- Language: C#
- Size: 6.73 MB
- Stars: 120
- Watchers: 17
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# BindingsRx
BindingsRx is a one or two way binding system for unity using unirx.
[](https://discord.gg/bS2rnGz)
It allows you to write more succinct code while showing intent for properties which are bound to other properties, and looks something like this:
```c#
myInputField.BindTextTo(someReactiveProperty);
// Changing myInputField.text will update someReactiveProperty and vice versa
```
## Dependencies
- [UniRx](https://github.com/neuecc/UniRx)
## Features
- Supports one and two way binding
- Helpers for creating your own custom bindings
- Works with `ReactiveProperty` and regular values
- Supports custom processing on binding via `IFilter` interface
- Simplifies complex UI interactions, such as binding dropdown options
As mentioned it works with the unirx `ReactiveProperty` but does not need them, so for example if I had a reactive property I could do:
```c#
var myReactiveProperty = new ReactiveProperty(1.0f);
mySlider.BindValueTo(myReactiveProperty);
```
However if I was working with a 3rd party library I may not have ReactiveProperty objects, so for that I would do:
```c#
var myNormalValue = 1.0f;
mySlider.BindValueTo(() => myNormalValue, x => myNormalValue = x);
```
You can also specify if you want one way or two way bindings explicitly.
```c#
var myReactiveProperty = new ReactiveProperty(1.0f);
mySlider.BindValueTo(myReactiveProperty, BindingTypes.OneWay);
```
Here is an example of making a dropdown in the UI bind to a reactive collection:
```c#
var exampleOptions = new ReactiveCollection();
exampleOptions.Add("Option 1");
exampleOptions.Add("Option 2");
exampleOptions.Add("Some Other Option");
someDropdownUIElement.BindOptionsTo(exampleOptions);
```
## Installation
You can take the unitypackage installation file from the relevent release.
## Quick Start
- Install the above package
- Install UniRx
## Running Examples
If you want to run the examples then just clone it and open the unity project in the `src` folder, then run the examples, I will try to add to as the library matures.
There are also a suite of tests which are being expanded as the project grows.
## Docs
See the docs folder for more information. (This will grow)
## Other Blurbs
If you like design patterns and practices then there is also a ECS framework built on unirx which can be found @ [grofit/ecsrx](https://github.com/grofit/ecsrx).