Added optional 'sortBy' parameter to BindList methods.

JordanMarr · Apr 1, 2024 · 3620772 · 3620772
1 parent 3a4c628
commit 3620772
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 7 deletions.
diff --git a/src/ReactiveElmish.Avalonia/ReactiveElmish.Avalonia.fsproj b/src/ReactiveElmish.Avalonia/ReactiveElmish.Avalonia.fsproj
@@ -17,7 +17,7 @@
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PackageProjectUrl>https://github.com/JordanMarr/ReactiveElmish.Avalonia</PackageProjectUrl>
 		<PackageTags>Avalonia F# fsharp Elmish Elm</PackageTags>
-		<Version>1.2.1</Version>
+		<Version>1.3.0</Version>
 		<!--Turn on warnings for unused values (arguments and let bindings) -->
 		<OtherFlags>$(OtherFlags) --warnon:1182</OtherFlags>
 		<TargetsForTfmSpecificBuildOutput>$(TargetsForTfmSpecificBuildOutput);CopyProjectReferencesToPackage</TargetsForTfmSpecificBuildOutput>

diff --git a/src/ReactiveElmish/ReactiveBindingsCS.fs b/src/ReactiveElmish/ReactiveBindingsCS.fs
@@ -26,15 +26,17 @@ type ReactiveBindingsCS(onPropertyChanged: Action<string>) =
     member this.BindList<'Model, 'ModelProjection>(
             store: IStore<'Model>, 
             modelProjectionSeq: Func<'Model, 'ModelProjection seq>,
+            [<Optional>] sortBy: Func<'ModelProjection, IComparable>,
             [<CallerMemberName; Optional; DefaultParameterValue("")>] vmPropertyName
-        ) = vm.BindList(store, modelProjectionSeq.Invoke, vmPropertyName)
+        ) = vm.BindList(store, modelProjectionSeq.Invoke, ?sortBy = opt sortBy, vmPropertyName = vmPropertyName)
 
     member this.BindList<'Model, 'ModelProjection, 'Mapped>(
             store: IStore<'Model>, 
             modelProjectionSeq: Func<'Model, 'ModelProjection seq>,
             map: Func<'ModelProjection, 'Mapped>,
+            [<Optional>] sortBy: Func<'Mapped, IComparable>,
             [<CallerMemberName; Optional; DefaultParameterValue("")>] vmPropertyName
-        ) = vm.BindList(store, modelProjectionSeq.Invoke, map.Invoke, vmPropertyName)
+        ) = vm.BindList(store, modelProjectionSeq.Invoke, map.Invoke, ?sortBy = opt sortBy, vmPropertyName = vmPropertyName)
 
     member this.BindKeyedList<'Model, 'Key, 'Value, 'Mapped when 'Value : equality and 'Mapped : not struct and 'Key : comparison>(
             store: IStore<'Model>, 

diff --git a/src/ReactiveElmish/ReactiveElmish.fsproj b/src/ReactiveElmish/ReactiveElmish.fsproj
@@ -17,7 +17,7 @@
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PackageProjectUrl>https://github.com/JordanMarr/ReactiveElmish</PackageProjectUrl>
 		<PackageTags>F# C# fsharp Elmish MVU MVVM</PackageTags>
-		<Version>1.3.0</Version>
+		<Version>1.4.0</Version>
 		<!--Turn on warnings for unused values (arguments and let bindings) -->
 		<OtherFlags>$(OtherFlags) --warnon:1182</OtherFlags>
 	</PropertyGroup>

diff --git a/src/ReactiveElmish/ReactiveElmishViewModel.fs b/src/ReactiveElmish/ReactiveElmishViewModel.fs
@@ -97,14 +97,19 @@ type ReactiveElmishViewModel(onPropertyChanged: string -> unit) =
     member this.BindList<'Model, 'ModelProjection>(
             store: IStore<'Model>, 
             modelProjectionSeq: 'Model -> 'ModelProjection seq,
+            ?sortBy: Func<'ModelProjection, IComparable>,
             [<CallerMemberName; Optional; DefaultParameterValue("")>] ?vmPropertyName
         ) = 
         if not (propertyCollections.ContainsKey vmPropertyName.Value) then
             let mutable readOnlyList = readOnlyCollection<'ModelProjection>()
             let sourceList = SourceList.createFrom (modelProjectionSeq store.Model)
             sourceList
                 .Connect()
-                .Bind(&readOnlyList)
+                |> fun x -> 
+                    match sortBy with
+                    | Some sortBy -> x.Sort(DynamicData.Binding.SortExpressionComparer.Ascending(sortBy))
+                    | None -> x.Sort(Comparer.Create(fun _ _ -> 0))
+                |> _.Bind(&readOnlyList)
                 .Subscribe()
                 |> this.AddDisposable
 
@@ -130,6 +135,7 @@ type ReactiveElmishViewModel(onPropertyChanged: string -> unit) =
             store: IStore<'Model>, 
             modelProjectionSeq: 'Model -> 'ModelProjection seq,
             map: 'ModelProjection -> 'Mapped,
+            ?sortBy: Func<'Mapped, IComparable>,
             [<CallerMemberName; Optional; DefaultParameterValue("")>] ?vmPropertyName
         ) = 
         let vmPropertyName = vmPropertyName.Value
@@ -140,7 +146,11 @@ type ReactiveElmishViewModel(onPropertyChanged: string -> unit) =
             sourceList
                 .Connect()
                 .Transform(map)
-                .Bind(&readOnlyList)
+                |> fun x -> 
+                    match sortBy with
+                    | Some sortBy -> x.Sort(DynamicData.Binding.SortExpressionComparer.Ascending(sortBy))
+                    | None -> x.Sort(Comparer.Create(fun _ _ -> 0))
+                |> _.Bind(&readOnlyList)
                 .Subscribe()
                 |> this.AddDisposable
 

diff --git a/src/Samples/AvaloniaExample/ViewModels/CounterViewModel.fs b/src/Samples/AvaloniaExample/ViewModels/CounterViewModel.fs
@@ -48,7 +48,13 @@ type CounterViewModel() =
         |> Program.mkStore
 
     member this.Count = this.Bind(local, _.Count)
-    member this.Actions = this.BindList(local, _.Actions, map = fun a -> { a with Description = $"** {a.Description} **" })
+    member this.Actions = 
+        this.BindList(
+        local
+        , _.Actions 
+        , map = fun a -> { a with Description = $"** {a.Description} **" }
+        , sortBy = _.Timestamp
+    )
     member this.Increment() = local.Dispatch Increment
     member this.Decrement() = local.Dispatch Decrement
     member this.Reset() = local.Dispatch Reset