ng-virtual-list 21.9.4 → 21.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +20 -59
  2. package/fesm2022/ng-virtual-list.mjs +999 -638
  3. package/fesm2022/ng-virtual-list.mjs.map +1 -1
  4. package/package.json +1 -1
  5. package/types/ng-virtual-list.d.ts +84 -13
package/README.md CHANGED
@@ -99,57 +99,6 @@ npm i ng-virtual-list
99
99
 
100
100
  <br/>
101
101
 
102
- ### IMPORTANT
103
-
104
- `Zone.js` is required for correct rendering.
105
-
106
- - `package.json`:
107
- ```json
108
- {
109
- ...
110
- "dependencies": {
111
- ...
112
- "zone.js": "~0.15.0"
113
- },
114
- }
115
- ```
116
-
117
- - `angular.json`:
118
- ```json
119
- {
120
- "projects": {
121
- "PROJECT_NAME": {
122
- ...
123
- "architect": {
124
- "build": {
125
- ...
126
- "options": {
127
- ...
128
- "polyfills": [
129
- "zone.js"
130
- ],
131
- }
132
- }
133
- }
134
- }
135
- }
136
- }
137
- ```
138
-
139
- - `app.config.ts`:
140
- ```ts
141
- import { ApplicationConfig, provideZoneChangeDetection } from '@angular/core';
142
-
143
- export const appConfig: ApplicationConfig = {
144
- providers: [
145
- ...
146
- provideZoneChangeDetection(),
147
- ]
148
- };
149
- ```
150
-
151
- <br/>
152
-
153
102
  ## 🚀 Quick Start
