@ringcentral/spring-ui 1.7.0 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (233) hide show
  1. package/Alert.js +3 -3
  2. package/Announcement.js +1 -1
  3. package/Autocomplete.js +174 -236
  4. package/Avatar.js +27 -13
  5. package/BottomNavigation.js +0 -3
  6. package/Checkbox.js +0 -2
  7. package/DatePicker.js +5 -13
  8. package/DateUtilsContext.js +0 -1
  9. package/Dialer.js +2 -50
  10. package/Dialog.js +4 -4
  11. package/Dropdown.js +0 -7
  12. package/FocusTrap.js +0 -32
  13. package/InlineEditable.js +0 -4
  14. package/Link.js +1 -1
  15. package/ListItem.js +1 -1
  16. package/ListNavigation.js +0 -6
  17. package/Menu.js +1 -1
  18. package/MenuDivider.js +2 -2
  19. package/MenuFooter.js +4 -4
  20. package/MenuHeader.js +4 -4
  21. package/MenuItem.js +1 -1
  22. package/MenuItemText.js +1 -1
  23. package/PageHeader.js +6 -4
  24. package/Popper.js +0 -1
  25. package/Rating.js +0 -5
  26. package/SingleFilter.js +0 -1
  27. package/Slider.js +1 -4
  28. package/Snackbar.js +0 -14
  29. package/SortableListItem.js +0 -1
  30. package/SplitButton.js +1 -3
  31. package/StatusIndicator.js +1 -1
  32. package/SubMenu.js +0 -4
  33. package/SwipeableDrawer.js +8 -146
  34. package/Switch.js +1 -4
  35. package/Tab.js +7 -8
  36. package/TabContext.js +0 -5
  37. package/TableBody.js +1 -1
  38. package/TableCell.js +0 -6
  39. package/TableRow.js +0 -1
  40. package/Tabs.js +20 -118
  41. package/Text.js +2 -4
  42. package/TimePicker.js +7 -46
  43. package/VirtualizedList.js +2 -30
  44. package/chunks/Alert.js +8 -7
  45. package/chunks/BottomNavigationItem.js +0 -1
  46. package/chunks/Button.js +0 -1
  47. package/chunks/Chip.js +0 -5
  48. package/chunks/Drawer.js +1 -30
  49. package/chunks/ListItem.js +3 -6
  50. package/chunks/Menu.js +3 -3
  51. package/chunks/MenuDivider.js +2 -3
  52. package/chunks/MenuItemText.js +3 -3
  53. package/chunks/MenuList.js +0 -3
  54. package/chunks/PickerTextField.js +0 -1
  55. package/chunks/Popover.js +0 -5
  56. package/chunks/Select.js +2 -39
  57. package/chunks/Squircle.js +0 -7
  58. package/chunks/StatusIndicator.js +1 -0
  59. package/chunks/StepIcon.js +1 -3
  60. package/chunks/StepperContext.js +0 -7
  61. package/chunks/Tooltip.js +0 -36
  62. package/chunks/VirtualizedMenu.js +2 -78
  63. package/chunks/getFade.js +2 -0
  64. package/chunks/useFocusTrapStack.js +0 -8
  65. package/chunks/useHelperTextId.js +0 -24
  66. package/chunks/useListNavigation.js +2 -17
  67. package/chunks/useMenuItemSelect.js +6 -19
  68. package/chunks/useMotionSafeTransition.js +0 -4
  69. package/chunks/useNestedParentMenu.js +0 -2
  70. package/chunks/usePrefersReducedMotion.js +0 -10
  71. package/chunks/useTooltipForceHide.js +0 -4
  72. package/chunks/useTrayNavigate.js +0 -1
  73. package/index.css +392 -120
  74. package/index.js +1 -1
  75. package/package.json +4 -4
  76. package/src/Accordion/Accordion.type.d.ts +0 -21
  77. package/src/AccordionHeader/AccordionHeader.type.d.ts +0 -14
  78. package/src/Alert/Alert.type.d.ts +0 -32
  79. package/src/Animation/components/ExpandCollapseCaret/ExpandCollapseCaret.d.ts +0 -4
  80. package/src/Animation/components/ShowHideEye/ShowHideEye.d.ts +0 -4
  81. package/src/Animation/hooks/useMotionSafeTransition/useMotionSafeTransition.d.ts +0 -4
  82. package/src/Autocomplete/Autocomplete.d.ts +0 -5
  83. package/src/Autocomplete/Autocomplete.type.d.ts +0 -84
  84. package/src/Autocomplete/SuggestionList/SuggestionList.d.ts +5 -89
  85. package/src/Autocomplete/SuggestionList/SuggestionListItem.d.ts +0 -2
  86. package/src/Autocomplete/SuggestionList/utils/SuggestionListItem.d.ts +1 -13
  87. package/src/Autocomplete/SuggestionList/utils/useDynamicHeight.d.ts +0 -6
  88. package/src/Autocomplete/SuggestionList/utils/useHighlightScroll.d.ts +0 -20
  89. package/src/Autocomplete/SuggestionList/utils/useSuggestionList.d.ts +3 -41
  90. package/src/Autocomplete/SuggestionList/utils/useSuggestionListGroup.d.ts +0 -49
  91. package/src/Autocomplete/useAutocomplete.d.ts +1 -62
  92. package/src/Autocomplete/useAutocompleteTag.d.ts +0 -33
  93. package/src/Avatar/Avatar.type.d.ts +0 -58
  94. package/src/AvatarGroup/AvatarGroup.type.d.ts +0 -3
  95. package/src/Backdrop/Backdrop.type.d.ts +0 -4
  96. package/src/Badge/Badge.type.d.ts +0 -33
  97. package/src/Block/Block.type.d.ts +0 -24
  98. package/src/BlockHeader/BlockHeader.type.d.ts +0 -5
  99. package/src/BottomNavigation/BottomNavigation.type.d.ts +0 -34
  100. package/src/BottomNavigationItem/BottomNavigationItem.type.d.ts +0 -39
  101. package/src/Button/Button.type.d.ts +0 -30
  102. package/src/CallButton/CallButton.type.d.ts +0 -4
  103. package/src/Checkbox/Checkbox.type.d.ts +0 -17
  104. package/src/Chip/Chip.type.d.ts +0 -41
  105. package/src/CircularProgressIndicator/CircularProgressIndicator.type.d.ts +0 -19
  106. package/src/DatePicker/Calendar.d.ts +1 -20
  107. package/src/DatePicker/DatePicker.type.d.ts +0 -18
  108. package/src/DatePicker/DatePickerHeader.d.ts +1 -12
  109. package/src/DatePicker/Day.d.ts +0 -7
  110. package/src/DatePicker/Year.d.ts +0 -6
  111. package/src/DatePicker/Years.d.ts +0 -7
  112. package/src/Dialer/DialDelete/DialDelete.d.ts +0 -3
  113. package/src/Dialer/DialPad/DialPad.d.ts +0 -106
  114. package/src/Dialer/DialPad/utils/types.d.ts +0 -5
  115. package/src/Dialer/DialPad/utils/useDialKeyboard.d.ts +0 -5
  116. package/src/Dialer/DialPad/utils/useKeyAudio.d.ts +0 -9
  117. package/src/Dialer/DialPadButton/DialPadButton.d.ts +0 -14
  118. package/src/Dialer/DialTextField/DialTextField.d.ts +0 -23
  119. package/src/Dialer/DialTextField/utils/getDialPadValueOnlyRegex.d.ts +0 -3
  120. package/src/Dialer/DialTextField/utils/useFixedEndSelection.d.ts +0 -3
  121. package/src/Dialog/Dialog.type.d.ts +0 -11
  122. package/src/Divider/Divider.type.d.ts +0 -17
  123. package/src/DragHandle/DragHandle.type.d.ts +0 -4
  124. package/src/Drawer/Drawer.d.ts +0 -28
  125. package/src/Drawer/Drawer.type.d.ts +0 -84
  126. package/src/Dropdown/Dropdown.type.d.ts +0 -64
  127. package/src/EmptyState/EmptyState.type.d.ts +0 -12
  128. package/src/FabButton/FabButton.type.d.ts +0 -5
  129. package/src/FocusTrap/FocusTrap.d.ts +0 -38
  130. package/src/FocusTrap/useFocusTrapStack.d.ts +0 -9
  131. package/src/FormField/FormField.type.d.ts +0 -26
  132. package/src/FormField/useHelperTextId.d.ts +0 -25
  133. package/src/FormLabel/FormLabel.type.d.ts +0 -14
  134. package/src/Icon/Icon.type.d.ts +0 -15
  135. package/src/IconButton/IconButton.type.d.ts +0 -30
  136. package/src/IconButton/IconButtonLabel.type.d.ts +0 -3
  137. package/src/IconButtonGroup/IconButtonGroup.type.d.ts +0 -8
  138. package/src/InlineEditable/InlineEditable.type.d.ts +0 -75
  139. package/src/LinearProgressIndicator/LinearProgressIndicator.type.d.ts +0 -31
  140. package/src/Link/Link.classes.d.ts +1 -1
  141. package/src/Link/Link.type.d.ts +1 -10
  142. package/src/ListItem/ListItem.type.d.ts +0 -41
  143. package/src/ListItemText/ListItemText.type.d.ts +0 -21
  144. package/src/ListNavigation/useListNavigation.d.ts +0 -16
  145. package/src/Menu/Menu.type.d.ts +0 -10
  146. package/src/MenuFooter/MenuFooter.type.d.ts +0 -4
  147. package/src/MenuHeader/MenuHeader.type.d.ts +0 -10
  148. package/src/MenuItem/MenuItem.type.d.ts +0 -19
  149. package/src/MenuItem/MenuItemSelectContext.d.ts +0 -3
  150. package/src/MenuItem/useMenuItemSelect.d.ts +0 -21
  151. package/src/MenuItemText/MenuItemText.type.d.ts +0 -17
  152. package/src/MenuList/MenuList.type.d.ts +0 -4
  153. package/src/MenuList/MenuListContext.d.ts +0 -6
  154. package/src/Modal/InnerModal.type.d.ts +0 -5
  155. package/src/Modal/Modal.type.d.ts +0 -11
  156. package/src/Modal/ModalContext.d.ts +0 -4
  157. package/src/Option/Option.type.d.ts +0 -3
  158. package/src/Overlap/Overlap.type.d.ts +0 -11
  159. package/src/PageHeader/PageHeader.type.d.ts +0 -4
  160. package/src/PickerTextField/PickerTextField.type.d.ts +0 -10
  161. package/src/Popover/Popover.type.d.ts +0 -29
  162. package/src/Popper/Popper.type.d.ts +0 -61
  163. package/src/Radio/Radio.type.d.ts +0 -5
  164. package/src/RadioGroup/RadioGroup.type.d.ts +0 -4
  165. package/src/Rating/Rating.type.d.ts +0 -74
  166. package/src/Select/Select.type.d.ts +0 -84
  167. package/src/SingleFilter/FilterButton/FilterButton.type.d.ts +0 -16
  168. package/src/SingleFilter/SingleFilter.type.d.ts +0 -26
  169. package/src/Skeleton/Skeleton.type.d.ts +0 -1
  170. package/src/Skeleton/SkeletonContainer/SkeletonContainer.classes.d.ts +1 -1
  171. package/src/Slider/Slider.classes.d.ts +1 -5
  172. package/src/Slider/Slider.type.d.ts +0 -104
  173. package/src/Snackbar/Snackbar.type.d.ts +0 -18
  174. package/src/SplitButton/SplitButton.type.d.ts +0 -21
  175. package/src/Squircle/Squircle.type.d.ts +0 -3
  176. package/src/StatusIndicator/StatusIndicator.classes.d.ts +1 -1
  177. package/src/StatusIndicator/StatusIndicator.type.d.ts +1 -9
  178. package/src/Step/Step.type.d.ts +0 -29
  179. package/src/Step/StepContext.d.ts +0 -7
  180. package/src/StepButton/StepButton.type.d.ts +0 -15
  181. package/src/StepContent/StepContent.type.d.ts +0 -7
  182. package/src/StepIcon/StepIcon.type.d.ts +0 -26
  183. package/src/StepLabel/StepLabel.type.d.ts +0 -23
  184. package/src/Stepper/Stepper.type.d.ts +0 -27
  185. package/src/SwipeableDrawer/SwipeableDrawer.d.ts +0 -26
  186. package/src/SwipeableDrawer/SwipeableDrawer.types.d.ts +0 -67
  187. package/src/SwipeableDrawer/hooks/useDrawerGestures.d.ts +0 -110
  188. package/src/SwipeableDrawer/hooks/useElementSizeObserver.d.ts +0 -5
  189. package/src/SwipeableDrawer/hooks/useSnapPoints.d.ts +0 -60
  190. package/src/Switch/Switch.type.d.ts +0 -9
  191. package/src/Tab/Tab.classes.d.ts +3 -2
  192. package/src/Tab/Tab.type.d.ts +0 -29
  193. package/src/TabContext/TabContext.d.ts +0 -4
  194. package/src/TabContext/TabContext.type.d.ts +0 -7
  195. package/src/TabPanel/TabPanel.type.d.ts +0 -10
  196. package/src/Table/Table.type.d.ts +0 -19
  197. package/src/TableBody/TableBody.type.d.ts +0 -3
  198. package/src/TableCell/TableCell.d.ts +0 -4
  199. package/src/TableCell/TableCell.type.d.ts +0 -35
  200. package/src/TableContainer/TableContainer.type.d.ts +0 -7
  201. package/src/TableFooter/TableFooter.type.d.ts +0 -3
  202. package/src/TableHead/TableHead.type.d.ts +0 -6
  203. package/src/TablePagination/TablePagination.type.d.ts +0 -47
  204. package/src/TableRow/TableRow.type.d.ts +0 -17
  205. package/src/Tabs/TabMoreMenu.d.ts +0 -16
  206. package/src/Tabs/TabScrollButton.d.ts +0 -10
  207. package/src/Tabs/Tabs.classes.d.ts +1 -1
  208. package/src/Tabs/Tabs.d.ts +1 -1
  209. package/src/Tabs/Tabs.type.d.ts +2 -36
  210. package/src/Tabs/TabsContext.d.ts +2 -0
  211. package/src/Tabs/hooks/useTabsScroller.d.ts +0 -30
  212. package/src/Tag/Tag.type.d.ts +0 -12
  213. package/src/Text/Text.type.d.ts +0 -13
  214. package/src/TextField/TextField.type.d.ts +0 -64
  215. package/src/Textarea/Textarea.type.d.ts +0 -13
  216. package/src/TimePicker/NumberPicker.type.d.ts +0 -12
  217. package/src/TimePicker/SelectionView.d.ts +0 -6
  218. package/src/TimePicker/TimeButton.d.ts +0 -3
  219. package/src/TimePicker/TimePicker.type.d.ts +0 -11
  220. package/src/TimePicker/ToggleText.type.d.ts +0 -3
  221. package/src/TimePicker/utils/TimeBoundary.d.ts +0 -3
  222. package/src/TimePicker/utils/TimePickerHelper.d.ts +0 -19
  223. package/src/TimePicker/utils/getNumberPickerBoundary.d.ts +0 -3
  224. package/src/Tooltip/TooltipTrigger.a11y.d.ts +0 -9
  225. package/src/Tooltip/TooltipTrigger.type.d.ts +0 -44
  226. package/src/Tooltip/TooltipView.type.d.ts +0 -25
  227. package/src/Tooltip/useTooltipForceHide.d.ts +0 -4
  228. package/src/Tray/Tray.type.d.ts +0 -13
  229. package/src/Tray/TrayContext.d.ts +0 -4
  230. package/src/Tray/hooks/useTray.d.ts +0 -16
  231. package/src/Tray/hooks/useTrayPanel.d.ts +0 -3
  232. package/src/VirtualizedList/VirtualizedList.type.d.ts +0 -27
  233. package/src/VirtualizedMenu/VirtualizedMenu.type.d.ts +0 -17
