@scaleflex/widget-common 4.0.7 → 4.3.0

package/lib/VirtualGrid/index.js

@@ -17,19 +17,19 @@ import VirtualGridItem from './VirtualGridItem';
 import { defaultGetItemKey, getLayoutInfo } from './VirtualGrid.utils';
 
 // TODO: Refactor the VirtualGrid to consider also the skeleton loading to avoid jumping, and use the same size of skeleton's and align items size.
-/**
- * A Virtual grid that applies (windowing) concept for reusing the DOM elements and avoid rerendering for all items.
- * @param {Array} items - The items that will be used in the grid (required).
- * @param {ReactNode} children - The children that will be rendered for each item (required).
- * @param {String} injectedItemPropName - The name of the prop that will be injected in the children  (optional).
- * @param {Number} overscan - The number of items that will be rendered before and after the viewport in rows  (optional).
- * @param {Function} getItemKey - The function that will be used to get the item key (optional).
- * @param {Boolean} stopChildEventsPropagation - if `true`, the children's items click events won't be propagated outside of the virtual grid component (incase of needing to handle some specific case on grid's container empty space click).
- * @param {Number} columnMinWidth - The minimum width of the column in pixels (optional - default is 214px).
- * @param {String} scrollToKeyOnMount - The key of the item that will be scrolled to on mount the grid (optional).
- * @param {ReactRef} apiRef - the reference that will contain the api functions to deal with the grid (optional)
- *        1- `scrollToItem({ key, index })` function that scrolls the grid to the specified item's key, the key should be the same property that's returned from getItemKey, index should be the item's index.
- * @returns {ReactNode} - The VirtualGrid component.
+/**
+ * A Virtual grid that applies (windowing) concept for reusing the DOM elements and avoid rerendering for all items.
+ * @param {Array} items - The items that will be used in the grid (required).
+ * @param {ReactNode} children - The children that will be rendered for each item (required).
+ * @param {String} injectedItemPropName - The name of the prop that will be injected in the children  (optional).
+ * @param {Number} overscan - The number of items that will be rendered before and after the viewport in rows  (optional).
+ * @param {Function} getItemKey - The function that will be used to get the item key (optional).
+ * @param {Boolean} stopChildEventsPropagation - if `true`, the children's items click events won't be propagated outside of the virtual grid component (incase of needing to handle some specific case on grid's container empty space click).
+ * @param {Number} columnMinWidth - The minimum width of the column in pixels (optional - default is 214px).
+ * @param {String} scrollToKeyOnMount - The key of the item that will be scrolled to on mount the grid (optional).
+ * @param {ReactRef} apiRef - the reference that will contain the api functions to deal with the grid (optional)
+ *        1- `scrollToItem({ key, index })` function that scrolls the grid to the specified item's key, the key should be the same property that's returned from getItemKey, index should be the item's index.
+ * @returns {ReactNode} - The VirtualGrid component.
  */
 import { jsx as _jsx } from "react/jsx-runtime";
 var MARGIN_BOTTOM_SPACE = 24;

package/lib/VirtualList/index.js

@@ -9,18 +9,18 @@ import { ViewportList } from 'react-viewport-list';
 import getScrollableParent from '@scaleflex/widget-explorer/lib/utils/getScrollableParent';
 import VirtualListItem from './VirtualListItem';
 
-/**
- * A Virtual list that applies (windowing) concept for reusing the DOM elements and avoid rerendering for all items.
- * @param {Array} items - The items that will be used in the list (required).
- * @param {ReactNode} children - The children that will be rendered for each item (required).
- * @param {String} injectedItemPropName - The name of the prop that will be injected in the children (optional).
- * @param {Number} overscan - The number of items that will be rendered before and after the viewport (optional).
- * @param {Function} getItemKey - The function that will be used to get the item key (optional).
- * @param {Function} renderSpacer - The function that will be used to render the spacer (optional).
- * @param {ReactRef} parentRef - the reference for the parent wrapper for the virtual list to be used in recognized the scroller/viewport element, not required if the virtual list is the parent and u don't need to have the apiRef (optional)
- * @param {ReactRef} apiRef - the reference that will contain the api functions to deal with the grid (optional)
- *        1- `scrollToItem({ key, index })` function that scrolls the grid to the specified item's key, the key should be the same property that's returned from getItemKey, index should be the item's index.
- * @returns {ReactNode} - The VirtualList component.
+/**
+ * A Virtual list that applies (windowing) concept for reusing the DOM elements and avoid rerendering for all items.
+ * @param {Array} items - The items that will be used in the list (required).
+ * @param {ReactNode} children - The children that will be rendered for each item (required).
+ * @param {String} injectedItemPropName - The name of the prop that will be injected in the children (optional).
+ * @param {Number} overscan - The number of items that will be rendered before and after the viewport (optional).
+ * @param {Function} getItemKey - The function that will be used to get the item key (optional).
+ * @param {Function} renderSpacer - The function that will be used to render the spacer (optional).
+ * @param {ReactRef} parentRef - the reference for the parent wrapper for the virtual list to be used in recognized the scroller/viewport element, not required if the virtual list is the parent and u don't need to have the apiRef (optional)
+ * @param {ReactRef} apiRef - the reference that will contain the api functions to deal with the grid (optional)
+ *        1- `scrollToItem({ key, index })` function that scrolls the grid to the specified item's key, the key should be the same property that's returned from getItemKey, index should be the item's index.
+ * @returns {ReactNode} - The VirtualList component.
  */
 import { jsx as _jsx } from "react/jsx-runtime";
 var defaultGetItemKey = function defaultGetItemKey(item, index) {

package/lib/hooks/useInputWithLocaleNumber.js

@@ -7,9 +7,9 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 import { useEffect, useMemo, useRef } from 'react';
 import { convertToLocaleNumber, toInitialNumber, getLocaleNumberSeparator } from '@scaleflex/widget-utils/lib/formatNumbers';
 
-/**
- * Helper hook that can adapt number input value to selected locale format (ex: "1,000,000.12" for "us"
- * and "1 000 000,12" for "fr"), but store changed value in number format like 1000000.12
+/**
+ * Helper hook that can adapt number input value to selected locale format (ex: "1,000,000.12" for "us"
+ * and "1 000 000,12" for "fr"), but store changed value in number format like 1000000.12
  */
 
 var CHARS_COUNT_TO_SEPARATE = 4;