Jewelry.EditingSystem.CommunityToolkit.Mvvm 3.0.0

Jewelry.EditingSystem.CommunityToolkit.Mvvm

This is a first-class integration package for combining Jewelry.EditingSystem with CommunityToolkit.Mvvm.

EditingSystem supports the following two primary usage patterns:

• standalone [Undoable] partial properties from Jewelry.EditingSystem
• [Undoable, ObservableProperty] properties from CommunityToolkit.Mvvm

This package provides the latter. Existing CommunityToolkit.Mvvm integration code continues to work as-is.

using CommunityToolkit.Mvvm.ComponentModel;
using Jewelry.EditingSystem;
using Jewelry.EditingSystem.CommunityToolkit.Mvvm;

[EditingHistory(nameof(_history))]
public sealed partial class SampleViewModel : ObservableObject
{
    private readonly History _history;

    public SampleViewModel(History history) => _history = history;

    [Undoable, ObservableProperty]
    private string? name;

    [Undoable, ObservableProperty]
    public partial int Count { get; set; }
}

Undo and Redo reuse the property setters generated by CommunityToolkit.Mvvm. As a result, the CommunityToolkit.Mvvm setter pipeline—including PropertyChanging / PropertyChanged, validation, command notifications, and recipient broadcasts—is preserved during Undo and Redo.

Inheriting from ObservableObject is not required. A partial ViewModel that already inherits a different base class can instead use CommunityToolkit.Mvvm's [INotifyPropertyChanged] attribute.

[INotifyPropertyChanged]
[EditingHistory(nameof(history))]
public sealed partial class DerivedViewModel(History history) : ExistingViewModelBase
{
    [Undoable, ObservableProperty]
    public partial int Count { get; set; }
}

For the CommunityToolkit.Mvvm integration, EditingSystem uses the single-parameter OnXChanging(T value) and OnXChanged(T value) hooks. Use the two-parameter changing / changed hooks for application-specific logic.

EditingHistory can refer to a non-null History field, property, or primary-constructor parameter.

Choosing Between It and Standalone [Undoable]

For models that do not need CommunityToolkit.Mvvm observable properties, you can use standalone [Undoable] partial properties with Jewelry.EditingSystem alone.

using Jewelry.EditingSystem;
using Jewelry.EditingSystem.Annotations;

[EditingHistory(nameof(history))]
public sealed partial class Model(History history)
{
    [Undoable]
    public partial int Value { get; set; }
}

To avoid name collisions and effects on existing code, standalone attributes are placed in Jewelry.EditingSystem.Annotations, while CommunityToolkit.Mvvm integration attributes remain in Jewelry.EditingSystem.CommunityToolkit.Mvvm.

The handwritten SetEditableProperty(...) approach remains available as a low-level API for compatibility and specialized scenarios, but the two attribute-based patterns above are recommended in most cases.