MPowerKit.VirtualizeListView 1.2.2

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package MPowerKit.VirtualizeListView --version 1.2.2                
NuGet\Install-Package MPowerKit.VirtualizeListView -Version 1.2.2                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="MPowerKit.VirtualizeListView" Version="1.2.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MPowerKit.VirtualizeListView --version 1.2.2                
#r "nuget: MPowerKit.VirtualizeListView, 1.2.2"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install MPowerKit.VirtualizeListView as a Cake Addin
#addin nuget:?package=MPowerKit.VirtualizeListView&version=1.2.2

// Install MPowerKit.VirtualizeListView as a Cake Tool
#tool nuget:?package=MPowerKit.VirtualizeListView&version=1.2.2                

MPowerKit.VirtualizeListView

MAUI Virtualize ListView with smooth scrolling and without platform-specific code

Nuget

It's not a secret to anybody, that ListView and CollectionView in MAUI have bad scrolling performance. This project started as an experimantal project POC to find a way to make a virtualize listview using ScrollView and AbsoluteLayout only. Suprisingly, the scrolling performance is way better, than was expected. So you can check it right now.

It works on all platforms MAUI supports and it has the same behavior on all platforms, because it does not have platform-specific code.

So, under the hood it is a ScrollView with custom typeof(Layout) as items layout. The main idea of virtualization for this listview is to change Translation (virtual position, but on Android it is still physical chage because of #5) of items while keeping them attached to the layout. VirtualizeItemsLayoutManger is responsible for virtualization process and for creating / removing views and it will not create more views as necessary.

Your PRs are welcome!

Android Windows
<video src="https://github.com/MPowerKit/VirtualizeListView/assets/23138430/edd8aa08-3a6a-404f-9e95-28343b13498f" controls="controls" width="287" height="630"/> <video src="https://github.com/MPowerKit/VirtualizeListView/assets/23138430/e9b6715a-7f56-4f23-b757-9c18c6597fad" controls="controls" width="426" height="240"/>

Implemented features:

  • Linear items layout
  • Grid items layout
  • Items spacing
  • Virtualization
  • Grouping
  • Collection padding
  • Scroll orientation (collection orientation)
  • Disable scrolling
  • Header / Footer
  • Load more
  • Scroll speed
  • Cache pool
  • Item tap handling
  • Item resize handling
  • Add, Remove, Replace, Move, Reset operations on collection
  • Drag and drop (reordering)
  • Sticky headers
  • Animated add/remove/move operations

Tips for better scrolling user experience

  • Bindings - your enemy. Try to avoid bindings in your item templates or do OneTime where you can. But if you need them, use only compiled bindings or better levitali/CompiledBindings library.
  • Try to avoid using triggers, they are slow.
  • Use as less templates as possible. The more templates you have, the more time it takes to create a view.
  • Use InitialCachePoolSize to set up the number of initial views to keep in cache. Default size is 4. The bigger value - the more cached views it creates during initialization. And if you have a lot of templates it can take some time to initialize pool for each template. So in this case just manipulate with the InitialCachePoolSize. If you have only 1 template, you can set it to 2, it will be enough.
  • Create separate view for DataTemplate and replace bindings where you can by manual setting the values from the code behind of that view.
  • Use as less layouts as possible. Use only ContentView, Grid, VerticalStackLayout or HorizontalStackLayout. Try to avoid using Border or Frame, better create RoundBorderEffect.
  • Try to avoid using Shadow property in your templates. It can slow down the rendering process.
  • Set the direct dimensions for your controls where you can in the template, especially for Image.
  • If you have very complex layout and the VirtualizeListView still not smooth and laggy, you can try to decrease ScrollSpeed, it may help in some cases. (MAUI does a lot of redundant work remeasuring and relayouting views few times).

Usage

Add UseMPowerKitListView() to your MauiProgram.cs file as next

builder
    .UseMauiApp<App>()
    .UseMPowerKitListView();

and in your xaml just use as a regular CollectionView.

Note: The root of the ItemTemplate has to be typeof(VirtualizeListViewCell), but group/header/footer templates are not allowed to have root of this type.

To change items spacing you need to reset the ItemsLayout property as next:

<mpowerkit:VirtualizeListView>
	<mpowerkit:VirtualizeListView.ItemsLayout>
		<mpowerkit:LinearLayout ItemSpacing="15" 
		                        InitialCachePoolSize="4" /> 
	</mpowerkit:VirtualizeListView.ItemsLayout>
</mpowerkit:VirtualizeListView>

By default it has zero spacing.

To change collection orientation just change the Orientation property of the VirtualizeListView as you would do this in ScrollView.

To disable scroll set CanScroll property to false, and do not change Orientation property to Neither.

Other useful features

FixedRefreshView

This package brings to you fixed MAUI's RefreshView as FixedRefreshView. Here, you can disable refreshing without disabling entire collection. For this you may use IsPullToRefreshEnabled.

ObservableRangeCollection

Also, this package contains ObservableRangeCollection which is an ObservableCollection, but it has a bunch of useful methods to manipulate the collection with batch updates. Recommended to use with VirtualizeListView. It provides few methods: AddRange, InsertRange, RemoveRange, ReplaceRange.

Known issues

  • In debug mode it can have bad scrolling performance, especially on Windows, but in release mode it works surprisingly very well.
Product Compatible and additional computed target framework versions.
.NET net8.0-android34.0 is compatible.  net8.0-ios17.2 is compatible.  net8.0-maccatalyst17.2 is compatible.  net8.0-windows10.0.22621 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.1 373 9/1/2024
2.0.0 137 8/27/2024
2.0.0-pre4 123 8/21/2024
2.0.0-pre3 113 8/21/2024
2.0.0-pre2 96 8/20/2024
1.2.5 169 8/15/2024
1.2.4 1,279 7/26/2024
1.2.3 80 7/26/2024
1.2.2 68 7/26/2024
1.2.0 92 7/23/2024
1.1.5 100 7/8/2024
1.1.4 114 7/3/2024
1.1.3 117 7/1/2024
1.1.2 88 6/26/2024
1.1.1 850 6/4/2024
1.1.0 102 5/31/2024
1.0.5 447 5/23/2024
1.0.4 104 5/21/2024
1.0.3 105 5/21/2024
1.0.2 348 5/13/2024
1.0.1 90 5/12/2024
1.0.0 101 5/11/2024