Skip to content

Commit e23059a

Browse files
author
Denis Hilt
committed
Compatibility doc (2)
1 parent 337acd1 commit e23059a

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,29 @@ Unlimited bidirectional virtual scrolling over limited viewport. A directive for
88
<p dir="rtl">
99
<sub>can donate? go <b><a href="https://github.com/dhilt/ngx-ui-scroll?sponsor=1">here</a></b></sub><sub> 👉 <br>make open-source world better</sub></p>
1010

11+
- [Compatibility](#compatibility)
1112
- [Motivation](#motivation)
1213
- [Features](#features)
1314
- [Getting](#getting)
1415
- [Usage](#usage)
1516
- [Settings](#settings)
1617
- [Adapter API](#adapter-api)
17-
- [Compatibility](#compatibility)
1818
- [Development](#development)
1919

2020
<br>
2121

22+
<a name="compatibility" id="compatibility"></a>
23+
### Compatibility
24+
25+
|ngx-ui-scroll|Angular|compiled|support|notes|
26+
|:--|:--|:--|:--|:--|
27+
|v1|5-12|View Engine|no|no dependencies (vscroll is not extracted)|
28+
|v2|5-12|View Engine|maintenance|vscroll is a bundle-dependency|
29+
|v3|12+|Ivy|active|vscroll is a peer-dependency|
30+
31+
So if the consumer app is view-engine compatible, you should use v2 which is in maintenance mode and under [v2-legacy](https://github.com/dhilt/ngx-ui-scroll/tree/v2-legacy) branch.
32+
33+
2234
### Motivation
2335

2436
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.
@@ -226,16 +238,6 @@ console.log('Two-phase replacement done');
226238
For more information, see [Adapter demo page](https://dhilt.github.io/ngx-ui-scroll/#adapter).
227239

228240

229-
<a name="compatibility" id="compatibility"></a>
230-
### Compatibility
231-
232-
|ngx-ui-scroll|Angular|compiled|support|notes|
233-
|:--|:--|:--|:--|:--|
234-
|1|5-12|View Engine|no|no dependencies|
235-
|2|5-12|View Engine|maintenance|vscroll is bundle-dependency|
236-
|3|12+|Ivy|active|vscroll is peer-dependency|
237-
238-
239241
### Development
240242

241243
There are some npm scripts available from package.json:
@@ -273,7 +275,7 @@ Also, there are some environment variables for additional customization of the d
273275

274276
|Name|Value|Description|
275277
|:--|:----|:----------|
276-
|DEV_SERVER_PORT|4200|Port the dev server (webpack) will use. Need to run `npm run start:env` instead of `npm run` to make this setting work.|
278+
|DEV_SERVER_PORT|4200|Port the dev server (webpack) will use. Need to run `npm run start-env` instead of `npm run` to make this setting work.|
277279
|TEST_BROWSER|default&nbsp;&#124; chrome&nbsp;&#124; firefox|Platform for running tests. By default a headless chrome is used; "chrome" or "firefox" are for running tests in real (chrome/ff) browser |
278280
|TEST_SERVER_PORT|9876|Port that will be used by non-default testing browser |
279281

0 commit comments

Comments
 (0)