@fluentui/react-virtualizer 9.0.0-alpha.2 → 9.0.0-alpha.21

package/dist/index.d.ts

@@ -1,15 +1,37 @@
-import type { ComponentProps } from '@fluentui/react-utilities';
-import type { ComponentState } from '@fluentui/react-utilities';
+import { ComponentProps } from '@fluentui/react-utilities';
+import { 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 { SetStateAction } from 'react';
-import type { Slot } from '@fluentui/react-utilities';
+import { 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;
+}
+
+/**
+ * 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.
@@ -25,8 +47,39 @@ export declare const useIntersectionObserver: (callback: IntersectionObserverCal
     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
  */
@@ -43,7 +96,7 @@ export declare type VirtualizerChildRenderFunction = (index: number) => React_2.
 
 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 +140,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 +158,12 @@ 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;
+    virtualizerContext?: VirtualizerContextProps;
 };
 
-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> & {
+declare type VirtualizerConfigState = {
     /**
      * The current virtualized array of children to show in the DOM.
      */
@@ -165,9 +194,126 @@ 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;
 };
 
+/**
+ * {@docCategory Virtualizer}
+ */
+export declare type VirtualizerContextProps = {
+    contextIndex: number;
+    setContextIndex: (index: number) => void;
+};
+
+export declare const VirtualizerContextProvider: React_2.Provider<VirtualizerContextProps>;
+
+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'>> & {
+    /**
+     * 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
+     */
+    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;
+};
+
+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'>> & {
+    /**
+     * 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;
+};
+
+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.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,"names":[],"sources":["../src/Hooks.ts"],"sourcesContent":["export * from './hooks/index';\n"],"mappings":"AAAA,cAAc"}

package/lib/Utilities.js

@@ -0,0 +1,2 @@
+export * from './utilities/index';
+//# sourceMappingURL=Utilities.js.map

package/lib/Utilities.js.map

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

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,"names":[],"sources":["../src/Virtualizer.ts"],"sourcesContent":["export * from './components/Virtualizer/index';\n"],"mappings":"AAAA,cAAc"}

package/lib/VirtualizerScrollView.js

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

package/lib/VirtualizerScrollView.js.map

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

package/lib/VirtualizerScrollViewDynamic.js

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

package/lib/VirtualizerScrollViewDynamic.js.map

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

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,"names":["useVirtualizerStyles_unstable","useVirtualizer_unstable","renderVirtualizer_unstable","Virtualizer","props","state","displayName"],"sources":["../../../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"],"mappings":"AACA,SAASA,6BAA6B,QAAQ;AAC9C,SAASC,uBAAuB,QAAQ;AACxC,SAASC,0BAA0B,QAAQ;AAG3C;;;;;AAKA,OAAO,MAAMC,WAAA,GAAqCC,KAAA,IAA4B;EAC5E,MAAMC,KAAA,GAAQJ,uBAAA,CAAwBG,KAAA;EACtCJ,6BAAA,CAA8BK,KAAA;EAE9B,OAAOH,0BAAA,CAA2BG,KAAA;AACpC;AAEAF,WAAA,CAAYG,WAAW,GAAG"}

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

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

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,"names":["React"],"sources":["../../../src/components/Virtualizer/Virtualizer.types.ts"],"sourcesContent":["import * as React from 'react';\nimport type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';\nimport { VirtualizerContextProps } from '../../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 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\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) => React.ReactNode;\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\nexport type VirtualizerProps = ComponentProps<Partial<VirtualizerSlots>> & VirtualizerConfigProps;\n"],"mappings":"AAAA,YAAYA,KAAA,MAAW"}

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,"names":[],"sources":["../../../src/components/Virtualizer/index.ts"],"sourcesContent":["export * from './Virtualizer';\nexport * from './Virtualizer.types';\nexport * from './useVirtualizer';\nexport * from './renderVirtualizer';\nexport * from './useVirtualizerStyles';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc"}

package/lib/components/Virtualizer/renderVirtualizer.js

@@ -1,18 +1,17 @@
-import * as React from 'react';
-import { getSlots } from '@fluentui/react-utilities';
+/** @jsxRuntime classic */ /** @jsx createElement */import * as React from 'react';
+import { createElement } from '@fluentui/react-jsx-runtime';
+import { getSlotsNext } 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
-  })));
+  } = getSlotsNext(state);
+  return /*#__PURE__*/createElement(React.Fragment, null, /*#__PURE__*/createElement(slots.beforeContainer, slotProps.beforeContainer, /*#__PURE__*/createElement(slots.before, slotProps.before)), state.virtualizedChildren, /*#__PURE__*/createElement(slots.afterContainer, slotProps.afterContainer, /*#__PURE__*/createElement(slots.after, slotProps.after)));
+};
+export const renderVirtualizerChildPlaceholder = (child, index) => {
+  return /*#__PURE__*/createElement(React.Suspense, {
+    key: `fui-virtualizer-placeholder-${index}`,
+    fallback: null
+  }, child);
 };
 //# 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,"names":["React","createElement","getSlotsNext","renderVirtualizer_unstable","state","slots","slotProps","Fragment","beforeContainer","before","virtualizedChildren","afterContainer","after","renderVirtualizerChildPlaceholder","child","index","Suspense","key","fallback"],"sources":["../../../src/components/Virtualizer/renderVirtualizer.tsx"],"sourcesContent":["/** @jsxRuntime classic */\n/** @jsx createElement */\n\nimport * as React from 'react';\nimport { createElement } from '@fluentui/react-jsx-runtime';\nimport { getSlotsNext } from '@fluentui/react-utilities';\nimport { VirtualizerSlots, VirtualizerState } from './Virtualizer.types';\nimport { ReactNode } from 'react';\n\nexport const renderVirtualizer_unstable = (state: VirtualizerState) => {\n  const { slots, slotProps } = getSlotsNext<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\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"],"mappings":"AAAA,2BACA,yBAEA,YAAYA,KAAA,MAAW;AACvB,SAASC,aAAa,QAAQ;AAC9B,SAASC,YAAY,QAAQ;AAI7B,OAAO,MAAMC,0BAAA,GAA8BC,KAAA,IAA4B;EACrE,MAAM;IAAEC,KAAA;IAAOC;EAAS,CAAE,GAAGJ,YAAA,CAA+BE,KAAA;EAE5D,oBACEH,aAZJ,CAYKD,KAAA,CAAMO,QAAQ,qBAEbN,aAdN,CAcOI,KAAA,CAAMG,eAAe,EAAKF,SAAA,CAAUE,eAAe,eAClDP,aAfR,CAeSI,KAAA,CAAMI,MAAM,EAAKH,SAAA,CAAUG,MAAM,IAGnCL,KAAA,CAAMM,mBAAmB,eAE1BT,aApBN,CAoBOI,KAAA,CAAMM,cAAc,EAAKL,SAAA,CAAUK,cAAc,eAChDV,aArBR,CAqBSI,KAAA,CAAMO,KAAK,EAAKN,SAAA,CAAUM,KAAK;AAIxC;AAEA,OAAO,MAAMC,iCAAA,GAAoCA,CAACC,KAAA,EAAkBC,KAAA,KAAkB;EACpF,oBACEd,aA7BJ,CA6BKD,KAAA,CAAMgB,QAAQ;IAACC,GAAA,EAAM,+BAA8BF,KAAM,EAAC;IAAEG,QAAA,EAAU;KACpEJ,KAAA;AAGP"}

