ObservableProperty Attribute for Class

Overview

To simplify the Observable Property attribute required for all properties inside the class.

Current Usage:

public partial class AddContact : ObservableObject
{
    [ObservableProperty] private Guid id;
    [ObservableProperty] private string firstName;
    [ObservableProperty] private string lastName;
    [ObservableProperty] private Phone phone;
    [ObservableProperty] private DateTime? expiry;
    [ObservableProperty] private ObservableCollection<Phone> extraPhones = new();
    [ObservableProperty] private string image;
    [ObservableProperty] private Group group;
    [ObservableProperty] private string email;
    [ObservableProperty]
    [NotifyPropertyChangedFor(nameof(ShowRingtonePlay))]
    [NotifyPropertyChangedFor(nameof(RingtoneFile))]
    private string ringtone;
    public bool ShowRingtonePlay => !Ringtone.IsNullOrEmpty();
    public string RingtoneFile => Path.GetFileName(Ringtone);
    [ObservableProperty] private ObservableCollection<string> emails = new();
    [ObservableProperty] private Company company;
    [ObservableProperty] private Country country;
    [ObservableProperty] private Relationship relationship;
    [ObservableProperty] private Address address;
    [ObservableProperty] private ObservableCollection<Event> events = new();
    [ObservableProperty] private ObservableCollection<SocialMedia> socials = new();
    [ObservableProperty] private ObservableCollection<Note> notes = new();

    private readonly CountryService countryService;
}

API breakdown

No Api breakdown

Usage example

[ObservableProperty] or [AllObservableProperty]
public partial class AddContact : ObservableObject
{
    private Guid id;
    private string firstName;
    private string lastName;
    private Phone phone;
    private DateTime? expiry;
    private ObservableCollection<Phone> extraPhones = new();
    private string image;
    private Group group;
    private string email;
    private ObservableCollection<string> emails = new();
    private Company company;
    private Country country;
    private Relationship relationship;
    private Address address;
    private ObservableCollection<Event> events = new();
    private ObservableCollection<SocialMedia> socials = new();
    private ObservableCollection<Note> notes = new();
    
    [NotifyPropertyChangedFor(nameof(ShowRingtonePlay))]
    [NotifyPropertyChangedFor(nameof(RingtoneFile))]
    private string ringtone;
    
    public bool ShowRingtonePlay => !Ringtone.IsNullOrEmpty();
    public string RingtoneFile => Path.GetFileName(Ringtone);
    
    private readonly CountryService countryService;
}

Breaking change?

No

Alternatives

No

Additional context

For much better code.

For automatic code generation, avoid public property and private readonly property.

Help us help you

Yes, I'd like to be assigned to work on this item

Inizia individuando l'attributo ObservableProperty e la relativa implementazione della generazione del codice nel repository. Esamina come vengono gestiti NotifyPropertyChangedFor e i campi readonly, quindi definisci l'ambito e le esclusioni dell'attributo a livello di classe. Il lavoro è completo quando una forma a livello di classe può generare le stesse proprietà osservabili senza richiedere un'annotazione per ogni campo, preservando gli attributi di notifica esistenti.