@@ -5,28 +5,9 @@ export declare type CircularProgressIndicatorVariant = 'indeterminate' | 'determ
5
5
  export declare type CircularProgressIndicatorSize = 'xlarge' | 'large' | 'medium' | 'small' | 'xsmall';
6
6
  export declare type CircularProgressIndicatorColor = 'primary' | 'neutral' | 'danger' | 'success' | 'warning';
7
7
  export declare type CircularProgressIndicatorProps = StandardProps<{
8
- /**
9
- * The variant of the indicator.
10
- * @default indeterminate
11
- */
12
8
  variant?: CircularProgressIndicatorVariant;
13
- /**
14
- * Sets the size of the indicator.
15
- * @default large
16
- */
17
9
  size?: CircularProgressIndicatorSize;
18
- /**
19
- * Sets the color of the indicator.
20
- * @default primary
21
- */
22
10
  color?: CircularProgressIndicatorColor;
23
- /**
24
- * Sets the value of the indicator.
25
- * Only applies to variant `determinate`
26
- */
27
11
  value?: number;
28
- /**
29
- * Sets the props that are applied to the `role="progressbar"` element
30
- */
31
12
  progressBarProps?: Omit<ComponentProps<'span'>, 'ref' | 'role'>;
32
13
  }, CircularProgressIndicatorClassesKey, 'span'>;
