ng-virtual-list 17.7.15 → 17.7.17
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 +8 -5
- package/esm2022/lib/const/index.mjs +2 -1
- package/esm2022/lib/ng-virtual-list.component.mjs +51 -6
- package/esm2022/lib/ng-virtual-list.service.mjs +12 -2
- package/fesm2022/ng-virtual-list.mjs +61 -5
- package/fesm2022/ng-virtual-list.mjs.map +1 -1
- package/lib/const/index.d.ts +1 -0
- package/lib/ng-virtual-list.component.d.ts +10 -1
- package/lib/ng-virtual-list.service.d.ts +5 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,7 +15,9 @@ Flexible, and actively maintained Angular library that excels with high-performa
|
|
|
15
15
|
[Live Demo](https://ng-virtual-list-chat-demo.eugene-grebennikov.pro/)
|
|
16
16
|
[(Code)](https://github.com/DjonnyX/ng-virtual-list-demo)
|
|
17
17
|
|
|
18
|
-
[Live Examples](https://ng-virtual-list.eugene-grebennikov.pro/)
|
|
18
|
+
[Live Examples (Storybook)](https://ng-virtual-list-examples.eugene-grebennikov.pro/)
|
|
19
|
+
|
|
20
|
+
[Examples](https://ng-virtual-list.eugene-grebennikov.pro/)
|
|
19
21
|
[(Code)](https://github.com/DjonnyX/ng-virtual-list-demo/tree/main/src/app)
|
|
20
22
|
|
|
21
23
|
<br/>
|
|
@@ -614,6 +616,7 @@ Inputs
|
|
|
614
616
|
| trackBy | string? = 'id' | The name of the property by which tracking is performed. |
|
|
615
617
|
| selectedIds | Array<[Id](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/id.ts)> \| [Id](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/id.ts) \| undefined | Sets the selected items. |
|
|
616
618
|
| collapsedIds | Array<[Id](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/id.ts)> | Sets the collapsed items. |
|
|
619
|
+
| screenReaderMessage | string? = "Showing items $1 to $2" | Message for screen reader. The message format is: "some text `$1` some text `$2`", where `$1` is the number of the first element of the screen collection, `$2` is the number of the last element of the screen collection. |
|
|
617
620
|
|
|
618
621
|
<br/>
|
|
619
622
|
|
|
@@ -640,7 +643,7 @@ Methods
|
|
|
640
643
|
| scrollTo | (id: [Id](https://github.com/DjonnyX/ng-virtual-list/blob/17.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". |
|
|
641
644
|
| scrollToEnd | (behavior?: ScrollBehavior) => void | Scrolls the scroll area to the desired element with the specified ID. |
|
|
642
645
|
| getItemBounds | (id: [Id](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/id.ts), behavior?: ScrollBehavior) => void | Returns the bounds of an element with a given id |
|
|
643
|
-
| focus | [Id](https://github.com/DjonnyX/ng-virtual-list/blob/
|
|
646
|
+
| focus | [Id](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/id.ts), align: [FocusAlignment](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/focus-alignment.ts) = [FocusAlignments.NONE](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/enums/focus-alignments.ts) | Focus an list item by a given id. |
|
|
644
647
|
|
|
645
648
|
<br/>
|
|
646
649
|
|
|
@@ -656,9 +659,9 @@ Properties
|
|
|
656
659
|
|
|
657
660
|
| Property | Type | Description |
|
|
658
661
|
|--|--|--|
|
|
659
|
-
| data | {\[id: [Id](https://github.com/DjonnyX/ng-virtual-list/blob/
|
|
660
|
-
| config | [IDisplayObjectConfig](https://github.com/DjonnyX/ng-virtual-list/blob/
|
|
661
|
-
| measures | [IDisplayObjectMeasures](https://github.com/DjonnyX/ng-virtual-list/blob/
|
|
662
|
+
| data | {\[id: [Id](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/types/id.ts) \], [otherProps: string]: any;} | Collection item data. |
|
|
663
|
+
| config | [IDisplayObjectConfig](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/models/display-object-config.model.ts) | Display object configuration. A set of `select`, `collapse`, and `focus` methods are also provided. |
|
|
664
|
+
| measures | [IDisplayObjectMeasures](https://github.com/DjonnyX/ng-virtual-list/blob/17.x/projects/ng-virtual-list/src/lib/models/display-object-measures.model.ts) \| undefined | Display object metrics. |
|
|
662
665
|
|
|
663
666
|
<br/>
|
|
664
667
|
|
|
@@ -16,6 +16,7 @@ export const DISPLAY_OBJECTS_LENGTH_MESUREMENT_ERROR = 1;
|
|
|
16
16
|
export const MAX_SCROLL_TO_ITERATIONS = 5;
|
|
17
17
|
export const DEFAULT_SNAPPING_METHOD = SnappingMethods.NORMAL;
|
|
18
18
|
export const DEFAULT_SELECT_METHOD = MethodsForSelecting.NONE;
|
|
19
|
+
export const DEFAULT_SCREEN_READER_MESSAGE = 'Showing items $1 to $2';
|
|
19
20
|
// presets
|
|
20
21
|
export const BEHAVIOR_AUTO = 'auto';
|
|
21
22
|
export const BEHAVIOR_INSTANT = 'instant';
|
|
@@ -54,4 +55,4 @@ export const PART_ITEM_SNAPPED = ' item-snapped';
|
|
|
54
55
|
export const PART_ITEM_SELECTED = ' item-selected';
|
|
55
56
|
export const PART_ITEM_COLLAPSED = ' item-collapsed';
|
|
56
57
|
export const PART_ITEM_FOCUSED = ' item-focused';
|
|
57
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
58
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9wcm9qZWN0cy9uZy12aXJ0dWFsLWxpc3Qvc3JjL2xpYi9jb25zdC9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEVBQUUsZUFBZSxFQUFFLG1CQUFtQixFQUFFLGVBQWUsRUFBRSxNQUFNLFVBQVUsQ0FBQztBQUNqRixPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0scUJBQXFCLENBQUM7QUFFakQsTUFBTSxDQUFDLE1BQU0saUJBQWlCLEdBQUcsRUFBRSxDQUFDO0FBRXBDLE1BQU0sQ0FBQyxNQUFNLG1CQUFtQixHQUFHLENBQUMsQ0FBQztBQUVyQyxNQUFNLENBQUMsTUFBTSx1QkFBdUIsR0FBRyxFQUFFLENBQUM7QUFFMUMsTUFBTSxDQUFDLE1BQU0saUJBQWlCLEdBQUcsR0FBRyxDQUFDO0FBRXJDLE1BQU0sQ0FBQyxNQUFNLFlBQVksR0FBRyxLQUFLLENBQUM7QUFFbEMsTUFBTSxDQUFDLE1BQU0sdUJBQXVCLEdBQUcsSUFBSSxDQUFDO0FBRTVDLE1BQU0sQ0FBQyxNQUFNLHlCQUF5QixHQUFHLElBQUksQ0FBQztBQUU5QyxNQUFNLENBQUMsTUFBTSxtQ0FBbUMsR0FBRyxLQUFLLENBQUM7QUFFekQsTUFBTSxDQUFDLE1BQU0sb0JBQW9CLEdBQUcsS0FBSyxDQUFDO0FBRTFDLE1BQU0sQ0FBQyxNQUFNLHNCQUFzQixHQUFHLElBQUksQ0FBQztBQUUzQyxNQUFNLENBQUMsTUFBTSxpQkFBaUIsR0FBRyxVQUFVLENBQUMsUUFBUSxDQUFDO0FBRXJELE1BQU0sQ0FBQyxNQUFNLHVCQUF1QixHQUFHLGVBQWUsQ0FBQyxNQUFNLENBQUM7QUFFOUQsTUFBTSxDQUFDLE1BQU0sdUNBQXVDLEdBQUcsQ0FBQyxDQUFDO0FBRXpELE1BQU0sQ0FBQyxNQUFNLHdCQUF3QixHQUFHLENBQUMsQ0FBQztBQUUxQyxNQUFNLENBQUMsTUFBTSx1QkFBdUIsR0FBRyxlQUFlLENBQUMsTUFBTSxDQUFDO0FBRTlELE1BQU0sQ0FBQyxNQUFNLHFCQUFxQixHQUFHLG1CQUFtQixDQUFDLElBQUksQ0FBQztBQUU5RCxNQUFNLENBQUMsTUFBTSw2QkFBNkIsR0FBRyx3QkFBd0IsQ0FBQztBQUV0RSxVQUFVO0FBRVYsTUFBTSxDQUFDLE1BQU0sYUFBYSxHQUFHLE1BQU0sQ0FBQztBQUVwQyxNQUFNLENBQUMsTUFBTSxnQkFBZ0IsR0FBRyxTQUFTLENBQUM7QUFFMUMsTUFBTSxDQUFDLE1BQU0sZUFBZSxHQUFHLFFBQVEsQ0FBQztBQUV4QyxNQUFNLENBQUMsTUFBTSxhQUFhLEdBQUcsT0FBTyxDQUFDO0FBRXJDLE1BQU0sQ0FBQyxNQUFNLFlBQVksR0FBRyxNQUFNLENBQUM7QUFFbkMsTUFBTSxDQUFDLE1BQU0sU0FBUyxHQUFHLEdBQUcsQ0FBQztBQUU3QixNQUFNLENBQUMsTUFBTSxXQUFXLEdBQUcsS0FBSyxDQUFDO0FBRWpDLE1BQU0sQ0FBQyxNQUFNLGtCQUFrQixHQUFHLFNBQVMsQ0FBQztBQUU1QyxNQUFNLENBQUMsTUFBTSxpQkFBaUIsR0FBRyxRQUFRLENBQUM7QUFFMUMsTUFBTSxDQUFDLE1BQU0sZ0JBQWdCLEdBQUcsTUFBTSxDQUFDO0FBRXZDLE1BQU0sQ0FBQyxNQUFNLFNBQVMsR0FBRyxNQUFNLENBQUM7QUFFaEMsTUFBTSxDQUFDLE1BQU0saUJBQWlCLEdBQUcsVUFBVSxDQUFDO0FBRTVDLE1BQU0sQ0FBQyxNQUFNLGVBQWUsR0FBRyxRQUFRLENBQUM7QUFFeEMsTUFBTSxDQUFDLE1BQU0sWUFBWSxHQUFHLGFBQWEsQ0FBQztBQUUxQyxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyxHQUFHLFlBQVksU0FBUyxDQUFDO0FBRTNELE1BQU0sQ0FBQyxNQUFNLGFBQWEsR0FBRyxJQUFJLENBQUM7QUFFbEMsTUFBTSxDQUFDLE1BQU0sY0FBYyxHQUFHLEdBQUcsQ0FBQztBQUVsQyxNQUFNLENBQUMsTUFBTSxhQUFhLEdBQUcsS0FBSyxDQUFDO0FBRW5DLE1BQU0sQ0FBQyxNQUFNLGNBQWMsR0FBRyxNQUFNLENBQUM7QUFFckMsTUFBTSxDQUFDLE1BQU0sV0FBVyxHQUFHLEdBQUcsQ0FBQztBQUUvQixNQUFNLENBQUMsTUFBTSxXQUFXLEdBQUcsR0FBRyxDQUFDO0FBRS9CLE1BQU0sQ0FBQyxNQUFNLGVBQWUsR0FBRyxPQUFPLENBQUM7QUFFdkMsTUFBTSxDQUFDLE1BQU0sZ0JBQWdCLEdBQUcsUUFBUSxDQUFDO0FBRXpDLE1BQU0sQ0FBQyxNQUFNLEVBQUUsR0FBRyxJQUFJLENBQUM7QUFFdkIsTUFBTSxDQUFDLE1BQU0sTUFBTSxHQUFHLFFBQVEsQ0FBQztBQUUvQixNQUFNLENBQUMsTUFBTSxVQUFVLEdBQUcsV0FBVyxDQUFDO0FBRXRDLE1BQU0sQ0FBQyxNQUFNLG1CQUFtQixHQUFHLFVBQVUsQ0FBQztBQUU5QyxNQUFNLENBQUMsTUFBTSxxQkFBcUIsR0FBRyxZQUFZLENBQUM7QUFFbEQsU0FBUztBQUVULE1BQU0sQ0FBQyxNQUFNLGlCQUFpQixHQUFHLE1BQU0sQ0FBQztBQUV4QyxNQUFNLENBQUMsTUFBTSxhQUFhLEdBQUcsV0FBVyxDQUFDO0FBRXpDLE1BQU0sQ0FBQyxNQUFNLGFBQWEsR0FBRyxXQUFXLENBQUM7QUFFekMsTUFBTSxDQUFDLE1BQU0sY0FBYyxHQUFHLFlBQVksQ0FBQztBQUUzQyxNQUFNLENBQUMsTUFBTSxpQkFBaUIsR0FBRyxlQUFlLENBQUM7QUFFakQsTUFBTSxDQUFDLE1BQU0sa0JBQWtCLEdBQUcsZ0JBQWdCLENBQUM7QUFFbkQsTUFBTSxDQUFDLE1BQU0sbUJBQW1CLEdBQUcsaUJBQWlCLENBQUM7QUFFckQsTUFBTSxDQUFDLE1BQU0saUJBQWlCLEdBQUcsZUFBZSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgQ29sbGVjdGlvbk1vZGVzLCBNZXRob2RzRm9yU2VsZWN0aW5nLCBTbmFwcGluZ01ldGhvZHMgfSBmcm9tIFwiLi4vZW51bXNcIjtcclxuaW1wb3J0IHsgRGlyZWN0aW9ucyB9IGZyb20gXCIuLi9lbnVtcy9kaXJlY3Rpb25zXCI7XHJcblxyXG5leHBvcnQgY29uc3QgREVGQVVMVF9JVEVNX1NJWkUgPSAyNDtcclxuXHJcbmV4cG9ydCBjb25zdCBERUZBVUxUX0JVRkZFUl9TSVpFID0gMjtcclxuXHJcbmV4cG9ydCBjb25zdCBERUZBVUxUX01BWF9CVUZGRVJfU0laRSA9IDEwO1xyXG5cclxuZXhwb3J0IGNvbnN0IERFRkFVTFRfTElTVF9TSVpFID0gNDAwO1xyXG5cclxuZXhwb3J0IGNvbnN0IERFRkFVTFRfU05BUCA9IGZhbHNlO1xyXG5cclxuZXhwb3J0IGNvbnN0IERFRkFVTFRfU0VMRUNUX0JZX0NMSUNLID0gdHJ1ZTtcclxuXHJcbmV4cG9ydCBjb25zdCBERUZBVUxUX0NPTExBUFNFX0JZX0NMSUNLID0gdHJ1ZTtcclxuXHJcbmV4cG9ydCBjb25zdCBERUZBVUxUX0VOQUJMRURfQlVGRkVSX09QVElNSVpBVElPTiA9IGZhbHNlO1xyXG5cclxuZXhwb3J0IGNvbnN0IERFRkFVTFRfRFlOQU1JQ19TSVpFID0gZmFsc2U7XHJcblxyXG5leHBvcnQgY29uc3QgVFJBQ0tfQllfUFJPUEVSVFlfTkFNRSA9ICdpZCc7XHJcblxyXG5leHBvcnQgY29uc3QgREVGQVVMVF9ESVJFQ1RJT04gPSBEaXJlY3Rpb25zLlZFUlRJQ0FMO1xyXG5cclxuZXhwb3J0IGNvbnN0IERFRkFVTFRfQ09MTEVDVElPTl9NT0RFID0gQ29sbGVjdGlvbk1vZGVzLk5PUk1BTDtcclxuXHJcbmV4cG9ydCBjb25zdCBESVNQTEFZX09CSkVDVFNfTEVOR1RIX01FU1VSRU1FTlRfRVJST1IgPSAxO1xyXG5cclxuZXhwb3J0IGNvbnN0IE1BWF9TQ1JPTExfVE9fSVRFUkFUSU9OUyA9IDU7XHJcblxyXG5leHBvcnQgY29uc3QgREVGQVVMVF9TTkFQUElOR19NRVRIT0QgPSBTbmFwcGluZ01ldGhvZHMuTk9STUFMO1xyXG5cclxuZXhwb3J0IGNvbnN0IERFRkFVTFRfU0VMRUNUX01FVEhPRCA9IE1ldGhvZHNGb3JTZWxlY3RpbmcuTk9ORTtcclxuXHJcbmV4cG9ydCBjb25zdCBERUZBVUxUX1NDUkVFTl9SRUFERVJfTUVTU0FHRSA9ICdTaG93aW5nIGl0ZW1zICQxIHRvICQyJztcclxuXHJcbi8vIHByZXNldHNcclxuXHJcbmV4cG9ydCBjb25zdCBCRUhBVklPUl9BVVRPID0gJ2F1dG8nO1xyXG5cclxuZXhwb3J0IGNvbnN0IEJFSEFWSU9SX0lOU1RBTlQgPSAnaW5zdGFudCc7XHJcblxyXG5leHBvcnQgY29uc3QgQkVIQVZJT1JfU01PT1RIID0gJ3Ntb290aCc7XHJcblxyXG5leHBvcnQgY29uc3QgRElTUExBWV9CTE9DSyA9ICdibG9jayc7XHJcblxyXG5leHBvcnQgY29uc3QgRElTUExBWV9OT05FID0gJ25vbmUnO1xyXG5cclxuZXhwb3J0IGNvbnN0IE9QQUNJVFlfMCA9ICcwJztcclxuXHJcbmV4cG9ydCBjb25zdCBPUEFDSVRZXzEwMCA9ICcxMDAnO1xyXG5cclxuZXhwb3J0IGNvbnN0IFZJU0lCSUxJVFlfVklTSUJMRSA9ICd2aXNpYmxlJztcclxuXHJcbmV4cG9ydCBjb25zdCBWSVNJQklMSVRZX0hJRERFTiA9ICdoaWRkZW4nO1xyXG5cclxuZXhwb3J0IGNvbnN0IFNJWkVfMTAwX1BFUlNFTlQgPSAnMTAwJSc7XHJcblxyXG5leHBvcnQgY29uc3QgU0laRV9BVVRPID0gJ2F1dG8nO1xyXG5cclxuZXhwb3J0IGNvbnN0IFBPU0lUSU9OX0FCU09MVVRFID0gJ2Fic29sdXRlJztcclxuXHJcbmV4cG9ydCBjb25zdCBQT1NJVElPTl9TVElDS1kgPSAnc3RpY2t5JztcclxuXHJcbmV4cG9ydCBjb25zdCBUUkFOU0xBVEVfM0QgPSAndHJhbnNsYXRlM2QnO1xyXG5cclxuZXhwb3J0IGNvbnN0IFpFUk9TX1RSQU5TTEFURV8zRCA9IGAke1RSQU5TTEFURV8zRH0oMCwwLDApYDtcclxuXHJcbmV4cG9ydCBjb25zdCBISURERU5fWklOREVYID0gJy0xJztcclxuXHJcbmV4cG9ydCBjb25zdCBERUZBVUxUX1pJTkRFWCA9ICcwJztcclxuXHJcbmV4cG9ydCBjb25zdCBUT1BfUFJPUF9OQU1FID0gJ3RvcCc7XHJcblxyXG5leHBvcnQgY29uc3QgTEVGVF9QUk9QX05BTUUgPSAnbGVmdCc7XHJcblxyXG5leHBvcnQgY29uc3QgWF9QUk9QX05BTUUgPSAneCc7XHJcblxyXG5leHBvcnQgY29uc3QgWV9QUk9QX05BTUUgPSAneSc7XHJcblxyXG5leHBvcnQgY29uc3QgV0lEVEhfUFJPUF9OQU1FID0gJ3dpZHRoJztcclxuXHJcbmV4cG9ydCBjb25zdCBIRUlHSFRfUFJPUF9OQU1FID0gJ2hlaWdodCc7XHJcblxyXG5leHBvcnQgY29uc3QgUFggPSAncHgnO1xyXG5cclxuZXhwb3J0IGNvbnN0IFNDUk9MTCA9ICdzY3JvbGwnO1xyXG5cclxuZXhwb3J0IGNvbnN0IFNDUk9MTF9FTkQgPSAnc2Nyb2xsZW5kJztcclxuXHJcbmV4cG9ydCBjb25zdCBDTEFTU19MSVNUX1ZFUlRJQ0FMID0gJ3ZlcnRpY2FsJztcclxuXHJcbmV4cG9ydCBjb25zdCBDTEFTU19MSVNUX0hPUklaT05UQUwgPSAnaG9yaXpvbnRhbCc7XHJcblxyXG4vLyBzdHlsZXNcclxuXHJcbmV4cG9ydCBjb25zdCBQQVJUX0RFRkFVTFRfSVRFTSA9ICdpdGVtJztcclxuXHJcbmV4cG9ydCBjb25zdCBQQVJUX0lURU1fTkVXID0gJyBpdGVtLW5ldyc7XHJcblxyXG5leHBvcnQgY29uc3QgUEFSVF9JVEVNX09ERCA9ICcgaXRlbS1vZGQnO1xyXG5cclxuZXhwb3J0IGNvbnN0IFBBUlRfSVRFTV9FVkVOID0gJyBpdGVtLWV2ZW4nO1xyXG5cclxuZXhwb3J0IGNvbnN0IFBBUlRfSVRFTV9TTkFQUEVEID0gJyBpdGVtLXNuYXBwZWQnO1xyXG5cclxuZXhwb3J0IGNvbnN0IFBBUlRfSVRFTV9TRUxFQ1RFRCA9ICcgaXRlbS1zZWxlY3RlZCc7XHJcblxyXG5leHBvcnQgY29uc3QgUEFSVF9JVEVNX0NPTExBUFNFRCA9ICcgaXRlbS1jb2xsYXBzZWQnO1xyXG5cclxuZXhwb3J0IGNvbnN0IFBBUlRfSVRFTV9GT0NVU0VEID0gJyBpdGVtLWZvY3VzZWQnO1xyXG5cclxuIl19
|