Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reactiveui/reactiveui.sourcegenerators
Use source generators to generate objects.
https://github.com/reactiveui/reactiveui.sourcegenerators
Last synced: 3 months ago
JSON representation
Use source generators to generate objects.
- Host: GitHub
- URL: https://github.com/reactiveui/reactiveui.sourcegenerators
- Owner: reactiveui
- License: mit
- Created: 2023-04-06T17:52:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T15:36:22.000Z (4 months ago)
- Last Synced: 2024-10-07T00:15:57.745Z (3 months ago)
- Language: C#
- Size: 542 KB
- Stars: 25
- Watchers: 9
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ReactiveUI.SourceGenerators
Use source generators to generate ReactiveUI objects.
These Source Generators were designed to work in full with ReactiveUI V19.5.31 and newer supporting all features, currently:
- [Reactive]
- [ObservableAsProperty]
- [ObservableAsProperty(PropertyName = "ReadOnlyPropertyName")]
- [ReactiveCommand]
- [ReactiveCommand(CanExecute = nameof(IObservableBoolName))] with CanExecute
- [ReactiveCommand][property: AttribueToAddToCommand] with Attribute passthrough
- [IViewFor(nameof(ViewModelName))]
Versions older than V19.5.31 to this:
- [Reactive] fully supported,
- [ObservableAsProperty] fully supported,
- [ReactiveCommand] all options supported except Cancellation Token asnyc methods.
# Historical ways
## Read-write properties
Typically properties are declared like this:
```csharp
private string _name;
public string Name
{
get => _name;
set => this.RaiseAndSetIfChanged(ref _name, value);
}
```
Before these Source Generators were avaliable we used ReactiveUI.Fody.
With ReactiveUI.Fody the `[Reactive]` Attribute was placed on a Public Property with Auto get / set properties, the generated code from the Source Generator and the Injected code using Fody are very similar with the exception of the Attributes.
```csharp
[Reactive]
public string Name { get; set; }
```
## ObservableAsPropertyHelper properties
Similarly, to declare output properties, the code looks like this:
```csharp
public partial class MyReactiveClass : ReactiveObject
{
ObservableAsPropertyHelper _firstName;
public MyReactiveClass()
{
_firstName = firstNameObservable
.ToProperty(this, x => x.FirstName);
}
public string FirstName => _firstName.Value;
private IObservable firstNameObservable() => Observable.Return("Test");
}
```
With ReactiveUI.Fody, you can simply declare a read-only property using the [ObservableAsProperty] attribute, using either option of the two options shown below.
```csharp
[ObservableAsProperty]
public string FirstName { get; }
```
# Welcome to a new way - Source Generators
## Usage Reactive property `[Reactive]`
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass : ReactiveObject
{
[Reactive]
private string _myProperty;
}
```
### Usage Reactive property with set Access Modifier
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass : ReactiveObject
{
[Reactive(SetModifier = AccessModifier.Protected)]
private string _myProperty;
}
```
## Usage ObservableAsPropertyHelper `[ObservableAsProperty]`
ObservableAsPropertyHelper is used to create a read-only property from an IObservable. The generated code will create a backing field and a property that returns the value of the backing field. The backing field is initialized with the value of the IObservable when the class is instantiated.
A private field is created with the name of the property prefixed with an underscore. The field is initialized with the value of the IObservable when the class is instantiated. The property is created with the same name as the field without the underscore. The property returns the value of the field until initialized, then it returns the value of the IObservable.
You can define the name of the property by using the PropertyName parameter. If you do not define the PropertyName, the property name will be the same as the field name without the underscore.
### Usage ObservableAsPropertyHelper with Field
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass : ReactiveObject
{
[ObservableAsProperty]
private string _myProperty = "Default Value";
public MyReactiveClass()
{
_myPrpertyHelper = MyPropertyObservable()
.ToProperty(this, x => x.MyProperty);
}
IObservable MyPropertyObservable() => Observable.Return("Test Value");
}
```
### Usage ObservableAsPropertyHelper with Observable Property
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass : ReactiveObject
{
public MyReactiveClass()
{
// default value for MyObservableProperty prior to initialization.
_myObservable = "Test Value Pre Init";
// Initialize generated _myObservablePropertyHelper
// for the generated MyObservableProperty
InitializeOAPH();
}
[ObservableAsProperty]
IObservable MyObservable => Observable.Return("Test Value");
}
```
### Usage ObservableAsPropertyHelper with Observable Property and specific PropertyName
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass : ReactiveObject
{
public MyReactiveClass()
{
// default value for TestValueProperty prior to initialization.
_testValueProperty = "Test Value Pre Init";
// Initialize generated _testValuePropertyHelper
// for the generated TestValueProperty
InitializeOAPH();
}
[ObservableAsProperty(PropertyName = TestValueProperty)]
IObservable MyObservable => Observable.Return("Test Value");
}
```
### Usage ObservableAsPropertyHelper with Observable Method
NOTE: This does not currently support methods with parameters
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass : ReactiveObject
{
public MyReactiveClass()
{
// Initialize generated _myObservablePropertyHelper
// for the generated MyObservableProperty
InitializeOAPH();
}
[ObservableAsProperty]
IObservable MyObservable() => Observable.Return("Test Value");
}
```
### Usage ObservableAsPropertyHelper with Observable Method and specific PropertyName
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass : ReactiveObject
{
public MyReactiveClass()
{
// Initialize generated _testValuePropertyHelper
// for the generated TestValueProperty
InitializeOAPH();
}
[ObservableAsProperty(PropertyName = TestValueProperty)]
IObservable MyObservable() => Observable.Return("Test Value");
}
```
## Usage ReactiveCommand `[ReactiveCommand]`
### Usage ReactiveCommand without parameter
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass
{
[ReactiveCommand]
private void Execute() { }
}
```
### Usage ReactiveCommand with parameter
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass
{
[ReactiveCommand]
private void Execute(string parameter) { }
}
```
### Usage ReactiveCommand with parameter and return value
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass
{
[ReactiveCommand]
private string Execute(string parameter) => parameter;
}
```
### Usage ReactiveCommand with parameter and async return value
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass
{
[ReactiveCommand]
private async Task Execute(string parameter) => await Task.FromResult(parameter);
}
```
### Usage ReactiveCommand with IObservable return value
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass
{
[ReactiveCommand]
private IObservable Execute(string parameter) => Observable.Return(parameter);
}
```
### Usage ReactiveCommand with CancellationToken
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass
{
[ReactiveCommand]
private async Task Execute(CancellationToken token) => await Task.Delay(1000, token);
}
```
### Usage ReactiveCommand with CancellationToken and parameter
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass
{
[ReactiveCommand]
private async Task Execute(string parameter, CancellationToken token)
{
await Task.Delay(1000, token);
return parameter;
}
}
```
### Usage ReactiveCommand with CanExecute
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass
{
private IObservable _canExecute;
[Reactive]
private string _myProperty1;
[Reactive]
private string _myProperty2;
public MyReactiveClass()
{
_canExecute = this.WhenAnyValue(x => x.MyProperty1, x => x.MyProperty2, (x, y) => !string.IsNullOrEmpty(x) && !string.IsNullOrEmpty(y));
}
[ReactiveCommand(CanExecute = nameof(_canExecute))]
private void Search() { }
}
```
### Usage ReactiveCommand with property Attribute pass through
```csharp
using ReactiveUI.SourceGenerators;
public partial class MyReactiveClass
{
private IObservable _canExecute;
[Reactive]
private string _myProperty1;
[Reactive]
private string _myProperty2;
public MyReactiveClass()
{
_canExecute = this.WhenAnyValue(x => x.MyProperty1, x => x.MyProperty2, (x, y) => !string.IsNullOrEmpty(x) && !string.IsNullOrEmpty(y));
}
[ReactiveCommand(CanExecute = nameof(_canExecute))]
[property: JsonIgnore]
private void Search() { }
}
```
## Usage IViewFor `[IViewFor(nameof(ViewModelName))]`
### IViewFor usage
IViewFor is used to link a View to a ViewModel, this is used to link the ViewModel to the View in a way that ReactiveUI can use it to bind the ViewModel to the View.
The ViewModel is passed as a type to the IViewFor Attribute using generics.
The class must inherit from a UI Control from any of the following platforms and namespaces:
- Maui (Microsoft.Maui)
- WinUI (Microsoft.UI.Xaml)
- WPF (System.Windows or System.Windows.Controls)
- WinForms (System.Windows.Forms)
- Avalonia (Avalonia)
- Uno (Windows.UI.Xaml).
```csharp
using ReactiveUI.SourceGenerators;
[IViewFor]
public partial class MyReactiveControl : UserControl
{
public MyReactiveControl()
{
InitializeComponent();
MyReactiveClass = new MyReactiveClass();
}
}
```
## Platform specific Attributes
### WinForms
#### RoutedControlHost
```csharp
using ReactiveUI.SourceGenerators.WinForms;
[RoutedControlHost("YourNameSpace.CustomControl")]
public partial class MyCustomRoutedControlHost;
```
#### ViewModelControlHost
```csharp
using ReactiveUI.SourceGenerators.WinForms;
[ViewModelControlHost("YourNameSpace.CustomControl")]
public partial class MyCustomViewModelControlHost;
```
### TODO:
- Add ObservableAsProperty to generate from a IObservable method with parameters.