[Proposal] ObservableRangeCollection

ObservableRangeCollection

• Proposed
• Prototype: Not Started
• Implementation: Not Started
  • iOS Support
  • Android Support
  • macOS Support
  • Windows Support
• Unit Tests: Not Started
• Sample: Not Started
• Documentation: Not Started

Summary

Represents a dynamic data collection that provides notifications when items get added, removed, or when the whole list is refreshed

Detailed Design

public class ObservableRangeCollection<T> : ObservableCollection<T>
{
  public ObservableRangeCollection() : base()
  {
  }

  public ObservableRangeCollection(IEnumerable<T> collection) : base(collection)
  {
  }

  public void AddRange(IEnumerable<T> collection, NotifyCollectionChangedAction notificationMode = NotifyCollectionChangedAction.Add);

  public void RemoveRange(IEnumerable<T> collection, NotifyCollectionChangedAction notificationMode = NotifyCollectionChangedAction.Reset);

  public void Replace(T item);

  public void ReplaceRange(IEnumerable<T> collection);
}

Usage Syntax

XAML Usage

N/A

C# Usage

public ObservableRangeCollection<int> collection = new();

public void AddNumbers(int count)
{
  var startingNumber = collection.Length;
  collection.AddRange(Enumerable.Range(startingNumber, count));
}

Drawbacks

We are deferring all MVVM components to the MVVM Toolkit, keeping the .NET MAUI Community Toolkit focused on .NET MAUI-specific tools.

Alternatives

• MvvmHelpers
• BulkObservableCollection
• RangeObservableCollection

[brminnick]

Agreed.

There are efforts being made internally to still sneak it into .NET 7.

But if it were to be added to a Community Toolkit, then https://github.com/CommunityToolkit/dotnet would be the best toolkit for it.

[pictos]

@kkppstudios you can copy the implementation to your code and use it there