@fluentui/react-virtualizer 9.0.0-alpha.8 → 9.0.0-alpha.80

package/dist/index.d.ts

@@ -2,14 +2,67 @@ import type { ComponentProps } from '@fluentui/react-utilities';
 import type { ComponentState } from '@fluentui/react-utilities';
 import type { Dispatch } from 'react';
 import type { FC } from 'react';
-import type { MutableRefObject } from 'react';
+import { MutableRefObject } from 'react';
 import * as React_2 from 'react';
+import type { RefObject } from 'react';
 import type { SetStateAction } from 'react';
 import type { Slot } from '@fluentui/react-utilities';
 import type { SlotClassNames } from '@fluentui/react-utilities';
 
 export declare const renderVirtualizer_unstable: (state: VirtualizerState) => JSX.Element;
 
+export declare const renderVirtualizerScrollView_unstable: (state: VirtualizerScrollViewState) => JSX.Element;
+
+export declare const renderVirtualizerScrollViewDynamic_unstable: (state: VirtualizerScrollViewDynamicState) => JSX.Element;
+
+/**
+ * Additional direct Ref prevents reading old resize entry data
+ * Backwards compatible with ResizeObserverCallback if preferred
+ */
+export declare interface ResizeCallbackWithRef {
+    (entries: ResizeObserverEntry[], observer: ResizeObserver, scrollRef?: MutableRefObject<HTMLElement | null>): void;
+}
+
+export declare type ScrollToInterface = {
+    scrollTo: (index: number, behavior?: ScrollBehavior, callback?: (index: number) => void) => void;
+    virtualizerLength: RefObject<number>;
+    currentIndex: RefObject<number> | undefined;
+};
+
+export declare const scrollToItemDynamic: (params: ScrollToItemDynamicParams) => void;
+
+export declare type ScrollToItemDynamicParams = {
+    index: number;
+    itemSizes: RefObject<number[]>;
+    totalSize: number;
+    scrollViewRef: RefObject<HTMLDivElement>;
+    axis?: 'horizontal' | 'vertical';
+    reversed?: boolean;
+    behavior?: ScrollBehavior;
+};
+
+export declare const scrollToItemStatic: (params: ScrollToItemStaticParams) => void;
+
+export declare type ScrollToItemStaticParams = {
+    index: number;
+    itemSize: number;
+    totalItems: number;
+    scrollViewRef: RefObject<HTMLDivElement>;
+    axis?: 'horizontal' | 'vertical';
+    reversed?: boolean;
+    behavior?: ScrollBehavior;
+};
+
+/**
+ * React hook that measures virtualized space dynamically to ensure optimized virtualization length.
+ */
+export declare const useDynamicVirtualizerMeasure: <TElement extends HTMLElement>(virtualizerProps: VirtualizerMeasureDynamicProps) => {
+    virtualizerLength: number;
+    bufferItems: number;
+    bufferSize: number;
+    scrollRef: (instance: TElement | null) => void;
+};
+
 /**
  * React hook that allows easy usage of the browser API IntersectionObserver within React
  * @param callback - A function called when the percentage of the target element is visible crosses a threshold.
@@ -19,14 +72,45 @@ export declare const renderVirtualizer_unstable: (state: VirtualizerState) => JS
  * @returns An array containing a callback to update the list of Elements the observer should listen to, a callback to
  * update the init options of the IntersectionObserver and a ref to the IntersectionObserver instance itself.
  */
