Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rrmanzano/maui-bindableproperty-generator
Source generator that automatically transforms fields into BindableProperties that can be used in MAUI
https://github.com/rrmanzano/maui-bindableproperty-generator
Last synced: 3 months ago
JSON representation
Source generator that automatically transforms fields into BindableProperties that can be used in MAUI
- Host: GitHub
- URL: https://github.com/rrmanzano/maui-bindableproperty-generator
- Owner: rrmanzano
- License: mit
- Created: 2022-04-01T18:36:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-20T22:39:11.000Z (11 months ago)
- Last Synced: 2024-07-29T16:04:06.698Z (3 months ago)
- Language: C#
- Size: 278 KB
- Stars: 127
- Watchers: 8
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - Maui.BindableProperty.Generator - bindableproperty-generator (Contributors Welcome for those / 1. [ThisAssembly](https://ignatandrei.github.io/RSCG_Examples/v2/docs/ThisAssembly) , in the [EnhancementProject](https://ignatandrei.github.io/RSCG_Examples/v2/docs/rscg-examples#enhancementproject) category)
- awesome-dotnet-maui - Maui.BindableProperty.Generator - bindableproperty-generator?style=flat-square)](https://github.com/rrmanzano/maui-bindableproperty-generator/stargazers)|[](https://github.com/rrmanzano/maui-bindableproperty-generator/commits) (Plugins)
- awesome-maui - Maui.BindableProperty.Generator - bindableproperty-generator?style=flat-square)](https://github.com/rrmanzano/maui-bindableproperty-generator/issues) [](https://github.com/rrmanzano/maui-bindableproperty-generator/stargazers)  - Source generator that automatically transforms fields into BindableProperties that can be used in MAUI. (Plugins / Get Started)
README
[](https://www.nuget.org/packages/M.BindableProperty.Generator/) [](https://github.com/rrmanzano/maui-bindableproperty-generator/) [](https://github.com/rrmanzano/maui-bindableproperty-generator/stargazers) 
# Maui.BindableProperty.Generator
Source generator that automatically transforms fields into BindableProperties that can be used in MAUI.
Are you looking for the Xamarin project? check this [link](https://github.com/rrmanzano/xamarin-bindableproperty-generator)
## Installation
First, [install NuGet](http://docs.nuget.org/docs/start-here/installing-nuget). Then, install [M.BindableProperty.Generator](https://www.nuget.org/packages/M.BindableProperty.Generator/) from the package manager console:
````bash
PM> Install-Package M.BindableProperty.Generator
````
## Usage - Simple implementation
Just decorate the field with the Bindable attribute.
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable]
private readonly string _placeholder;
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty PlaceholderProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(Placeholder),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string),
propertyChanged: __PlaceholderChanged,
propertyChanging: __PlaceholderChanging);
public string Placeholder
{
get => (string)GetValue(PlaceholderProperty);
set => SetValue(PlaceholderProperty, value);
}
private static void __PlaceholderChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
{
var ctrl = (HeaderControl)bindable;
ctrl.OnPlaceholderChanged((string)newValue);
}
partial void OnPlaceholderChanged(string value);
private static void __PlaceholderChanging(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
{
var ctrl = (HeaderControl)bindable;
ctrl.OnPlaceholderChanging((string)newValue);
}
partial void OnPlaceholderChanging(string value);
}
```
## Options
| Option | Description | Type |
| ------------- | ------------------------------ | ------------------------------ |
| `PropertyName` | Specifies the prefix used to create the BindableProperty, if `PropertyName` is null, then will take the name of the field removing the underscores and using PascalCase. Example: `_tex_t` will be transformed to `Text`. | `string` |
| `OnChanged` | Specifies the name of the method to be executed when the property changes, if not specified, will generate a partial method that will be notified when the property changed. | `string` |
| `OnChanging` | Specifies the name of the method to be executed when the property is changing, if not specified, will generate a partial method that will be notified when the property is changing. | `string` |
| `DefaultValue` | Specifies the "text/value" that will be used as default. Example: `default(string)`| `string` |
| `DefaultBindingMode` | Specifies the "BindingMode" as string that will be used as default. Options: `Default/TwoWay/OneWay/OneWayToSource/OneTime`. Example: `nameof(BindingMode.TwoWay)`| `string` |
| `HidesUnderlyingProperty` | Specifies if the BindingProperty will hide the current implementation. | `bool` |
| `ValidateValue` | Specifies the name of the method to be executed to validate the values. | `string` |
| `PropertyAccessibility` | Specifies the property accessibility, if no parameter is specified, what is defined in the class will be used, Options: `Private/ProtectedAndInternal/Protected/Internal/ProtectedOrInternal/Public`. Example: `BindablePropertyAccessibility.ProtectedOrInternal` | `BindablePropertyAccessibility` |
## Usage - **PropertyName**
Just decorate the field with the Bindable attribute.
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(PropertyName = "LastName")]
private readonly? string _l;
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty LastNameProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(LastName),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string?),
propertyChanged: __LastNameChanged,
propertyChanging: __LastNameChanging);
public string? LastName
{
get => (string?)GetValue(LastNameProperty);
set => SetValue(LastNameProperty, value);
}
...
}
```
## Usage - **OnChanged**
### Example 1 - No Parameters
Just decorate the field with the Bindable attribute.
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(OnChanged = nameof(UpdateDisplayName))]
private readonly string _firstName;
private void UpdateDisplayName()
{
// Do stuff here
}
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(FirstName),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string),
propertyChanged: __FirstNameChanged,
propertyChanging: __FirstNameChanging);
public string FirstName
{
get => (string)GetValue(FirstNameProperty);
set => SetValue(FirstNameProperty, value);
}
private static void __FirstNameChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
{
var ctrl = (HeaderControl)bindable;
ctrl.UpdateDisplayName();
}
...
}
```
### Example 2 - One Parameter
Just decorate the field with the Bindable attribute. The 'UpdateDisplayName' method must have only one parameter (must match the type of the field)
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(OnChanged = nameof(UpdateDisplayName))]
private readonly string _firstName;
private void UpdateDisplayName(string newValue)
{
// Do stuff here
}
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(FirstName),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string),
propertyChanged: __FirstNameChanged,
propertyChanging: __FirstNameChanging);
public string FirstName
{
get => (string)GetValue(FirstNameProperty);
set => SetValue(FirstNameProperty, value);
}
private static void __FirstNameChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
{
var ctrl = (HeaderControl)bindable;
ctrl.UpdateDisplayName((string)newValue);
}
...
}
```
### Example 3 - Two Parameters
Just decorate the field with the Bindable attribute. The 'UpdateDisplayName' method must have two parameters (must match the type of the field)
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(OnChanged = nameof(UpdateDisplayName))]
private readonly string _firstName;
private void UpdateDisplayName(string oldValue, string newValue)
{
// Do stuff here
}
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(FirstName),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string),
propertyChanged: __FirstNameChanged,
propertyChanging: __FirstNameChanging);
public string FirstName
{
get => (string)GetValue(FirstNameProperty);
set => SetValue(FirstNameProperty, value);
}
private static void __FirstNameChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
{
var ctrl = (HeaderControl)bindable;
ctrl.UpdateDisplayName((string)oldValue, (string)newValue);
}
...
}
```
### Example 4 - Partial method
Just decorate the field with the Bindable attribute and by default will generated a partial method
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable()]
private readonly string _firstName;
partial void OnFirstNameChanged(string value)
{
// Do stuff here
}
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(FirstName),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string),
propertyChanged: __FirstNameChanged,
propertyChanging: __FirstNameChanging);
public string FirstName
{
get => (string)GetValue(FirstNameProperty);
set => SetValue(FirstNameProperty, value);
}
private static void __FirstNameChanged(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
{
var ctrl = (HeaderControl)bindable;
ctrl.OnFirstNameChanged((string)newValue);
}
partial void OnFirstNameChanged(string value);
...
}
```
## Usage - **OnChanging**
### Example 1
Just decorate the field with the Bindable attribute.
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(OnChanging = nameof(UpdateDisplayNameBeforeChange))]
private readonly string _firstName = string.Empty;
private void UpdateDisplayNameBeforeChange()
{
// Do stuff here
}
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(FirstName),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string),
propertyChanged: __FirstNameChanged,
propertyChanging: __FirstNameChanging);
public string FirstName
{
get => (string)GetValue(FirstNameProperty);
set => SetValue(FirstNameProperty, value);
}
...
private static void __FirstNameChanging(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
{
var ctrl = (HeaderControl)bindable;
ctrl.UpdateDisplayNameBeforeChange();
}
...
}
```
### Example 2 - Partial method
Just decorate the field with the Bindable attribute.
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable()]
private readonly string _firstName = string.Empty;
partial void OnFirstNameChanging(string value)
{
// Do stuff here
}
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(FirstName),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string),
propertyChanged: __FirstNameChanged,
propertyChanging: __FirstNameChanging);
public string FirstName
{
get => (string)GetValue(FirstNameProperty);
set => SetValue(FirstNameProperty, value);
}
...
private static void __FirstNameChanging(Microsoft.Maui.Controls.BindableObject bindable, object oldValue, object newValue)
{
var ctrl = (HeaderControl)bindable;
ctrl.OnFirstNameChanging((string)newValue);
}
partial void OnFirstNameChanging(string value);
...
}
```
## Usage - **DefaultValue**
### Example 1 - DateTime
Just decorate the field with the Bindable attribute and add the "text/value" that you want to use as default value.
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(DefaultValue = "DateTime.Now")]
private readonly DateTime _birthDate;
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty BirthDateProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(BirthDate),
typeof(DateTime?),
typeof(HeaderControl),
defaultValue: DateTime.Now,
propertyChanged: __BirthDateChanged,
propertyChanging: __BirthDateChanging);
public System.DateTime BirthDate
{
get => (System.DateTime)GetValue(BirthDateProperty);
set => SetValue(BirthDateProperty, value);
}
...
}
```
### Example 2 - String
Just decorate the field with the Bindable attribute and add the "text/value" that you want to use as default value.
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(DefaultValue = "USA")]
private readonly string _country;
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty CountryProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(Country),
typeof(string),
typeof(HeaderControl),
defaultValue: "USA",
propertyChanged: __CountryChanged,
propertyChanging: __CountryChanging);
public string Country
{
get => (string)GetValue(CountryProperty);
set => SetValue(CountryProperty, value);
}
...
}
```
## Usage - **DefaultBindingMode**
Just decorate the field with the Bindable attribute and add the "BindingMode" that you want to use as default value.
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(DefaultBindingMode = nameof(BindingMode.TwoWay))]
private readonly string _firstName;
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty FirstNameProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(FirstName),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string),
propertyChanged: __FirstNameChanged,
propertyChanging: __FirstNameChanging,
defaultBindingMode: Microsoft.Maui.Controls.BindingMode.TwoWay);
public string FirstName
{
get => (string)GetValue(FirstNameProperty);
set => SetValue(FirstNameProperty, value);
}
...
}
```
## Usage - **HidesUnderlyingProperty**
Just decorate the field with the Bindable attribute and set "HidesUnderlyingProperty = true".
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(HidesUnderlyingProperty = true, DefaultValue = "Color.FromArgb(\"#cc3340\")")]
private readonly Color? _backgroundColor;
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static new readonly Microsoft.Maui.Controls.BindableProperty BackgroundColorProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(BackgroundColor),
typeof(Color?),
typeof(HeaderControl),
defaultValue: Color.FromArgb("#cc3340"),
propertyChanged: __BackgroundColorChanged,
propertyChanging: __BackgroundColorChanging);
public new Color? BackgroundColor
{
get => (Color?)GetValue(BackgroundColorProperty);
set => SetValue(BackgroundColorProperty, value);
}
...
}
```
## Usage - **ValidateValue**
### Example 1 - Non-Static Method
Just decorate the field with the Bindable attribute. The 'ValidateNotNull' method must have two parameters (one of type BindableObject and the second one must be the same as the field)
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(ValidateValue = nameof(ValidateIsNullOrEmpty))]
private readonly string? _country;
private bool ValidateIsNullOrEmpty(BindableObject _, string? value)
{
// Do stuff here
return !string.IsNullOrEmpty(value);
}
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty CountryProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(Country),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string?),
propertyChanged: __CountryChanged,
propertyChanging: __CountryChanging,
validateValue: __ValidateIsNullOrEmpty);
public string? Country
{
get => (string?)GetValue(CountryProperty);
set => SetValue(CountryProperty, value);
}
private static bool __ValidateIsNullOrEmpty(Microsoft.Maui.Controls.BindableObject bindable, object value)
{
var ctrl = (HeaderControl)bindable;
return ctrl.ValidateIsNullOrEmpty(ctrl, (string?)value);
}
...
}
```
### Example 2 - Static Method
Just decorate the field with the Bindable attribute. The 'ValidateNotNull' method must have two parameters (one of type BindableObject and the second one must be object type)
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(ValidateValue = nameof(ValidateNotNull))]
private readonly string? _zipCode;
private static bool ValidateNotNull(BindableObject _, object value) => value != null;
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
public static readonly Microsoft.Maui.Controls.BindableProperty ZipCodeProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(ZipCode),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string?),
propertyChanged: __ZipCodeChanged,
propertyChanging: __ZipCodeChanging,
validateValue: ValidateNotNull);
public string? ZipCode
{
get => (string?)GetValue(ZipCodeProperty);
set => SetValue(ZipCodeProperty, value);
}
...
}
```
## Usage - **PropertyAccessibility**
Just decorate the field with the Bindable attribute and set "PropertyAccessibility = Private/ProtectedAndInternal/Protected/Internal/ProtectedOrInternal/Public".
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
[AutoBindable(PropertyAccessibility = BindablePropertyAccessibility.ProtectedOrInternal)]
private readonly string? _age;
}
```
the prevoius code will generate this:
```csharp
public partial class HeaderControl
{
protected internal static readonly Microsoft.Maui.Controls.BindableProperty AgeProperty =
Microsoft.Maui.Controls.BindableProperty.Create(
nameof(Age),
typeof(string),
typeof(HeaderControl),
defaultValue: default(string?),
propertyChanged: __AgeChanged,
propertyChanging: __AgeChanging);
protected internal string? Age
{
get => (string?)GetValue(AgeProperty);
set => SetValue(AgeProperty, value);
}
...
}
```
## Do you want to remove the compiler warning CS0169 ?
```csharp
using Maui.BindableProperty.Generator.Core;
public partial class HeaderControl : ContentView
{
#pragma warning disable CS0169
[AutoBindable]
private readonly string? _country;
#pragma warning restore CS0169
}
```
## Project status
- ✅ `PropertyName` - Done
- ✅ `OnChanged` - Done
- ✅ `OnChanging` - Done
- ✅ `DefaultValue` - Done
- ✅ `DefaultBindingMode` - Done
- ✅ `HidesUnderlyingProperty` - Done
- ✅ `ValidateValue` - Done
- ✅ `PropertyAccessibility` - Done
- 🔳 Allow nested class - In Progress
- 🔳 Add Attributes Property - Pending
## Extra info
This repo is using part of the code of [CodeWriter](https://github.com/SaladLab/CodeWriter "CodeWriter") to generate the CSharp files, thanks to the author.