angular / angular/components

bug(cdk) Replacing datasource does not refresh/display items in cdk-virtual-scrollport

Open
#22,464 8 comments 7 reactions 0 assignees View on GitHub
area: cdk/scrolling P3
Dominant language
TypeScript
Stars
25k
Forks
6.8k
Avg merge
1d 8h
Merged PRs (30d)
91

Description

**Overview**

The first time you assign a datasource for iteration within the cdk-virtual-scrollport, all works as expected, as per the documentation example of displaying the first page of items. See "Virtual scroll with a custom data source" on https://material.angular.io/cdk/scrolling/examples

The bug however is if you subsequently try to assign a new instance of a datasource object to the same scroller. You will find that the scrollport will not request/display the first page of items from that new datasource **until the user scrolls the visible area**.

**Motivation/Use Case**
In the real-world our virtual data can require some sort of user driven filtering, like a search screen. Which will require a complete replacement of all the underlying/cached data in the scroller with fresh results. This is ideally achieved by replacing the datasource when the user triggers the search.

**Expected Behavior**
Scroller should reset itself automatically when given a new datasource and request the first page of rows in exactly the same way it does when it was assigned the first datasource.

**Actual Behavior**
CollectionViewer does not fire an event to the subscription in connect() until it has a range that differs.

**Minimal repro:**
See https://stackblitz.com/edit/angular-fs9xei-rgkahy?file=src%2Fapp%2Fcdk-virtual-scroll-data-source-example.ts

Run the sample, initial list items will appear. Click on the "Switch datasource button", and you will see the items in the list stuck with saying "loading..." indefinitely. You have to scroll before the datasource actually gets asked for data to be able to be displayed.

**Environment**
Angular: 11
CDK/Material: 11
Browser(s): n/a
Operating System (e.g. Windows, macOS, Ubuntu): n/a

Contributor guide

Open the contributing guide

Research direction

Start by running the linked StackBlitz reproduction and reviewing the CDK virtual scroll data-source example. Trace how cdk-virtual-scrollport replaces its datasource and how CollectionViewer events reach the subscription in connect(). Done means switching datasources requests and displays the first page without requiring a scroll.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.