@@ -1,36 +1,17 @@
1
1
  import React from 'react';
2
2
  import { DateType } from './DatePicker.type';
3
3
  declare type CalendarProps = {
4
- /** DateRange for setting */
5
4
  dateRange: {
6
- /** Min date @DateIOType */
7
5
  min: DateType;
8
- /** Max date @DateIOType */
9
6
  max: DateType;
10
7
  };
11
- /** Disable past dates */
12
8
  disablePast?: boolean;
13
- /** Disable future dates */
14
9
  disableFuture?: boolean;
15
- /** Text label for Today button */
16
10
  todayButtonText?: string;
17
- /** Date format string, default with 'MM/DD/YYYY' */
18
11
  formatString?: string;
19
- /** Custom renderer for day @DateIOType */
20
- renderDay?: (
21
- /** day to render */
22
- day: DateType,
23
- /** the selelcted Date */
24
- selectedDate: DateType,
25
- /** is the day in current month */
26
- dayInCurrentMonth: boolean,
27
- /** day Component */
28
- dayComponent: JSX.Element) => JSX.Element;
29
- /** Disable specific date @DateIOType */
12
+ renderDay?: (day: DateType, selectedDate: DateType, dayInCurrentMonth: boolean, dayComponent: JSX.Element) => JSX.Element;
30
13
  shouldDisableDate: (day: DateType) => boolean;
31
- /** Callback firing on month change. Return promise to render spinner till it will not be resolved @DateIOType */
32
14
  onMonthChange?: (date: DateType) => void | Promise<void>;
33
- /** Custom loading indicator */
34
15
  loadingIndicator?: JSX.Element;
35
16
  date: DateType;
36
17
  onSelectDay: (day: DateType, fromUserSelect?: boolean) => void;
@@ -6,31 +6,13 @@ import { DatePickerClassesKey } from './DatePicker.classes';
6
6
  import { ScreenReaderProps } from './utils';
7
7
  export declare type DateType = dayjs.Dayjs;
8
8
  export declare type DatePickerProps = StandardProps<{
9
- /**
10
- * Calendar onChange
11
- *
12
- * @param {Date} date update date value
13
- * @param {boolean} fromUserSelect is that change come from user select day, when `false` mean that is come from range limitation
14
- */
15
9
  onChange?: (date: Date | null, fromUserSelect?: boolean) => void;
16
- /** i18n locale country */
17
10
  locale?: string;
18
- /** value for picker */
19
11
  value?: Date | null;
20
- /**
21
- * Customize aria-labels for DatePicker components.
22
- * Pass this prop for localization or custom accessibility labels.
23
- * If not provided, default English labels will be used.
24
- */
25
12
  screenReaderProps?: ScreenReaderProps;
26
- /** Date format string, default with 'MM/DD/YYYY' */
27
13
  formatString?: string;
28
- /** when hover on the textField, if show the clearBtn. With default is true. */
29
14
  clearBtn?: boolean;
30
- /** Min date */
31
15
  min?: Date | DateType | null;
32
- /** Max date */
33
16
  max?: Date | DateType | null;
34
- /** Text label for Today button */
35
17
  todayButtonText?: string;
36
18
  } & Omit<Partial<CalendarProps>, 'date' | 'dateRange' | 'handleDaySelect' | 'getInvalidateDateInRange'>, DatePickerClassesKey, typeof PickerTextField, 'value' | 'children' | 'defaultValue'>;
@@ -3,23 +3,12 @@ import { SlideDirection } from './SlideDirection';
3
3
  import { DateType } from './DatePicker.type';
4
4
  declare type ViewType = 'day' | 'year';
5
5
  declare type DatePickerHeaderProps = {
6
- /** the month on display */
7
6
  focusedDate: DateType;
8
- /** with options 'right' | 'left' */
9
7
  slideDirection: SlideDirection;
10
- /** the current view mode, with options 'day' | 'year'. */
11
8
  view: ViewType;
12
- /** when change view mode */
13
9
  onViewChange: () => void;
14
- /** trigger when Month changes */
15
- onMonthChange: (
16
- /** the month selected */
17
- date: DateType,
18
- /** slideDirection */
19
- direction: SlideDirection) => void | Promise<void>;
20
- /** is disable PrevMonth? with default false. */
10
+ onMonthChange: (date: DateType, direction: SlideDirection) => void | Promise<void>;
21
11
  disablePrevMonth?: boolean;
22
- /** is disable NextMonth? with default false. */
23
12
  disableNextMonth?: boolean;
24
13
  };
25
14
  declare const DatePickerHeader: FunctionComponent<DatePickerHeaderProps>;
@@ -2,19 +2,12 @@
2
2
  import { PropsWithRoot } from '@ringcentral/spring-base';
3
3
  import { DateType } from './DatePicker.type';
4
4
  declare type DayProps = PropsWithRoot<{
5
- /** display as content */
6
5
  children: string;
7
- /** is the year disabled */
8
6
  disabled: boolean;
9
- /** is the year focused */
10
7
  focused?: boolean;
11
- /** when user select */
12
8
  onSelect: (value: string) => void;
13
- /** is the year selected */
14
9
  selected: boolean;
15
- /** the value of the year */
16
10
  value: string;
17
- /** tabindex */
18
11
  date: DateType;
19
12
  current: boolean;
20
13
  }, 'button', 'className'>;
@@ -2,17 +2,11 @@
2
2
  import { PropsWithRoot } from '@ringcentral/spring-base';
3
3
  import { DateType } from './DatePicker.type';
4
4
  declare type YearProps = PropsWithRoot<{
5
- /** display as content */
6
5
  children: string;
7
- /** is the year disabled */
8
6
  disabled: boolean;
9
- /** when user select */
10
7
  onSelect: (value: string) => void;
11
- /** is the year selected */
12
8
  selected: boolean;
13
- /** the value of the year */
14
9
  value: string;
15
- /** tabindex */
16
10
  date: DateType;
17
11
  current: boolean;
18
12
  }, 'button', 'className'>;
@@ -1,19 +1,12 @@
1
1
  /// <reference types="react" />
2
2
  import { DateType } from './DatePicker.type';
3
3
  declare type YearsProps = {
4
- /** the selected date. */
5
4
  date: DateType;
6
- /** min Date of the displayed years range. */
7
5
  minDate: DateType;
8
- /** max Date of the displayed years range. */
9
6
  maxDate: DateType;
10
- /** is disable the past years. */
11
7
  disablePast?: boolean;
12
- /** is disable the future years. */
13
8
  disableFuture?: boolean;
14
- /** when selected year changes. */
15
9
  onYearChange: (date: DateType) => void;
16
- /** now date */
17
10
  now: DateType;
18
11
  };
19
12
  declare const Years: import("react").ForwardRefExoticComponent<YearsProps & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,11 +1,8 @@
1
1
  import { FunctionComponent } from 'react';
2
2
  import { DialPadOnChangeReason } from '../DialPad';
3
3
  declare type DialDeleteProps = {
4
- /** that children for host delete behaviors */
5
4
  children: React.ReactElement;
6
- /** trigger when delete */
7
5
  onDelete?: (e: React.MouseEvent<unknown, MouseEvent> | React.TouchEvent<unknown> | React.KeyboardEvent<unknown>, reason: DialPadOnChangeReason) => void;
8
- /** trigger when clear */
9
6
  onClear?: (e: React.MouseEvent<unknown, MouseEvent> | React.TouchEvent<unknown> | React.KeyboardEvent<unknown>, reason: DialPadOnChangeReason) => void;
10
7
  externalWindow?: Window;
11
8
  };
@@ -6,137 +6,31 @@ import dialPadStyle from './styles/DialPad.css';
6
6
  import type { DIALER_PAD_ICON_VALUES, DialPadAction, DialPadControl, DialPadSoundMap } from './utils';
7
7
  declare type DialPadOnChangeReason = UseLongPressEventReason | 'customKeyboard';
8
8
  declare type DialPadProps = {
9
- /**
10
- * trigger when value change, `reason` for trigger from what event
11
- *
12
- * `reason` will be `customKeyboard` when it trigger by `useDiaKeyboard`.
13
- */
14
9
  onChange?: (value: string, reason: DialPadOnChangeReason) => void;
15
- /**
16
- * keypad sounds
17
- *
18
- * By default, we not have any sound for best file size for you can define when and what audio you need
19
- * should pass sound map when you want play sound.
20
- *
21
- * @example
22
- *
23
- * ```ts
24
- * import { DialerPadSoundsMPEG } from '@ringcentral/spring-ui';
25
- * import { DialerPadSoundsOGG } from '@ringcentral/spring-ui';
26
- * ```
27
- */
28
10
  sounds?: DialPadSoundMap;
29
- /** volume of keypad sound */
30
11
  volume?: number;
31
- /** is keypad sound muted */
32
12
  muted?: boolean;
33
- /**
34
- * sinkId of keypad sound
35
- *
36
- * @important
37
- * Safari is not supported the `setSinkId` method
38
- * https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/setSinkId#browser_compatibility
39
- */
40
13
  sinkId?: string;
41
- /**
42
- * long press '0' time to typing '+'
43
- *
44
- * @default 1000ms
45
- */
46
14
  longPressDelay?: number;
47
- /**
48
- * time of persist button background when manual trigger by 'actionRef'
49
- * button background will not persist if persistBgTime less than 0
50
- * @default 200
51
- * */
52
15
  persistBgTime?: number;
53
- /**
54
- * make that dialPad size auto fixed container width
55
- *
56
- * @default true
57
- */
58
16
  autoSize?: boolean;
59
- /** can manual trigger audio by ref */
60
17
  action?: Ref<DialPadAction>;
61
- /**
62
- * control inner action,
63
- * ### you should use with `useDialKeyboard`
64
- */
65
18
  control?: Ref<DialPadControl>;
66
- /** method to get addition props for below each `DialPadButton` */
67
19
  getDialPadButtonProps?: (value: DIALER_PAD_ICON_VALUES) => Omit<IconButtonProps, 'value' | 'onKeyDown' | 'onFocus'> & HTMLDataAttribute;
68
- /**
69
- * size of dialPad
70
- *
71
- * @default 'large'
72
- */
73
20
  size?: 'large' | 'medium';
74
21
  } & Omit<HTMLAttributes<HTMLDivElement>, 'onChange'> & Pick<DialPadButtonProps, 'classes'>;
75
22
  declare const DialPad: import("react").ForwardRefExoticComponent<{
76
- /**
77
- * trigger when value change, `reason` for trigger from what event
78
- *
79
- * `reason` will be `customKeyboard` when it trigger by `useDiaKeyboard`.
80
- */
81
23
  onChange?: ((value: string, reason: DialPadOnChangeReason) => void) | undefined;
82
- /**
83
- * keypad sounds
84
- *
85
- * By default, we not have any sound for best file size for you can define when and what audio you need
86
- * should pass sound map when you want play sound.
87
- *
88
- * @example
89
- *
90
- * ```ts
91
- * import { DialerPadSoundsMPEG } from '@ringcentral/spring-ui';
92
- * import { DialerPadSoundsOGG } from '@ringcentral/spring-ui';
93
- * ```
94
- */
95
24
  sounds?: DialPadSoundMap | undefined;
96
- /** volume of keypad sound */
97
25
  volume?: number | undefined;
98
- /** is keypad sound muted */
99
26
  muted?: boolean | undefined;
100
- /**
101
- * sinkId of keypad sound
102
- *
103
- * @important
104
- * Safari is not supported the `setSinkId` method
105
- * https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/setSinkId#browser_compatibility
106
- */
107
27
  sinkId?: string | undefined;
108
- /**
109
- * long press '0' time to typing '+'
110
- *
111
- * @default 1000ms
112
- */
113
28
  longPressDelay?: number | undefined;
114
- /**
115
- * time of persist button background when manual trigger by 'actionRef'
116
- * button background will not persist if persistBgTime less than 0
117
- * @default 200
118
- * */
119
29
  persistBgTime?: number | undefined;
120
- /**
121
- * make that dialPad size auto fixed container width
122
- *
123
- * @default true
124
- */
125
30
  autoSize?: boolean | undefined;
126
- /** can manual trigger audio by ref */
127
31
  action?: Ref<DialPadAction> | undefined;
128
- /**
129
- * control inner action,
130
- * ### you should use with `useDialKeyboard`
131
- */
132
32
  control?: Ref<DialPadControl> | undefined;
133
- /** method to get addition props for below each `DialPadButton` */
134
33
  getDialPadButtonProps?: ((value: DIALER_PAD_ICON_VALUES) => Omit<IconButtonProps, 'value' | 'onKeyDown' | 'onFocus'> & HTMLDataAttribute) | undefined;
135
- /**
136
- * size of dialPad
137
- *
138
- * @default 'large'
139
- */
140
34
  size?: "medium" | "large" | undefined;
141
35
  } & Omit<HTMLAttributes<HTMLDivElement>, "onChange"> & Pick<DialPadButtonProps, "classes"> & import("react").RefAttributes<HTMLDivElement>>;
142
36
  export type { DialPadAction, DialPadOnChangeReason, DialPadProps };
@@ -1,11 +1,6 @@
1
1
  export declare type DialPadAction = {
2
- /**
3
- * play key audio
4
- * @returns return false if key isn't acceptable
5
- */
6
2
  playAudio: (key: string) => false | Promise<void>;
7
3
  };
8
- /** inner props ref, should prevent import that directly */
9
4
  export declare type DialPadControl = {
10
5
  handleKeyboardEffect: (value: string, isKeyup: boolean) => void;
11
6
  };
@@ -4,11 +4,6 @@ export declare type UseDialKeyboard<E extends KeyboardEvent | React.KeyboardEven
4
4
  onKeyDown?: (e: E) => void;
5
5
  onKeyUp?: (e: E) => void;
6
6
  };
