@ringcentral/spring-ui 1.7.0 → 1.8.0

package/src/Tooltip/TooltipTrigger.type.d.ts

@@ -1,59 +1,15 @@
 import { ReactElement, ReactNode } from 'react';
 import { TooltipViewProps } from './TooltipView.type';
 export declare type TooltipTriggerProps = {
-    /**
-     * Tooltip reference element.
-     */
     children: ReactElement;
-    /**
-     * render tooltip
-     */
     renderTooltip: (open: boolean, getAnchorEl: () => Element | null, tooltipId: string) => ReactNode;
-    /**
-     * Callback fired when the component's open state changed.
-     * Only for uncontrolled mode.
-     */
     onOpenStateChange?: (event: Event, isOpen: boolean) => void;
-    /**
-     * If `true`, the tooltip is shown.
-     */
     open?: boolean;
-    /**
-     * If `true`, use a 1500ms delay.
-     * @default false
-     */
     delay?: boolean | number;
-    /**
-     * Do not respond to focus-visible events.
-     */
     disableFocusListener?: boolean;
-    /**
-     * If enabled, wraps the anchor element in a `span` to ensure the Tooltip
-     * can still be triggered even if the anchor element has pointer events disabled.
-     * Pass a `triggerWrapperProps` prop to override attributes of the wrapper element.
-     * @default false
-     */
     triggerWhenDisabled?: boolean;
-    /**
-     * Attributes to be applied to the wrapper element used when
-     * `triggerWhenDisabled` is enabled.
-     */
     triggerWrapperProps?: React.HTMLAttributes<HTMLSpanElement>;
-    /**
-     * The ID to use for the tooltip element and aria-describedby attribute.
-     * If not provided, a unique ID will be auto-generated using React.useId().
-     * This prop is managed by the parent Tooltip component
-     * @internal
-     */
     tooltipId?: string;
-    /**
-     * Tooltip title. Zero-length titles string, undefined, null and false are never displayed.
-     */
     title?: TooltipViewProps['children'];
-    /**
-     * Set to `true` if the `title` acts as an accessible description.
-     * By default the `title` acts as an accessible label for the child.
-     * @default false
-     */
     describeChild?: boolean;
 };

package/src/Tooltip/TooltipView.type.d.ts

@@ -7,38 +7,13 @@ import { PopperPaperProps } from '../PopperPaper';
 import { TooltipViewClassesKey } from './TooltipView.classes';
 export declare type TooltipSize = 'small' | 'medium';
 export declare type TooltipViewProps = StandardProps<{
-    /**
-     * Tooltip title. Zero-length titles string, undefined, null and false are never displayed.
-     */
     children?: ReactNode;
-    /** color for tooltip */
     color?: 'neutral' | 'danger' | 'success' | 'inverted';
-    /**
-     * The size of the tooltip.
-     * @default 'small'
-     */
     size?: TooltipSize;
-    /** icon for tooltip */
     icon?: IconProps['symbol'];
-    /**
-     * If `true`, interactions within the TooltipView will be disabled. This ensures that mouse events
-     * on the surrounding elements will not be blocked by the Tooltip. When controlling the `open` prop
-     * of the Tooltip component yourself, this prop will be implicitly set to `false`.
-     * @default true
-     */
     disableInteractions?: boolean;
-    /**
-     * Props applied to Popper
-     */
     PopperProps?: Omit<PopperProps, 'anchorEl' | 'className'> & HTMLDataAttribute;
-    /**
-     * Props passed to the underlying PopperPaper component.
-     */
     PopperPaperProps?: Partial<PopperPaperProps>;
     motionProps?: MotionProps | null;
-    /**
-     * If `true`, the tooltip will be hidden by setting css display to none.
-     * This is useful when you want to hide the tooltip while the mouse is still in the anchor element.
-     */
     tooltipForceHide?: boolean;
 } & Pick<PopperProps, 'placement' | 'anchorEl'>, TooltipViewClassesKey>;

package/src/Tooltip/useTooltipForceHide.d.ts

