Skip to content

virtual-scroll: add onContentRendered hook to VirtualScrollStrategy #10290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 7, 2018

Conversation

mmalerba
Copy link
Contributor

@mmalerba mmalerba commented Mar 6, 2018

progress toward #10113

@mmalerba mmalerba requested review from amcdnl, jelbourn and crisbeto March 6, 2018 19:26
@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Mar 6, 2018
@@ -122,6 +128,9 @@ export class CdkVirtualScrollViewport implements OnInit, OnDestroy {
this._ngZone.run(() => {
this._renderedRangeSubject.next(this._renderedRange = range);
this._changeDetectorRef.markForCheck();
this._ngZone.runOutsideAngular(() => this._ngZone.onStable.pipe(take(1)).subscribe(() => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems a little weird to run outside Angular and then waiting for the zone to stabilize. What about flipping them around like:

ngZone.onStable.pipe(take(1)).subscribe(() => {
  ngZone.runOutsideAngular(() => onContentCentered());
});

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't subscribing within the zone cause another change detection when the zone stabilizes?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does NgZone patch into the observable subscriptions? AFAIK it only does browser APIs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jelbourn I was worried about that too, but I tested by creating a component that did:

ngAfterContentChecked() {
  this.ngZone.onStable.subscribe(() => {})
}

It didn't go into a death spiral, so it looks like @crisbeto's suggestion would work.

To me it seems clearer to have it the way it is though. It makes it obvious that I don't want any change detection as a result of this subscription.

/** Measure the combined size of all of the rendered items. */
measureRenderedContentSize() {
return this.orientation === 'horizontal' ?
this._contentWrapper.nativeElement.offsetWidth :
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull out the this._contentWrapper.nativeElement into a variable?

@@ -179,9 +186,13 @@ export class AutoSizeVirtualScrollStrategy implements VirtualScrollStrategy {
}

/** Update the viewport's total content size. */
private _updateTotalContentSize() {
private _updateTotalContentSize(renderedContentSize) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one's missing a type.

this._renderContentForOffset(this._viewport.measureScrollOffset());
}
}

/** Called when the range of items rendered in the DOM has changed. */
onContentRendered() {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Name this function for what it does instead of when it's called?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see these more as hooks for someone implementing a VirtualScrollStrategy, therefore I think it makes sense to name them based on when they're called. What it actually does will depend on the particular concrete strategy

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to then break the content of this function out into another function that gets called here? With the current name/behavior, it's not immediately clear what the code is meant to do without jumping around the file.

@@ -122,6 +128,9 @@ export class CdkVirtualScrollViewport implements OnInit, OnDestroy {
this._ngZone.run(() => {
this._renderedRangeSubject.next(this._renderedRange = range);
this._changeDetectorRef.markForCheck();
this._ngZone.runOutsideAngular(() => this._ngZone.onStable.pipe(take(1)).subscribe(() => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't subscribing within the zone cause another change detection when the zone stabilizes?

@mmalerba
Copy link
Contributor Author

mmalerba commented Mar 7, 2018

Comments addressed PTAL

@@ -129,6 +126,17 @@ export class AutoSizeVirtualScrollStrategy implements VirtualScrollStrategy {
this._addBufferPx = addBufferPx;
}

/**
* Checks the size of the currently rendered content and uses it tp update the estimated item size
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"tp" -> "to"

Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jelbourn jelbourn added pr: lgtm action: merge The PR is ready for merge by the caretaker and removed pr: needs review labels Mar 7, 2018
@mmalerba mmalerba merged commit 733e86e into angular:virtual-scroll Mar 7, 2018
mmalerba added a commit that referenced this pull request Mar 7, 2018
…y` (#10290)

* virtual-scroll: add `onContentRendered` hook to `VirtualScrollStrategy`

* address comemnts
mmalerba added a commit that referenced this pull request Mar 9, 2018
…y` (#10290)

* virtual-scroll: add `onContentRendered` hook to `VirtualScrollStrategy`

* address comemnts
mmalerba added a commit that referenced this pull request Mar 19, 2018
…y` (#10290)

* virtual-scroll: add `onContentRendered` hook to `VirtualScrollStrategy`

* address comemnts
mmalerba added a commit to mmalerba/components that referenced this pull request Apr 5, 2018
…y` (angular#10290)

* virtual-scroll: add `onContentRendered` hook to `VirtualScrollStrategy`

* address comemnts
mmalerba added a commit that referenced this pull request May 22, 2018
* feat(virtual-scroll): fixed size virtual scroll (#9316)

* feat(virtual-scroll): fixed size virtual scroll

* address some comments

* change VirtualScrollStrategy interface a bit

* address some more comments

* fix lint & build

* chore: move virtual-scroll to cdk-experimental (#9974)

* virtual-scroll: simplify scroll listener logic (#10102)

* virtual-scroll: only move views that need to be moved (#10099)

* virtual-scroll: only move views that need to be moved

* address comments

* virtual-scroll: switch `throttleTime` to `sampleTime` (#10179)

* virtual-scroll: switch throttleTime to sampleTime

* add comment

* virtual-scroll: allow user to pass `Observable<T[]>` (#10158)

* virtual-scroll: rename `Range` to `ListRange` to avoid confusion with native `Range` (#10220)

* virtual-scroll: add autosize scroll strategy (#10219)

* rename fixed size virtual scroll directive

* add autosize virtual scroll strategy

* add item size estimator class

* add logic for jumping rendered content based on scroll position

* address comments

* virtual-scroll: add `onContentRendered` hook to `VirtualScrollStrategy` (#10290)

* virtual-scroll: add `onContentRendered` hook to `VirtualScrollStrategy`

* address comemnts

* virtual-scroll: add incremental scroll logic in `AutosizeVirtualScrollStrategy` (#10504)

* virtual-scroll: add incremental scroll logic in `AutosizeVirtualScrollStrategy`.

This still has a couple issues that need to be ironed out and it doesn't
have the code for correcting the error between the predicted and actual
scroll position. (See various TODOs for additional things that need
work).

* fix lint

* address comments

* address comments

* fix bazel

* fix devapp

* fix lint

* cleanup

* virtual-scroll: rewrite offset in terms of "to-top" and fix a bug where items were removed too soon (#10986)

* rewrite offsets to the end of the rendered content as offsets to the
start

* add some more autosize demos for testing

* make sure not to remove too many items

* address comments

* virtual-scroll: address amcdnl's feedback (#10988)

* rewrite offsets to the end of the rendered content as offsets to the
start

* add some more autosize demos for testing

* make sure not to remove too many items

* virtual-scroll: address amcdnl's feedback

* virtual-scroll: fix updating when data changes and add trackBy demos (#11085)

* virtual-scroll: add logic to correct the scroll position as user move… (#11137)

* virtual-scroll: add logic to correct the scroll position as user moves toward the top

* address comments

* fix(scrolling): adds right to fix pushed content (#11192)

* fix(scrolling): adds right to fix pushed content

* chore: address feedback

* chore: address pr feedback

* virtual-scroll: add tests for fixed size items (#11255)

* virtual-scroll: add tests for fixed size items

* address comments

* fix bug in fixed size strategy

* fix bazel build

* virtual-scroll: add tests for `cdkVirtualFor` logic (#11275)

* merge fixed size test components into one

* add tests for cdkVirtualFor logic

* allow undefined to be explicitly passed as trackBy

* fix bazel build

* address comments

* add some basic tests (#11295)

* fix lint

* virtual-scroll: add e2e tests for autosize scroll strategy (#11345)

* set up virtual scroll page in e2e app

* add gulp task for e2e:watch

* add e2e tests for autosize

* address comments

* address comments

* fix lint and tests

* fix bad rebase

* fix(scrolling): scrollbar jump when data change on scroll (#11193)

* fix(scrolling): data change not updating size

* chore: remove todo

* chore: more performant fix for jump
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 8, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants