You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-15
Original file line number
Diff line number
Diff line change
@@ -8,29 +8,16 @@ A directive for [Angular](https://angular.io/) framework to provide unlimited bi
8
8
<pdir="rtl">
9
9
<sub>can donate? go <b><ahref="https://github.com/dhilt/ngx-ui-scroll?sponsor=1">here</a></b></sub><sub> 👉 <br>make open-source world better</sub></p>
10
10
11
-
-[Compatibility](#compatibility)
12
11
-[Motivation](#motivation)
13
12
-[Features](#features)
14
13
-[Getting](#getting)
15
14
-[Usage](#usage)
16
15
-[Settings](#settings)
17
16
-[Adapter API](#adapter-api)
17
+
-[Compatibility](#compatibility)
18
18
-[Development](#development)
19
19
<br>
20
20
21
-
<aname="compatibility"id="compatibility"></a>
22
-
### Compatibility
23
-
24
-
The ngx-ui-scroll library has no breaking changes in its API, but there are inevitable changes in how it is built and distributed to the host app depending on the version of the Angular.
25
-
26
-
|ngx-ui-scroll|Angular|compiled|support|notes|
27
-
|:--|:--|:--|:--|:--|
28
-
|v1|5-12|View Engine|no|no dependencies (vscroll is not extracted)|
29
-
|v2|5-12|View Engine|maintenance|vscroll is a bundle-dependency|
30
-
|v3|12+|Ivy|active|vscroll is a peer-dependency|
31
-
32
-
So if the consumer app is view-engine compatible, you should use ngx-ui-scroll v2 which is in maintenance mode and under [v2-legacy](https://github.com/dhilt/ngx-ui-scroll/tree/v2-legacy) branch.
33
-
34
21
### Motivation
35
22
36
23
Scrolling large datasets may cause performance issues. Many DOM elements, many data-bindings, many event listeners... The common way to improve the performance is to render only a small portion of the dataset visible to a user. Other dataset elements that are not visible to a user are virtualized with upward and downward empty padding elements which should provide a consistent viewport with consistent scrollbar parameters.
@@ -229,7 +216,7 @@ Below is the list of invocable methods of the Adapter API with description and l
229
216
230
217
Along with the documented API there are some undocumented features that can be treated as experimental. They are not tested enough and might change over time. Some of them can be found on the [experimental tab](https://dhilt.github.io/ngx-ui-scroll/#experimental) of the demo app.
231
218
232
-
All of the Adapter methods are asynchronous, because they work with DOM and may take time to complete. For this purpose the Adapter methods return a Promise resolving at the moment when the Scroller terminates its internal processes, which were triggered by the invocation of the correspondent Adapter method. This is called the [Adapter Return API](https://dhilt.github.io/ngx-ui-scroll/#adapter#return-value). This promise has exactly the same nature as the promise of the [Adapter.relax method](https://dhilt.github.io/ngx-ui-scroll/#experimental#adapter-relax). Both "Relax" and "Return API" are the instruments of the App-Scroller processes normalization. It might be quite important to run some logic after the Scroller finishes its job and relaxes. Below is an example of how an explicit sequence of the Adapter methods can be safely implemented:
219
+
All Adapter methods are asynchronous because they interact with the DOM, which can be a time-consuming operation. Each Adapter method returns a Promise that resolves when the Scroller has terminated all internal processestriggered by that specific method call. This is called the [Adapter Return API](https://dhilt.github.io/ngx-ui-scroll/#adapter#return-value). The Promise returned by each Adapter method has exactly the same nature as the promise of the [Adapter.relax method](https://dhilt.github.io/ngx-ui-scroll/#experimental#adapter-relax). Both the "Relax" method and the "Return API" serve as tools for normalizing App-Scroller processes. In many cases, it is crucial to perform certain logic only after the Scroller has finished its work and entered a relaxed state. Below is an example of how to safely implement a sequence of Adapter method calls:
For more information, see [Adapter demo page](https://dhilt.github.io/ngx-ui-scroll/#adapter).
244
231
245
232
233
+
### Compatibility
234
+
235
+
The ngx-ui-scroll library has no breaking changes in its API, but there are inevitable changes in how it is built and distributed to the host app depending on the version of the Angular. This means that while your code using the library’s API remains compatible across versions, you may need to select the appropriate ngx-ui-scroll package version to match your Angular project’s build system and compatibility requirements.
0 commit comments