@ringcentral/spring-ui 1.7.0 → 1.9.0

package/src/Autocomplete/SuggestionList/utils/useHighlightScroll.d.ts

@@ -1,33 +1,14 @@
-import React from 'react';
+/// <reference types="react" />
 import { FlatIndexLocationWithAlign, ListItem } from 'react-virtuoso';
 declare type UseHighlightScrollParams = {
-    /** function to call to scroll to target index */
+    virtualize?: boolean;
     scrollToIndex: (location: FlatIndexLocationWithAlign) => void;
-    /** that scroll container height ref */
     containerHeighRef: React.MutableRefObject<number>;
 };
-/**
- * scroll into current highlight index
- */
-export declare function useHighlightScroll({ containerHeighRef, scrollToIndex, }: UseHighlightScrollParams): {
-    /**
-     * scroller reference
-     */
-    scrollerRef: React.MutableRefObject<HTMLElement | undefined>;
-    /**
-     * Scroll to target highlighted index
-     * @param prevHighlightedIndex previous highlightedIndex
-     * @param currHighlightedIndex current highlightedIndex
-     * @param topHighlightIndex top highlighIndex for check should scroll when init
-     */
+export declare function useHighlightScroll({ virtualize, containerHeighRef, scrollToIndex, }: UseHighlightScrollParams): {
+    scrollerRef: import("react").MutableRefObject<HTMLElement | undefined>;
     scrollToHighlightedIndex: (prevHighlightedIndex: number, currHighlightedIndex: number, topHighlightIndex?: number) => void;
-    /**
-     * set to virtuoso `scrollerRef` prop, auto bind inner `scrollerRef`
-     */
     scrollerRefFn: (elm: HTMLElement) => HTMLElement;
-    /**
-     * set to virtuoso `itemsRendered` prop, auto bind inner `renderedItemsRef`
-     */
     itemsRendered: (e: ListItem<unknown>[]) => ListItem<unknown>[];
 };
 export {};

package/src/Autocomplete/SuggestionList/utils/useSuggestionList.d.ts

@@ -11,64 +11,27 @@ export declare type SuggestionListGetItemPropsOptions<T> = {
 };
 export declare type SuggestionListHighlightChangeReason = 'keyboard' | 'mouse' | 'auto' | undefined;
 export declare type SuggestionListFilterOptions<T> = (options: T[], state: {
-    /** current input value */
     inputValue?: string;
-    /** is that input value have been changed or not */
     inputChanged?: boolean;
-    /** get option label */
     getOptionLabel: (option: T) => string;
-    /** current be selected item array  */
     selectedItems: T[];
+    isOptionEqualToValue: (option: T, value: T) => boolean;
 }) => T[];
 export declare type UseSuggestionListParams<T extends SuggestionListItemData = SuggestionListItemData> = {
-    /** current suggestion list unique id */
     id?: string;
-    /** current text field input value */
     inputValue?: string;
-    /** emit current input value */
     onInputChange?: (value: string) => void;
-    /** that input ref you binding event */
     inputRef: React.RefObject<HTMLInputElement>;
-    /**
-     * If `true`, will allow disabled items highlightable.
-     */
     disabledItemsHighlightable?: boolean;
-    /**
-     * process filtered options result, let you can handle result after filter
-     */
     processFilteredResult?: (options: T[], inputValue: string) => T[];
-    /**
-     * A filter function that determines the options that are eligible.
-     *
-     * @param {T[]} options The options to render.
-     * @param {object} state The state of the component.
-     * @returns {T[]}
-     */
     filterOptions?: SuggestionListFilterOptions<T>;
-    /** emit when item be select */
     onSelect?: (event: React.ChangeEvent<{}>, selectedItems: T) => void;
-    /**
-     * @param event keydown event
-     * @param highlightedIndex current menu highlightedIndex
-     */
     onKeyDown?: (event: React.KeyboardEvent<HTMLInputElement | HTMLTextAreaElement>, highlightedIndex?: number | null) => void;
-    /**
-     * Trigger when click clear button.
-     */
     onClear?: React.MouseEventHandler<HTMLButtonElement>;
-    /**
-     * Used to determine the string value for a given option.
-     * It's used to fill the input (and the list box options if `renderOption` is not provided).
-     *
-     * @param {T} option
-     * @returns {string}
-     */
     getOptionLabel?: (option: T) => string;
+    isOptionEqualToValue?: (option: T, value: T) => boolean;
 } & Omit<UseAutocompleteGroupParams<T>, 'filteredResult' | 'id'>;
-/**
- * provide suggestion list with search function and expandable group with virtualized list
- */
-export declare const useSuggestionList: <T extends SuggestionListItemData = SuggestionListItemData>({ id, inputValue: inputValueProp, getOptionLabel, filterOptions, disabledItemsHighlightable, options, onInputChange: onInputChangeProp, inputRef, onKeyDown: onKeyDownProp, onSelect, onClear, getOptionDisabled, groupBy, onGroupExpanded, groupVariant, groupExpanded, groupDefaultExpanded, getExpandIconProps, processFilteredResult, }: UseSuggestionListParams<T>) => {
+export declare const useSuggestionList: <T extends SuggestionListItemData = SuggestionListItemData>({ id, inputValue: inputValueProp, getOptionLabel, filterOptions, disabledItemsHighlightable, options, onInputChange: onInputChangeProp, inputRef, onKeyDown: onKeyDownProp, onSelect, onClear, getOptionDisabled, groupBy, onGroupExpanded, groupVariant, groupExpanded, groupDefaultExpanded, getExpandIconProps, processFilteredResult, isOptionEqualToValue, }: UseSuggestionListParams<T>) => {
     reset: (isFocus?: boolean | undefined) => void;
     clearInput: () => void;
     forceUpdate: () => void;
@@ -94,7 +57,6 @@ export declare const useSuggestionList: <T extends SuggestionListItemData = Sugg
     changeHighlightedIndexReasonRef: import("react").MutableRefObject<SuggestionListHighlightChangeReason>;
     changeHighlightedIndexReason: SuggestionListHighlightChangeReason;
     optionsGroupList: import("./SuggestionListItem").SuggestionListGroupedOption<T>[];
-    /** current unique id */
     id: string;
     getNextFocusableOption: (index?: number, isInfinite?: any) => number;
     handleF10KeyDown: (e: React.KeyboardEvent<HTMLInputElement | HTMLTextAreaElement>) => void;

package/src/Autocomplete/SuggestionList/utils/useSuggestionListGroup.d.ts

@@ -2,63 +2,14 @@ import { ButtonHTMLAttributes, PropsWithoutRef } from 'react';
 import { SuggestionListGroupedOption, SuggestionListItemData } from './SuggestionListItem';
 export declare type UseAutocompleteGroupParams<T extends SuggestionListItemData = SuggestionListItemData> = {
     id: string;
-    /**
-     * @requires
-     * options for search
-     */
     options: T[];
-    /**
-     * Used to determine the disabled state for a given option.
-     *
-     * @param {T} option The option to test.
-     * @returns {boolean}
-     */
     getOptionDisabled?: (option: T) => boolean;
-    /**
-     * current filtered results
-     */
     filteredResult: T[];
-    /**
-     * group layout mode
-     *
-     * - `normal`: use group name as group title
-     * - `expanded`: use first-item as group title, and that is `clickable`
-     *
-     * @default 'normal'
-     */
     groupVariant?: 'normal' | 'expanded';
-    /**
-     * group expanded state, you can control expanded state by that
-     *
-     * - `true`: expand all
-     * - `false`: collapse all
-     * - `{key: boolean}`: control group state
-     */
     groupExpanded?: Record<string, boolean> | boolean;
-    /**
-     * group default expanded state
-     *
-     * - `true`: expand all
-     * - `false`: collapse all
-     * - `{key: boolean}`: control group state
-     */
     groupDefaultExpanded?: Record<string, boolean> | boolean;
-    /**
-     * If provided, the options will be grouped under the returned string.
-     * The groupBy value is also used as the text for group headings when `renderGroup` is not provided.
-     *
-     * @param {T} option The options to group.
-     * @returns {string} The group key
-     */
     groupBy?: (option: T) => string;
-    /**
-     * Trigger when group item expanded state change.
-     *
-     * @param {object} group The state of the group.
-     * @param {object} groupStateMap The whole group state
-     */
     onGroupExpanded?: (group: SuggestionListGroupedOption<T>, groupStateMap: Record<string, boolean>) => void;
-    /** The props apply to ExpandIcon */
     getExpandIconProps?: (group: SuggestionListGroupedOption) => PropsWithoutRef<React.DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>> | undefined;
 };
 declare type ExpandedMapState = Record<string, boolean>;

package/src/Autocomplete/useAutocomplete.d.ts

@@ -3,82 +3,22 @@ import { SuggestionListGetItemPropsOptions, SuggestionListItemData, UseSuggestio
 import { UseAutocompleteTagParams } from './useAutocompleteTag';
 export declare type AutocompleteCloseReason = 'toggleInput' | 'escape' | 'select-option' | 'blur';
 export declare type UseAutocompleteParams<T extends SuggestionListItemData = SuggestionListItemData> = {
-    /** input container ref, if you have a scrollable input, that will be needed */
     inputContainerRef?: React.RefObject<HTMLDivElement>;
-    /**
-     * if you want add `freeSolo` item at `first` or `last` of options array,
-     * set that will auto add item into options
-     */
     addNoOptionItem?: 'first' | 'last';
-    /**
-     * Control the popup open state.
-     */
     open?: boolean;
-    /**
-     * Callback fired when the popup requests to be opened.
-     * Use in controlled mode (see open).
-     *
-     * @param {object} event The event source of the callback.
-     */
     onOpen?: (event: React.ChangeEvent<{}>) => void;
-    /**
-     * Callback fired when the popup requests to be closed.
-     * Use in controlled mode (see open).
-     *
-     * @param {object} event The event source of the callback.
-     * @param {string} reason Can be: `"toggleInput"`, `"escape"`, `"select-option"`, `"blur"`.
-     */
     onClose?: (event: React.ChangeEvent<{}>, reason: AutocompleteCloseReason) => void;
-    /**
-     * If `true`, the popup won't close when a value is selected.
-     * This prop defaults to the value of the `multiple` prop.
-     *
-     * @default multiple
-     */
     disableCloseOnSelect?: boolean;
-    /**
-     * This is the initial isOpen value when Autocomplete is initialized.
-     */
     initialIsOpen?: boolean;
-    /** current input value */
     inputValue?: string;
-    /**
-     * If `true`, the selected option becomes the value of the input
-     * when the input loses focus unless the user chooses
-     * a different option or changes the character string in the input.
-     */
     autoSelect?: boolean;
-    /**
-     * If `true`, the popup will open on input focus.
-     * @default true
-     */
     openOnFocus?: boolean;
-    /**
-     * If `true`, when the input element is clicked it will toggle
-     * the visibility of the popup.
-     *
-     * @default true
-     */
     toggleWithInput?: boolean;
-    /**
-     * Render when search no have any options.
-     *
-     * @param {object} additionItems
-     * render when not have any options,
-     * if set that the freeSolo auto add items will not be cover
-     */
     renderNoOptions?: (getNoOptionsProps: (additionProps: PropsWithoutRef<DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>>) => DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>, additionItem: SuggestionListItemData | null) => React.ReactNode;
-    /**
-     * If `true`, the first option is automatically highlighted.
-     * @default true
-     */
     autoHighlight?: boolean;
-    /**
-     * current focused state
-     */
     focused?: boolean;
 } & Pick<InputHTMLAttributes<HTMLInputElement>, 'disabled' | 'required'> & UseSuggestionListParams<T> & Omit<UseAutocompleteTagParams<T>, 'id'>;
-export declare const useAutocomplete: <T extends SuggestionListItemData = SuggestionListItemData>({ multiple: multipleProp, variant, inputValue: inputValueProp, getOptionLabel, keyToTags, filterOptions: filterOptionsProp, disabledItemsHighlightable, options, freeSolo, onInputChange: onInputChangeProp, maxFreeSolo, onMaxFreeSolo, openOnFocus, toggleWithInput, disableCloseOnSelect, initialIsOpen, autoSelect, inputContainerRef, inputRef, wrapperRef, onKeyDown: onKeyDownProp, onChange: onSelectChange, value: selectedItemsProp, disabled, renderNoOptions, onClear, autoHighlight, getOptionDisabled, addNoOptionItem, groupBy, onGroupExpanded, groupVariant, groupExpanded, groupDefaultExpanded, getExpandIconProps, required, open: openProp, onOpen, onClose, focused, }: UseAutocompleteParams<T>) => {
+export declare const useAutocomplete: <T extends SuggestionListItemData = SuggestionListItemData>({ multiple: multipleProp, variant, inputValue: inputValueProp, getOptionLabel, keyToTags, filterOptions: filterOptionsProp, disabledItemsHighlightable, options, freeSolo, onInputChange: onInputChangeProp, maxFreeSolo, onMaxFreeSolo, openOnFocus, toggleWithInput, disableCloseOnSelect, initialIsOpen, autoSelect, inputContainerRef, inputRef, wrapperRef, onKeyDown: onKeyDownProp, onChange: onSelectChange, value: selectedItemsProp, disabled, renderNoOptions, onClear, autoHighlight, getOptionDisabled, addNoOptionItem, groupBy, onGroupExpanded, groupVariant, groupExpanded, groupDefaultExpanded, getExpandIconProps, required, open: openProp, onOpen, onClose, focused, isOptionEqualToValue, }: UseAutocompleteParams<T>) => {
     focusInput: () => void | undefined;
     readOnly: boolean | undefined;
     getTagProps: ({ index, selectedItem, ...restTagProps }: import("./useAutocompleteTag").GetTagProps<T>) => {
@@ -89,6 +29,7 @@ export declare const useAutocomplete: <T extends SuggestionListItemData = Sugges
         children?: import("react").ReactNode;
         onKeyDown?: import("react").KeyboardEventHandler<HTMLElement> | undefined;
         onKeyUp?: import("react").KeyboardEventHandler<HTMLElement> | undefined;
+        onMouseDown?: import("react").MouseEventHandler<HTMLElement> | undefined;
         onClick?: import("react").MouseEventHandler<HTMLElement> | undefined;
         'aria-hidden'?: boolean | "true" | "false" | undefined;
         dir?: string | undefined;
@@ -153,7 +94,7 @@ export declare const useAutocomplete: <T extends SuggestionListItemData = Sugges
         'aria-describedby'?: string | undefined;
         'aria-details'?: string | undefined;
         'aria-disabled'?: boolean | "true" | "false" | undefined;
-        'aria-dropeffect'?: "link" | "none" | "copy" | "execute" | "move" | "popup" | undefined;
+        'aria-dropeffect'?: "copy" | "link" | "none" | "execute" | "move" | "popup" | undefined;
         'aria-errormessage'?: string | undefined;
         'aria-expanded'?: boolean | "true" | "false" | undefined;
         'aria-flowto'?: string | undefined;
@@ -290,7 +231,6 @@ export declare const useAutocomplete: <T extends SuggestionListItemData = Sugges
         onDragStartCapture?: import("react").DragEventHandler<HTMLElement> | undefined;
         onDrop?: import("react").DragEventHandler<HTMLElement> | undefined;
         onDropCapture?: import("react").DragEventHandler<HTMLElement> | undefined;
-        onMouseDown?: import("react").MouseEventHandler<HTMLElement> | undefined;
         onMouseDownCapture?: import("react").MouseEventHandler<HTMLElement> | undefined;
         onMouseMove?: import("react").MouseEventHandler<HTMLElement> | undefined;
         onMouseMoveCapture?: import("react").MouseEventHandler<HTMLElement> | undefined;
@@ -343,7 +283,7 @@ export declare const useAutocomplete: <T extends SuggestionListItemData = Sugges
         onTransitionEnd?: import("react").TransitionEventHandler<HTMLElement> | undefined;
         onTransitionEndCapture?: import("react").TransitionEventHandler<HTMLElement> | undefined;
     };
-    getClearButtonProps: (props?: Pick<Omit<DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "color">, "value" | "children" | "onKeyDown" | "onKeyUp" | "onClick" | "disabled" | "aria-hidden" | "dir" | "form" | "slot" | "style" | "title" | "aria-live" | "aria-atomic" | "role" | "name" | "className" | "accessKey" | "draggable" | "hidden" | "lang" | "translate" | "id" | "prefix" | "contentEditable" | "inputMode" | "tabIndex" | "key" | "defaultChecked" | "defaultValue" | "formAction" | "formMethod" | "formNoValidate" | "formTarget" | "placeholder" | "type" | "onFocus" | "onBlur" | "onMouseEnter" | "onMouseLeave" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "contextMenu" | "spellCheck" | "radioGroup" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "is" | "aria-activedescendant" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocusCapture" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "autoFocus" | "formEncType"> | undefined) => Pick<Omit<DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "color">, "value" | "children" | "onKeyDown" | "onKeyUp" | "onClick" | "disabled" | "aria-hidden" | "dir" | "form" | "slot" | "style" | "title" | "aria-live" | "aria-atomic" | "role" | "name" | "className" | "accessKey" | "draggable" | "hidden" | "lang" | "translate" | "id" | "prefix" | "contentEditable" | "inputMode" | "tabIndex" | "key" | "defaultChecked" | "defaultValue" | "formAction" | "formMethod" | "formNoValidate" | "formTarget" | "placeholder" | "type" | "onFocus" | "onBlur" | "onMouseEnter" | "onMouseLeave" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "contextMenu" | "spellCheck" | "radioGroup" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "is" | "aria-activedescendant" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocusCapture" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "autoFocus" | "formEncType">;
+    getClearButtonProps: (props?: Pick<Omit<DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "color">, "value" | "children" | "onKeyDown" | "onKeyUp" | "onMouseDown" | "onClick" | "disabled" | "aria-hidden" | "dir" | "form" | "slot" | "style" | "title" | "aria-live" | "aria-atomic" | "role" | "name" | "className" | "accessKey" | "draggable" | "hidden" | "lang" | "translate" | "id" | "prefix" | "contentEditable" | "inputMode" | "tabIndex" | "key" | "defaultChecked" | "defaultValue" | "formAction" | "formMethod" | "formNoValidate" | "formTarget" | "placeholder" | "type" | "onFocus" | "onBlur" | "onMouseEnter" | "onMouseLeave" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "contextMenu" | "spellCheck" | "radioGroup" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "is" | "aria-activedescendant" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocusCapture" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDownCapture" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "autoFocus" | "formEncType"> | undefined) => Pick<Omit<DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "color">, "value" | "children" | "onKeyDown" | "onKeyUp" | "onMouseDown" | "onClick" | "disabled" | "aria-hidden" | "dir" | "form" | "slot" | "style" | "title" | "aria-live" | "aria-atomic" | "role" | "name" | "className" | "accessKey" | "draggable" | "hidden" | "lang" | "translate" | "id" | "prefix" | "contentEditable" | "inputMode" | "tabIndex" | "key" | "defaultChecked" | "defaultValue" | "formAction" | "formMethod" | "formNoValidate" | "formTarget" | "placeholder" | "type" | "onFocus" | "onBlur" | "onMouseEnter" | "onMouseLeave" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "contextMenu" | "spellCheck" | "radioGroup" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "is" | "aria-activedescendant" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocusCapture" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDownCapture" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "autoFocus" | "formEncType">;
     activeIndex: number;
     setActiveIndex: (tagToFocus: number, focus?: any) => void;
     isOpen: boolean;
@@ -411,7 +351,7 @@ export declare const useAutocomplete: <T extends SuggestionListItemData = Sugges
         'aria-describedby'?: string | undefined;
         'aria-details'?: string | undefined;
         'aria-disabled': boolean | "true" | "false";
-        'aria-dropeffect'?: "link" | "none" | "copy" | "execute" | "move" | "popup" | undefined;
+        'aria-dropeffect'?: "copy" | "link" | "none" | "execute" | "move" | "popup" | undefined;
         'aria-errormessage'?: string | undefined;
         'aria-expanded'?: boolean | "true" | "false" | undefined;
         'aria-flowto'?: string | undefined;
@@ -631,7 +571,6 @@ export declare const useAutocomplete: <T extends SuggestionListItemData = Sugges
     reset: (isFocus?: boolean | undefined) => void;
     forceUpdate: () => void;
     optionsGroupList: import("./SuggestionList").SuggestionListGroupedOption<T>[];
-    /** that state of current Autocomplete focused, both tag or input focused */
     focused: boolean | undefined;
     id: string;
     inputChanged: boolean;

package/src/Autocomplete/useAutocompleteTag.d.ts

@@ -11,54 +11,21 @@ export declare type GetTagProps<T> = PropsWithChildren<{
     disabled?: boolean;
 } & PropsWithoutRef<Omit<DetailedHTMLProps<HTMLAttributes<HTMLElement>, HTMLElement>, 'color'>> & HTMLDataAttribute>;
 export declare type UseAutocompleteTagParams<T extends SuggestionListItemData = SuggestionListItemData> = {
-    /** id for unique */
     id: string;
-    /** that input ref you binding event */
     inputRef: React.RefObject<HTMLInputElement>;
-    /** wrapper container ref, if you have `tag` or use in `popper`, that will be needed */
     wrapperRef?: React.RefObject<HTMLDivElement>;
-    /** when that return `true` will ignore freeSolo create event */
     getStopCreateFreeSolo?: () => boolean;
-    /** trigger when check free solo complete */
     onReset?: (e?: ChangeEvent<{}>) => void;
-    /**
-     * max number of tags,
-     * @default 20
-     */
     maxFreeSolo?: number;
-    /** emit when bigger than maxFreeSolo number */
     onMaxFreeSolo?: (max?: number) => void;
-    /**
-     * one of that character, also can be confirm a tag
-     * @default
-     * [',', ';', '↵']
-     */
     keyToTags?: string[];
-    /** selectedItems array list */
     value?: T[];
-    /**
-     * emit tags change event
-     */
     onChange?: (selectedItems: T[]) => void;
-    /**
-     * display mode,
-     * when be `autocomplete`, that `multiple` will be `false`
-     *
-     * @default tags
-     */
     variant?: 'tags' | 'autocomplete';
-    /**
-     * If `true`, the Autocomplete is free solo, meaning that the user input is not bound to provided options.
-     */
     freeSolo?: boolean;
-    /**
-     * is that can select multiple, default is `false`
-     */
     multiple?: boolean;
-    /** trigger when addTags is called */
     onAddTags?: () => void;
 } & Pick<InputHTMLAttributes<HTMLInputElement>, 'disabled' | 'required'> & Pick<UseSuggestionListParams<T>, 'getOptionLabel' | 'onInputChange'>;
-/** @inner inner hook work with useAutocomplete */
 export declare const useAutocompleteTag: <T extends SuggestionListItemData = SuggestionListItemData>({ id: AutocompleteId, value: selectedItemsProp, onChange: onSelectChange, variant, getOptionLabel, onInputChange: onInputChangeProp, freeSolo, multiple, wrapperRef, inputRef, maxFreeSolo, keyToTags, onMaxFreeSolo, required, disabled, getStopCreateFreeSolo, onReset, onAddTags, }: UseAutocompleteTagParams<T>) => {
     focused: boolean;
     setFocused: import("react").Dispatch<import("react").SetStateAction<boolean>>;
@@ -128,7 +95,7 @@ export declare const useAutocompleteTag: <T extends SuggestionListItemData = Sug
         'aria-describedby'?: string | undefined;
         'aria-details'?: string | undefined;
         'aria-disabled': boolean | "true" | "false";
-        'aria-dropeffect'?: "link" | "none" | "copy" | "execute" | "move" | "popup" | undefined;
+        'aria-dropeffect'?: "copy" | "link" | "none" | "execute" | "move" | "popup" | undefined;
         'aria-errormessage'?: string | undefined;
         'aria-expanded'?: boolean | "true" | "false" | undefined;
         'aria-flowto'?: string | undefined;
@@ -336,6 +303,7 @@ export declare const useAutocompleteTag: <T extends SuggestionListItemData = Sug
         children?: import("react").ReactNode;
         onKeyDown?: import("react").KeyboardEventHandler<HTMLElement> | undefined;
         onKeyUp?: import("react").KeyboardEventHandler<HTMLElement> | undefined;
+        onMouseDown?: import("react").MouseEventHandler<HTMLElement> | undefined;
         onClick?: import("react").MouseEventHandler<HTMLElement> | undefined;
         'aria-hidden'?: boolean | "true" | "false" | undefined;
         dir?: string | undefined;
@@ -400,7 +368,7 @@ export declare const useAutocompleteTag: <T extends SuggestionListItemData = Sug
         'aria-describedby'?: string | undefined;
         'aria-details'?: string | undefined;
         'aria-disabled'?: boolean | "true" | "false" | undefined;
-        'aria-dropeffect'?: "link" | "none" | "copy" | "execute" | "move" | "popup" | undefined;
+        'aria-dropeffect'?: "copy" | "link" | "none" | "execute" | "move" | "popup" | undefined;
         'aria-errormessage'?: string | undefined;
         'aria-expanded'?: boolean | "true" | "false" | undefined;
         'aria-flowto'?: string | undefined;
@@ -537,7 +505,6 @@ export declare const useAutocompleteTag: <T extends SuggestionListItemData = Sug
         onDragStartCapture?: import("react").DragEventHandler<HTMLElement> | undefined;
         onDrop?: import("react").DragEventHandler<HTMLElement> | undefined;
         onDropCapture?: import("react").DragEventHandler<HTMLElement> | undefined;
-        onMouseDown?: import("react").MouseEventHandler<HTMLElement> | undefined;
         onMouseDownCapture?: import("react").MouseEventHandler<HTMLElement> | undefined;
         onMouseMove?: import("react").MouseEventHandler<HTMLElement> | undefined;
         onMouseMoveCapture?: import("react").MouseEventHandler<HTMLElement> | undefined;

package/src/Avatar/Avatar.type.d.ts

@@ -8,79 +8,21 @@ declare type ExtendElementType = ElementType;
 export declare type AvatarVariant = 'circle' | 'squircle';
 export declare type AvatarSize = 'xxlarge' | 'xlarge' | 'large' | 'medium' | 'small' | 'xsmall' | 'xxsmall';
 declare type BaseAvatarProps = WithClassesProps<{
-    /**
-     * Used in combination with `src` or `srcSet` to
-     * provide an alt attribute for the rendered `img` element.
-     */
     alt?: string;
-    /**
-     * Used to render text elements inside the Avatar if `src` or `srcSet` is not set.
-     * This can be an element, or just a string.
-     */
     children?: ReactNode;
-    /**
-     * [Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#attributes) applied to the `img` element if the component is used to display an image.
-     * It can be used to listen for the loading error event.
-     */
     imgProps?: Omit<ComponentProps<'img'>, 'alt' | 'src' | 'srcSet'>;
-    /**
-     * The size of the component.
-     * @default 'xlarge'
-     */
     size?: AvatarSize;
-    /**
-     * The `src` attribute for the `img` element.
-     * If an error occurs while loading the avatar image, it will fallback to alternatives in the following order:
-     * 1. The provided children string.
-     * 2. The first letter of the alt text.
-     * 3. A generic icon. (**Only applies to variant 'circle'**)
-     */
     src?: string;
-    /**
-     * The `srcSet` attribute for the `img` element.
-     * Use this attribute for responsive image display.
-     */
     srcSet?: string;
-    /**
-     * Icon symbol.
-     */
     symbol?: ComponentType;
-    /**
-     * The variant to use.
-     * @default 'circle'
-     */
     variant?: AvatarVariant;
-    /**
-     * The color of the component.
-     * @default 'default'
-     */
     color?: 'default' | 'primary';
-    /**
-     * This will apply to the avatar shape node
-     * @default div
-     * */
     component?: 'div' | 'button';
-    /**
-     * If this component is clickable. When enabled hover, pressed and focus states are triggered.
-     */
     clickable?: boolean;
-    /**
-     * Props of the avatar shape
-     */
     avatarShapeRef?: Ref<ElementRef<'div' | 'button'>>;
-    /**
-     * If `true`, the Avatar will show a StatusIndicator component. Does not apply to the `xxsmall`/`xsmall` sizes.
-     */
     showStatusIndicator?: boolean;
-    /**
-     * Props passed to the StatusIndicator component. Only applicable if `showStatusIndicator` is `true`.
-     */
     IndicatorProps?: StatusIndicatorProps;
-    /** Attributes applied to root */
     rootProps?: Omit<ComponentProps<'div'>, 'className' | 'classes'> & Partial<OverlapProps>;
-    /**
-     * If `true`, the component is disabled.
-     */
     disabled?: boolean;
 } & Pick<UseFocusVisibleOptions, 'onFocusVisible'>, AvatarClassesKey>;
 export declare type AvatarProps<T extends ExtendElementType = DefaultElementType> = OverridableProps<BaseAvatarProps, T>;

package/src/AvatarGroup/AvatarGroup.type.d.ts

@@ -4,9 +4,6 @@ import { AvatarGroupClassesKey } from './AvatarGroup.classes';
 declare type DefaultElementType = 'div';
 declare type ExtendElementType = 'div' | 'button';
 declare type BaseAvatarGroupProps = WithClassesProps<{
-    /**
-     * You can only pass 2 Avatar components as children
-     */
     children: ReactNode;
 }, AvatarGroupClassesKey>;
 export declare type AvatarGroupProps<T extends ExtendElementType = DefaultElementType> = OverridableProps<BaseAvatarGroupProps, T>;

package/src/Backdrop/Backdrop.type.d.ts

@@ -1,9 +1,5 @@
 import { StandardProps } from '@ringcentral/spring-base';
 import { BackdropClassesKey } from './Backdrop.classes';
 export declare type BackdropProps = StandardProps<{
-    /**
-     * Prop to set backdrop transparent
-     * @default false
-     */
     isTransparent?: boolean;
 }, BackdropClassesKey, 'div'>;

package/src/Badge/Badge.type.d.ts

@@ -8,45 +8,12 @@ export declare type BadgeOverlap = 'rectangular' | 'circular';
 export declare type BadgeAnchorOrigin = 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight';
 export declare type BadgeType = 'standard' | 'dot';
 export declare type BadgeProps = StandardProps<{
-    /**
-     * The variant to use.
-     * @default 'contained'
-     */
     variant?: BadgeVariant;
-    /**
-     * The count type to use.
-     * @default 'standard'
-     */
     type?: BadgeType;
-    /**
-     * The integer to display. Undefined count with dot type can be used to show a dot.
-     */
     count?: number | string;
-    /**
-     * The color of the component.
-     * @default 'primary'
-     */
     color?: BadgeColor;
-    /**
-     * The size of the component.
-     * @default 'small'
-     */
     size?: BadgeSize;
-    /**
-     * Wrapped shape the badge should overlap.
-     * Note: Automatically take effect when there are child elements.
-     * @default 'rectangular'
-     */
     overlap?: BadgeOverlap;
-    /**
-     * Use the overlap position when there are no child elements.
-     * Note: If true, please give the parent element a position relative or absolute to make the badge work.
-     * @default false
-     */
     forceOverlap?: boolean;
-    /**
-     * The anchor of the badge.
-     * @default 'topRight'
-     */
     anchorOrigin?: BadgeAnchorOrigin;
 } & Omit<UseBadgeParameters, 'badgeContent'>, BadgeClassesKey, 'span'>;

package/src/Block/Block.type.d.ts

@@ -5,35 +5,11 @@ export declare type BlockBorderRadius = 'none' | 'xsmall' | 'small' | 'medium';
 export declare type BlockColor = 'default' | 'neutral';
 declare type DefaultElementType = 'div';
 declare type BaseBlockProps = WithClassesProps<{
-    /**
-     * If `true`, flex direction is set to 'row'.
-     * @default false
-     */
     row?: boolean;
-    /**
-     * If `false`, container padding is set to 0.
-     * @default true
-     */
     padding?: boolean;
-    /**
-     * If `false`, the border is hidden.
-     * @default true
-     */
     bordered?: boolean;
-    /**
-     * The border radius of the component.
-     * @default 'medium'
-     */
     borderRadius?: BlockBorderRadius;
-    /**
-     * The color of the component.
-     * @default 'default'
-     */
     color?: BlockColor;
-    /**
-     * If `false`, the background is hidden.
-     * @default true
-     */
     background?: boolean;
 }, BlockClassesKey>;
 export declare type BlockProps<T extends ElementType = DefaultElementType> = OverridableProps<BaseBlockProps, T>;