7
- /**
8
- * Provide you can get event apply on trigger events area
9
- * @param options onKeyDown, onKeyUp that you also want apply on target
10
- * @returns onKeyDown, onKeyUp, control
11
- */
12
7
  export declare const useDialKeyboard: <E extends KeyboardEvent | import("react").KeyboardEvent<any> = import("react").KeyboardEvent<any>>({ onKeyDown: onKeyDownArg, onKeyUp: onKeyUpArg, }?: UseDialKeyboard<E>) => {
13
8
  onKeyDown: (e: E) => void;
14
9
  onKeyUp: (e: E) => void;
@@ -1,15 +1,6 @@
1
1
  import { DialPadSoundMap } from './DialPadUtils';
2
2
  export declare type UseKeyAudioOptions = {
3
3
  sounds?: DialPadSoundMap;
4
- /**
5
- * custom audio process, you can custom audio process when you want to custom audio process
6
- */
7
4
  processor?: (audio: HTMLAudioElement) => void;
8
5
  };
9
- /**
10
- * Custom hook that handles playing audio for key presses in a dial pad.
11
- *
12
- * @param audioOption - The audio options for configuring the hook.
13
- * @returns A function that plays the audio for a given key.
14
- */
15
6
  export declare const useKeyAudio: ({ sounds, processor }: UseKeyAudioOptions) => (key: string) => false | Promise<void>;
@@ -3,24 +3,10 @@ import { IconButtonProps } from '../../IconButton';
3
3
  import { DialPadOnChangeReason } from '../DialPad';
4
4
  import dialPadButtonStyle from './styles/DialPadButton.css';
5
5
  export declare type DialPadButtonProps = {
6
- /** output value when press */
7
6
  value: string;
8
- /** output value when long press */
9
7
  longPressValue?: string;
10
- /**
11
- * time for long press delay trigger
12
- *
13
- * @default 1000ms
14
- */
15
8
  longPressDelay?: number;
16
- /** emit effect when trigger number enter */
17
9
  onKeyEffect?: (value: string, reason: DialPadOnChangeReason) => void;
18
- /**
19
- * the inner icon size of the Icon container
20
- *
21
- * - medium: `32.25%`;
22
- * - large: `64.5%`;
23
- */
24
10
  iconSize?: 'medium' | 'large';
25
11
  } & Omit<IconButtonProps, 'color'>;
26
12
  declare const DialPadButton: FunctionComponent<DialPadButtonProps>;
@@ -2,34 +2,11 @@
2
2
  import { TextFieldProps } from '../../TextField';
3
3
  import { DialPadOnChangeReason } from '../DialPad';
4
4
  declare type DialTextFieldProps = {
5
- /** for custom window */
6
5
  externalWindow?: Window;
7
- /** current value */
8
6
  value: string;
9
- /** emit when value change */
10
7
  onChange(value: string): unknown;
11
- /**
12
- * emit latest trigger value, that will be helpful when you in `keypadMode`, and `onlyAllowKeypadValue`
13
- * `reason` for trigger from what event
14
- */
15
8
  onEmit?: (value: string, reason: DialPadOnChangeReason) => void;
16
- /**
17
- * only allow keypad value 1234567890*+#
18
- *
19
- * will be enable when `keypadMode` is true by default
20
- */
21
9
  onlyAllowKeypadValue?: boolean;
22
- /**
23
- * is that in keypad mode, keypad mode
24
- *
25
- * 1. only dialer keypad key can be typing 1234567890*+#
26
- * 2. can't select text
27
- * 3. can't delete text
28
- * 4. can't change cursor position
29
- * 5. keep focus position in the latest
30
- * 6. non maxLength
31
- * 7. when pasting a value into a TextField, the sounds emit one by one at 300ms intervals and trigger `onEmit` when intervals done.
32
- */
33
10
  keypadMode?: boolean;
34
11
  } & Omit<TextFieldProps, 'onChange' | 'value' | 'onClear' | 'clearBtn'>;
35
12
  declare const DialTextField: import("react").ForwardRefExoticComponent<Pick<DialTextFieldProps, "error" | "value" | "onKeyDown" | "onKeyUp" | "onClick" | "disabled" | "label" | "classes" | "focused" | "required" | "className" | "id" | "defaultValue" | "placeholder" | "readOnly" | "size" | "type" | "externalWindow" | "onFocus" | "onBlur" | "onChange" | "helperText" | "FormHelperTextProps" | "variant" | "fullWidth" | "autoFocus" | "inputProps" | "inputRef" | "endAdornment" | "startAdornment" | "RootProps" | "useNativeClearBtn" | "clearText" | "showCharacterCount" | "ClearButtonProps" | "inputComponent" | "showMaskValueToggleButton" | "maskValue" | "onMaskValueChange" | "MaskValueButtonProps" | "ShowHideEyeIconProps" | "onEmit" | "onlyAllowKeypadValue" | "keypadMode"> & import("react").RefAttributes<HTMLDivElement>>;
@@ -1,4 +1 @@
1
- /**
2
- * return regex with only allow dialPad value `1234567890*+#-`
3
- */
4
1
  export declare function getDialPadValueOnlyRegex(): RegExp;
@@ -1,7 +1,4 @@
1
1
  import { KeyboardEvent } from 'react';
2
- /**
3
- * bind with ref, let input can always focus at end of latest character
4
- */
5
2
  export declare const useFixedEndSelection: () => {
6
3
  ref: import("react").RefObject<HTMLInputElement>;
7
4
  onFocus: () => void;
@@ -6,19 +6,8 @@ export declare type DialogSize = 'small' | 'medium' | 'large' | 'fullHeight' | '
6
6
  export declare type DialogPlacement = 'left' | 'right';
7
7
  export declare type DialogCloseReason = ModalCloseReason | 'closeButtonClick';
8
8
  export declare type DialogProps = StandardProps<{
9
- /**
10
- * The size of the dialog.
11
- * @default "medium"
12
- */
13
9
  size?: DialogSize;
14
- /**
15
- * The placement of the dialog. Only applies to size `fullHeight`.
16
- * @default "right"
17
- */
18
10
  placement?: DialogPlacement;
19
- /**
20
- * The props passed to the body slot of body.
21
- */
22
11
  bodyProps?: GroupedMotionProps<ComponentPropsWithRef<'div'> & HTMLDataAttribute>;
23
12
  open: boolean;
24
13
  onClose?: (event: SyntheticEvent<HTMLElement | HTMLButtonElement>, reason: DialogCloseReason) => void;
@@ -5,26 +5,9 @@ declare type ExtendElementType = 'hr' | 'li' | 'div';
5
5
  export declare type DividerVariant = 'full' | 'middle';
6
6
  export declare type DividerOrientation = 'horizontal' | 'vertical';
7
7
  declare type BaseDividerProps = WithClassesProps<{
8
- /**
9
- * @default 'full'
10
- */
11
8
  variant?: DividerVariant;
12
- /**
13
- * @default 'horizontal'
14
- */
15
9
  orientation?: DividerOrientation;
16
- /**
17
- * The title of the Divider. Only used for horizontal Dividers.
18
- * Make sure to pass an `after:bg-color` className.
19
- */
20
10
  title?: string;
21
- /**
22
- * If true, a vertical divider will have the correct height when used in flex container.
23
- * (By default, a vertical divider will have a calculated height of 0px
24
- * if it is the child of a flex container.)
25
- *
26
- * @default false
27
- */
28
11
  flexItem?: boolean;
29
12
  }, DividerClassesKey>;
30
13
  export declare type DividerProps<T extends ExtendElementType = DefaultElementType> = OverridableProps<BaseDividerProps, T>;
@@ -3,10 +3,6 @@ import { DragHandleClassesKey } from './DragHandle.classes';
3
3
  declare type DefaultElementType = 'div';
4
4
  export declare type DragHandleAnchor = 'top' | 'bottom';
5
5
  declare type BaseDragHandleProps = WithClassesProps<{
6
- /**
7
- * The anchor position to determine handle orientation
8
- * @default 'top'
9
- */
10
6
  anchor?: DragHandleAnchor;
11
7
  }, DragHandleClassesKey>;
12
8
  export declare type DragHandleProps<T extends DefaultElementType = DefaultElementType> = OverridableProps<BaseDragHandleProps, T>;
@@ -1,33 +1,5 @@
1
1
  /// <reference types="react" />
2
2
  import { DrawerProps } from './Drawer.type';
3
3
  import drawerStyles from './styles/Drawer.css';
4
- /**
5
- * Drawer Component - Base drawer without gesture support
6
- *
7
- * A clean, lightweight drawer component that provides basic modal/slide functionality.
8
- * For gesture support, use SwipeableDrawer which builds on top of this component.
9
- *
10
- * @example
11
- * ```tsx
12
- * // Simple navigation drawer
13
- * <Drawer
14
- * open={open}
15
- * onClose={onClose}
16
- * anchor="left"
17
- * variant="temporary"
18
- * >
19
- * <Navigation />
20
- * </Drawer>
21
- *
22
- * // Bottom sheet without gestures
23
- * <Drawer
24
- * open={open}
25
- * onClose={onClose}
26
- * anchor="bottom"
27
- * >
28
- * <Content />
29
- * </Drawer>
30
- * ```
31
- */
32
4
  declare const Drawer: import("react").ForwardRefExoticComponent<Pick<DrawerProps, "children" | "onKeyDown" | "onKeyUp" | "onClick" | "aria-hidden" | "dir" | "footer" | "header" | "slot" | "style" | "title" | "aria-live" | "aria-atomic" | "role" | "classes" | "anchor" | "className" | "accessKey" | "draggable" | "hidden" | "lang" | "translate" | "id" | "prefix" | "contentEditable" | "inputMode" | "tabIndex" | "key" | "defaultChecked" | "defaultValue" | "placeholder" | "container" | "isEnabled" | "onFocus" | "onBlur" | "onMouseEnter" | "onMouseLeave" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "contextMenu" | "spellCheck" | "radioGroup" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "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" | `data-${string}` | "variant" | "open" | "disableRestoreFocus" | "disableAutoFocus" | "disableEnforceFocus" | "hideBackdrop" | "disableBackdropClick" | "onBackdropClick" | "disableEscapeKeyDown" | "onEscapeKeyDown" | "onClose" | "backdropProps" | "blocking" | "motionProps" | "disablePortal" | "onExitComplete" | "disableBackdropAnimation" | "disableScrollLock" | "bodyProps" | "measurementRefs" | "headerProps"> & import("react").RefAttributes<HTMLDivElement>>;
33
5
  export { Drawer, drawerStyles };