ng-virtual-list 0.2.1 → 0.2.2
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.
- package/README.md +23 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -190,3 +190,26 @@ export class AppComponent {
|
|
|
190
190
|
}
|
|
191
191
|
|
|
192
192
|
```
|
|
193
|
+
|
|
194
|
+
## API
|
|
195
|
+
|
|
196
|
+
[NgVirtualListComponent](https://github.com/DjonnyX/ng-virtual-list/blob/main/projects/ng-virtual-list/src/lib/ng-virtual-list.component.ts)
|
|
197
|
+
|
|
198
|
+
Inputs
|
|
199
|
+
|
|
200
|
+
| Property | type | Description |
|
|
201
|
+
|---|---|---|
|
|
202
|
+
| 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 |
|
|
203
|
+
| itemHeight | number | Height of a typical list item |
|
|
204
|
+
| itemRenderer | TemplateRef | Rendering element template |
|
|
205
|
+
| 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 |
|
|
206
|
+
|
|
207
|
+
<br/>
|
|
208
|
+
|
|
209
|
+
Outputs
|
|
210
|
+
|
|
211
|
+
| event | type | Description |
|
|
212
|
+
|---|---|---|
|
|
213
|
+
| onScroll | (e: Event) => void | Fires when the list has been scrolled |
|
|
214
|
+
| onScrollEnd | (e: Event) => void | Fires when the list has completed scrolling. |
|
|
215
|
+
|