R3Utility.ObservableCollections 0.3.0

R3Utility

A utility library for Cysharp/R3 that provides enhanced reactive programming capabilities, focusing on validation, property binding, and UI event observation.

🚨 Breaking Changes (v0.3.0)

Starting from version 0.3.0, ObservableCollectionsExtensions has been moved to a separate package: R3Utility.ObservableCollections. If you were using ObserveElementProperty, please install the new package and update your imports accordingly.

dotnet add package R3Utility.ObservableCollections

using R3Utility.ObservableCollections;

Features

Two-Way Binding Extensions

• Convert INotifyPropertyChanged properties to BindableReactiveProperty
• Automatic value propagation in both directions
• Support for deep property path binding (up to 3 levels)

Reactive Validation

• Combine multiple boolean observables with various logical operations
• Support for creating executable command sources based on validation states

Observable Element Property Monitoring (R3Utility.ObservableCollections)

• Observe changes in specific properties of elements within a collection.
• Customizable option, pushCurrentValueOnSubscribe to control initial value emission.
• Support for deep property path binding (up to 3 levels)

WinForms UI Event Observables (R3Utility.WinForms)

• Convert common UI events into observables
• Supports TextBox, Button, CheckBox, ComboBox, and Control drag-and-drop events

API Reference

ReactivePropertyExtensions

ReactiveValidationHelper

ObservableCollectionsExtensions(R3Utility.ObservableCollections)

WinForms UIComponentExtensions (R3Utility.WinForms)

Usage Examples

Two-Way Binding

// Create a BindableReactiveProperty<T> that is two-way bound
BindableReactiveProperty<string> name = item.ToTwoWayBindableReactiveProperty(x => x.Name);

// This will also update the Name property of the item object
name.Value = "X"; //item.Name = "X"

// This will also update the Value property of the BindableReactiveProperty
item.Name = "Y"; //name.Value = "Y"


// Deep property path binding
BindableReactiveProperty<string> nestedProperty = viewModel.ToTwoWayBindableReactiveProperty(
    x => x.User,
    x => x.Profile,
    x => x.DisplayName
);

Validation Helpers

// Combine multiple validation states
Observable<bool> isValid = ReactiveValidationHelper.CombineLatestValuesAreAllTrue(
      emailValidation,
      passwordValidation,
      termsAccepted
);

// Create executable command source
Observable<bool> canExecute = ReactiveValidationHelper.CreateCanExecuteSource(
      emailProperty,
      passwordProperty
);
command = canExecute.ToReactiveCommand();

Observing Properties in a Collection

using ObservableCollections;
using R3;
using R3Utility.ObservableCollections;

ObservableList<Item> collection = [];
Item item1 = new() { Name = "foo" };

collection.Add(item1);
var disposable = collection.ObserveElementProperty(x => x.Name, pushCurrentValueOnSubscribe: false)
                           .Subscribe(property => Console.WriteLine($"Instance:{property.Instance}, propertyName:{property.PropertyName}, Value:{property.Value}"));
        
//Changes are output. `Instance:WpfApp1.Item, propertyName:Name, Value:bar`
item1.Name = "bar";

disposable.Dispose();

Installation

dotnet add package R3Utility
dotnet add package R3Utility.ObservableCollections
dotnet add package R3Utility.WinForms

License

R3Utility is distributed under a free and open-source license. Feel free to use it in your projects!

Contributions

We welcome contributions to the R3Utility project! If you have any suggestions, bug reports, or feature requests, please feel free to open an issue or submit a pull request. We're excited to make R3Utility better together.