package/lib/components/Virtualizer/useVirtualizer.js

@@ -1,7 +1,9 @@
 import { useIntersectionObserver } from '../../hooks/useIntersectionObserver';
-import { useEffect, useRef, useState, useCallback, useReducer } from 'react';
+import { useEffect, useRef, useCallback, useReducer } from 'react';
 import { resolveShorthand } from '@fluentui/react-utilities';
 import { flushSync } from 'react-dom';
+import { useVirtualizerContextState_unstable } from '../../Utilities';
+import { renderVirtualizerChildPlaceholder } from './renderVirtualizer';
 export function useVirtualizer_unstable(props) {
   const {
     itemSize,
@@ -11,14 +13,15 @@ export function useVirtualizer_unstable(props) {
     getItemSize,
     bufferItems = Math.round(virtualizerLength / 4.0),
     bufferSize = Math.floor(bufferItems / 2.0) * itemSize,
-    intersectionObserverRoot,
+    scrollViewRef,
     axis = 'vertical',
     reversed = false,
-    onUpdateIndex,
-    onCalculateIndex
+    virtualizerContext
   } = props;
-  // Tracks the initial item to start virtualizer at, -1 implies first render cycle
-  const [virtualizerStartIndex, setVirtualizerStartIndex] = useState(-1);
+  /* The context is optional, it's useful for injecting additional index logic, or performing uniform state updates*/
+  const _virtualizerContext = useVirtualizerContextState_unstable(virtualizerContext);
+  const actualIndex = _virtualizerContext.contextIndex;
+  const setActualIndex = _virtualizerContext.setContextIndex;
   // Store ref to before padding element
   const beforeElementRef = useRef(null);
   // Store ref to before padding element
@@ -55,19 +58,17 @@ export function useVirtualizer_unstable(props) {
   };
   const batchUpdateNewIndex = index => {
     // Local updates
-    onUpdateIndex === null || onUpdateIndex === void 0 ? void 0 : onUpdateIndex(index, virtualizerStartIndex);
     updateChildRows(index);
     updateCurrentItemSizes(index);
     // State setters
-    setVirtualizerStartIndex(index);
+    setActualIndex(index);
   };
   // Observe intersections of virtualized components
   const {
     setObserverList
   } = useIntersectionObserver((entries, observer) => {
-    /* Sanity check - do we even need virtualization? */
-    if (virtualizerLength > numItems) {
-      if (virtualizerStartIndex !== 0) {
+    /* Sanity check - do we even need virtualization? */if (virtualizerLength > numItems) {
+      if (actualIndex !== 0) {
         batchUpdateNewIndex(0);
       }
       // No-op
@@ -129,31 +130,25 @@ export function useVirtualizer_unstable(props) {
     }
     // For now lets use hardcoded size to assess current element to paginate on
     const startIndex = getIndexFromScrollPosition(measurementPos);
-    let bufferedIndex = Math.max(startIndex - bufferCount, 0);
-    if (onCalculateIndex) {
-      // User has chance to intervene/customize prior to render
-      // They may want to normalize this value.
-      bufferedIndex = onCalculateIndex(bufferedIndex);
-    }
+    const bufferedIndex = Math.max(startIndex - bufferCount, 0);
     // Safety limits
     const maxIndex = Math.max(numItems - virtualizerLength, 0);
     const newStartIndex = Math.min(Math.max(bufferedIndex, 0), maxIndex);
-    if (virtualizerStartIndex !== newStartIndex) {
+    if (actualIndex !== newStartIndex) {
       // We flush sync this and perform an immediate state update
-      // due to virtualizerStartIndex invalidation.
       flushSync(() => {
         batchUpdateNewIndex(newStartIndex);
       });
     }
   }, {
-    root: intersectionObserverRoot ? intersectionObserverRoot === null || intersectionObserverRoot === void 0 ? void 0 : intersectionObserverRoot.current : null,
+    root: scrollViewRef ? scrollViewRef === null || scrollViewRef === void 0 ? void 0 : scrollViewRef.current : null,
     rootMargin: '0px',
     threshold: 0
   });
   const findIndexRecursive = (scrollPos, lowIndex, highIndex) => {
     if (lowIndex > highIndex) {
       // We shouldn't get here - but no-op the index if we do.
-      return virtualizerStartIndex;
+      return actualIndex;
     }
     const midpoint = Math.floor((lowIndex + highIndex) / 2);
     const iBefore = Math.max(midpoint - 1, 0);
@@ -173,8 +168,7 @@ export function useVirtualizer_unstable(props) {
     }
   };
   const getIndexFromSizeArray = scrollPos => {
-    /* Quick searches our progressive height array */
-    if (scrollPos === 0 || childProgressiveSizes.current.length === 0 || scrollPos <= childProgressiveSizes.current[0]) {
+    /* Quick searches our progressive height array */if (scrollPos === 0 || childProgressiveSizes.current.length === 0 || scrollPos <= childProgressiveSizes.current[0]) {
       // Check start
       return 0;
     }
@@ -198,21 +192,22 @@ export function useVirtualizer_unstable(props) {
     return childProgressiveSizes.current[numItems - 1];
   };
   const calculateBefore = () => {
+    const currentIndex = Math.min(actualIndex, numItems);
     if (!getItemSize) {
       // The missing items from before virtualization starts height
-      return virtualizerStartIndex * itemSize;
+      return currentIndex * itemSize;
     }
-    if (virtualizerStartIndex <= 0) {
+    if (currentIndex <= 0) {
       return 0;
     }
     // Time for custom size calcs
-    return childProgressiveSizes.current[virtualizerStartIndex - 1];
+    return childProgressiveSizes.current[currentIndex - 1];
   };
   const calculateAfter = () => {
     if (numItems === 0) {
       return 0;
     }
-    const lastItemIndex = Math.min(virtualizerStartIndex + virtualizerLength, numItems - 1);
+    const lastItemIndex = Math.min(actualIndex + virtualizerLength, numItems - 1);
     if (!getItemSize) {
       // The missing items from after virtualization ends height
       const remainingItems = numItems - lastItemIndex - 1;
@@ -221,20 +216,19 @@ export function useVirtualizer_unstable(props) {
     // Time for custom size calcs
     return childProgressiveSizes.current[numItems - 1] - childProgressiveSizes.current[lastItemIndex];
   };
-  const updateChildRows = newIndex => {
+  const updateChildRows = useCallback(newIndex => {
     if (numItems === 0) {
-      /* Nothing to virtualize */
-      return [];
+      /* Nothing to virtualize */return [];
     }
     if (childArray.current.length !== numItems) {
       childArray.current = new Array(virtualizerLength);
     }
-    const actualIndex = Math.max(newIndex, 0);
-    const end = Math.min(actualIndex + virtualizerLength, numItems);
-    for (let i = actualIndex; i < end; i++) {
-      childArray.current[i - actualIndex] = renderChild(i);
+    const _actualIndex = Math.max(newIndex, 0);
+    const end = Math.min(_actualIndex + virtualizerLength, numItems);
+    for (let i = _actualIndex; i < end; i++) {
+      childArray.current[i - _actualIndex] = renderVirtualizerChildPlaceholder(renderChild(i), i);
     }
-  };
+  }, [numItems, renderChild, virtualizerLength]);
   const setBeforeRef = useCallback(element => {
     if (!element || beforeElementRef.current === element) {
       return;
@@ -297,26 +291,37 @@ export function useVirtualizer_unstable(props) {
   // Initialization on mount - update array index to 0 (ready state).
   // Only fire on mount (no deps).
   useEffect(() => {
-    if (virtualizerStartIndex < 0) {
+    if (actualIndex < 0) {
       batchUpdateNewIndex(0);
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
   // If the user passes in an updated renderChild function - update current children
   useEffect(() => {
-    if (virtualizerStartIndex >= 0) {
-      updateChildRows(virtualizerStartIndex);
+    if (actualIndex >= 0) {
+      updateChildRows(actualIndex);
       forceUpdate();
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [renderChild]);
+  }, [renderChild, updateChildRows]);
+  useEffect(() => {
+    // Ensure we repopulate if getItemSize callback changes
+    populateSizeArrays();
+    // We only run this effect on getItemSize change (recalc dynamic sizes)
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [getItemSize]);
   // Ensure we have run through and updated the whole size list array at least once.
   initializeSizeArray();
   if (getItemSize && (numItems !== childSizes.current.length || numItems !== childProgressiveSizes.current.length)) {
     // Child length mismatch, repopulate size arrays.
     populateSizeArrays();
   }
-  const isFullyInitialized = hasInitialized.current && virtualizerStartIndex >= 0;
+  // Ensure we recalc if virtualizer length changes
+  const maxCompare = Math.min(virtualizerLength, numItems);
+  if (childArray.current.length !== maxCompare && actualIndex + childArray.current.length < numItems) {
+    updateChildRows(actualIndex);
+  }
+  const isFullyInitialized = hasInitialized.current && actualIndex >= 0;
   return {
     components: {
       before: 'div',
@@ -354,7 +359,7 @@ export function useVirtualizer_unstable(props) {
     beforeBufferHeight: isFullyInitialized ? calculateBefore() : 0,
     afterBufferHeight: isFullyInitialized ? calculateAfter() : 0,
     totalVirtualizerHeight: isFullyInitialized ? calculateTotalSize() : virtualizerLength * itemSize,
-    virtualizerStartIndex,
+    virtualizerStartIndex: actualIndex,
     axis,
     bufferSize,
     reversed