@ringcentral/juno 2.4.1 → 2.5.0

package/components/Virtuoso/react-virtuoso/components.d.ts

@@ -1,11 +1,7 @@
-import React, { ForwardRefExoticComponent } from 'react';
-import { Grid, GridHandle } from './Grid';
-import { Components, ComputeItemKey, FollowOutput, GroupContent, GroupItemContent, IndexLocationWithAlign, ItemContent, ListItem, ListRange, ScrollSeekConfiguration } from './interfaces';
-import { List, ListHandle } from './List';
-declare type CompProps<T> = T extends React.ForwardRefExoticComponent<infer R> ? R : never;
-declare type ListProps = CompProps<typeof List>;
-declare type GridProps = CompProps<typeof Grid>;
-export interface VirtuosoProps<D> extends Omit<ListProps, 'groupCounts' | 'groupContent' | 'itemsRendered'> {
+/// <reference types="styled-jsx" />
+import { ReactElement } from 'react';
+import { Components, ComputeItemKey, FixedHeaderContent, FollowOutput, GridComponents, GridComputeItemKey, GridItemContent, GridRootProps, GroupContent, GroupItemContent, IndexLocationWithAlign, ItemContent, ListItem, ListRange, ListRootProps, ScrollIntoViewLocation, ScrollSeekConfiguration, TableComponents } from './interfaces';
+export interface VirtuosoProps<D, C> extends ListRootProps {
     /**
      * The total amount of items to be rendered.
      */
@@ -15,14 +11,35 @@ export interface VirtuosoProps<D> extends Omit<ListProps, 'groupCounts' | 'group
      */
     data?: readonly D[];
     /**
-     * Increases the visual window which is used to calculate the rendered items with the specified **amount in pixels**.
-     * Effectively, this makes the component "chunk" the rendering of new items by renderng more items than the necessary, but reducing the re-renders on scroll.
-     * Setting { main: number, reverse: number } lets you extend the list in both the main and the reverse scrollable directions.
+     * Additional context available in the custom components and content callbacks
+     */
+    context?: C;
+    /**
+     * *The property accepts pixel values.*
+     *
+     * Set the overscan property to make the component "chunk" the rendering of new items on scroll.
+     * The property causes the component to render more items than the necessary, but reduces the re-renders on scroll.
+     * Setting `{ main: number, reverse: number }` lets you extend the list in both the main and the reverse scrollable directions.
+     * See the `increaseViewportBy` property for a similar behavior (equivalent to the `overscan` in react-window).
+     *
      */
     overscan?: number | {
         main: number;
         reverse: number;
     };
+    /**
+     *
+     * *The property accepts pixel values.*
+     *
+     * Set the increaseViewportBy property to artificially increase the viewport size, causing items to be rendered before outside of the viewport.
+     * The property causes the component to render more items than the necessary, but can help with slow loading content.
+     * Using `{ top?: number, bottom?: number }` lets you set the increase for each end separately.
+     *
+     */
+    increaseViewportBy?: number | {
+        top: number;
+        bottom: number;
+    };
     /**
      * Set the amount of items to remain fixed at the top of the list.
      *
@@ -31,8 +48,9 @@ export interface VirtuosoProps<D> extends Omit<ListProps, 'groupCounts' | 'group
     topItemCount?: number;
     /**
      * Set to a value between 0 and totalCount - 1 to make the list start scrolled to that item.
+     * Pass in an object to achieve additional effects similar to `scrollToIndex`.
      */
-    initialTopMostItemIndex?: number;
+    initialTopMostItemIndex?: number | IndexLocationWithAlign;
     /**
      * Set this value to offset the initial location of the list.
      * Warning: using this property will still run a render cycle at the scrollTop: 0 list window.
@@ -47,15 +65,15 @@ export interface VirtuosoProps<D> extends Omit<ListProps, 'groupCounts' | 'group
     /**
      * Use the `components` property for advanced customization of the elements rendered by the list.
      */
-    components?: Components;
+    components?: Components<C>;
     /**
      * Set the callback to specify the contents of the item.
      */
-    itemContent?: ItemContent<D>;
+    itemContent?: ItemContent<D, C>;
     /**
      * If specified, the component will use the function to generate the `key` property for each list item.
      */
-    computeItemKey?: ComputeItemKey;
+    computeItemKey?: ComputeItemKey<D, C>;
     /**
      * By default, the component assumes the default item height from the first rendered item (rendering it as a "probe").
      *
@@ -69,14 +87,9 @@ export interface VirtuosoProps<D> extends Omit<ListProps, 'groupCounts' | 'group
     /**
      * Allows customizing the height/width calculation of `Item` elements.
      *
-     * The default implementation reads `el.offsetHeight` and `el.offsetWidth`.
+     * The default implementation reads `el.getBoundingClientRect().height` and `el.getBoundingClientRect().width`.
      */
     itemSize?: (el: HTMLElement, field: 'offsetHeight' | 'offsetWidth') => number;
-    /**
-     * Custom window object for use different window instance
-     *
-     * The default will be browser `window`
-     */
     /**
      * Can be used to improve performance if the rendered items are of known size.
      * Setting it causes the component to skip item measurements.
@@ -161,12 +174,20 @@ export interface VirtuosoProps<D> extends Omit<ListProps, 'groupCounts' | 'group
      * Uses the document scroller rather than wrapping the list in its own.
      */
     useWindowScroll?: boolean;
+    /**
+     * Pass a reference to a scrollable parent element, so that the list won't wrap in its own.
+     */
+    customScrollParent?: HTMLElement;
     /**
      * Provides access to the root DOM element
      */
     scrollerRef?: (ref: HTMLElement | Window | null) => any;
+    /**
+     * By default `4`. Redefine to change how much away from the bottom the scroller can be before the list is not considered not at bottom.
+     */
+    atBottomThreshold?: number;
 }
-export interface GroupedVirtuosoProps<D> extends Omit<VirtuosoProps<D>, 'totalCount' | 'itemContent'>, Pick<ListProps, 'groupCounts' | 'groupContent'> {
+export interface GroupedVirtuosoProps<D, C> extends Omit<VirtuosoProps<D, C>, 'totalCount' | 'itemContent'> {
     /**
      * Specifies the amount of items in each group (and, actually, how many groups are there).
      * For example, passing [20, 30] will display 2 groups with 20 and 30 items each.
@@ -179,25 +200,193 @@ export interface GroupedVirtuosoProps<D> extends Omit<VirtuosoProps<D>, 'totalCo
     /**
      * Specifies how each each item gets rendered.
      */
-    itemContent?: GroupItemContent<D>;
+    itemContent?: GroupItemContent<D, C>;
+}
+export interface TableVirtuosoProps<D, C> extends Omit<VirtuosoProps<D, C>, 'components' | 'headerFooterTag' | 'topItemCount'> {
+    /**
+     * Use the `components` property for advanced customization of the elements rendered by the table.
+     */
+    components?: TableComponents<C>;
+    /**
+     * Set the contents of the table header.
+     */
+    fixedHeaderContent?: FixedHeaderContent;
+    /**
+     * The total amount of items to be rendered.
+     */
+    totalCount?: number;
+    /**
+     * The data items to be rendered. If data is set, the total count will be inferred from the length of the array.
+     */
+    data?: readonly D[];
+    /**
+     * Set the overscan property to make the component "chunk" the rendering of new items on scroll.
+     * The property causes the component to render more items than the necessary, but reduces the re-renders on scroll.
+     * Setting `{ main: number, reverse: number }` lets you extend the list in both the main and the reverse scrollable directions.
+     * See the `increaseViewportBy` property for a similar behavior (equivalent to the `overscan` in `react-window`).
+     */
+    overscan?: number | {
+        main: number;
+        reverse: number;
+    };
+    /**
+     * Set the increaseViewportBy property to artificially increase the viewport size, causing items to be rendered before outside of the viewport.
+     * The property causes the component to render more items than the necessary, but can help with slow loading content.
+     * Using `{ top?: number, bottom?: number }` lets you set the increase for each end separately.
+     */
+    increaseViewportBy?: number | {
+        top: number;
+        bottom: number;
+    };
+    /**
+     * Set to a value between 0 and totalCount - 1 to make the list start scrolled to that item.
+     */
+    initialTopMostItemIndex?: number;
+    /**
+     * Set this value to offset the initial location of the list.
+     * Warning: using this property will still run a render cycle at the scrollTop: 0 list window.
+     * If possible, avoid using it and stick to `initialTopMostItemIndex` instead.
+     */
+    initialScrollTop?: number;
+    /**
+     * Use for server-side rendering - if set, the list will render the specified amount of items
+     * regardless of the container / item size.
+     */
+    initialItemCount?: number;
+    /**
+     * Set the callback to specify the contents of the item.
+     */
+    itemContent?: ItemContent<D, C>;
+    /**
+     * If specified, the component will use the function to generate the `key` property for each list item.
+     */
+    computeItemKey?: ComputeItemKey<D, C>;
+    /**
+     * By default, the component assumes the default item height from the first rendered item (rendering it as a "probe").
+     *
+     * If the first item turns out to be an outlier (very short or tall), the rest of the rendering will be slower,
+     * as multiple passes of rendering should happen for the list to fill the viewport.
+     *
+     * Setting `defaultItemHeight` causes the component to skip the "probe" rendering and use the property
+     * value as default height instead.
+     */
+    defaultItemHeight?: number;
+    /**
+     * Allows customizing the height/width calculation of `Item` elements.
+     *
+     * The default implementation reads `el.getBoundingClientRect().height` and `el.getBoundingClientRect().width`.
+     */
+    itemSize?: (el: HTMLElement, field: 'offsetHeight' | 'offsetWidth') => number;
+    /**
+     * Can be used to improve performance if the rendered items are of known size.
+     * Setting it causes the component to skip item measurements.
+     */
+    fixedItemHeight?: number;
+    /**
+     * Use to display placeholders if the user scrolls fast through the list.
+     *
+     * Set `components.ScrollSeekPlaceholder` to change the placeholder content.
+     */
+    scrollSeekConfiguration?: ScrollSeekConfiguration | false;
+    /**
+     * If set to `true`, the list automatically scrolls to bottom if the total count is changed.
+     * Set to `"smooth"` for an animated scrolling.
+     *
+     * By default, `followOutput` scrolls down only if the list is already at the bottom.
+     * To implement an arbitrary logic behind that, pass a function:
+     *
+     * ```tsx
+     * <Virtuoso
+     *  followOutput={(isAtBottom: boolean) => {
+     *    if (expression) {
+     *      return 'smooth' // can be 'auto' or false to avoid scrolling
+     *    } else {
+     *      return false
+     *    }
+     *  }} />
+     * ```
+     */
+    followOutput?: FollowOutput;
+    /**
+     * Use when implementing inverse infinite scrolling - decrease the value this property
+     * in combination with  `data` or `totalCount` to prepend items to the top of the list.
+     *
+     * Warning: the firstItemIndex should **be a positive number**, based on the total amount of items to be displayed.
+     */
+    firstItemIndex?: number;
+    /**
+     * Called when the list starts/stops scrolling.
+     */
+    isScrolling?: (isScrolling: boolean) => void;
+    /**
+     * Gets called when the user scrolls to the end of the list.
+     * Receives the last item index as an argument. Can be used to implement endless scrolling.
+     */
+    endReached?: (index: number) => void;
+    /**
+     * Called when the user scrolls to the start of the list.
+     */
+    startReached?: (index: number) => void;
+    /**
+     * Called with the new set of items each time the list items are rendered due to scrolling.
+     */
+    rangeChanged?: (range: ListRange) => void;
+    /**
+     * Called with true / false when the list has reached the bottom / gets scrolled up.
+     * Can be used to load newer items, like `tail -f`.
+     */
+    atBottomStateChange?: (atBottom: boolean) => void;
+    /**
+     * Called with `true` / `false` when the list has reached the top / gets scrolled down.
+     */
+    atTopStateChange?: (atTop: boolean) => void;
+    /**
+     * Called when the total list height is changed due to new items or viewport resize.
+     */
+    totalListHeightChanged?: (height: number) => void;
+    /**
+     * Called with the new set of items each time the list items are rendered due to scrolling.
+     */
+    itemsRendered?: (items: ListItem<D>[]) => void;
+    /**
+     * Setting `alignToBottom` to `true` aligns the items to the bottom of the list if the list is shorter than the viewport.
+     * Use `followOutput` property to keep the list aligned when new items are appended.
+     */
+    alignToBottom?: boolean;
+    /**
+     * Uses the document scroller rather than wrapping the list in its own.
+     */
+    useWindowScroll?: boolean;
+    /**
+     * Pass a reference to a scrollable parent element, so that the table won't wrap in its own.
+     */
+    customScrollParent?: HTMLElement;
+    /**
+     * Provides access to the root DOM element
+     */
+    scrollerRef?: (ref: HTMLElement | Window | null) => any;
+    /**
+     * By default `4`. Redefine to change how much away from the bottom the scroller can be before the list is not considered not at bottom.
+     */
+    atBottomThreshold?: number;
 }
-export interface VirtuosoGridProps extends GridProps {
+export interface VirtuosoGridProps<C extends unknown = unknown> extends GridRootProps {
     /**
      * The total amount of items to be rendered.
      */
-    totalCount: GridProps['totalCount'];
+    totalCount: number;
     /**
      * Set the callback to specify the contents of the item.
      */
-    itemContent?: GridProps['itemContent'];
+    itemContent?: GridItemContent<C>;
     /**
      * Use the `components` property for advanced customization of the elements rendered by the list.
      */
-    components?: GridProps['components'];
+    components?: GridComponents<C>;
     /**
      * Set the overscan property to make the component "chunk" the rendering of new items on scroll.
      * The property causes the component to render more items than the necessary, but reduces the re-renders on scroll.
-     * Setting { main: number, reverse: number } lets you extend the list in both the main and the reverse scrollable directions.
+     * Setting `{ main: number, reverse: number }` lets you extend the list in both the main and the reverse scrollable directions.
      */
     overscan?: number | {
         main: number;
@@ -206,7 +395,7 @@ export interface VirtuosoGridProps extends GridProps {
     /**
      * If specified, the component will use the function to generate the `key` property for each list item.
      */
-    computeItemKey?: ComputeItemKey;
+    computeItemKey?: GridComputeItemKey;
     /**
      * Use to display placeholders if the user scrolls fast through the list.
      *
@@ -255,12 +444,20 @@ export interface VirtuosoGridProps extends GridProps {
      * Uses the document scroller rather than wrapping the grid in its own.
      */
     useWindowScroll?: boolean;
+    /**
+     * Pass a reference to a scrollable parent element, so that the grid won't wrap in its own.
+     */
+    customScrollParent?: HTMLElement;
 }
-export interface VirtuosoHandle extends ListHandle {
+export interface VirtuosoHandle {
     /**
-     * Scrolls the component to the specified item index. See {{IndexLocationWithAlign}} for more options.
+     * Scrolls the component to the specified item index. See {@link IndexLocationWithAlign} for more options.
      */
     scrollToIndex(location: number | IndexLocationWithAlign): void;
+    /**
+     * Scrolls the item into view if necessary. See [the website example](http://virtuoso.dev/keyboard-navigation/) for an implementation.
+     */
+    scrollIntoView(location: ScrollIntoViewLocation): void;
     /**
      * Scrolls the component to the specified location. See [ScrollToOptions (MDN)](https://developer.mozilla.org/en-US/docs/Web/API/ScrollToOptions)
      */
@@ -270,21 +467,31 @@ export interface VirtuosoHandle extends ListHandle {
      */
     scrollBy(location: ScrollToOptions): void;
 }
-export interface GroupedVirtuosoHandle extends ListHandle {
+export interface GroupedVirtuosoHandle {
+    scrollToIndex(location: number | IndexLocationWithAlign): void;
+    scrollTo(location: ScrollToOptions): void;
+    scrollBy(location: ScrollToOptions): void;
+}
+export interface VirtuosoGridHandle {
     scrollToIndex(location: number | IndexLocationWithAlign): void;
     scrollTo(location: ScrollToOptions): void;
     scrollBy(location: ScrollToOptions): void;
 }
-export interface VirtuosoGridHandle extends GridHandle {
+export interface TableVirtuosoHandle {
+    scrollIntoView(location: ScrollIntoViewLocation): void;
     scrollToIndex(location: number | IndexLocationWithAlign): void;
     scrollTo(location: ScrollToOptions): void;
     scrollBy(location: ScrollToOptions): void;
 }
-export declare const Virtuoso: <D extends unknown = any>(props: VirtuosoProps<D> & {
-    ref?: ((instance: VirtuosoHandle | null) => void) | React.RefObject<VirtuosoHandle> | null | undefined;
-}) => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, any> | null) | (new (props: any) => React.Component<any, any, any>)>;
-export declare const GroupedVirtuoso: <D extends unknown = any>(props: GroupedVirtuosoProps<D> & {
-    ref?: ((instance: GroupedVirtuosoHandle | null) => void) | React.RefObject<GroupedVirtuosoHandle> | null | undefined;
-}) => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, any> | null) | (new (props: any) => React.Component<any, any, any>)>;
-export declare const VirtuosoGrid: ForwardRefExoticComponent<VirtuosoGridProps>;
-export {};
+export declare const Virtuoso: <ItemData extends unknown = any, Context extends unknown = any>(props: VirtuosoProps<ItemData, Context> & {
+    ref?: ((instance: VirtuosoHandle | null) => void) | import("react").RefObject<VirtuosoHandle> | null | undefined;
+}) => ReactElement<any, string | ((props: any) => ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
+export declare const GroupedVirtuoso: <ItemData extends unknown = any, Context extends unknown = any>(props: GroupedVirtuosoProps<ItemData, Context> & {
+    ref?: ((instance: GroupedVirtuosoHandle | null) => void) | import("react").RefObject<GroupedVirtuosoHandle> | null | undefined;
+}) => ReactElement<any, string | ((props: any) => ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
+export declare const TableVirtuoso: <ItemData extends unknown = any, Context extends unknown = any>(props: TableVirtuosoProps<ItemData, Context> & {
+    ref?: ((instance: TableVirtuosoHandle | null) => void) | import("react").RefObject<TableVirtuosoHandle> | null | undefined;
+}) => ReactElement<any, string | ((props: any) => ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
+export declare const VirtuosoGrid: <Context extends unknown = any>(props: VirtuosoGridProps<Context> & {
+    ref?: ((instance: VirtuosoGridHandle | null) => void) | import("react").RefObject<VirtuosoGridHandle> | null | undefined;
+}) => ReactElement<any, string | ((props: any) => ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;

package/components/Virtuoso/react-virtuoso/components.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var Grid_1 = require("./Grid");
 var List_1 = require("./List");
+var Table_1 = require("./Table");
 exports.Virtuoso = List_1.List;
 exports.GroupedVirtuoso = List_1.List;
+exports.TableVirtuoso = Table_1.Table;
 exports.VirtuosoGrid = Grid_1.Grid;

package/components/Virtuoso/react-virtuoso/domIOSystem.d.ts

@@ -1,16 +1,14 @@
 import * as u from '@virtuoso.dev/urx';
-export declare const UP: "up";
-export declare const DOWN: "down";
-export declare type ScrollDirection = typeof UP | typeof DOWN;
 export declare const domIOSystem: u.SystemSpec<never[], () => {
+    scrollContainerState: u.Stream<[number, number]>;
     scrollTop: u.Stream<number>;
     viewportHeight: u.Stream<number>;
     headerHeight: u.StatefulStream<number>;
     footerHeight: u.StatefulStream<number>;
+    scrollHeight: u.Stream<number>;
     smoothScrollTargetReached: u.Stream<true>;
     scrollTo: u.Stream<ScrollToOptions>;
     scrollBy: u.Stream<ScrollToOptions>;
-    scrollDirection: u.StatefulStream<ScrollDirection>;
     statefulScrollTop: u.StatefulStream<number>;
     deviation: u.StatefulStream<number>;
     scrollingInProgress: u.StatefulStream<boolean>;

package/components/Virtuoso/react-virtuoso/domIOSystem.js

@@ -2,39 +2,41 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
 var u = tslib_1.__importStar(require("@virtuoso.dev/urx"));
-exports.UP = 'up';
-exports.DOWN = 'down';
 exports.domIOSystem = u.system(function () {
+    var scrollContainerState = u.stream();
     var scrollTop = u.stream();
     var deviation = u.statefulStream(0);
     var smoothScrollTargetReached = u.stream();
     var statefulScrollTop = u.statefulStream(0);
     var viewportHeight = u.stream();
+    var scrollHeight = u.stream();
     var headerHeight = u.statefulStream(0);
     var footerHeight = u.statefulStream(0);
     var scrollTo = u.stream();
     var scrollBy = u.stream();
     var scrollingInProgress = u.statefulStream(false);
+    u.connect(u.pipe(scrollContainerState, u.map(function (_a) {
+        var _b = tslib_1.__read(_a, 1), scrollTop = _b[0];
+        return scrollTop;
+    })), scrollTop);
+    u.connect(u.pipe(scrollContainerState, u.map(function (_a) {
+        var _b = tslib_1.__read(_a, 2), scrollHeight = _b[1];
+        return scrollHeight;
+    })), scrollHeight);
     u.connect(scrollTop, statefulScrollTop);
-    var scrollDirection = u.statefulStream(exports.DOWN);
-    u.connect(u.pipe(scrollTop, u.scan(function (acc, scrollTop) {
-        return {
-            direction: scrollTop < acc.prevScrollTop ? exports.UP : exports.DOWN,
-            prevScrollTop: scrollTop,
-        };
-    }, { direction: exports.DOWN, prevScrollTop: 0 }), u.map(function (value) { return value.direction; })), scrollDirection);
     return {
         // input
+        scrollContainerState: scrollContainerState,
         scrollTop: scrollTop,
         viewportHeight: viewportHeight,
         headerHeight: headerHeight,
         footerHeight: footerHeight,
+        scrollHeight: scrollHeight,
         smoothScrollTargetReached: smoothScrollTargetReached,
         // signals
         scrollTo: scrollTo,
         scrollBy: scrollBy,
         // state
-        scrollDirection: scrollDirection,
         statefulScrollTop: statefulScrollTop,
         deviation: deviation,
         scrollingInProgress: scrollingInProgress,