react-simplikit 0.0.7 → 0.0.8

package/dist/components/SwitchCase/index.d.ts

@@ -19,7 +19,7 @@ type Props<Case> = {
  * @param {Record<string | number, () => JSX.Element>} caseBy - An object that maps values to
  *   components to render. The keys represent possible values, and the values are functions returning
  *   the corresponding components.
- * @param {() => JSX.Element} defaultComponent - The component to render if `value` does not match
+ * @param {() => JSX.Element} [defaultComponent] - The component to render if `value` does not match
  *   any key in `caseBy`.
  *
  * @returns {JSX.Element} A React component that conditionally renders based on cases.

package/dist/hooks/useAsyncEffect/index.d.ts

@@ -5,7 +5,7 @@ import { DependencyList } from 'react';
  * `useAsyncEffect` is a custom hook for handling asynchronous side effects in React components.
  * It follows the same cleanup pattern as `useEffect` while ensuring async operations are handled safely.
  *
- * @param {() => Promise<void | (() => void)>} [effect] - An asynchronous function executed in the `useEffect` pattern.
+ * @param {() => Promise<void | (() => void)>} effect - An asynchronous function executed in the `useEffect` pattern.
  *   This function can optionally return a cleanup function.
  * @param {DependencyList} [deps] - A dependency array.
  *   The effect will re-run whenever any value in this array changes. If omitted, it runs only once when the component mounts.

package/dist/hooks/useImpressionRef/index.d.ts

@@ -11,10 +11,10 @@ type UseImpressionRefOptions = Partial<{
  * This hook uses `IntersectionObserver` and the `Visibility API` to track the element's visibility.
  *
  * @param {UseImpressionRefOptions} options - Options for tracking the element's visibility.
- * @param {() => void} options.onImpressionStart - Callback function executed when the element enters the view
- * @param {() => void} options.onImpressionEnd - Callback function executed when the element exits the view
- * @param {number} options.timeThreshold - Minimum time the element must be visible (in milliseconds)
- * @param {number} options.areaThreshold - Minimum ratio of the element that must be visible (0 to 1)
+ * @param {() => void} [options.onImpressionStart] - Callback function executed when the element enters the view
+ * @param {() => void} [options.onImpressionEnd] - Callback function executed when the element exits the view
+ * @param {number} [options.timeThreshold=0] - Minimum time the element must be visible (in milliseconds)
+ * @param {number} [options.areaThreshold=0] - Minimum ratio of the element that must be visible (0 to 1)
  * @param {string} options.rootMargin - Margin to adjust the detection area
  *
  * @returns {(element: Element | null) => void} A function to set the element. Attach this function to the `ref` attribute, and the callbacks will be executed whenever the element's visibility changes.

package/dist/hooks/useIntersectionObserver/index.d.ts

@@ -6,7 +6,9 @@
  * @param {(entry: IntersectionObserverEntry) => void} callback - A callback function that is executed when the visibility of the element changes.
  *   You can check `entry.isIntersecting` to determine if the element is in view.
  * @param {IntersectionObserverInit} options - Options for the `IntersectionObserver`.
- *   You can specify values such as `root`, `rootMargin`, and `threshold`.
+ * @param {boolean} [options.root] - The element that is used as the viewport for checking visibility of the target.
+ * @param {string} [options.rootMargin] - Margin around the root.
+ * @param {number | number[]} [options.threshold] - Either a single number or an array of numbers which indicate at what percentage of the target's visibility the observer's callback should be executed.
  *
  * @returns {(element: Element | null) => void} A function to set the element. Attach this function to the `ref` attribute, and the `callback` will be executed whenever the element's visibility changes.
  *

package/dist/hooks/useThrottle/index.d.ts

@@ -24,6 +24,7 @@ declare function throttle<F extends (...args: any[]) => void>(func: F, throttleM
  * @param {F} callback - The function to be throttled.
  * @param {number} wait - The number of milliseconds to throttle invocations to.
  * @param {{ edges?: Array<'leading' | 'trailing'> }} [options] - Options to control the behavior of the throttle.
+ * @param {Array<'leading' | 'trailing'>} [options.edges=['leading', 'trailing']] - An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
  * @returns {F & { cancel: () => void }} - Returns the throttled function with a `cancel` method to cancel pending executions.
  *
  * @example

package/esm/components/SwitchCase/index.d.mts

@@ -19,7 +19,7 @@ type Props<Case> = {
  * @param {Record<string | number, () => JSX.Element>} caseBy - An object that maps values to
  *   components to render. The keys represent possible values, and the values are functions returning
  *   the corresponding components.
- * @param {() => JSX.Element} defaultComponent - The component to render if `value` does not match
+ * @param {() => JSX.Element} [defaultComponent] - The component to render if `value` does not match
  *   any key in `caseBy`.
  *
  * @returns {JSX.Element} A React component that conditionally renders based on cases.

package/esm/hooks/useAsyncEffect/index.d.mts

@@ -5,7 +5,7 @@ import { DependencyList } from 'react';
  * `useAsyncEffect` is a custom hook for handling asynchronous side effects in React components.
  * It follows the same cleanup pattern as `useEffect` while ensuring async operations are handled safely.
  *
- * @param {() => Promise<void | (() => void)>} [effect] - An asynchronous function executed in the `useEffect` pattern.
+ * @param {() => Promise<void | (() => void)>} effect - An asynchronous function executed in the `useEffect` pattern.
  *   This function can optionally return a cleanup function.
  * @param {DependencyList} [deps] - A dependency array.
  *   The effect will re-run whenever any value in this array changes. If omitted, it runs only once when the component mounts.

package/esm/hooks/useImpressionRef/index.d.mts

@@ -11,10 +11,10 @@ type UseImpressionRefOptions = Partial<{
  * This hook uses `IntersectionObserver` and the `Visibility API` to track the element's visibility.
  *
  * @param {UseImpressionRefOptions} options - Options for tracking the element's visibility.
- * @param {() => void} options.onImpressionStart - Callback function executed when the element enters the view
- * @param {() => void} options.onImpressionEnd - Callback function executed when the element exits the view
- * @param {number} options.timeThreshold - Minimum time the element must be visible (in milliseconds)
- * @param {number} options.areaThreshold - Minimum ratio of the element that must be visible (0 to 1)
+ * @param {() => void} [options.onImpressionStart] - Callback function executed when the element enters the view
+ * @param {() => void} [options.onImpressionEnd] - Callback function executed when the element exits the view
+ * @param {number} [options.timeThreshold=0] - Minimum time the element must be visible (in milliseconds)
+ * @param {number} [options.areaThreshold=0] - Minimum ratio of the element that must be visible (0 to 1)
  * @param {string} options.rootMargin - Margin to adjust the detection area
  *
  * @returns {(element: Element | null) => void} A function to set the element. Attach this function to the `ref` attribute, and the callbacks will be executed whenever the element's visibility changes.

package/esm/hooks/useIntersectionObserver/index.d.mts

@@ -6,7 +6,9 @@
  * @param {(entry: IntersectionObserverEntry) => void} callback - A callback function that is executed when the visibility of the element changes.
  *   You can check `entry.isIntersecting` to determine if the element is in view.
  * @param {IntersectionObserverInit} options - Options for the `IntersectionObserver`.
- *   You can specify values such as `root`, `rootMargin`, and `threshold`.
+ * @param {boolean} [options.root] - The element that is used as the viewport for checking visibility of the target.
+ * @param {string} [options.rootMargin] - Margin around the root.
+ * @param {number | number[]} [options.threshold] - Either a single number or an array of numbers which indicate at what percentage of the target's visibility the observer's callback should be executed.
  *
  * @returns {(element: Element | null) => void} A function to set the element. Attach this function to the `ref` attribute, and the `callback` will be executed whenever the element's visibility changes.
  *

package/esm/hooks/useThrottle/index.d.mts

@@ -24,6 +24,7 @@ declare function throttle<F extends (...args: any[]) => void>(func: F, throttleM
  * @param {F} callback - The function to be throttled.
  * @param {number} wait - The number of milliseconds to throttle invocations to.
  * @param {{ edges?: Array<'leading' | 'trailing'> }} [options] - Options to control the behavior of the throttle.
+ * @param {Array<'leading' | 'trailing'>} [options.edges=['leading', 'trailing']] - An optional array specifying whether the function should be invoked on the leading edge, trailing edge, or both.
  * @returns {F & { cancel: () => void }} - Returns the throttled function with a `cancel` method to cancel pending executions.
  *
  * @example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-simplikit",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "main": "./dist/index.js",
   "sideEffects": false,
   "files": [