Thanks to visit codestin.com
Credit goes to github.com

Skip to content

refactor(template): rename viewCacheSize to templateCacheSize #1602

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.

Sign up for GitHub

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
Aug 11, 2023
Merged

refactor(template): rename viewCacheSize to templateCacheSize #1602

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e975fe
refactor(template): rename viewCacheSize to templateCacheSize
hoebbelsB Aug 4, 2023
ccc08e3
Merge branch 'main' into refactor-rename-templatecache
hoebbelsB Aug 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions apps/docs/docs/template/api/virtual-scrolling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ all pre-packaged ScrollStrategies as well as control the majority of inputs.
- configurable frame budget (defaults to 60 FPS)
- Super efficient layouting with css transformations
- Scoped layouting with css containment
- Define a viewCache in order to re-use views instead of re-creating them
- Define a templateCache in order to re-use views instead of re-creating them
- triggers change-detection on `EmbeddedView` level
- Zone-agnostic, opt-out of `NgZone` with `patchZone`
- 3 Configurable `RxVirtualScrollStrategy` providing the core logic to calculate the viewRange and position DOM
Expand Down Expand Up @@ -433,14 +433,14 @@ Read more about the concurrent mode in the [concurrent strategies section](https

#### Inputs

| Input | Type | description |
| ---------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `trackBy` | `keyof T` or `(index: number, item: T) => any` | Identifier function for items. `rxVirtualFor` provides a shorthand where you can name the property directly. |
| `patchZone` | `boolean` | _default: `true`_ if set to `false`, the `RxVirtualForDirective` will operate out of `NgZone`. See [NgZone optimizations](https://www.rx-angular.io/docs/template/performance-issues/ngzone-optimizations) |
| `parent` | `boolean` | _default: `false`_ if set to `false`, the `RxVirtualForDirective` won't inform its host component about changes being made to the template. More performant, `@ViewChild` and `@ContentChild` queries won't work. [Handling view and content queries](https://www.rx-angular.io/docs/template/performance-issues/handling-view-and-content-queries) |
| `strategy` | `Observable<RxStrategyNames \ string> \ RxStrategyNames \ string>` | _default: `normal`_ configure the `RxStrategyRenderStrategy` used to detect changes. [Render Strategies](https://www.rx-angular.io/docs/cdk/render-strategies) |
| `renderCallback` | `Subject<U>` | giving the developer the exact timing when the `RxVirtualForDirective` created, updated, removed its template. Useful for situations where you need to know when rendering is done. |
| `viewCacheSize` | `number` | _default: `20`_ Controls the amount if views held in cache for later re-use when a user is scrolling the list If this is set to 0, `rxVirtualFor` won't cache any view, thus destroying & re-creating very often on scroll events. |
| Input | Type | description |
| ------------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `trackBy` | `keyof T` or `(index: number, item: T) => any` | Identifier function for items. `rxVirtualFor` provides a shorthand where you can name the property directly. |
| `patchZone` | `boolean` | _default: `true`_ if set to `false`, the `RxVirtualForDirective` will operate out of `NgZone`. See [NgZone optimizations](https://www.rx-angular.io/docs/template/performance-issues/ngzone-optimizations) |
| `parent` | `boolean` | _default: `false`_ if set to `false`, the `RxVirtualForDirective` won't inform its host component about changes being made to the template. More performant, `@ViewChild` and `@ContentChild` queries won't work. [Handling view and content queries](https://www.rx-angular.io/docs/template/performance-issues/handling-view-and-content-queries) |
| `strategy` | `Observable<RxStrategyNames \ string> \ RxStrategyNames \ string>` | _default: `normal`_ configure the `RxStrategyRenderStrategy` used to detect changes. [Render Strategies](https://www.rx-angular.io/docs/cdk/render-strategies) |
| `renderCallback` | `Subject<U>` | giving the developer the exact timing when the `RxVirtualForDirective` created, updated, removed its template. Useful for situations where you need to know when rendering is done. |
| `templateCacheSize` | `number` | _default: `20`_ Controls the amount if views held in cache for later re-use when a user is scrolling the list If this is set to 0, `rxVirtualFor` won't cache any view, thus destroying & re-creating very often on scroll events. |

### RxVirtualScrollViewportComponent

Expand Down Expand Up @@ -631,7 +631,7 @@ import { RX_VIRTUAL_SCROLL_DEFAULT_OPTIONS } from '@rx-angular/template/experime
useValue: { // should be of type `RxVirtualScrollDefaultOptions`
runwayItems: 50,
// turn off cache by default
viewCacheSize: 0
templateCacheSize: 0
}
}]
})
Expand All @@ -641,7 +641,7 @@ import { RX_VIRTUAL_SCROLL_DEFAULT_OPTIONS } from '@rx-angular/template/experime

```ts
/* determines how many templates can be cached and re-used on rendering */
const DEFAULT_VIEW_CACHE_SIZE = 20;
const DEFAULT_TEMPLATE_CACHE_SIZE = 20;
/* determines how many views will be rendered in scroll direction */
const DEFAULT_ITEM_SIZE = 50;
/* determines how many views will be rendered in the opposite scroll direction */
Expand All @@ -655,7 +655,7 @@ const DEFAULT_RUNWAY_ITEMS_OPPOSITE = 2;
```ts
export interface RxVirtualScrollDefaultOptions {
/* determines how many templates can be cached and re-used on rendering, defaults to 20 */
viewCacheSize?: number;
templateCacheSize?: number;
/* determines how many views will be rendered in scroll direction, defaults to 15 */
runwayItems?: number;
/* determines how many views will be rendered in the opposite scroll direction, defaults to 5 */
Expand Down
2 changes: 1 addition & 1 deletion libs/template/experimental/virtual-scrolling/src/lib/model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface TemplateSettings<Implicit, Context, ComputedContext> {
templateRef: TemplateRef<Context>;
createViewContext: CreateViewContext<Implicit, Context, ComputedContext>;
updateViewContext: UpdateViewContext<Implicit, Context, ComputedContext>;
viewCacheSize: number;
templateCacheSize: number;
}

export interface ListRange {
Expand Down
8 changes: 4 additions & 4 deletions libs/template/experimental/virtual-scrolling/src/lib/virtual-for.directive.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ import {
RxVirtualListTemplateManager,
} from './virtual-list-template-manager';
import {
DEFAULT_VIEW_CACHE_SIZE,
DEFAULT_TEMPLATE_CACHE_SIZE,
RX_VIRTUAL_SCROLL_DEFAULT_OPTIONS,
} from './virtual-scroll.config';

Expand Down Expand Up @@ -324,8 +324,8 @@ export class RxVirtualFor<T, U extends NgIterable<T> = NgIterable<T>>
* scrolling the list. If this is set to 0, `rxVirtualFor` won't cache any view,
* thus destroying & re-creating very often on scroll events.
*/
@Input('rxVirtualForViewCacheSize') viewCacheSize =
this.defaults?.viewCacheSize || DEFAULT_VIEW_CACHE_SIZE;
@Input('rxVirtualForTemplateCacheSize') templateCacheSize =
this.defaults?.templateCacheSize || DEFAULT_TEMPLATE_CACHE_SIZE;

/**
* @description
Expand Down Expand Up @@ -605,7 +605,7 @@ export class RxVirtualFor<T, U extends NgIterable<T> = NgIterable<T>>
templateRef: this.template,
createViewContext: this.createViewContext.bind(this),
updateViewContext: this.updateViewContext.bind(this),
viewCacheSize: this.viewCacheSize,
templateCacheSize: this.templateCacheSize,
});
this.render()
.pipe(takeUntil(this._destroy$))
Expand Down
4 changes: 2 additions & 2 deletions libs/template/experimental/virtual-scrolling/src/lib/virtual-list-template-manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export function createVirtualListTemplateManager<
templateRef,
createViewContext,
updateViewContext,
viewCacheSize,
templateCacheSize,
}: TemplateSettings<T, C, any>): RxVirtualListTemplateManager<T, C> {
let _viewCache: EmbeddedViewRef<C>[] = [];
let itemCount = 0;
Expand Down Expand Up @@ -143,7 +143,7 @@ export function createVirtualListTemplateManager<
* destroyed.
*/
function _maybeCacheView(view: EmbeddedViewRef<C>) {
if (_viewCache.length < viewCacheSize) {
if (_viewCache.length < templateCacheSize) {
_viewCache.push(view);
return true;
} else {
Expand Down
6 changes: 3 additions & 3 deletions libs/template/experimental/virtual-scrolling/src/lib/virtual-scroll.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { InjectionToken } from '@angular/core';

export interface RxVirtualScrollDefaultOptions {
/* determines how many templates can be cached and re-used on rendering, defaults to 20 */
viewCacheSize?: number;
templateCacheSize?: number;
/* determines how many views will be rendered in scroll direction, defaults to 15 */
runwayItems?: number;
/* determines how many views will be rendered in the opposite scroll direction, defaults to 5 */
Expand All @@ -25,13 +25,13 @@ export function RX_VIRTUAL_SCROLL_DEFAULT_OPTIONS_FACTORY(): RxVirtualScrollDefa
return {
runwayItems: DEFAULT_RUNWAY_ITEMS,
runwayItemsOpposite: DEFAULT_RUNWAY_ITEMS_OPPOSITE,
viewCacheSize: DEFAULT_VIEW_CACHE_SIZE,
templateCacheSize: DEFAULT_TEMPLATE_CACHE_SIZE,
itemSize: DEFAULT_ITEM_SIZE,
};
}

/** @internal */
export const DEFAULT_VIEW_CACHE_SIZE = 20;
export const DEFAULT_TEMPLATE_CACHE_SIZE = 20;
/** @internal */
export const DEFAULT_ITEM_SIZE = 50;
/** @internal */
Expand Down
2 changes: 1 addition & 1 deletion libs/template/experimental/virtual-scrolling/tests/autosize.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ function mountAutoSize(
*rxVirtualFor="
let item of items;
renderCallback: renderCallback;
viewCacheSize: viewCache;
templateCacheSize: viewCache;
strategy: strategy;
trackBy: trackBy;
"
Expand Down
2 changes: 1 addition & 1 deletion libs/template/experimental/virtual-scrolling/tests/dynamic-size.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ function mountDynamicSize(
*rxVirtualFor="
let item of items;
renderCallback: renderCallback;
viewCacheSize: viewCache;
templateCacheSize: viewCache;
strategy: strategy;
trackBy: trackBy;
"
Expand Down
2 changes: 1 addition & 1 deletion libs/template/experimental/virtual-scrolling/tests/fixed-size.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ function mountFixedSize(
*rxVirtualFor="
let item of items;
renderCallback: renderCallback;
viewCacheSize: viewCache;
templateCacheSize: viewCache;
strategy: strategy;
trackBy: trackBy;
"
Expand Down
4 changes: 2 additions & 2 deletions libs/template/experimental/virtual-scrolling/tests/fixtures.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
DEFAULT_ITEM_SIZE,
DEFAULT_RUNWAY_ITEMS,
DEFAULT_RUNWAY_ITEMS_OPPOSITE,
DEFAULT_VIEW_CACHE_SIZE,
DEFAULT_TEMPLATE_CACHE_SIZE,
} from '../src/lib/virtual-scroll.config';

function randomContent(minLength = 1, maxLength = 50) {
Expand Down Expand Up @@ -83,7 +83,7 @@ export const defaultMountConfig: VirtualScrollMountConfig<Item> = {
runwayItems: DEFAULT_RUNWAY_ITEMS,
runwayItemsOpposite: DEFAULT_RUNWAY_ITEMS_OPPOSITE,
itemSize: DEFAULT_ITEM_SIZE,
viewCache: DEFAULT_VIEW_CACHE_SIZE,
viewCache: DEFAULT_TEMPLATE_CACHE_SIZE,
containerHeight: 300,
} as const;
export const defaultItemLength = 500;
Expand Down