-export declare const useIntersectionObserver: (callback: IntersectionObserverCallback, options?: IntersectionObserverInit | undefined) => {
+export declare const useIntersectionObserver: (callback: IntersectionObserverCallback, options?: IntersectionObserverInit) => {
     setObserverList: Dispatch<SetStateAction<Element[] | undefined>>;
-    setObserverInit: Dispatch<SetStateAction<IntersectionObserverInit | undefined>>;
+    setObserverInit: (newInit: IntersectionObserverInit | undefined) => void;
     observer: MutableRefObject<IntersectionObserver | undefined>;
 };
 
+/**
+ * useResizeObserverRef_unstable simplifies resize observer connection and ensures debounce/cleanup
+ */
+export declare const useResizeObserverRef_unstable: (resizeCallback: ResizeCallbackWithRef) => (instance: HTMLElement | HTMLDivElement | null) => void;
+
+/**
+ * React hook that measures virtualized space based on a static size to ensure optimized virtualization length.
+ */
+export declare const useStaticVirtualizerMeasure: <TElement extends HTMLElement>(virtualizerProps: VirtualizerMeasureProps) => {
+    virtualizerLength: number;
+    bufferItems: number;
+    bufferSize: number;
+    scrollRef: (instance: TElement | null) => void;
+};
+
 export declare function useVirtualizer_unstable(props: VirtualizerProps): VirtualizerState;
 
+export declare const useVirtualizerContext_unstable: () => VirtualizerContextProps;
+
+export declare function useVirtualizerScrollView_unstable(props: VirtualizerScrollViewProps): VirtualizerScrollViewState;
+
+export declare function useVirtualizerScrollViewDynamic_unstable(props: VirtualizerScrollViewDynamicProps): VirtualizerScrollViewDynamicState;
+
+/**
+ * Apply styling to the Virtualizer states
+ */
+export declare const useVirtualizerScrollViewDynamicStyles_unstable: (state: VirtualizerScrollViewDynamicState) => VirtualizerScrollViewDynamicState;
+
+/**
+ * Apply styling to the Virtualizer states
+ */
+export declare const useVirtualizerScrollViewStyles_unstable: (state: VirtualizerScrollViewState) => VirtualizerScrollViewState;
+
 /**
  * Apply styling to the Virtualizer states
  */
@@ -39,11 +123,11 @@ export declare const useVirtualizerStyles_unstable: (state: VirtualizerState) =>
  */
 export declare const Virtualizer: FC<VirtualizerProps>;
 
-export declare type VirtualizerChildRenderFunction = (index: number) => React_2.ReactNode;
+export declare type VirtualizerChildRenderFunction = (index: number, isScrolling: boolean) => React_2.ReactNode;
 
 export declare const virtualizerClassNames: SlotClassNames<VirtualizerSlots>;
 
-export declare type VirtualizerProps = ComponentProps<Partial<VirtualizerSlots>> & {
+declare type VirtualizerConfigProps = {
     /**
      * Child render function.
      * Iteratively called to return current virtualizer DOM children.
@@ -87,9 +171,8 @@ export declare type VirtualizerProps = ComponentProps<Partial<VirtualizerSlots>>
     bufferSize?: number;
     /**
      * Enables users to override the intersectionObserverRoot.
-     * @default null
      */
-    intersectionObserverRoot?: React_2.MutableRefObject<HTMLElement | null>;
+    scrollViewRef?: React_2.MutableRefObject<HTMLElement | null>;
     /**
      * The scroll direction
      * @default vertical
@@ -106,35 +189,21 @@ export declare type VirtualizerProps = ComponentProps<Partial<VirtualizerSlots>>
      */
     getItemSize?: (index: number) => number;
     /**
-     * Notify users of index changes
-     */
-    onUpdateIndex?: (index: number, prevIndex: number) => void;
-    /**
-     * Allow users to intervene in index calculation changes
+     * Virtualizer context can be passed as a prop for extended class use
      */
-    onCalculateIndex?: (newIndex: number) => number;
-};
-
-export declare type VirtualizerSlots = {
+    virtualizerContext?: VirtualizerContextProps;
     /**
-     * The intersection observed 'before' element will detect when scrolling towards the beginning.
+     * Callback for notifying when a flagged index has been rendered
      */
-    before: NonNullable<Slot<'div', 'td'>>;
+    onRenderedFlaggedIndex?: (index: number) => void;
+    flaggedIndex?: MutableRefObject<number | null>;
     /**
-     * A block place holding whitespace at the beginning of current DOM children.
-     */
-    beforeContainer: NonNullable<Slot<'div', 'tr'>>;
-    /**
-     * The intersection observed 'after' element will detect when scrolling towards the end.
-     */
-    after: NonNullable<Slot<'div', 'td'>>;
-    /**
-     * A block place holding whitespace after the end of current DOM children.
+     * Imperative ref contains our scrollTo index functionality for user control.
      */
-    afterContainer: NonNullable<Slot<'div', 'tr'>>;
+    imperativeVirtualizerRef?: RefObject<VirtualizerDataRef>;
 };
 
-export declare type VirtualizerState = ComponentState<VirtualizerSlots> & {
+declare type VirtualizerConfigState = {
     /**
      * The current virtualized array of children to show in the DOM.
      */
@@ -165,9 +234,158 @@ export declare type VirtualizerState = ComponentState<VirtualizerSlots> & {
      */
     reversed?: boolean;
     /**
-     * Tells the virtualizer how much
+     * Pixel size of intersection observers and how much they 'cross over' into the bufferItems index.
+     * Minimum 1px.
      */
     bufferSize: number;
+    /**
+     * Ref for access to internal size knowledge, can be used to measure updates
+     */
+    childSizes: React_2.MutableRefObject<number[]>;
+    /**
+     * Ref for access to internal progressive size knowledge, can be used to measure updates
+     */
+    childProgressiveSizes: React_2.MutableRefObject<number[]>;
+};
+
+/**
+ * {@docCategory Virtualizer}
+ */
+export declare type VirtualizerContextProps = {
+    contextIndex: number;
+    setContextIndex: (index: number) => void;
+};
+
+export declare const VirtualizerContextProvider: React_2.Provider<VirtualizerContextProps>;
+
+export declare type VirtualizerDataRef = {
+    progressiveSizes: RefObject<number[]>;
+    nodeSizes: RefObject<number[]>;
+    setFlaggedIndex: (index: number | null) => void;
+    currentIndex: RefObject<number>;
+};
+
+export declare type VirtualizerMeasureDynamicProps = {
+    defaultItemSize: number;
+    currentIndex: number;
+    numItems: number;
+    getItemSize: (index: number) => number;
+    direction?: 'vertical' | 'horizontal';
+};
+
+export declare type VirtualizerMeasureProps = {
+    defaultItemSize: number;
+    direction?: 'vertical' | 'horizontal';
+};
+
+export declare type VirtualizerProps = ComponentProps<Partial<VirtualizerSlots>> & VirtualizerConfigProps;
+
+/**
+ * Virtualizer ScrollView
+ */
+export declare const VirtualizerScrollView: React_2.FC<VirtualizerScrollViewProps>;
+
+export declare const virtualizerScrollViewClassNames: SlotClassNames<VirtualizerScrollViewSlots>;
+
+/**
+ * Virtualizer ScrollView
+ */
+export declare const VirtualizerScrollViewDynamic: React_2.FC<VirtualizerScrollViewDynamicProps>;
+
+export declare const virtualizerScrollViewDynamicClassNames: SlotClassNames<VirtualizerScrollViewDynamicSlots>;
+
+export declare type VirtualizerScrollViewDynamicProps = ComponentProps<Partial<VirtualizerScrollViewDynamicSlots>> & Partial<Omit<VirtualizerConfigProps, 'itemSize' | 'numItems' | 'getItemSize' | 'children' | 'flagIndex'>> & {
+    /**
+     * Set as the minimum item size.
+     * Axis: 'vertical' = Height
+     * Axis: 'horizontal' = Width
+     */
+    itemSize: number;
+    /**
+     * Callback for acquiring size of individual items
+     * @param index - the index of the requested size's child
+     * If undefined, Virtualizer will auto-measure by default (performance tradeoff)
+     */
+    getItemSize?: (index: number) => number;
+    /**
+     * The total number of items to be virtualized.
+     */
+    numItems: number;
+    /**
+     * Child render function.
+     * Iteratively called to return current virtualizer DOM children.
+     * Will act as a row or column indexer depending on Virtualizer settings.
+     */
+    children: VirtualizerChildRenderFunction;
+    /**
+     * Imperative ref contains our scrollTo index functionality for user control.
+     */
+    imperativeRef?: RefObject<ScrollToInterface>;
+    /**
+     * Imperative ref contains our scrollTo index functionality for user control.
+     */
+    enablePagination?: boolean;
 };
 
+export declare type VirtualizerScrollViewDynamicSlots = VirtualizerScrollViewSlots;
+
+export declare type VirtualizerScrollViewDynamicState = ComponentState<VirtualizerScrollViewDynamicSlots> & VirtualizerConfigState;
+
+export declare type VirtualizerScrollViewProps = ComponentProps<Partial<VirtualizerScrollViewSlots>> & Partial<Omit<VirtualizerConfigProps, 'itemSize' | 'numItems' | 'getItemSize' | 'children' | 'flagIndex' | 'imperativeVirtualizerRef'>> & {
+    /**
+     * Virtualizer item size in pixels - static.
+     * Axis: 'vertical' = Height
+     * Axis: 'horizontal' = Width
+     */
+    itemSize: number;
+    /**
+     * The total number of items to be virtualized.
+     */
+    numItems: number;
+    /**
+     * Child render function.
+     * Iteratively called to return current virtualizer DOM children.
+     * Will act as a row or column indexer depending on Virtualizer settings.
+     */
+    children: VirtualizerChildRenderFunction;
+    /**
+     * Imperative ref contains our scrollTo index functionality for user control.
+     */
+    imperativeRef?: RefObject<ScrollToInterface>;
+    /**
+     * Imperative ref contains our scrollTo index functionality for user control.
+     */
+    enablePagination?: boolean;
+};
+
+export declare type VirtualizerScrollViewSlots = VirtualizerSlots & {
+    /**
+     * The root container that provides embedded scrolling.
+     */
+    container: NonNullable<Slot<'div'>>;
+};
+
+export declare type VirtualizerScrollViewState = ComponentState<VirtualizerScrollViewSlots> & VirtualizerConfigState;
+
+export declare type VirtualizerSlots = {
+    /**
+     * The intersection observed 'before' element will detect when scrolling towards the beginning.
+     */
+    before: NonNullable<Slot<'div', 'td'>>;
+    /**
+     * A block place holding whitespace at the beginning of current DOM children.
+     */
+    beforeContainer: NonNullable<Slot<'div', 'tr'>>;
+    /**
+     * The intersection observed 'after' element will detect when scrolling towards the end.
+     */
+    after: NonNullable<Slot<'div', 'td'>>;
+    /**
+     * A block place holding whitespace after the end of current DOM children.
+     */
+    afterContainer: NonNullable<Slot<'div', 'tr'>>;
+};
+
+export declare type VirtualizerState = ComponentState<VirtualizerSlots> & VirtualizerConfigState;
+
 export { }

package/lib/Hooks.js

@@ -1,2 +1 @@
 export * from './hooks/index';
-//# sourceMappingURL=Hooks.js.map

package/lib/Hooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"Hooks.js","sourceRoot":"../src/","sources":["packages/react-components/react-virtualizer/src/Hooks.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC","sourcesContent":["export * from './hooks/index';\n"]}
+{"version":3,"sources":["Hooks.ts"],"sourcesContent":["export * from './hooks/index';\n"],"names":[],"mappings":"AAAA,cAAc,gBAAgB"}

package/lib/Utilities.js

@@ -0,0 +1 @@
+export * from './utilities/index';

package/lib/Utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["Utilities.ts"],"sourcesContent":["export * from './utilities/index';\n"],"names":[],"mappings":"AAAA,cAAc,oBAAoB"}

package/lib/Virtualizer.js

@@ -1,2 +1 @@
 export * from './components/Virtualizer/index';
-//# sourceMappingURL=Virtualizer.js.map

package/lib/Virtualizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"Virtualizer.js","sourceRoot":"../src/","sources":["packages/react-components/react-virtualizer/src/Virtualizer.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC","sourcesContent":["export * from './components/Virtualizer/index';\n"]}
+{"version":3,"sources":["Virtualizer.ts"],"sourcesContent":["export * from './components/Virtualizer/index';\n"],"names":[],"mappings":"AAAA,cAAc,iCAAiC"}

package/lib/VirtualizerScrollView.js

@@ -0,0 +1 @@
+export * from './components/VirtualizerScrollView/index';

package/lib/VirtualizerScrollView.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["VirtualizerScrollView.ts"],"sourcesContent":["export * from './components/VirtualizerScrollView/index';\n"],"names":[],"mappings":"AAAA,cAAc,2CAA2C"}

package/lib/VirtualizerScrollViewDynamic.js

@@ -0,0 +1 @@
+export * from './components/VirtualizerScrollViewDynamic/index';

package/lib/VirtualizerScrollViewDynamic.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["VirtualizerScrollViewDynamic.ts"],"sourcesContent":["export * from './components/VirtualizerScrollViewDynamic/index';\n"],"names":[],"mappings":"AAAA,cAAc,kDAAkD"}

package/lib/components/Virtualizer/Virtualizer.js

@@ -1,15 +1,13 @@
-import { useVirtualizerStyles_unstable } from './useVirtualizerStyles';
+import { useVirtualizerStyles_unstable } from './useVirtualizerStyles.styles';
 import { useVirtualizer_unstable } from './useVirtualizer';
 import { renderVirtualizer_unstable } from './renderVirtualizer';
 /**
  * Virtualizer pseudo-component, this functional wrapper
  * provides a simple interface for reducing the total number
  * of elements rendered at one time in large lists.
- */
-export const Virtualizer = props => {
-  const state = useVirtualizer_unstable(props);
-  useVirtualizerStyles_unstable(state);
-  return renderVirtualizer_unstable(state);
+ */ export const Virtualizer = (props)=>{
+    const state = useVirtualizer_unstable(props);
+    useVirtualizerStyles_unstable(state);
+    return renderVirtualizer_unstable(state);
 };
 Virtualizer.displayName = 'Virtualizer';
-//# sourceMappingURL=Virtualizer.js.map

package/lib/components/Virtualizer/Virtualizer.js.map

@@ -1 +1 @@
-{"version":3,"mappings":"AACA,SAASA,6BAA6B,QAAQ,wBAAwB;AACtE,SAASC,uBAAuB,QAAQ,kBAAkB;AAC1D,SAASC,0BAA0B,QAAQ,qBAAqB;AAGhE;;;;;AAKA,OAAO,MAAMC,WAAW,GAA0BC,KAAuB,IAAI;EAC3E,MAAMC,KAAK,GAAGJ,uBAAuB,CAACG,KAAK,CAAC;EAC5CJ,6BAA6B,CAACK,KAAK,CAAC;EAEpC,OAAOH,0BAA0B,CAACG,KAAK,CAAC;AAC1C,CAAC;AAEDF,WAAW,CAACG,WAAW,GAAG,aAAa","names":["useVirtualizerStyles_unstable","useVirtualizer_unstable","renderVirtualizer_unstable","Virtualizer","props","state","displayName"],"sourceRoot":"../src/","sources":["packages/react-components/react-virtualizer/src/components/Virtualizer/Virtualizer.ts"],"sourcesContent":["import type { VirtualizerProps } from './Virtualizer.types';\nimport { useVirtualizerStyles_unstable } from './useVirtualizerStyles';\nimport { useVirtualizer_unstable } from './useVirtualizer';\nimport { renderVirtualizer_unstable } from './renderVirtualizer';\nimport type { FC } from 'react';\n\n/**\n * Virtualizer pseudo-component, this functional wrapper\n * provides a simple interface for reducing the total number\n * of elements rendered at one time in large lists.\n */\nexport const Virtualizer: FC<VirtualizerProps> = (props: VirtualizerProps) => {\n  const state = useVirtualizer_unstable(props);\n  useVirtualizerStyles_unstable(state);\n\n  return renderVirtualizer_unstable(state);\n};\n\nVirtualizer.displayName = 'Virtualizer';\n"]}
+{"version":3,"sources":["Virtualizer.ts"],"sourcesContent":["import type { VirtualizerProps } from './Virtualizer.types';\nimport { useVirtualizerStyles_unstable } from './useVirtualizerStyles.styles';\nimport { useVirtualizer_unstable } from './useVirtualizer';\nimport { renderVirtualizer_unstable } from './renderVirtualizer';\nimport type { FC } from 'react';\n\n/**\n * Virtualizer pseudo-component, this functional wrapper\n * provides a simple interface for reducing the total number\n * of elements rendered at one time in large lists.\n */\nexport const Virtualizer: FC<VirtualizerProps> = (props: VirtualizerProps) => {\n  const state = useVirtualizer_unstable(props);\n  useVirtualizerStyles_unstable(state);\n\n  return renderVirtualizer_unstable(state);\n};\n\nVirtualizer.displayName = 'Virtualizer';\n"],"names":["useVirtualizerStyles_unstable","useVirtualizer_unstable","renderVirtualizer_unstable","Virtualizer","props","state","displayName"],"mappings":"AACA,SAASA,6BAA6B,QAAQ,gCAAgC;AAC9E,SAASC,uBAAuB,QAAQ,mBAAmB;AAC3D,SAASC,0BAA0B,QAAQ,sBAAsB;AAGjE;;;;CAIC,GACD,OAAO,MAAMC,cAAoC,CAACC;IAChD,MAAMC,QAAQJ,wBAAwBG;IACtCJ,8BAA8BK;IAE9B,OAAOH,2BAA2BG;AACpC,EAAE;AAEFF,YAAYG,WAAW,GAAG"}

package/lib/components/Virtualizer/Virtualizer.types.js

@@ -1,2 +1 @@
-export {};
-//# sourceMappingURL=Virtualizer.types.js.map
+import * as React from 'react';

package/lib/components/Virtualizer/Virtualizer.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"Virtualizer.types.js","sourceRoot":"../src/","sources":["packages/react-components/react-virtualizer/src/components/Virtualizer/Virtualizer.types.ts"],"names":[],"mappings":"","sourcesContent":["import * as React from 'react';\nimport type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';\n\nexport type VirtualizerSlots = {\n  /**\n   * The intersection observed 'before' element will detect when scrolling towards the beginning.\n   */\n  before: NonNullable<Slot<'div', 'td'>>;\n  /**\n   * A block place holding whitespace at the beginning of current DOM children.\n   */\n  beforeContainer: NonNullable<Slot<'div', 'tr'>>;\n  /**\n   * The intersection observed 'after' element will detect when scrolling towards the end.\n   */\n  after: NonNullable<Slot<'div', 'td'>>;\n  /**\n   * A block place holding whitespace after the end of current DOM children.\n   */\n  afterContainer: NonNullable<Slot<'div', 'tr'>>;\n};\n\nexport type VirtualizerState = ComponentState<VirtualizerSlots> & {\n  /**\n   * The current virtualized array of children to show in the DOM.\n   */\n  virtualizedChildren: React.ReactNode[];\n  /**\n   * The current start index for the virtualizer, all previous index's will be removed from DOM.\n   */\n  virtualizerStartIndex: number;\n  /**\n   * Current buffer height required at beginning of array.\n   */\n  afterBufferHeight: number;\n  /**\n   * Current buffer height required at end of array.\n   */\n  beforeBufferHeight: number;\n  /**\n   * The total current height of the scrollView/child content.\n   */\n  totalVirtualizerHeight: number;\n  /**\n   * The scroll direction\n   * @default vertical\n   */\n  axis?: 'vertical' | 'horizontal';\n  /**\n   * Tells the virtualizer to measure in the reverse direction (for column-reverse order etc.)\n   */\n  reversed?: boolean;\n  /**\n   * Tells the virtualizer how much\n   */\n  bufferSize: number;\n};\n\n// Virtualizer render function to procedurally generate children elements as rows or columns via index.\n// Q: Use generic typing and passing through object data or a simple index system?\nexport type VirtualizerChildRenderFunction = (index: number) => React.ReactNode;\n\nexport type VirtualizerProps = ComponentProps<Partial<VirtualizerSlots>> & {\n  /**\n   * Child render function.\n   * Iteratively called to return current virtualizer DOM children.\n   * Will act as a row or column indexer depending on Virtualizer settings.\n   * Can be used dynamically.\n   */\n  children: VirtualizerChildRenderFunction;\n\n  /**\n   * Default cell size to use if no custom callback provided.\n   * If implementing `getItemSize` this should be the initial and ideally minimum cell size.\n   */\n  itemSize: number;\n\n  /**\n   * The total number of items to be virtualized.\n   */\n  numItems: number;\n\n  /**\n   * Number of children to render in the DOM during virtualization.\n   * Constraints:\n   * - Large enough that the items rendered in DOM cover the viewport\n   *   and intersection observer buffers (buffersize) at both ends.\n   */\n  virtualizerLength: number;\n\n  /**\n   * Defaults to 1/4th of virtualizerLength.\n   * Controls the number of elements rendered before the current index entering the virtualized viewport.\n   * Constraints:\n   * - Large enough to cover bufferSize (prevents buffers intersecting into the viewport during rest state).\n   * - Small enough that the end buffer and end index (start index + virtualizerLength) is not within viewport at rest.\n   */\n  bufferItems?: number;\n\n  /**\n   * Defaults to half of bufferItems size (in pixels).\n   * The length (in pixels) before the end/start DOM index where the virtualizer recalculation will be triggered.\n   * Increasing this reduces whitespace on ultra-fast scroll, as additional elements\n   * are buffered to appear while virtualization recalculates.\n   * Constraints:\n   * - At least 1px - although this will only trigger the recalculation after bookends (whitespace) enter viewport.\n   * - BufferSize must be smaller than bufferItems pixel size, as it prevents bookends entering viewport at rest.\n   */\n  bufferSize?: number;\n\n  /**\n   * Enables users to override the intersectionObserverRoot.\n   * @default null\n   */\n  intersectionObserverRoot?: React.MutableRefObject<HTMLElement | null>;\n\n  /**\n   * The scroll direction\n   * @default vertical\n   */\n  axis?: 'vertical' | 'horizontal';\n\n  /**\n   * Tells the virtualizer to measure in the reverse direction (for column-reverse order etc.)\n   * This value should be flipped in RTL implementation (TBD whether automate RTL).\n   */\n  reversed?: boolean;\n\n  /**\n   * Callback for acquiring size of individual items\n   * @param index - the index of the requested size's child\n   */\n  getItemSize?: (index: number) => number;\n\n  /**\n   * Notify users of index changes\n   */\n  onUpdateIndex?: (index: number, prevIndex: number) => void;\n\n  /**\n   * Allow users to intervene in index calculation changes\n   */\n  onCalculateIndex?: (newIndex: number) => number;\n};\n"]}
+{"version":3,"sources":["Virtualizer.types.ts"],"sourcesContent":["import * as React from 'react';\nimport type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';\nimport type { VirtualizerContextProps } from '../../Utilities';\nimport type { RefObject, MutableRefObject } from 'react';\n\nexport type VirtualizerSlots = {\n  /**\n   * The intersection observed 'before' element will detect when scrolling towards the beginning.\n   */\n  before: NonNullable<Slot<'div', 'td'>>;\n  /**\n   * A block place holding whitespace at the beginning of current DOM children.\n   */\n  beforeContainer: NonNullable<Slot<'div', 'tr'>>;\n  /**\n   * The intersection observed 'after' element will detect when scrolling towards the end.\n   */\n  after: NonNullable<Slot<'div', 'td'>>;\n  /**\n   * A block place holding whitespace after the end of current DOM children.\n   */\n  afterContainer: NonNullable<Slot<'div', 'tr'>>;\n};\n\nexport type VirtualizerConfigState = {\n  /**\n   * The current virtualized array of children to show in the DOM.\n   */\n  virtualizedChildren: React.ReactNode[];\n  /**\n   * The current start index for the virtualizer, all previous index's will be removed from DOM.\n   */\n  virtualizerStartIndex: number;\n  /**\n   * Current buffer height required at beginning of array.\n   */\n  afterBufferHeight: number;\n  /**\n   * Current buffer height required at end of array.\n   */\n  beforeBufferHeight: number;\n  /**\n   * The total current height of the scrollView/child content.\n   */\n  totalVirtualizerHeight: number;\n  /**\n   * The scroll direction\n   * @default vertical\n   */\n  axis?: 'vertical' | 'horizontal';\n  /**\n   * Tells the virtualizer to measure in the reverse direction (for column-reverse order etc.)\n   */\n  reversed?: boolean;\n  /**\n   * Pixel size of intersection observers and how much they 'cross over' into the bufferItems index.\n   * Minimum 1px.\n   */\n  bufferSize: number;\n  /**\n   * Ref for access to internal size knowledge, can be used to measure updates\n   */\n  childSizes: React.MutableRefObject<number[]>;\n  /**\n   * Ref for access to internal progressive size knowledge, can be used to measure updates\n   */\n  childProgressiveSizes: React.MutableRefObject<number[]>;\n};\n\nexport type VirtualizerState = ComponentState<VirtualizerSlots> & VirtualizerConfigState;\n\n// Virtualizer render function to procedurally generate children elements as rows or columns via index.\n// Q: Use generic typing and passing through object data or a simple index system?\nexport type VirtualizerChildRenderFunction = (index: number, isScrolling: boolean) => React.ReactNode;\n\nexport type VirtualizerDataRef = {\n  progressiveSizes: RefObject<number[]>;\n  nodeSizes: RefObject<number[]>;\n  setFlaggedIndex: (index: number | null) => void;\n  currentIndex: RefObject<number>;\n};\n\nexport type VirtualizerConfigProps = {\n  /**\n   * Child render function.\n   * Iteratively called to return current virtualizer DOM children.\n   * Will act as a row or column indexer depending on Virtualizer settings.\n   * Can be used dynamically.\n   */\n  children: VirtualizerChildRenderFunction;\n\n  /**\n   * Default cell size to use if no custom callback provided.\n   * If implementing `getItemSize` this should be the initial and ideally minimum cell size.\n   */\n  itemSize: number;\n\n  /**\n   * The total number of items to be virtualized.\n   */\n  numItems: number;\n\n  /**\n   * Number of children to render in the DOM during virtualization.\n   * Constraints:\n   * - Large enough that the items rendered in DOM cover the viewport\n   *   and intersection observer buffers (buffersize) at both ends.\n   */\n  virtualizerLength: number;\n\n  /**\n   * Defaults to 1/4th of virtualizerLength.\n   * Controls the number of elements rendered before the current index entering the virtualized viewport.\n   * Constraints:\n   * - Large enough to cover bufferSize (prevents buffers intersecting into the viewport during rest state).\n   * - Small enough that the end buffer and end index (start index + virtualizerLength) is not within viewport at rest.\n   */\n  bufferItems?: number;\n\n  /**\n   * Defaults to half of bufferItems size (in pixels).\n   * The length (in pixels) before the end/start DOM index where the virtualizer recalculation will be triggered.\n   * Increasing this reduces whitespace on ultra-fast scroll, as additional elements\n   * are buffered to appear while virtualization recalculates.\n   * Constraints:\n   * - At least 1px - although this will only trigger the recalculation after bookends (whitespace) enter viewport.\n   * - BufferSize must be smaller than bufferItems pixel size, as it prevents bookends entering viewport at rest.\n   */\n  bufferSize?: number;\n\n  /**\n   * Enables users to override the intersectionObserverRoot.\n   */\n  scrollViewRef?: React.MutableRefObject<HTMLElement | null>;\n\n  /**\n   * The scroll direction\n   * @default vertical\n   */\n  axis?: 'vertical' | 'horizontal';\n\n  /**\n   * Tells the virtualizer to measure in the reverse direction (for column-reverse order etc.)\n   * This value should be flipped in RTL implementation (TBD whether automate RTL).\n   */\n  reversed?: boolean;\n\n  /**\n   * Callback for acquiring size of individual items\n   * @param index - the index of the requested size's child\n   */\n  getItemSize?: (index: number) => number;\n\n  /**\n   * Virtualizer context can be passed as a prop for extended class use\n   */\n  virtualizerContext?: VirtualizerContextProps;\n\n  /**\n   * Callback for notifying when a flagged index has been rendered\n   */\n  // eslint-disable-next-line @nx/workspace-consistent-callback-type -- can't change type of existing callback\n  onRenderedFlaggedIndex?: (index: number) => void;\n\n  /*\n   * Callback for notifying when a flagged index has been rendered\n   */\n  flaggedIndex?: MutableRefObject<number | null>;\n\n  /**\n   * Imperative ref contains our scrollTo index functionality for user control.\n   */\n  imperativeVirtualizerRef?: RefObject<VirtualizerDataRef>;\n};\n\nexport type VirtualizerProps = ComponentProps<Partial<VirtualizerSlots>> & VirtualizerConfigProps;\n"],"names":["React"],"mappings":"AAAA,YAAYA,WAAW,QAAQ"}

package/lib/components/Virtualizer/index.js

@@ -2,5 +2,4 @@ export * from './Virtualizer';
 export * from './Virtualizer.types';
 export * from './useVirtualizer';
 export * from './renderVirtualizer';
-export * from './useVirtualizerStyles';
-//# sourceMappingURL=index.js.map
+export * from './useVirtualizerStyles.styles';

package/lib/components/Virtualizer/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"../src/","sources":["packages/react-components/react-virtualizer/src/components/Virtualizer/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC","sourcesContent":["export * from './Virtualizer';\nexport * from './Virtualizer.types';\nexport * from './useVirtualizer';\nexport * from './renderVirtualizer';\nexport * from './useVirtualizerStyles';\n"]}
+{"version":3,"sources":["index.ts"],"sourcesContent":["export * from './Virtualizer';\nexport * from './Virtualizer.types';\nexport * from './useVirtualizer';\nexport * from './renderVirtualizer';\nexport * from './useVirtualizerStyles.styles';\n"],"names":[],"mappings":"AAAA,cAAc,gBAAgB;AAC9B,cAAc,sBAAsB;AACpC,cAAc,mBAAmB;AACjC,cAAc,sBAAsB;AACpC,cAAc,gCAAgC"}

package/lib/components/Virtualizer/renderVirtualizer.js

@@ -1,18 +1,23 @@
+  import { jsx as _jsx, jsxs as _jsxs } from "@fluentui/react-jsx-runtime/jsx-runtime";
 import * as React from 'react';
-import { getSlots } from '@fluentui/react-utilities';
-export const renderVirtualizer_unstable = state => {
-  const {
-    slots,
-    slotProps
-  } = getSlots(state);
-  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(slots.beforeContainer, {
-    ...slotProps.beforeContainer
-  }, /*#__PURE__*/React.createElement(slots.before, {
-    ...slotProps.before
-  })), state.virtualizedChildren, /*#__PURE__*/React.createElement(slots.afterContainer, {
-    ...slotProps.afterContainer
-  }, /*#__PURE__*/React.createElement(slots.after, {
-    ...slotProps.after
-  })));
+import { assertSlots } from '@fluentui/react-utilities';
+export const renderVirtualizer_unstable = (state)=>{
+    assertSlots(state);
+    return /*#__PURE__*/ _jsxs(React.Fragment, {
+        children: [
+            /*#__PURE__*/ _jsx(state.beforeContainer, {
+                children: /*#__PURE__*/ _jsx(state.before, {})
+            }),
+            state.virtualizedChildren,
+            /*#__PURE__*/ _jsx(state.afterContainer, {
+                children: /*#__PURE__*/ _jsx(state.after, {})
+            })
+        ]
+    });
+};
+export const renderVirtualizerChildPlaceholder = (child, index)=>{
+    return /*#__PURE__*/ _jsx(React.Suspense, {
+        fallback: null,
+        children: child
+    }, `fui-virtualizer-placeholder-${index}`);
 };
-//# sourceMappingURL=renderVirtualizer.js.map

package/lib/components/Virtualizer/renderVirtualizer.js.map

@@ -1 +1 @@
-{"version":3,"mappings":"AAAA,OAAO,KAAKA,KAAK,MAAM,OAAO;AAC9B,SAASC,QAAQ,QAAQ,2BAA2B;AAGpD,OAAO,MAAMC,0BAA0B,GAAIC,KAAuB,IAAI;EACpE,MAAM;IAAEC,KAAK;IAAEC;EAAS,CAAE,GAAGJ,QAAQ,CAAmBE,KAAK,CAAC;EAE9D,oBACEH,oBAACA,KAAK,CAACM,QAAQ,qBAEbN,oBAACI,KAAK,CAACG,eAAe;IAAA,GAAKF,SAAS,CAACE;EAAe,gBAClDP,oBAACI,KAAK,CAACI,MAAM;IAAA,GAAKH,SAAS,CAACG;EAAM,EAAI,CAChB,EAEvBL,KAAK,CAACM,mBAAmB,eAE1BT,oBAACI,KAAK,CAACM,cAAc;IAAA,GAAKL,SAAS,CAACK;EAAc,gBAChDV,oBAACI,KAAK,CAACO,KAAK;IAAA,GAAKN,SAAS,CAACM;EAAK,EAAI,CACf,CACR;AAErB,CAAC","names":["React","getSlots","renderVirtualizer_unstable","state","slots","slotProps","Fragment","beforeContainer","before","virtualizedChildren","afterContainer","after"],"sourceRoot":"../src/","sources":["packages/react-components/react-virtualizer/src/components/Virtualizer/renderVirtualizer.tsx"],"sourcesContent":["import * as React from 'react';\nimport { getSlots } from '@fluentui/react-utilities';\nimport { VirtualizerSlots, VirtualizerState } from './Virtualizer.types';\n\nexport const renderVirtualizer_unstable = (state: VirtualizerState) => {\n  const { slots, slotProps } = getSlots<VirtualizerSlots>(state);\n\n  return (\n    <React.Fragment>\n      {/* The 'before' bookend to hold items in place and detect scroll previous */}\n      <slots.beforeContainer {...slotProps.beforeContainer}>\n        <slots.before {...slotProps.before} />\n      </slots.beforeContainer>\n      {/* The reduced list of non-virtualized children to be rendered */}\n      {state.virtualizedChildren}\n      {/* The 'after' bookend to hold items in place and detect scroll next */}\n      <slots.afterContainer {...slotProps.afterContainer}>\n        <slots.after {...slotProps.after} />\n      </slots.afterContainer>\n    </React.Fragment>\n  );\n};\n"]}
+{"version":3,"sources":["renderVirtualizer.tsx"],"sourcesContent":["/** @jsxRuntime automatic */\n/** @jsxImportSource @fluentui/react-jsx-runtime */\n\nimport * as React from 'react';\nimport type { VirtualizerSlots, VirtualizerState } from './Virtualizer.types';\nimport type { ReactNode } from 'react';\n\nimport { assertSlots } from '@fluentui/react-utilities';\n\nexport const renderVirtualizer_unstable = (state: VirtualizerState) => {\n  assertSlots<VirtualizerSlots>(state);\n  return (\n    <React.Fragment>\n      {/* The 'before' bookend to hold items in place and detect scroll previous */}\n      <state.beforeContainer>\n        <state.before />\n      </state.beforeContainer>\n      {/* The reduced list of non-virtualized children to be rendered */}\n      {state.virtualizedChildren}\n      {/* The 'after' bookend to hold items in place and detect scroll next */}\n      <state.afterContainer>\n        <state.after />\n      </state.afterContainer>\n    </React.Fragment>\n  );\n};\n\nexport const renderVirtualizerChildPlaceholder = (child: ReactNode, index: number) => {\n  return (\n    <React.Suspense key={`fui-virtualizer-placeholder-${index}`} fallback={null}>\n      {child}\n    </React.Suspense>\n  );\n};\n"],"names":["React","assertSlots","renderVirtualizer_unstable","state","Fragment","beforeContainer","before","virtualizedChildren","afterContainer","after","renderVirtualizerChildPlaceholder","child","index","Suspense","fallback"],"mappings":"AAAA,0BAA0B,GAC1B,iDAAiD;AAEjD,YAAYA,WAAW,QAAQ;AAI/B,SAASC,WAAW,QAAQ,4BAA4B;AAExD,OAAO,MAAMC,6BAA6B,CAACC;IACzCF,YAA8BE;IAC9B,qBACE,MAACH,MAAMI,QAAQ;;0BAEb,KAACD,MAAME,eAAe;0BACpB,cAAA,KAACF,MAAMG,MAAM;;YAGdH,MAAMI,mBAAmB;0BAE1B,KAACJ,MAAMK,cAAc;0BACnB,cAAA,KAACL,MAAMM,KAAK;;;;AAIpB,EAAE;AAEF,OAAO,MAAMC,oCAAoC,CAACC,OAAkBC;IAClE,qBACE,KAACZ,MAAMa,QAAQ;QAA8CC,UAAU;kBACpEH;OADkB,CAAC,4BAA4B,EAAEC,MAAM,CAAC;AAI/D,EAAE"}