@ringcentral/spring-ui 1.7.0 → 1.8.0

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>) => {
@@ -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>>;

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>;

package/src/BlockHeader/BlockHeader.type.d.ts

@@ -3,12 +3,7 @@ import { OverridableComponent, OverridableProps, WithClassesProps } from '@ringc
 import { BlockHeaderClassesKey } from './BlockHeader.classes';
 declare type DefaultElementType = 'div';
 declare type BaseBlockHeaderProps = WithClassesProps<{
-    /** End slot of this header. */
     endSlot?: ReactNode;
-    /**
-     * If true, show blockHeader divider
-     * @default false
-     */
     divider?: boolean;
 }, BlockHeaderClassesKey>;
 export declare type BlockHeaderProps<T extends ElementType = DefaultElementType> = OverridableProps<BaseBlockHeaderProps, T>;

package/src/BottomNavigation/BottomNavigation.type.d.ts

@@ -5,55 +5,21 @@ import { BottomNavigationItemProps } from '../BottomNavigationItem';
 import { BottomNavigationClassesKey } from './BottomNavigation.classes';
 export declare type CollapseReason = 'EscapeKeyDown' | 'TabBlur' | 'ClickAway' | 'ToggleMore' | 'ItemSelected';
 export declare type BottomNavigationProps<T = string> = StandardProps<{
-    /**
-     * The default value. Use when the component is not controlled.
-     */
     defaultValue?: T;
-    /**
-     * The value of the activated navigation item.
-     */
     value?: T;
-    /**
-     * The default data of navigation items. Use when the component is not controlled.
-     */
     defaultData?: {
         visible: T[];
         more?: T[];
     };
-    /**
-     * The data of navigation items.
-     * The max count of visible items is **6**,
-     * it would be **5** due to the appearance of more button when there are items in more section.
-     */
     data?: {
         visible: T[];
         more?: T[];
     };
-    /**
-     * Callback invoked when new value is being set.
-     */
     onChange?: (event: React.SyntheticEvent, value: T) => void;
-    /**
-     * Used when rendering the navigation items.
-     * @param value value of current navigation item
-     * @returns {ReactNode}
-     */
     renderItem: (value: T) => ReactNode;
-    /**
-     * Props applied to the more button (which only appears when there are items in the more section.)
-     */
     MoreProps?: Omit<BottomNavigationItemProps, 'symbol'>;
-    /**
-     * Shows up at the bottom when more section expanded.
-     */
     description?: ReactNode;
-    /**
-     * Invoke when more section collapsed.
-     */
     onCollapse?: (event: React.SyntheticEvent | undefined, reason: CollapseReason) => void;
-    /**
-     * If `true`, the bottom navigation will take up the full width of its container.
-     */
     fullWidth?: boolean;
 } & Omit<HTMLMotionProps<'div'>, 'onChange'>, BottomNavigationClassesKey>;
 export interface BottomNavigationComponent {

package/src/BottomNavigationItem/BottomNavigationItem.type.d.ts

@@ -5,56 +5,17 @@ import { IconButtonProps } from '../IconButton';
 import { TooltipProps } from '../Tooltip';
 import { BottomNavigationItemClassesKey } from './BottomNavigationItem.classes';
 export declare type BottomNavigationItemProps<T = string> = StandardProps<{
-    /**
-     * Value of the navigation item.
-     */
     value?: T;
-    /**
-     * Icon symbol.
-     */
     symbol: ComponentType;
-    /**
-     * Icon symbol when activated is true.
-     */
     activatedSymbol?: ComponentType;
-    /**
-     * Badge count.
-     * The integer to display. It displays in dot mode if has not count specified.
-     */
     count?: number;
-    /**
-     * If true, navigation item will be displayed in an activated state.
-     */
     activated?: boolean;
-    /**
-     * If true, navigation item will be displayed in an expanded state.
-     */
     expanded?: boolean;
-    /**
-     * Callback fired when the button is clicked.
-     *
-     * @param {React.MouseEvent<HTMLButtonElement>} event The event source of the callback.
-     */
     onClick?: (e: React.MouseEvent<HTMLButtonElement>) => void;
-    /**
-     * Props applied to Badge component
-     */
     BadgeProps?: Omit<BadgeProps, 'count'> & HTMLDataAttribute;
-    /**
-     * Props applied to IconButton component
-     */
     ButtonProps?: Omit<IconButtonProps, 'symbol' | 'variant' | 'size' | 'shape' | 'color' | 'onClick'> & HTMLDataAttribute;
-    /**
-     * This label will be displayed in tooltip by default.
-     */
     label?: string;
-    /**
-     * Props applied to Tooltip component
-     */
     TooltipProps?: Omit<TooltipProps, 'title' | 'PopperProps' | 'open' | 'onOpenStateChange'> & HTMLDataAttribute;
-    /**
-     * Ref will be passed to the button.
-     */
     ref?: React.ForwardedRef<HTMLButtonElement>;
 }, BottomNavigationItemClassesKey>;
 export interface BottomNavigationItemComponent {

package/src/Button/Button.type.d.ts

@@ -9,44 +9,14 @@ export declare type ButtonSize = 'xlarge' | 'large' | 'medium' | 'small' | 'xsma
 export declare type ButtonVariant = 'text' | 'contained' | 'outlined' | 'inverted';
 export declare type ButtonColor = 'primary' | 'secondary' | 'danger' | 'warning' | 'success' | 'neutral';
 declare type BaseButtonProps = WithClassesProps<WithTooltipProps<{
-    /** Icon placed before the children. */
     startIcon?: IconProps['symbol'] | React.ReactNode;
-    /** Icon placed after the children. */
     endIcon?: IconProps['symbol'] | React.ReactNode;
-    /**
-     * If `true`, the button will take up the full width of its container.
-     * @default false
-     */
     fullWidth?: boolean;
-    /**
-     * The size of the component.
-     * @default 'medium'
-     */
     size?: ButtonSize;
-    /**
-     * The variant to use.
-     * @default 'contained'
-     */
     variant?: ButtonVariant;
-    /**
-     * The color of the component.
-     * @default 'primary'
-     */
     color?: ButtonColor;
-    /**
-     * If the component is in a loading state. Disables interactions and hides the startIcon if set.
-     * @default false
-     */
-    /**
-     * Controls whether the component should have a background in its resting state.
-     * Does not apply to the "text" variant.
-     * @default true
-     */
     background?: boolean;
     loading?: boolean;
-    /**
-     * Sets the props that are applied to the CircularProgressIndicator if `loading` is `true`.
-     */
     CircularProgressIndicatorProps?: CircularProgressIndicatorProps;
 } & Omit<UseButtonParameters, 'href' | 'type' | 'rootRef'>>, ButtonClassesKey>;
 export declare type ButtonProps<T extends ExtendElementType = DefaultElementType> = OverridableProps<BaseButtonProps, T>;

package/src/CallButton/CallButton.type.d.ts

@@ -5,10 +5,6 @@ export declare type DefaultElementType = 'button';
 declare type ExtendElementType = 'button';
 declare type BaseCallButtonProps = Omit<IconButtonProps, 'classes' | 'symbol' | 'label' | 'color' | 'variant' | 'shape' | 'size'> & WithClassesProps<{
     variant: 'start' | 'end';
-    /**
-     * The size of the component.
-     * @default "medium"
-     */
     size?: 'large' | 'medium' | 'small';
 }, UnionOmit<IconButtonClassesKey, 'rectangular' | 'outlined' | 'label' | 'primary'>>;
 export declare type CallButtonProps<T extends ExtendElementType = DefaultElementType> = OverridableProps<BaseCallButtonProps, T>;

package/src/Checkbox/Checkbox.type.d.ts

@@ -4,27 +4,10 @@ import { StandardProps } from '@ringcentral/spring-base';
 import { CheckboxClassesKey } from './Checkbox.classes';
 export declare type CheckboxShape = 'rectangular' | 'squircle';
 export declare type CheckboxProps = StandardProps<{
-    /**
-     * If `true`, the component appears indeterminate.
-     * @default false
-     */
     indeterminate?: boolean;
-    /**
-     * If `true`, the Checkbox will be automatically focused on mount.
-     * @default false
-     */
     autoFocus?: boolean;
-    /**
-     * Pass a ref to the `input` element.
-     */
     inputRef?: Ref<HTMLInputElement>;
-    /** Attributes applied to root */
     rootProps?: Omit<ComponentProps<'div'>, 'className'>;
-    /** Attributes applied to `input` element */
     inputProps?: Omit<ComponentProps<'input'>, 'className' | 'type' | 'ref'>;
-    /**
-     * The shape of the checkbox.
-     * @default 'rectangular'
-     */
     shape?: CheckboxShape;
 } & Omit<UseSwitchParameters, 'readonly'>, CheckboxClassesKey>;

package/src/Chip/Chip.type.d.ts

@@ -5,56 +5,15 @@ import { ChipClassesKey } from './Chip.classes';
 declare type DefaultElementType = 'div';
 export declare type ExtendElementType = 'div' | 'a';
 declare type BaseChipProps = WithClassesProps<{
-    /**
-     * Slot for putting an Avatar or Icon before label
-     */
     startSlot?: ReactElement;
-    /**
-     * This prop isn't supported.
-     * Use the `component` prop if you need to change the children structure.
-     */
     children?: null;
-    /**
-     * If `true`, the chip will appear clickable,
-     * even if the onClick prop is not defined.
-     * If `false`, the chip will not appear clickable, even if onClick prop is defined.
-     * This can be used, for example,
-     * along with the component prop to indicate an anchor Chip is clickable.
-     * Note: this controls the UI and does not affect the onClick event.
-     */
     clickable?: boolean;
-    /**
-     * If `true`, there is a max-width at 144,
-     * If `false`, there is no max-width.
-     * @default true
-     */
     truncate?: boolean;
-    /**
-     * The color of the component.
-     * @default 'default'
-     */
     color?: 'default' | 'error';
-    /**
-     * The size of the component.
-     * @default 'large'
-     */
     size?: 'large' | 'medium' | 'small';
-    /**
-     * The content of the component.
-     */
     label?: React.ReactNode;
-    /**
-     * Callback fired
-     * 1. when the delete icon is clicked
-     * 2. press 'Backspace' or 'Delete' when Chip is focused
-     * If set, the delete icon will be shown.
-     */
     onDelete?: (event: MouseEvent<Element> | KeyboardEvent<Element>) => void;
-    /** Attributes applied to delete icon button */
     DeleteIconProps?: Omit<IconButtonProps, 'variant' | 'size' | 'shape'>;
-    /**
-     * If `true`, the component is disabled.
-     */
     disabled?: boolean;
 }, ChipClassesKey>;
 export declare type ChipProps<T extends ExtendElementType = DefaultElementType> = OverridableProps<BaseChipProps, T>;