Merge pull request #338 from w-ahmad/fix/row-details-state

fix: persist row details pane state per-item

Author: w-ahmad

src/Helpers/TValue.cs

@@ -0,0 +1,25 @@
+namespace WinUI.TableView.Helpers;
+
+/// <summary>
+/// Represents a value type wrapper that enables implicit conversion between the wrapped value and the wrapper type.
+/// </summary>
+/// <typeparam name="T">The value type to be wrapped. Must be a struct.</typeparam>
+/// <param name="Value">The value to wrap.</param>
+internal record TValue<T>(T Value) where T : struct
+{
+    /// <summary>
+    /// Defines an implicit conversion from a <see cref="TValue{T}"/> instance to its underlying value of type T.
+    /// </summary>
+    public static implicit operator T(TValue<T> value)
+    {
+        return value.Value;
+    }
+
+    /// <summary>
+    /// Defines an implicit conversion from the underlying value type to a <see cref="TValue{T}"/> instance.
+    /// </summary>
+    public static implicit operator TValue<T>(T value)
+    {
+        return new(value);
+    }
+}

src/TableView.Properties.cs

@@ -6,7 +6,9 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
+using WinUI.TableView.Helpers;
 
 namespace WinUI.TableView;
 
@@ -262,7 +264,7 @@ public partial class TableView
     /// <summary>
     /// Identifies the <see cref="ShowFilterItemsCount"/> dependency property.
     /// </summary>
-    public static readonly DependencyProperty ShowFilterItemsCountProperty =  DependencyProperty.Register(nameof(ShowFilterItemsCount), typeof(bool), typeof(TableView), new PropertyMetadata(false));
+    public static readonly DependencyProperty ShowFilterItemsCountProperty = DependencyProperty.Register(nameof(ShowFilterItemsCount), typeof(bool), typeof(TableView), new PropertyMetadata(false));
 
     /// <summary>
     /// Gets or sets a value indicating whether opening the column filter over header right-click is enabled.
@@ -359,6 +361,11 @@ public bool ShowFilterItemsCount
     /// </summary>
     internal bool IsEditing { get; private set; }
 
+    /// <summary>
+    /// Gets the visibility states of details pane for each item.
+    /// </summary>
+    internal ConditionalWeakTable<object, TValue<bool>> DetailsPaneStates { get; } = [];
+
     /// <summary>
     /// Gets or sets the filter handler for the TableView.
     /// </summary>

src/TableView.cs

@@ -109,6 +109,7 @@ protected override void PrepareContainerForItemOverride(DependencyObject element
             {
                 row.EnsureCellsStyle(default, item);
                 row.ApplyCellsSelectionState();
+                row.RowPresenter?.ApplyDetailsPaneState(item);
 
                 if (CurrentCellSlot.HasValue)
                 {
@@ -675,6 +676,8 @@ private static TableViewBoundColumn GetTableViewColumnFromType(string? propertyN
     /// </summary>
     private void ItemsSourceChanged(DependencyPropertyChangedEventArgs e)
     {
+        DetailsPaneStates.Clear();
+
         using var defer = _collectionView.DeferRefresh();
         _collectionView.Source = null!;
 

src/TableViewRowPresenter.cs

@@ -3,6 +3,7 @@
 using Microsoft.UI.Xaml.Controls;
 using Microsoft.UI.Xaml.Controls.Primitives;
 using Microsoft.UI.Xaml.Data;
+using Microsoft.UI.Xaml.Input;
 using Microsoft.UI.Xaml.Media;
 using Microsoft.UI.Xaml.Shapes;
 using System;
@@ -68,8 +69,7 @@ protected override void OnApplyTemplate()
 
         if (_detailsToggleButton is not null)
         {
-            _detailsToggleButton.Checked += OnDetailsToggleButtonChecked;
-            _detailsToggleButton.Unchecked += OnDetailsToggleButtonUnChecked;
+            _detailsToggleButton.Tapped += OnDetailsToggleButtonTapped;
         }
 
         if (_detailsPanel is not null)
@@ -190,11 +190,8 @@ internal void SetRowDetailsVisibility()
         }
         else if (mode is TableViewRowDetailsVisibilityMode.VisibleWhenSelected)
         {
-            if (_detailsToggleButton is not null)
-                _detailsToggleButton.IsChecked = TableViewRow?.IsSelected ?? false;
-            else
-                VisualStates.GoToState(this, false, (TableViewRow?.IsSelected ?? false) ? VisualStates.StateDetailsVisible : VisualStates.StateDetailsCollapsed);
-
+            var state = (TableViewRow?.IsSelected ?? false) ? VisualStates.StateDetailsVisible : VisualStates.StateDetailsCollapsed;
+            VisualStates.GoToState(this, false, state);
             VisualStates.GoToState(this, false, VisualStates.StateDetailsButtonCollapsed);
         }
         else if (mode is TableViewRowDetailsVisibilityMode.VisibleWhenExpanded)
@@ -209,19 +206,37 @@ internal void SetRowDetailsVisibility()
     }
 
     /// <summary>
-    /// Handles the Checked event of the details toggle button.
+    /// Handles the Tapped event of the details toggle button.
+    /// </summary>
+    private void OnDetailsToggleButtonTapped(object sender, TappedRoutedEventArgs e)
+    {
+        ToggleDetailsPane(TableViewRow?.Content, _detailsToggleButton!.IsChecked ?? false);
+    }
+
+    /// <summary>
+    /// Toggles the visibility of the details pane.
     /// </summary>
-    private void OnDetailsToggleButtonChecked(object sender, RoutedEventArgs e)
+    private void ToggleDetailsPane(object? content, bool isVisible)
     {
-        VisualStates.GoToState(this, false, VisualStates.StateDetailsVisible);
+        if (TableView is null || content is null) return;
+
+        TableView.DetailsPaneStates.AddOrUpdate(content, isVisible);
+        var state = isVisible ? VisualStates.StateDetailsVisible : VisualStates.StateDetailsCollapsed;
+        VisualStates.GoToState(this, false, state);
     }
 
     /// <summary>
-    /// Handles the Unchecked event of the details toggle button.
+    /// Ensures that the details pane visibility is synchronized for the specified item when row.
     /// </summary>
-    private void OnDetailsToggleButtonUnChecked(object sender, RoutedEventArgs e)
+    internal void ApplyDetailsPaneState(object? item)
     {
-        VisualStates.GoToState(this, false, VisualStates.StateDetailsCollapsed);
+        if (TableView?.RowDetailsVisibilityMode is TableViewRowDetailsVisibilityMode.VisibleWhenExpanded &&
+            _detailsToggleButton is not null && TableView is not null && item is not null)
+        {
+            var isChecked = TableView.DetailsPaneStates.TryGetValue(item, out var value) ? value.Value : false;
+            _detailsToggleButton!.IsChecked = isChecked;
+            ToggleDetailsPane(item, isChecked);
+        }
     }
 
     /// <summary>

src/Themes/TableViewRowPresenter.xaml

@@ -131,7 +131,6 @@
 
                                 <ContentPresenter x:Name="DetailsPresenter"
                                                   Grid.Row="1"
-                                                  Content="{Binding}"
                                                   Padding="{ThemeResource TableViewDetailsPadding}" />
                             </Grid>
                         </Grid>