@af-utils/virtual-core - npm Package Compare versions

Comparing version 0.0.11 to 0.0.12

lib/index.d.ts

@@ -45,5 +45,8 @@ /**
     private _stickyOffset;
+    /** {@inheritDoc VirtualScrollerRuntimeParams.itemCount} */
     private _itemCount;
     private _availableWidgetSize;
+    /** {@inheritDoc VirtualScrollerRuntimeParams.overscanCount} */
     private _overscanCount;
+    /** {@inheritDoc VirtualScrollerRuntimeParams.estimatedItemSize} */
     private _estimatedItemSize;
@@ -59,5 +62,3 @@ private _scrollElement;
     private _msb;
-    /**
-     * @readonly
-     * Scroll direction */
+    /** @readonly {@inheritDoc VirtualScrollerInitialParams.horizontal} */
     horizontal: boolean;
@@ -145,4 +146,7 @@ /**
     /**
-     * Returns snapshot of current scroll position. {@link VirtualScrollerExactPosition}
+     * Returns snapshot of current scroll position.
      *
+     * @remarks
+     * {@link VirtualScrollerExactPosition}
+     *
      * @privateRemarks
@@ -199,3 +203,3 @@ * "returns" tag is missed by api-extractor for getters (for now).
     /**
-     * Start observing size of `element` at `index`. Observing is finished if element is `null`.
+     * Start/finish observing size of `element` at `index`. Observing is finished if element is `null`.
      * @param index - item index
@@ -205,3 +209,3 @@ * @param element - element for item
      * @remarks
-     * If an item was registered like `el( 5, HTMLElement )` it must be killed with `el( 5, null )` before killing the instance.
+     * If an item was registered like `el(5, HTMLElement)` - it must be killed with `el(5, null)` before killing the instance.
      */
@@ -267,3 +271,3 @@ el(index: number, element: HTMLElement | null): void;
      * Notify model about items quantity change
-     * @param itemCount - new items quantity
+     * @param itemCount - new items quantity. {@link VirtualScrollerRuntimeParams.itemCount}
      */
@@ -287,5 +291,5 @@ setItemCount(itemCount: number): void;
  *
- * - `SCROLL_SIZE`: sum of all item sizes was changed;
+ * - `SCROLL_SIZE`: {@link VirtualScroller.scrollSize} was changed;
  *
- * - `SIZES`: at least one item size was changed.
+ * - `SIZES`: at least one item size was changed. {@link VirtualScroller.sizesHash}.
  *
@@ -388,2 +392,18 @@ * @privateRemarks
      * Total items quantity
+     *
+     * @remarks
+     * Maximum suported value is `2_147_483_647` (int32 max).
+     * This limit exists, because item sizes cache implementation has bitwise operations, which work only with int32.
+     * But there is one more limit. W3C does not provide maximum allowed values for height, width, margin, etc.
+     *
+     * CSS theoretically supports infinite precision and infinite ranges for all value types;
+     * however in reality implementations have finite capacity.
+     * UAs should support reasonably useful ranges and precisions
+     *
+     * This quote was found {@link https://www.w3.org/TR/css3-values/#numeric-ranges | here}.
+     * Chrome's experimentally found maximum value is `33_554_428`.
+     * So some problems may happen if {@link @af-utils/virtual-core#VirtualScroller.scrollSize} is bigger.
+     *
+     * @privateRemarks
+     * TODO: format remarks with blockquote when api-extractor starts supporting it
      */
@@ -395,3 +415,3 @@ itemCount?: number;
      * @remarks
-     * Actual size is always reported by internal `ResizeObserver`.
+     * Actual size is always reported by internal `ResizeObserver` when {@link VirtualScroller.el} is called.
      * Bad item size assumptions can turn into shaky scrolling experience. Accuracy here is rewarded.
@@ -398,0 +418,0 @@ */

package.json

 {
   "name": "@af-utils/virtual-core",
   "private": false,
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "Model for rendering large scrollable data",
@@ -42,3 +42,3 @@ "repository": "https://github.com/nowaalex/af-utils.git",
   "dependencies": {
-    "@af-utils/scrollend-polyfill": "0.0.8"
+    "@af-utils/scrollend-polyfill": "0.0.9"
   },
@@ -45,0 +45,0 @@ "publishConfig": {

No alert changes

Improved metrics

Total package byte prevSize

77759

increased by2.24%

Lines of code

912

increased by2.24%

Dependency changes

• + Added@af-utils/scrollend-polyfill@0.0.9(transitive)

• - Removed@af-utils/scrollend-polyfill@0.0.8(transitive)

• Updated@af-utils/scrollend-polyfill@0.0.9