Merge pull request #1549 from rx-angular/fix-virtual-scroll-docs

hoebbelsB · web-flow · commit 0a599db60465 · 2023-04-25T02:11:45.000+02:00
docs(template): fix virtual scroll strategy usage description
diff --git a/apps/docs/docs/template/api/virtual-scrolling.md b/apps/docs/docs/template/api/virtual-scrolling.md
@@ -51,8 +51,8 @@ export class MyComponent {}
 ```
 
 ```html
-<rx-virtual-scroll-viewport>
-  <div [itemSize]="50" *rxVirtualFor="let hero of heroes$;">
+<rx-virtual-scroll-viewport [itemSize]="50">
+  <div *rxVirtualFor="let hero of heroes$;">
     <div>
       <div><strong>{{ hero.name }}</strong></div>
       <div>{{ hero.id }}</div>
@@ -150,8 +150,8 @@ export class MyComponent {}
 ### Fixed size virtual-scroll using `*rxVirtualFor` with `Observable` values
 
 ```html
-<rx-virtual-scroll-viewport>
-  <div class="hero" [itemSize]="50" *rxVirtualFor="let hero of heroes$;">
+<rx-virtual-scroll-viewport [itemSize]="50">
+  <div class="hero" *rxVirtualFor="let hero of heroes$;">
     <div>
       <div><strong>{{ hero.name }}</strong></div>
       <div>{{ hero.id }}</div>
@@ -179,8 +179,8 @@ export class AnyComponent {
 ### Fixed size virtual-scroll using `*rxVirtualFor` with static values
 
 ```html
-<rx-virtual-scroll-viewport>
-  <div class="hero" [itemSize]="50" *rxVirtualFor="let hero of heroes">
+<rx-virtual-scroll-viewport [itemSize]="50">
+  <div class="hero" *rxVirtualFor="let hero of heroes">
     <div>
       <div><strong>{{ hero.name }}</strong></div>
       <div>{{ hero.id }}</div>
@@ -210,12 +210,8 @@ export class AnyComponent {
 The `trackBy` input either takes a `keyof T` or the regular `TrackByFunction` (`(index: number, item: T) => any`) as a value.
 
 ```html
-<rx-virtual-scroll-viewport>
-  <div
-    class="hero"
-    [itemSize]="50"
-    *rxVirtualFor="let hero of heroes; trackBy: 'id'"
-  >
+<rx-virtual-scroll-viewport [itemSize]="50">
+  <div class="hero" *rxVirtualFor="let hero of heroes; trackBy: 'id'">
     <div>
       <div><strong>{{ hero.name }}</strong></div>
       <div>{{ hero.id }}</div>
diff --git a/libs/template/experimental/virtual-scrolling/src/lib/virtual-list-template-manager.ts b/libs/template/experimental/virtual-scrolling/src/lib/virtual-list-template-manager.ts
@@ -33,6 +33,7 @@ export interface RxVirtualListTemplateManager<T, C> {
  * @internal
  *
  * Factory that returns a `ListTemplateManager` for the passed params.
+ * Similar to https://github.com/angular/components/blob/main/src/cdk/collections/recycle-view-repeater-strategy.ts
  *
  * @param templateSettings
  */

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@ export interface RxVirtualListTemplateManager<T, C> {`
`33`	`33`	`* @internal`
`34`	`34`	`*`
`35`	`35`	* Factory that returns a `ListTemplateManager` for the passed params.
	`36`	`+ * Similar to https://github.com/angular/components/blob/main/src/cdk/collections/recycle-view-repeater-strategy.ts`
`36`	`37`	`*`
`37`	`38`	`* @param templateSettings`
`38`	`39`	`*/`