154
103
  ```html
155
104
  <ng-virtual-list [items]="items" [bufferSize]="5" [itemRenderer]="itemRenderer" [itemSize]="64"></ng-virtual-list>
@@ -570,11 +519,14 @@ const X_LITE_BLUE_PLASMA_GRADIENT: GradientColor = ["rgba(133, 142, 255, 0)", "r
570
519
  ROUND_CORNER: RoundedCorner = [3, 3, 3, 3],
571
520
  SCROLLBAR_GRADIENT: ScrollBarTheme = {
572
521
  fill: ["rgba(51, 0, 97, 1)", "rgba(73, 0, 97, 1)"],
522
+ hoverFill: ["rgba(73, 6, 133, 1)", "rgba(73, 6, 133, 1)"],
523
+ pressedFill: ["rgba(73, 6, 150, 1)", "rgba(95, 0, 150, 1)"],
573
524
  strokeGradientColor: X_LITE_BLUE_PLASMA_GRADIENT,
574
525
  strokeAnimationDuration: 1000,
575
526
  thickness: 6,
576
527
  roundCorner: ROUND_CORNER,
577
528
  rippleColor: 'rgba(255,255,255,0.5)',
529
+ rippleEnabled: true,
578
530
  };
579
531
 
580
532
  @Component({
@@ -725,6 +677,11 @@ Inputs
725
677
  | snapScrollToBottom | boolean? = false | Determines whether the scroll will be anchored to the end of the list at startup.. Default value is "false". |
726
678
  | snapToEndTransitionInstantOffset | number? = 0 | Sets the offset value; if the scroll area value is exceeded, the scroll animation will be disabled. Default value is "0". |
727
679
  | scrollbarMinSize | number? = 80 | Minimum scrollbar size. |
680
+ | scrollbarEnabled | boolean? = true | Determines whether the scrollbar is shown or not. The default value is "true". |
681
+ | scrollbarInteractive | boolean? = true | Determines whether scrolling using the scrollbar will be possible. The default value is "true". |
682
+ | overscrollEnabled | boolean? = true | Determines whether the overscroll (re-scroll) feature will work. The default value is "true". |
683
+ | animationParams | [IAnimationParams](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/types/animation-params.ts)? = { scrollToItem: 50, navigateToItem: 150 } | Animation parameters. The default value is "{ scrollToItem: 50, navigateToItem: 150 }". |
684
+ | scrollBehavior | ScrollBehavior? = 'smooth' | Defines the scrolling behavior for any element on the page. The default value is "smooth". |
728
685
 
729
686
  <br/>
730
687
 
@@ -748,9 +705,13 @@ Methods
748
705
  | Method | Type | Description |
749
706
  |--|--|--|
750
707
  | scrollTo | (id: [Id](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/types/id.ts), cb?: () => void, options?: [IScrollOptions](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/models/scroll-options.model.ts)) | The method scrolls the list to the element with the given `id` and returns the value of the scrolled area. |
751
- | scrollToEnd | (cb?: () => void, options?: [IScrollOptions](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/models/scroll-options.model.ts)) | Scrolls the scroll area to the last item in the collection. |
708
+ | scrollToStart | (cb?: () => void, options?: [IScrollOptions](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/models/scroll-options.model.ts)) | Scrolls the scroll area to the first item in the collection. |
709
+ | scrollToEndItem | (cb?: () => void, options?: [IScrollOptions](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/models/scroll-options.model.ts)) | Scrolls the scroll area to the last item in the collection. |
710
+ | scrollToEnd | | Scrolls the list to the end of the content height. |
752
711
  | getItemBounds | (id: [Id](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/types/id.ts), behavior?: ScrollBehavior) => void | Returns the bounds of an element with a given id |
753
712
  | focus | [Id](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/types/id.ts), align: [FocusAlignment](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/types/focus-alignment.ts) = [FocusAlignments.NONE](https://github.com/DjonnyX/ng-virtual-list/blob/21.x/projects/ng-virtual-list/src/lib/enums/focus-alignments.ts) | Focus an list item by a given id. |
713
+ | cacheClean | | Force clearing the cache. |
714
+ | stopSnappingScrollToEnd | | Stops the list from snapping to the bottom edge. |
754
715
 
755
716
  <br/>
756
717
 
@@ -776,13 +737,13 @@ Properties
776
737
 
777
738
  | Angular version | ng-virtual-list version | git | npm |
778
739
  |--|--|--|--|
779
- | 20.x | 20.9.3 | [20.x](https://github.com/DjonnyX/ng-virtual-list/tree/20.x) | [20.9.3](https://www.npmjs.com/package/ng-virtual-list/v/20.9.3) |
780
- | 19.x | 19.9.5 | [19.x](https://github.com/DjonnyX/ng-virtual-list/tree/19.x) | [19.9.5](https://www.npmjs.com/package/ng-virtual-list/v/19.9.5) |
781
- | 18.x | 18.9.3 | [18.x](https://github.com/DjonnyX/ng-virtual-list/tree/18.x) | [18.9.3](https://www.npmjs.com/package/ng-virtual-list/v/18.9.3) |
782
- | 17.x | 17.9.3 | [17.x](https://github.com/DjonnyX/ng-virtual-list/tree/17.x) | [17.9.3](https://www.npmjs.com/package/ng-virtual-list/v/17.9.3) |
783
- | 16.x | 16.9.4 | [16.x](https://github.com/DjonnyX/ng-virtual-list/tree/16.x) | [16.9.4](https://www.npmjs.com/package/ng-virtual-list/v/16.9.4) |
784
- | 15.x | 15.9.4 | [15.x](https://github.com/DjonnyX/ng-virtual-list/tree/15.x) | [15.9.4](https://www.npmjs.com/package/ng-virtual-list/v/15.9.4) |
785
- | 14.x | 14.9.4 | [14.x](https://github.com/DjonnyX/ng-virtual-list/tree/14.x) | [14.9.4](https://www.npmjs.com/package/ng-virtual-list/v/14.9.4) |
740
+ | 20.x | 20.10.0 | [20.x](https://github.com/DjonnyX/ng-virtual-list/tree/20.x) | [20.10.0](https://www.npmjs.com/package/ng-virtual-list/v/20.10.0) |
741
+ | 19.x | 19.10.0 | [19.x](https://github.com/DjonnyX/ng-virtual-list/tree/19.x) | [19.10.0](https://www.npmjs.com/package/ng-virtual-list/v/19.10.0) |
742
+ | 18.x | 18.10.0 | [18.x](https://github.com/DjonnyX/ng-virtual-list/tree/18.x) | [18.10.0](https://www.npmjs.com/package/ng-virtual-list/v/18.10.0) |
743
+ | 17.x | 17.10.0 | [17.x](https://github.com/DjonnyX/ng-virtual-list/tree/17.x) | [17.10.0](https://www.npmjs.com/package/ng-virtual-list/v/17.10.0) |
744
+ | 16.x | 16.9.6 | [16.x](https://github.com/DjonnyX/ng-virtual-list/tree/16.x) | [16.9.6](https://www.npmjs.com/package/ng-virtual-list/v/16.9.6) |
745
+ | 15.x | 15.9.6 | [15.x](https://github.com/DjonnyX/ng-virtual-list/tree/15.x) | [15.9.6](https://www.npmjs.com/package/ng-virtual-list/v/15.9.6) |
746
+ | 14.x | 14.9.6 | [14.x](https://github.com/DjonnyX/ng-virtual-list/tree/14.x) | [14.9.6](https://www.npmjs.com/package/ng-virtual-list/v/14.9.6) |
786
747
 
787
748
  <br/>
788
749