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

Comparing version 0.0.2 to 0.0.3

lib/bundlesize.index.js

@@ -1,4 +0,4 @@
-export const raw = 4664;
-export const min = 2360;
-export const minGz = 1160;
-export const minBrotli = 1055;
+export const raw = 5064;
+export const min = 2375;
+export const minGz = 1162;
+export const minBrotli = 1046;

lib/index.d.ts

@@ -11,5 +11,7 @@ /**
 import { JSX as JSX_2 } from 'react/jsx-runtime';
-import type { ReactNode } from 'react';
+import { ReactNode } from 'react';
+import type { ScrollElement } from '@af-utils/virtual-core';
 import { VirtualScroller } from '@af-utils/virtual-core';
-import type { VirtualScrollerInitialParams } from '@af-utils/virtual-core';
+import { VirtualScrollerEvent } from '@af-utils/virtual-core';
+import { VirtualScrollerInitialParams } from '@af-utils/virtual-core';
 
@@ -19,2 +21,3 @@ /**
  * React component.
+ * {@link ListProps}.
  * Small abstraction, which in 90% cases allows to avoid hook boilerplate.
@@ -63,9 +66,7 @@ */
 
-declare type On = Parameters<VirtualScroller["on"]>;
-
 /**
  * @public
- * React component
- * Rerenders only on certain {@link @af-utils/virtual-core#Event}
- * Allows to optimize performance
+ * React component.
+ * Rerenders only on certain {@link @af-utils/virtual-core#(VirtualScrollerEvent:variable)}.
+ * Allows to optimize performance.
  */
@@ -78,12 +79,6 @@ export declare const Subscription: (props: SubscriptionProps) => ReactNode;
  */
