ng-virtual-list 19.1.30 → 20.0.0

package/README.md

@@ -1,7 +1,7 @@
 # NgVirtualList
 Maximum performance for extremely large lists.
 
-Angular version 19.X.X.
+Angular version 20.X.X.
 
 ![intro](https://github.com/user-attachments/assets/80fbed6c-9f77-48c3-a7a6-2cedf32aebc2)
 
@@ -28,9 +28,9 @@ Template:
 
 <ng-template #hotizontalItemRenderer let-data="data">
   @if (data) {
-    <div class="list__h-container" (click)="onItemClick(data)">
-      <span>{{data.name}}</span>
-    </div>
+  <div class="list__h-container" (click)="onItemClick(data)">
+    <span>{{data.name}}</span>
+  </div>
   }
 </ng-template>
 ```
@@ -68,14 +68,14 @@ Template:
   @if (data) {
     @switch (data.type) {
       @case ("group-header") {
-        <div class="list__h-group-container">
-          <span>{{data.name}}</span>
-        </div>
+      <div class="list__h-group-container">
+        <span>{{data.name}}</span>
+      </div>
       }
       @default {
-        <div class="list__h-container" (click)="onItemClick(data)">
-          <span>{{data.name}}</span>
-        </div>
+      <div class="list__h-container" (click)="onItemClick(data)">
+        <span>{{data.name}}</span>
+      </div>
       }
     }
   }
@@ -124,9 +124,9 @@ Template:
 
 <ng-template #itemRenderer let-data="data">
   @if (data) {
-    <div class="list__container">
-      <p>{{data.name}}</p>
-    </div>
+  <div class="list__container">
+    <p>{{data.name}}</p>
+  </div>
   }
 </ng-template>
 ```
@@ -167,14 +167,14 @@ Template:
   @if (data) {
     @switch (data.type) {
       @case ("group-header") {
-        <div class="list__group-container">
-          <p>{{data.name}}</p>
-        </div>
+      <div class="list__group-container">
+        <p>{{data.name}}</p>
+      </div>
       }
       @default {
-        <div class="list__container">
-          <p>{{data.name}}</p>
-        </div>
+      <div class="list__container">
+        <p>{{data.name}}</p>
+      </div>
       }
     }
   }
@@ -194,14 +194,14 @@ Template (with snapping):
   @if (data) {
     @switch (data.type) {
       @case ("group-header") {
-        <div class="list__group-container">
-          <p>{{data.name}}</p>
-        </div>
+      <div class="list__group-container">
+        <p>{{data.name}}</p>
+      </div>
       }
       @default {
-        <div class="list__container">
-          <p>{{data.name}}</p>
-        </div>
+      <div class="list__container">
+        <p>{{data.name}}</p>
+      </div>
       }
     }
   }
@@ -435,23 +435,22 @@ List items are encapsulated in shadowDOM, so to override default styles you need
 
 ## API
 
-[NgVirtualListComponent](https://github.com/DjonnyX/ng-virtual-list/blob/19.x/projects/ng-virtual-list/src/lib/ng-virtual-list.component.ts)
+[NgVirtualListComponent](https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/ng-virtual-list.component.ts)
 
 Inputs
 
 | Property | Type | Description |
 |---|---|---|
 | id | number | Readonly. Returns the unique identifier of the component. | 
-| items | [IVirtualListCollection](https://github.com/DjonnyX/ng-virtual-list/blob/19.x/projects/ng-virtual-list/src/lib/models/collection.model.ts) | Collection of list items. The collection of elements must be immutable. |
+| items | [IVirtualListCollection](https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/models/collection.model.ts) | Collection of list items. |
 | itemSize | number? = 24 | If direction = 'vertical', then the height of a typical element. If direction = 'horizontal', then the width of a typical element. Ignored if the dynamicSize property is true. |
 | itemsOffset | number? = 2 | Number of elements outside the scope of visibility. Default value is 2. |
 | itemRenderer | TemplateRef | Rendering element template. |
-| stickyMap | [IVirtualListStickyMap?](https://github.com/DjonnyX/ng-virtual-list/blob/19.x/projects/ng-virtual-list/src/lib/models/sticky-map.model.ts) | Dictionary zIndex by id of the list element. If the value is not set or equal to 0, then a simple element is displayed, if the value is greater than 0, then the sticky position mode is enabled for the element. |
+| stickyMap | [IVirtualListStickyMap?](https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/models/sticky-map.model.ts) | Dictionary zIndex by id of the list element. If the value is not set or equal to 0, then a simple element is displayed, if the value is greater than 0, then the sticky position mode is enabled for the element. |
 | snap | boolean? = false | Determines whether elements will snap. Default value is "false". |
-| direction | [Direction? = 'vertical'](https://github.com/DjonnyX/ng-virtual-list/blob/19.x/projects/ng-virtual-list/src/lib/enums/direction.ts) | Determines the direction in which elements are placed. Default value is "vertical". |
+| snapToItem | boolean? = false | Determines whether scroll positions will be snapped to the element. Default value is "false". |
+| direction | [Direction? = 'vertical'](https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/enums/direction.ts) | Determines the direction in which elements are placed. Default value is "vertical". |
 | dynamicSize | boolean? = false | If true then the items in the list can have different sizes and the itemSize property is ignored. If false then the items in the list have a fixed size specified by the itemSize property. The default value is false. |
-| enabledBufferOptimization | boolean? = true | Experimental! Enables buffer optimization. Can only be used if items in the collection are not added or updated. |
-| trackBy | string? = 'id' | The name of the property by which tracking is performed. |
 
 <br/>
 
@@ -459,8 +458,8 @@ Outputs
 
 | Event | Type | Description |
 |---|---|---|
-| onScroll | ([IScrollEvent](https://github.com/DjonnyX/ng-virtual-list/blob/19.x/projects/ng-virtual-list/src/lib/models/scroll-event.model.ts)) => void | Fires when the list has been scrolled. |
-| onScrollEnd | ([IScrollEvent](https://github.com/DjonnyX/ng-virtual-list/blob/19.x/projects/ng-virtual-list/src/lib/models/scroll-event.model.ts)) => void | Fires when the list has completed scrolling. |
+| onScroll | (scrollSize: number) => void | Fires when the list has been scrolled. |
+| onScrollEnd | (scrollSize: number) => void | Fires when the list has completed scrolling. |
 
 <br/>
 
@@ -468,30 +467,4 @@ Methods
 
 | Method | Type | Description |
 |--|--|--|
-| scrollTo | (id: [Id](https://github.com/DjonnyX/ng-virtual-list/blob/19.x/projects/ng-virtual-list/src/lib/types/id.ts), behavior: ScrollBehavior = 'auto') => number | The method scrolls the list to the element with the given id and returns the value of the scrolled area. Behavior accepts the values ​​"auto", "instant" and "smooth". |
-
-<br/>
-
-## Licence
-
-MIT License
-
-Copyright (c) 2025 Evgenii Grebennikov
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+| scrollTo | (id: [Id](https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/types/id.ts), behavior: ScrollBehavior = 'auto') => number | The method scrolls the list to the element with the given id and returns the value of the scrolled area. Behavior accepts the values ​​"auto", "instant" and "smooth". |