@@ -1,7 +1,3 @@
-/**
- * store tooltip open state when forceHide is true and set tooltip open to false
- * restore open state once forceHide changed to false
- */
 export declare const useTooltipForceHide: (forceHide: boolean) => {
     open: boolean;
     onOpenStateChange: (event: Event, isOpen: boolean) => void;

package/src/Tray/Tray.type.d.ts

@@ -6,21 +6,8 @@ export declare type TrayActions = {
     navigateTo: (value: TrayNavigateValue) => void;
 };
 export declare type TrayProps = StandardProps<{
-    /**
-     * The value of the currently selected `TrayPanel`.
-     */
     value?: TrayValue;
-    /**
-     * The default value. Use when the component is not controlled.
-     */
     defaultValue?: TrayValue;
-    /**
-     * Callback invoked when new value is being set.
-     */
     onChange?: (event: React.SyntheticEvent | null, value: TrayValue) => void;
-    /**
-     * A ref with imperative actions.
-     * It allows to navigate to other panel
-     */
     actions?: Ref<TrayActions>;
 }, TrayClassesKey, 'div'>;

package/src/Tray/TrayContext.d.ts

@@ -3,10 +3,6 @@ import { TrayNavigateValue } from './types';
 export declare type TrayContextValue = {
     value: string | number;
     navigateTo: (value: TrayNavigateValue, event: SyntheticEvent | null) => void;
-    /**
-     * The direction from which the TrayPanel will slide in.
-     * @default 'right'
-     */
     direction: 'left' | 'right';
     containerRef: RefObject<HTMLDivElement>;
 };

package/src/Tray/hooks/useTray.d.ts

@@ -1,31 +1,15 @@
 import { RefObject, SyntheticEvent } from 'react';
 import { TrayNavigateValue, TrayValue } from '../types';
 export declare type UseTrayParameters = {
-    /**
-     * The value of the currently selected `TrayPanel`.
-     */
     value?: TrayValue;
-    /**
-     * The default value. Use when the component is not controlled.
-     */
     defaultValue?: TrayValue;
-    /**
-     * Callback invoked when new value is being set.
-     */
     onChange?: (event: SyntheticEvent | null, value: TrayValue) => void;
     containerRef: RefObject<HTMLDivElement>;
 };
 export declare type UseTray = (parameters: UseTrayParameters) => {
     trayContextValue: {
         value: TrayValue;
-        /**
-         * @param newValue If null, back to previous panel
-         */
         navigateTo: (value: TrayNavigateValue, event?: SyntheticEvent | null) => void;
-        /**
-         * The direction from which the TrayPanel will slide in.
-         * @default 'right'
-         */
         direction: 'left' | 'right';
         containerRef: RefObject<HTMLDivElement>;
     };

package/src/Tray/hooks/useTrayPanel.d.ts

@@ -1,9 +1,6 @@
 import { RefObject } from 'react';
 import { TrayValue } from '../types';
 export declare type UseTrayPanelParameters = {
-    /**
-     * Unique id of this TrayPanel
-     */
     value: TrayValue;
 };
 export declare type UseTrayPanel = (parameters: UseTrayPanelParameters) => {

package/src/VirtualizedList/VirtualizedList.type.d.ts

@@ -4,45 +4,18 @@ import { ListProps } from '../List';
 import { UseListNavigationActions } from '../ListNavigation';
 import { VirtuosoContextType } from './VirtuosoContextType';
 export declare type VirtualizedListActions = {
-    /**
-     * Focus to target item. If it is not focusable, will focus to list.
-     */
     focusByIndex: (index: number) => void;
 } & UseListNavigationActions;
 export declare type VirtualizedListProps<D = unknown, C = {}> = {
-    /**
-     * Flag to indicate if the VirtualizedList is ready and can process actions. If set to `false`
-     * and the `focusByIndex` action is called, the component will wait for the `isReady` flag to be
-     * true before processing the action.
-     *
-     * @default true
-     */
     isReady?: boolean;
-    /**
-     * If true, will disable some keyboard navigation logic that cannot implement in infinite list
-     */
     infinite?: boolean;
-    /**
-     * A ref with virtuoso actions
-     */
     virtuosoActions?: Ref<VirtuosoHandle>;
-    /**
-     * A ref with virtualized list actions
-     */
     actions?: Ref<VirtualizedListActions>;
-    /**
-     * An array of indexes to make certain items don't be unmount.
-     * This prop must be used with prop `computeItemKey`.
-     */
     keepInvisibleItems?: number[];
     isItemDisabled?: (index: number) => boolean;
     children: (index: number, data: D) => ReactNode;
     ref?: Ref<HTMLDivElement>;
     ListProps?: ListProps;
-    /**
-     * The index of the item to automatically focus on when the list is focused.
-     * @default 0
-     */
     firstFocusIndex?: number;
 } & Omit<VirtuosoProps<D, Omit<C, keyof VirtuosoContextType> & VirtuosoContextType>, 'itemContent' | 'children'>;
 export interface VirtualizedListComponent {

package/src/VirtualizedMenu/VirtualizedMenu.type.d.ts

@@ -5,26 +5,9 @@ import { PopperActions } from '../Popper';
 import { VirtualizedMenuClassesKey } from './VirtualizedMenu.classes';
 import { VirtualizedMenuListProps } from './VirtualizedMenuList';
 export declare type VirtualizedMenuProps<D = unknown> = StandardProps<{
-    /**
-     * The maximum height of the Menu list. If no value is provided, the Menu will
-     * not have a max height. The underlying Popover component will take care of
-     * ensuring the Menu is resized to fit within the available space in the viewport.
-     * @default undefined
-     */
     maxHeight?: number;
-    /**
-     * Triggered when focus leaves the menu and the menu should close.
-     */
     onClose?: () => void;
-    /**
-     * Controls whether the menu is displayed.
-     */
     open: boolean;
-    /**
-     * If true, focus first focusable item. If no focusable item, focus to list.
-     * If number, focus item by index. If it is no focusable, focus to list.
-     * If function, like others, but get index lazy.
-     */
     initialFocus?: number | boolean | (() => number | boolean);
     VirtualizedListProps?: Omit<VirtualizedMenuListProps<D>, 'maxHeight' | 'initialFocus' | 'children'>;
     popperActions?: Ref<PopperActions>;