-declare type SubscriptionProps = {
-    /**
-     * {@inheritDoc @af-utils/virtual-core#VirtualScroller}
-     */
+export declare type SubscriptionProps = {
     model: VirtualScroller;
     children: () => ReactNode;
-    /**
-     * {@inheritDoc @af-utils/virtual-core#Event}
-     */
-    events?: Parameters<VirtualScroller["on"]>[1];
+    events?: readonly VirtualScrollerEvent[] | VirtualScrollerEvent[];
 };
@@ -94,6 +89,6 @@
  * React hook.
- * Rerenders component when one of {@link @af-utils/virtual-core#Event} gets emitted.
+ * Rerenders component when one of {@link @af-utils/virtual-core#(VirtualScrollerEvent:variable)} gets emitted.
  * Usually {@link Subscription} is a better alternative
  */
-export declare const useComponentSubscription: (model: VirtualScroller, events?: On[1]) => void;
+export declare const useComponentSubscription: (model: VirtualScroller, events?: readonly VirtualScrollerEvent[] | VirtualScrollerEvent[]) => void;
 
@@ -105,3 +100,3 @@ /**
  */
-export declare const useScroller: (model: VirtualScroller, scroller: Parameters<VirtualScroller["setScroller"]>[0]) => void;
+export declare const useScroller: (model: VirtualScroller, scroller: ScrollElement | null) => void;
 
@@ -111,6 +106,6 @@ /**
  * React hook.
- * Allows to subscribe to {@link @af-utils/virtual-core#Event} without unnecessary rerenders.
+ * Allows to subscribe to {@link @af-utils/virtual-core#(VirtualScrollerEvent:variable)} without unnecessary rerenders.
  * For example can be used in load-on-demand.
  */
-export declare const useSubscription: (model: VirtualScroller, events: Parameters<VirtualScroller["on"]>[1], callBack: Parameters<VirtualScroller["on"]>[0]) => void;
+export declare const useSubscription: (model: VirtualScroller, events: readonly VirtualScrollerEvent[] | VirtualScrollerEvent[], callBack: () => void) => void;
 
@@ -122,3 +117,3 @@ /**
  * Use this hook to avoid unneeded boilerplate.
- * @returns Array of 2 callback refs: [ outer, inner ]
+ * @returns Array of 2 callback refs: [ outer, inner ].
  */
@@ -131,2 +126,4 @@ export declare const useSyncedStyles: (model: VirtualScroller) => [(el: HTMLElement | null) => void, (el: HTMLElement | null) => void];
  * Calls {@link useVirtualModel} and synchronizes it with props
+ * @param params - {@link @af-utils/virtual-core#VirtualScrollerInitialParams}
+ * @returns same {@link @af-utils/virtual-core#VirtualScroller} instance
  */
@@ -141,5 +138,7 @@ export declare const useVirtual: (params: VirtualScrollerInitialParams) => VirtualScroller;
  * Normally {@link useVirtual} should be used.
+ * @param params - {@link @af-utils/virtual-core#VirtualScrollerInitialParams}
+ * @returns same {@link @af-utils/virtual-core#VirtualScroller} instance
  */
-export declare const useVirtualModel: (params: ConstructorParameters<typeof VirtualScroller>[0]) => VirtualScroller;
+export declare const useVirtualModel: (params: VirtualScrollerInitialParams) => VirtualScroller;
 
 export { }

lib/index.js

@@ -5,3 +5,3 @@ import { jsxs as t, jsx as e } from "react/jsx-runtime";
 
-import { Event as l, _ALL_EVENTS as c, VirtualScroller as a } from "@af-utils/virtual-core";
+import { VirtualScrollerEvent as l, _ALL_EVENTS as c, VirtualScroller as a } from "@af-utils/virtual-core";
 
@@ -86,3 +86,3 @@ import { useSyncExternalStore as h } from "use-sync-external-store/shim";
  * React hook.
- * Rerenders component when one of {@link @af-utils/virtual-core#Event} gets emitted.
+ * Rerenders component when one of {@link @af-utils/virtual-core#(VirtualScrollerEvent:variable)} gets emitted.
  * Usually {@link Subscription} is a better alternative
@@ -126,3 +126,3 @@ */ const z = function(t, e) {
  * React hook.
- * Allows to subscribe to {@link @af-utils/virtual-core#Event} without unnecessary rerenders.
+ * Allows to subscribe to {@link @af-utils/virtual-core#(VirtualScrollerEvent:variable)} without unnecessary rerenders.
  * For example can be used in load-on-demand.
@@ -138,2 +138,4 @@ */ , R = (t, e, o) => i((() => {
  * Normally {@link useVirtual} should be used.
+ * @param params - {@link @af-utils/virtual-core#VirtualScrollerInitialParams}
+ * @returns same {@link @af-utils/virtual-core#VirtualScroller} instance
  */ , _ = t => s().current ||= new a(t)
@@ -144,2 +146,4 @@ /**
  * Calls {@link useVirtualModel} and synchronizes it with props
+ * @param params - {@link @af-utils/virtual-core#VirtualScrollerInitialParams}
+ * @returns same {@link @af-utils/virtual-core#VirtualScroller} instance
  */ , b = t => {
@@ -152,6 +156,6 @@ const e = _(t);
  * @public
- * React component
- * Rerenders only on certain {@link @af-utils/virtual-core#Event}
- * Allows to optimize performance
+ * React component.
+ * Rerenders only on certain {@link @af-utils/virtual-core#(VirtualScrollerEvent:variable)}.
+ * Allows to optimize performance.
  */ export { E as List, w as Subscription, f as mapVisibleRange, d as mapVisibleRangeWithOffset, z as useComponentSubscription, O as useScroller, R as useSubscription, y as useSyncedStyles, b as useVirtual, _ as useVirtualModel };
 //# sourceMappingURL=index.js.map

lib/types/components/List/index.d.ts

@@ -6,2 +6,3 @@ import type { ElementType } from "react";
  * React component.
+ * {@link ListProps}.
  * Small abstraction, which in 90% cases allows to avoid hook boilerplate.
@@ -8,0 +9,0 @@ */

lib/types/components/Subscription/index.d.ts

@@ -1,25 +0,10 @@
-import type { VirtualScroller } from "@af-utils/virtual-core";
-import type { ReactNode } from "react";
+/// <reference types="react" />
+import type { SubscriptionProps } from "../../../types";
 /**
  * @public
- * {@link Subscription} component props
+ * React component.
+ * Rerenders only on certain {@link @af-utils/virtual-core#(VirtualScrollerEvent:variable)}.
+ * Allows to optimize performance.
  */
-export type SubscriptionProps = {
-    /**
-     * {@inheritDoc @af-utils/virtual-core#VirtualScroller}
-     */
-    model: VirtualScroller;
-    children: () => ReactNode;
-    /**
-     * {@inheritDoc @af-utils/virtual-core#Event}
-     */
-    events?: Parameters<VirtualScroller["on"]>[1];
-};
-/**
- * @public
- * React component
- * Rerenders only on certain {@link @af-utils/virtual-core#Event}
- * Allows to optimize performance
- */
-declare const Subscription: (props: SubscriptionProps) => ReactNode;
+declare const Subscription: (props: SubscriptionProps) => import("react").ReactNode;
 export default Subscription;

lib/types/hooks/useComponentSubscription/index.d.ts

@@ -1,10 +0,9 @@
-import type { VirtualScroller } from "@af-utils/virtual-core";
-type On = Parameters<VirtualScroller["on"]>;
+import { VirtualScrollerEvent, VirtualScroller } from "@af-utils/virtual-core";
 /**
  * @public
  * React hook.
- * Rerenders component when one of {@link @af-utils/virtual-core#Event} gets emitted.
+ * Rerenders component when one of {@link @af-utils/virtual-core#(VirtualScrollerEvent:variable)} gets emitted.
  * Usually {@link Subscription} is a better alternative
  */
-declare const useComponentSubscription: (model: VirtualScroller, events?: On[1]) => void;
+declare const useComponentSubscription: (model: VirtualScroller, events?: readonly VirtualScrollerEvent[] | VirtualScrollerEvent[]) => void;
 export default useComponentSubscription;

lib/types/hooks/useScroller/index.d.ts

@@ -1,2 +0,2 @@
-import type { VirtualScroller } from "@af-utils/virtual-core";
+import type { ScrollElement, VirtualScroller } from "@af-utils/virtual-core";
 /**
@@ -7,3 +7,3 @@ * @public
  */
-declare const useScroller: (model: VirtualScroller, scroller: Parameters<VirtualScroller["setScroller"]>[0]) => void;
+declare const useScroller: (model: VirtualScroller, scroller: ScrollElement | null) => void;
 export default useScroller;

lib/types/hooks/useSubscription/index.d.ts

@@ -1,9 +0,9 @@
-import type { VirtualScroller } from "@af-utils/virtual-core";
+import { VirtualScroller, VirtualScrollerEvent } from "@af-utils/virtual-core";
 /**
  * @public
  * React hook.
- * Allows to subscribe to {@link @af-utils/virtual-core#Event} without unnecessary rerenders.
+ * Allows to subscribe to {@link @af-utils/virtual-core#(VirtualScrollerEvent:variable)} without unnecessary rerenders.
  * For example can be used in load-on-demand.
  */
-declare const useSubscription: (model: VirtualScroller, events: Parameters<VirtualScroller["on"]>[1], callBack: Parameters<VirtualScroller["on"]>[0]) => void;
+declare const useSubscription: (model: VirtualScroller, events: readonly VirtualScrollerEvent[] | VirtualScrollerEvent[], callBack: () => void) => void;
 export default useSubscription;

lib/types/hooks/useSyncedStyles/index.d.ts

@@ -7,5 +7,5 @@ import { VirtualScroller } from "@af-utils/virtual-core";
  * Use this hook to avoid unneeded boilerplate.
- * @returns Array of 2 callback refs: [ outer, inner ]
+ * @returns Array of 2 callback refs: [ outer, inner ].
  */
 declare const useSyncedStyles: (model: VirtualScroller) => [(el: HTMLElement | null) => void, (el: HTMLElement | null) => void];
 export default useSyncedStyles;

lib/types/hooks/useVirtual/index.d.ts

@@ -6,4 +6,6 @@ import type { VirtualScrollerInitialParams } from "@af-utils/virtual-core";
  * Calls {@link useVirtualModel} and synchronizes it with props
+ * @param params - {@link @af-utils/virtual-core#VirtualScrollerInitialParams}
+ * @returns same {@link @af-utils/virtual-core#VirtualScroller} instance
  */
 declare const useVirtual: (params: VirtualScrollerInitialParams) => import("@af-utils/virtual-core").VirtualScroller;
 export default useVirtual;

lib/types/hooks/useVirtualModel/index.d.ts

@@ -1,2 +0,2 @@
-import { VirtualScroller } from "@af-utils/virtual-core";
+import { VirtualScroller, VirtualScrollerInitialParams } from "@af-utils/virtual-core";
 /**
@@ -8,4 +8,6 @@ * @public
  * Normally {@link useVirtual} should be used.
+ * @param params - {@link @af-utils/virtual-core#VirtualScrollerInitialParams}
+ * @returns same {@link @af-utils/virtual-core#VirtualScroller} instance
  */
-declare const useVirtualModel: (params: ConstructorParameters<typeof VirtualScroller>[0]) => VirtualScroller;
+declare const useVirtualModel: (params: VirtualScrollerInitialParams) => VirtualScroller;
 export default useVirtualModel;

lib/types/types/index.d.ts

@@ -1,3 +0,3 @@
-import type { ElementType, ComponentProps } from "react";
-import type { VirtualScroller } from "@af-utils/virtual-core";
+import type { ReactNode, ElementType, ComponentProps } from "react";
+import type { VirtualScroller, VirtualScrollerEvent } from "@af-utils/virtual-core";
 /**
@@ -27,1 +27,10 @@ * @public
 };
+/**
+ * @public
+ * {@link Subscription} component props
+ */
+export type SubscriptionProps = {
+    model: VirtualScroller;
+    children: () => ReactNode;
+    events?: readonly VirtualScrollerEvent[] | VirtualScrollerEvent[];
+};

package.json

 {
   "name": "@af-utils/virtual-react",
   "private": false,
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "React components and hooks for rendering large scrollable data",
@@ -62,3 +62,3 @@ "repository": "https://github.com/nowaalex/af-utils.git",
   "dependencies": {
-    "@af-utils/virtual-core": "0.0.2"
+    "@af-utils/virtual-core": "0.0.3"
   },
@@ -65,0 +65,0 @@ "peerDependencies": {

No alert changes

Improved metrics

Total package byte prevSize

33987

increased by4.08%

Lines of code

410

increased by0.49%

Dependency changes

• + Added@af-utils/virtual-core@0.0.3(transitive)

• - Removed@af-utils/virtual-core@0.0.2(transitive)

• Updated@af-utils/virtual-core@0.0.3