@itwin/itwinui-react 1.34.1 → 1.36.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 (136) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/cjs/core/ButtonGroup/ButtonGroup.js +1 -0
  3. package/cjs/core/Carousel/Carousel.d.ts +68 -0
  4. package/cjs/core/Carousel/Carousel.js +130 -0
  5. package/cjs/core/Carousel/CarouselContext.d.ts +37 -0
  6. package/cjs/core/Carousel/CarouselContext.js +12 -0
  7. package/cjs/core/Carousel/CarouselDot.d.ts +13 -0
  8. package/cjs/core/Carousel/CarouselDot.js +46 -0
  9. package/cjs/core/Carousel/CarouselDotsList.d.ts +32 -0
  10. package/cjs/core/Carousel/CarouselDotsList.js +132 -0
  11. package/cjs/core/Carousel/CarouselNavigation.d.ts +15 -0
  12. package/cjs/core/Carousel/CarouselNavigation.js +88 -0
  13. package/cjs/core/Carousel/CarouselSlide.d.ts +14 -0
  14. package/cjs/core/Carousel/CarouselSlide.js +63 -0
  15. package/cjs/core/Carousel/CarouselSlider.d.ts +5 -0
  16. package/cjs/core/Carousel/CarouselSlider.js +94 -0
  17. package/cjs/core/Carousel/index.d.ts +4 -0
  18. package/cjs/core/Carousel/index.js +10 -0
  19. package/cjs/core/ColorPicker/ColorSwatch.d.ts +1 -1
  20. package/cjs/core/DatePicker/DatePicker.d.ts +5 -0
  21. package/cjs/core/DatePicker/DatePicker.js +38 -13
  22. package/cjs/core/Menu/Menu.js +8 -3
  23. package/cjs/core/Modal/Modal.d.ts +5 -0
  24. package/cjs/core/Modal/Modal.js +11 -9
  25. package/cjs/core/Modal/ModalContent.d.ts +14 -0
  26. package/cjs/core/Modal/ModalContent.js +46 -0
  27. package/cjs/core/Modal/index.d.ts +2 -0
  28. package/cjs/core/Modal/index.js +3 -1
  29. package/cjs/core/Table/Table.d.ts +1 -0
  30. package/cjs/core/Table/Table.js +34 -20
  31. package/cjs/core/Table/TableCell.js +3 -3
  32. package/cjs/core/Table/TableRowMemoized.js +12 -7
  33. package/cjs/core/Table/actionHandlers/index.d.ts +2 -1
  34. package/cjs/core/Table/actionHandlers/index.js +5 -1
  35. package/cjs/core/Table/cells/DefaultCell.d.ts +1 -1
  36. package/cjs/core/Table/cells/DefaultCell.js +5 -2
  37. package/cjs/core/Table/columns/actionColumn.d.ts +35 -0
  38. package/cjs/core/Table/columns/actionColumn.js +91 -0
  39. package/cjs/core/Table/columns/expanderColumn.d.ts +47 -0
  40. package/cjs/core/Table/columns/expanderColumn.js +81 -0
  41. package/cjs/core/Table/columns/index.d.ts +3 -0
  42. package/cjs/core/Table/columns/index.js +15 -0
  43. package/cjs/core/Table/columns/selectionColumn.d.ts +35 -0
  44. package/cjs/core/Table/columns/selectionColumn.js +67 -0
  45. package/cjs/core/Table/filters/DateRangeFilter/DateRangeFilter.js +18 -2
  46. package/cjs/core/Table/hooks/index.d.ts +2 -2
  47. package/cjs/core/Table/hooks/index.js +1 -3
  48. package/cjs/core/Table/hooks/useExpanderCell.d.ts +0 -1
  49. package/cjs/core/Table/hooks/useExpanderCell.js +25 -39
  50. package/cjs/core/Table/hooks/useResizeColumns.js +8 -2
  51. package/cjs/core/Table/hooks/useSelectionCell.d.ts +0 -1
  52. package/cjs/core/Table/hooks/useSelectionCell.js +6 -52
  53. package/cjs/core/Table/index.d.ts +1 -0
  54. package/cjs/core/Table/index.js +5 -1
  55. package/cjs/core/Table/utils.js +1 -1
  56. package/cjs/core/Toast/Toast.js +1 -1
  57. package/cjs/core/Typography/Anchor/Anchor.d.ts +1 -0
  58. package/cjs/core/Typography/Anchor/Anchor.js +1 -0
  59. package/cjs/core/index.d.ts +5 -3
  60. package/cjs/core/index.js +9 -2
  61. package/cjs/core/utils/components/Popover.js +13 -1
  62. package/cjs/core/utils/hooks/index.d.ts +1 -0
  63. package/cjs/core/utils/hooks/index.js +1 -0
  64. package/cjs/core/utils/hooks/useMediaQuery.d.ts +2 -0
  65. package/cjs/core/utils/hooks/useMediaQuery.js +46 -0
  66. package/cjs/core/utils/hooks/useTheme.d.ts +5 -0
  67. package/cjs/core/utils/hooks/useTheme.js +20 -14
  68. package/cjs/types/react-table-config.d.ts +18 -0
  69. package/esm/core/ButtonGroup/ButtonGroup.js +1 -0
  70. package/esm/core/Carousel/Carousel.d.ts +68 -0
  71. package/esm/core/Carousel/Carousel.js +124 -0
  72. package/esm/core/Carousel/CarouselContext.d.ts +37 -0
  73. package/esm/core/Carousel/CarouselContext.js +6 -0
  74. package/esm/core/Carousel/CarouselDot.d.ts +13 -0
  75. package/esm/core/Carousel/CarouselDot.js +40 -0
  76. package/esm/core/Carousel/CarouselDotsList.d.ts +32 -0
  77. package/esm/core/Carousel/CarouselDotsList.js +126 -0
  78. package/esm/core/Carousel/CarouselNavigation.d.ts +15 -0
  79. package/esm/core/Carousel/CarouselNavigation.js +82 -0
  80. package/esm/core/Carousel/CarouselSlide.d.ts +14 -0
  81. package/esm/core/Carousel/CarouselSlide.js +57 -0
  82. package/esm/core/Carousel/CarouselSlider.d.ts +5 -0
  83. package/esm/core/Carousel/CarouselSlider.js +88 -0
  84. package/esm/core/Carousel/index.d.ts +4 -0
  85. package/esm/core/Carousel/index.js +6 -0
  86. package/esm/core/ColorPicker/ColorSwatch.d.ts +1 -1
  87. package/esm/core/DatePicker/DatePicker.d.ts +5 -0
  88. package/esm/core/DatePicker/DatePicker.js +38 -13
  89. package/esm/core/Menu/Menu.js +8 -3
  90. package/esm/core/Modal/Modal.d.ts +5 -0
  91. package/esm/core/Modal/Modal.js +11 -9
  92. package/esm/core/Modal/ModalContent.d.ts +14 -0
  93. package/esm/core/Modal/ModalContent.js +39 -0
  94. package/esm/core/Modal/index.d.ts +2 -0
  95. package/esm/core/Modal/index.js +1 -0
  96. package/esm/core/Table/Table.d.ts +1 -0
  97. package/esm/core/Table/Table.js +30 -16
  98. package/esm/core/Table/TableCell.js +2 -2
  99. package/esm/core/Table/TableRowMemoized.js +12 -7
  100. package/esm/core/Table/actionHandlers/index.d.ts +2 -1
  101. package/esm/core/Table/actionHandlers/index.js +2 -1
  102. package/esm/core/Table/cells/DefaultCell.d.ts +1 -1
  103. package/esm/core/Table/cells/DefaultCell.js +5 -2
  104. package/esm/core/Table/columns/actionColumn.d.ts +35 -0
  105. package/esm/core/Table/columns/actionColumn.js +84 -0
  106. package/esm/core/Table/columns/expanderColumn.d.ts +47 -0
  107. package/esm/core/Table/columns/expanderColumn.js +74 -0
  108. package/esm/core/Table/columns/index.d.ts +3 -0
  109. package/esm/core/Table/columns/index.js +7 -0
  110. package/esm/core/Table/columns/selectionColumn.d.ts +35 -0
  111. package/esm/core/Table/columns/selectionColumn.js +60 -0
  112. package/esm/core/Table/filters/DateRangeFilter/DateRangeFilter.js +18 -2
  113. package/esm/core/Table/hooks/index.d.ts +2 -2
  114. package/esm/core/Table/hooks/index.js +2 -2
  115. package/esm/core/Table/hooks/useExpanderCell.d.ts +0 -1
  116. package/esm/core/Table/hooks/useExpanderCell.js +24 -35
  117. package/esm/core/Table/hooks/useResizeColumns.js +8 -2
  118. package/esm/core/Table/hooks/useSelectionCell.d.ts +0 -1
  119. package/esm/core/Table/hooks/useSelectionCell.js +5 -48
  120. package/esm/core/Table/index.d.ts +1 -0
  121. package/esm/core/Table/index.js +1 -0
  122. package/esm/core/Table/utils.js +1 -1
  123. package/esm/core/Toast/Toast.js +1 -1
  124. package/esm/core/Typography/Anchor/Anchor.d.ts +1 -0
  125. package/esm/core/Typography/Anchor/Anchor.js +1 -0
  126. package/esm/core/index.d.ts +5 -3
  127. package/esm/core/index.js +3 -2
  128. package/esm/core/utils/components/Popover.js +13 -1
  129. package/esm/core/utils/hooks/index.d.ts +1 -0
  130. package/esm/core/utils/hooks/index.js +1 -0
  131. package/esm/core/utils/hooks/useMediaQuery.d.ts +2 -0
  132. package/esm/core/utils/hooks/useMediaQuery.js +39 -0
  133. package/esm/core/utils/hooks/useTheme.d.ts +5 -0
  134. package/esm/core/utils/hooks/useTheme.js +20 -14
  135. package/esm/types/react-table-config.d.ts +18 -0
  136. package/package.json +3 -2
@@ -11,6 +11,7 @@ exports.useTheme = void 0;
11
11
  var react_1 = __importDefault(require("react"));
12
12
  require("@itwin/itwinui-css/css/global.css");
13
13
  var dom_1 = require("../functions/dom");
14
+ var useMediaQuery_1 = require("./useMediaQuery");
14
15
  /**
15
16
  * Hook that applies styling and theme to all components.
16
17
  * Defaults to light theme if none provided or set elsewhere.
@@ -20,6 +21,8 @@ var dom_1 = require("../functions/dom");
20
21
  var useTheme = function (theme, themeOptions) {
21
22
  var _a;
22
23
  var ownerDocument = (_a = themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.ownerDocument) !== null && _a !== void 0 ? _a : (0, dom_1.getDocument)();
24
+ var prefersHighContrast = (0, useMediaQuery_1.useMediaQuery)('(prefers-contrast: more)');
25
+ var highContrast = react_1.default.useMemo(function () { var _a; return !!((_a = themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.highContrast) !== null && _a !== void 0 ? _a : prefersHighContrast); }, [prefersHighContrast, themeOptions === null || themeOptions === void 0 ? void 0 : themeOptions.highContrast]);
23
26
  react_1.default.useLayoutEffect(function () {
24
27
  if (!(ownerDocument === null || ownerDocument === void 0 ? void 0 : ownerDocument.body.classList.contains('iui-body'))) {
25
28
  ownerDocument === null || ownerDocument === void 0 ? void 0 : ownerDocument.body.classList.add('iui-body');
@@ -34,20 +37,20 @@ var useTheme = function (theme, themeOptions) {
34
37
  var addOSTheme = function (_a) {
35
38
  var isDark = _a.matches;
36
39
  if (isDark) {
37
- addDarkTheme(ownerDocument);
40
+ applyTheme('dark', { ownerDocument: ownerDocument, highContrast: highContrast });
38
41
  }
39
42
  else {
40
- addLightTheme(ownerDocument);
43
+ applyTheme('light', { ownerDocument: ownerDocument, highContrast: highContrast });
41
44
  }
42
45
  };
43
46
  switch (theme) {
44
47
  case 'light':
45
48
  (_c = prefersDarkMediaQuery === null || prefersDarkMediaQuery === void 0 ? void 0 : prefersDarkMediaQuery.removeEventListener) === null || _c === void 0 ? void 0 : _c.call(prefersDarkMediaQuery, 'change', addOSTheme);
46
- addLightTheme(ownerDocument);
49
+ applyTheme('light', { ownerDocument: ownerDocument, highContrast: highContrast });
47
50
  break;
48
51
  case 'dark':
49
52
  (_d = prefersDarkMediaQuery === null || prefersDarkMediaQuery === void 0 ? void 0 : prefersDarkMediaQuery.removeEventListener) === null || _d === void 0 ? void 0 : _d.call(prefersDarkMediaQuery, 'change', addOSTheme);
50
- addDarkTheme(ownerDocument);
53
+ applyTheme('dark', { ownerDocument: ownerDocument, highContrast: highContrast });
51
54
  break;
52
55
  case 'os':
53
56
  if (prefersDarkMediaQuery != undefined) {
@@ -55,26 +58,29 @@ var useTheme = function (theme, themeOptions) {
55
58
  (_e = prefersDarkMediaQuery.addEventListener) === null || _e === void 0 ? void 0 : _e.call(prefersDarkMediaQuery, 'change', addOSTheme);
56
59
  }
57
60
  else {
58
- addLightTheme(ownerDocument);
61
+ applyTheme('light', { ownerDocument: ownerDocument, highContrast: highContrast });
59
62
  }
60
63
  break;
61
64
  default:
62
65
  if (ownerDocument.documentElement.className.indexOf('iui-theme') === -1) {
63
- addLightTheme(ownerDocument);
66
+ applyTheme('light', { ownerDocument: ownerDocument, highContrast: highContrast });
64
67
  }
65
68
  }
66
69
  return function () {
67
70
  var _a;
68
71
  (_a = prefersDarkMediaQuery === null || prefersDarkMediaQuery === void 0 ? void 0 : prefersDarkMediaQuery.removeEventListener) === null || _a === void 0 ? void 0 : _a.call(prefersDarkMediaQuery, 'change', addOSTheme);
69
72
  };
70
- }, [ownerDocument, theme]);
73
+ }, [highContrast, ownerDocument, theme]);
71
74
  };
72
75
  exports.useTheme = useTheme;
73
- var addLightTheme = function (ownerDocument) {
74
- ownerDocument.documentElement.classList.add('iui-theme-light');
75
- ownerDocument.documentElement.classList.remove('iui-theme-dark');
76
- };
77
- var addDarkTheme = function (ownerDocument) {
78
- ownerDocument.documentElement.classList.add('iui-theme-dark');
79
- ownerDocument.documentElement.classList.remove('iui-theme-light');
76
+ var applyTheme = function (theme, _a) {
77
+ var ownerDocument = _a.ownerDocument, highContrast = _a.highContrast;
78
+ var classList = ownerDocument.documentElement.classList;
79
+ var currentTheme = Array.from(classList).find(function (cls) {
80
+ return cls.startsWith('iui-theme');
81
+ });
82
+ if (currentTheme) {
83
+ classList.remove(currentTheme);
84
+ }
85
+ classList.add("iui-theme-" + theme + (highContrast ? '-hc' : ''));
80
86
  };
@@ -2,9 +2,22 @@
2
2
  declare module 'react-table' {
3
3
  type FieldType = 'text' | 'number' | 'date' | string;
4
4
  type CellRendererProps<D extends object = {}> = {
5
+ /**
6
+ * Cell HTML props passed from the Table.
7
+ */
5
8
  cellElementProps: TableCellProps;
9
+ /**
10
+ * Table specific cell props like `column`, `row`.
11
+ */
6
12
  cellProps: CellProps<D>;
13
+ /**
14
+ * Cell's content.
15
+ */
7
16
  children: React.ReactNode;
17
+ /**
18
+ * Function that returns whether the cell is disabled.
19
+ */
20
+ isDisabled?: (rowData: D) => boolean;
8
21
  };
9
22
  interface TableOptions<D extends object = {}> extends Omit<UseTableOptions<D>, 'data'>, UseRowSelectOptions<D>, UseExpandedOptions<D>, UseFiltersOptions<D>, UsePaginationOptions<D>, Omit<UseResizeColumnsOptions<D>, 'disableResizing'>, UseSortByOptions<D> {
10
23
  /**
@@ -73,6 +86,11 @@ declare module 'react-table' {
73
86
  * @default false
74
87
  */
75
88
  disableReordering?: boolean;
89
+ /**
90
+ * If true, column's visibility cannot be toggled.
91
+ * @default false
92
+ */
93
+ disableToggleVisibility?: boolean;
76
94
  }
77
95
  interface ColumnInstance<D extends object = {}> extends UseFiltersColumnProps<D>, UseGroupByColumnProps<D>, UseResizeColumnsColumnProps<D>, UseSortByColumnProps<D> {
78
96
  originalWidth: number;
@@ -65,6 +65,7 @@ export var ButtonGroup = React.forwardRef(function (props, ref) {
65
65
  return (React.createElement("div", __assign({ className: cx({
66
66
  'iui-button-group': orientation === 'horizontal',
67
67
  'iui-button-group-vertical': orientation === 'vertical',
68
+ 'iui-button-group-overflow-x': !!overflowButton && orientation === 'horizontal',
68
69
  }, className), "aria-orientation": orientation, ref: refs }, rest), !!overflowButton && visibleCount < items.length ? (React.createElement(React.Fragment, null,
69
70
  overflowButton && overflowPlacement === 'start' && (React.createElement("div", null, overflowButton(visibleCount))),
70
71
  items.slice(0, visibleCount - 1),
@@ -0,0 +1,68 @@
1
+ import React from 'react';
2
+ import '@itwin/itwinui-css/css/carousel.css';
3
+ export declare type CarouselProps = {
4
+ /**
5
+ * Index of the currently shown slide.
6
+ * Can be used to set the default index or control the active slide programmatically.
7
+ * @default 0
8
+ */
9
+ activeSlideIndex?: number;
10
+ /**
11
+ * Callback fired when the current slide changes.
12
+ */
13
+ onSlideChange?: (index: number) => void;
14
+ } & React.ComponentPropsWithoutRef<'div'>;
15
+ /**
16
+ * The Carousel component consists of a set of slides, normally displayed one at a time. A navigation section is
17
+ * located below the slides, consisting of "dots" and "previous"/"next" buttons, used for changing slides.
18
+ *
19
+ * The currently shown slide can also be changed using the left/right arrow keys or by dragging on a touch device.
20
+ *
21
+ * This component uses a composition approach so it should be used with the provided subcomponents.
22
+ *
23
+ * @example
24
+ * <Carousel>
25
+ * <Carousel.Slider>
26
+ * <Carousel.Slide>...</Carousel.Slide>
27
+ * <Carousel.Slide>...</Carousel.Slide>
28
+ * <Carousel.Slide>...</Carousel.Slide>
29
+ * </Carousel.Slider>
30
+ * <Carousel.Navigation />
31
+ * </Carousel>
32
+ */
33
+ export declare const Carousel: React.ForwardRefExoticComponent<{
34
+ /**
35
+ * Index of the currently shown slide.
36
+ * Can be used to set the default index or control the active slide programmatically.
37
+ * @default 0
38
+ */
39
+ activeSlideIndex?: number | undefined;
40
+ /**
41
+ * Callback fired when the current slide changes.
42
+ */
43
+ onSlideChange?: ((index: number) => void) | undefined;
44
+ } & Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & React.RefAttributes<HTMLElement>> & {
45
+ Slider: React.ForwardRefExoticComponent<Pick<React.DetailedHTMLProps<React.OlHTMLAttributes<HTMLOListElement>, HTMLOListElement>, "key" | keyof React.OlHTMLAttributes<HTMLOListElement>> & React.RefAttributes<HTMLOListElement>>;
46
+ Slide: React.ForwardRefExoticComponent<{
47
+ index?: number | undefined;
48
+ } & Pick<React.DetailedHTMLProps<React.LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "key" | keyof React.LiHTMLAttributes<HTMLLIElement>> & React.RefAttributes<HTMLLIElement>>;
49
+ Navigation: React.ForwardRefExoticComponent<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>, "key" | keyof React.HTMLAttributes<HTMLElement>> & React.RefAttributes<HTMLElement>> & {
50
+ PreviousButton: React.ForwardRefExoticComponent<{
51
+ isActive?: boolean | undefined;
52
+ } & Omit<import("..").ButtonProps<"button">, "startIcon" | "endIcon"> & React.RefAttributes<HTMLButtonElement>>;
53
+ NextButton: React.ForwardRefExoticComponent<{
54
+ isActive?: boolean | undefined;
55
+ } & Omit<import("..").ButtonProps<"button">, "startIcon" | "endIcon"> & React.RefAttributes<HTMLButtonElement>>;
56
+ };
57
+ DotsList: React.ForwardRefExoticComponent<{
58
+ length?: number | undefined;
59
+ currentIndex?: number | undefined;
60
+ onSlideChange?: ((index: number) => void) | undefined;
61
+ } & Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & React.RefAttributes<HTMLDivElement>>;
62
+ Dot: React.ForwardRefExoticComponent<{
63
+ isActive?: boolean | undefined;
64
+ isSmall?: boolean | undefined;
65
+ isSmaller?: boolean | undefined;
66
+ } & Pick<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "key" | keyof React.ButtonHTMLAttributes<HTMLButtonElement>> & React.RefAttributes<HTMLButtonElement>>;
67
+ };
68
+ export default Carousel;
@@ -0,0 +1,124 @@
1
+ var __assign = (this && this.__assign) || function () {
2
+ __assign = Object.assign || function(t) {
3
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
4
+ s = arguments[i];
5
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
6
+ t[p] = s[p];
7
+ }
8
+ return t;
9
+ };
10
+ return __assign.apply(this, arguments);
11
+ };
12
+ var __rest = (this && this.__rest) || function (s, e) {
13
+ var t = {};
14
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
15
+ t[p] = s[p];
16
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
17
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
18
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
19
+ t[p[i]] = s[p[i]];
20
+ }
21
+ return t;
22
+ };
23
+ /*---------------------------------------------------------------------------------------------
24
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
25
+ * See LICENSE.md in the project root for license terms and full copyright notice.
26
+ *--------------------------------------------------------------------------------------------*/
27
+ import React from 'react';
28
+ import cx from 'classnames';
29
+ import { getRandomValue, useMergedRefs, useTheme } from '../utils';
30
+ import '@itwin/itwinui-css/css/carousel.css';
31
+ import { CarouselContext } from './CarouselContext';
32
+ import { CarouselSlider } from './CarouselSlider';
33
+ import { CarouselSlide } from './CarouselSlide';
34
+ import { CarouselDotsList } from './CarouselDotsList';
35
+ import { CarouselDot } from './CarouselDot';
36
+ import { CarouselNavigation } from './CarouselNavigation';
37
+ /**
38
+ * The Carousel component consists of a set of slides, normally displayed one at a time. A navigation section is
39
+ * located below the slides, consisting of "dots" and "previous"/"next" buttons, used for changing slides.
40
+ *
41
+ * The currently shown slide can also be changed using the left/right arrow keys or by dragging on a touch device.
42
+ *
43
+ * This component uses a composition approach so it should be used with the provided subcomponents.
44
+ *
45
+ * @example
46
+ * <Carousel>
47
+ * <Carousel.Slider>
48
+ * <Carousel.Slide>...</Carousel.Slide>
49
+ * <Carousel.Slide>...</Carousel.Slide>
50
+ * <Carousel.Slide>...</Carousel.Slide>
51
+ * </Carousel.Slider>
52
+ * <Carousel.Navigation />
53
+ * </Carousel>
54
+ */
55
+ export var Carousel = Object.assign(React.forwardRef(function (props, ref) {
56
+ var _a = props.activeSlideIndex, userActiveIndex = _a === void 0 ? 0 : _a, onSlideChange = props.onSlideChange, className = props.className, children = props.children, rest = __rest(props, ["activeSlideIndex", "onSlideChange", "className", "children"]);
57
+ // Generate a stateful random id if not specified
58
+ var id = React.useState(function () { var _a; return (_a = props.id) !== null && _a !== void 0 ? _a : "iui-carousel-" + getRandomValue(10); })[0];
59
+ useTheme();
60
+ var isManuallyUpdating = React.useRef(false);
61
+ var scrollInstantly = React.useRef(false);
62
+ var carouselRef = React.useRef(null);
63
+ var refs = useMergedRefs(carouselRef, ref);
64
+ var _b = React.useState(userActiveIndex), currentIndex = _b[0], _setCurrentIndex = _b[1];
65
+ React.useEffect(function () {
66
+ _setCurrentIndex(userActiveIndex);
67
+ }, [userActiveIndex]);
68
+ var setCurrentIndex = React.useCallback(function (index) {
69
+ var _a;
70
+ _setCurrentIndex(index);
71
+ isManuallyUpdating.current = true;
72
+ (_a = carouselRef.current) === null || _a === void 0 ? void 0 : _a.focus();
73
+ }, []);
74
+ var _c = React.useState(0), slideCount = _c[0], setSlideCount = _c[1];
75
+ var _d = React.useState({}), keysPressed = _d[0], setKeysPressed = _d[1];
76
+ var handleKeyDown = function (event) {
77
+ if (event.altKey || event.ctrlKey || event.metaKey || event.shiftKey) {
78
+ return;
79
+ }
80
+ if (event.key === 'ArrowLeft' || event.key === 'ArrowRight') {
81
+ setKeysPressed(function (old) {
82
+ var _a;
83
+ return (__assign(__assign({}, old), (_a = {}, _a[event.key] = true, _a)));
84
+ });
85
+ }
86
+ };
87
+ var handleKeyUp = function (event) {
88
+ switch (event.key) {
89
+ case 'ArrowLeft': {
90
+ setKeysPressed(function (old) { return (__assign(__assign({}, old), { ArrowLeft: false })); });
91
+ setCurrentIndex(function (old) { return (slideCount + old - 1) % slideCount; });
92
+ break;
93
+ }
94
+ case 'ArrowRight': {
95
+ setKeysPressed(function (old) { return (__assign(__assign({}, old), { ArrowRight: false })); });
96
+ setCurrentIndex(function (old) { return (slideCount + old + 1) % slideCount; });
97
+ break;
98
+ }
99
+ }
100
+ };
101
+ var userOnSlideChange = React.useRef(onSlideChange);
102
+ React.useEffect(function () {
103
+ var _a;
104
+ (_a = userOnSlideChange.current) === null || _a === void 0 ? void 0 : _a.call(userOnSlideChange, currentIndex);
105
+ }, [currentIndex]);
106
+ return (React.createElement("section", __assign({ "aria-roledescription": 'carousel', tabIndex: 0, onKeyDown: handleKeyDown, onKeyUp: handleKeyUp, ref: refs, className: cx('iui-carousel', className) }, rest, { id: id }),
107
+ React.createElement(CarouselContext.Provider, { value: {
108
+ currentIndex: currentIndex,
109
+ setCurrentIndex: setCurrentIndex,
110
+ slideCount: slideCount,
111
+ setSlideCount: setSlideCount,
112
+ keysPressed: keysPressed,
113
+ idPrefix: id,
114
+ isManuallyUpdating: isManuallyUpdating,
115
+ scrollInstantly: scrollInstantly,
116
+ } }, children)));
117
+ }), {
118
+ Slider: CarouselSlider,
119
+ Slide: CarouselSlide,
120
+ Navigation: CarouselNavigation,
121
+ DotsList: CarouselDotsList,
122
+ Dot: CarouselDot,
123
+ });
124
+ export default Carousel;
@@ -0,0 +1,37 @@
1
+ import React from 'react';
2
+ export declare const CarouselContext: React.Context<{
3
+ /**
4
+ * Stateful index of currently active slide.
5
+ */
6
+ currentIndex: number;
7
+ /**
8
+ * State updater for currentIndex.
9
+ */
10
+ setCurrentIndex: (index: number | ((old: number) => void)) => void;
11
+ /**
12
+ * Number of slides in the carousel. Gets set in `CarouselSlider` for reading in `CarouselDotsList`.
13
+ */
14
+ slideCount: number;
15
+ /**
16
+ * State updater for slideCount.
17
+ */
18
+ setSlideCount: (length: number | ((old: number) => void)) => void;
19
+ /**
20
+ * Stateful value of the left/right arrow keys currently pressed.
21
+ */
22
+ keysPressed: Record<string, boolean>;
23
+ /**
24
+ * Prefix used for setting id for internal carousel components.
25
+ */
26
+ idPrefix: string;
27
+ /**
28
+ * Ref object used for preventing intersection observer callback from interfering with manual slide updates.
29
+ *
30
+ * Should be set to true when updating slides using any manual actions (e.g. clicking buttons), and should be set to false when the slide update completes.
31
+ */
32
+ isManuallyUpdating: React.MutableRefObject<boolean>;
33
+ /**
34
+ * Ref object used to skip smooth scrolling when button is clicked too many times.
35
+ */
36
+ scrollInstantly: React.MutableRefObject<boolean>;
37
+ } | undefined>;
@@ -0,0 +1,6 @@
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ import React from 'react';
6
+ export var CarouselContext = React.createContext(undefined);
@@ -0,0 +1,13 @@
1
+ import React from 'react';
2
+ /**
3
+ * `CarouselDot` is the actual "dot" component used to activate a slide on clicking.
4
+ * It should be used as a child of `CarouselDotsList`.
5
+ */
6
+ export declare const CarouselDot: React.ForwardRefExoticComponent<{
7
+ /** Is this dot currently active? */
8
+ isActive?: boolean | undefined;
9
+ /** Should be set to true for dots that are one spot from the edge of truncation. The dot size becomes small. */
10
+ isSmall?: boolean | undefined;
11
+ /** Should be set to true for dots that are at the edge of truncation. The dot size becomes even smaller. */
12
+ isSmaller?: boolean | undefined;
13
+ } & Pick<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "key" | keyof React.ButtonHTMLAttributes<HTMLButtonElement>> & React.RefAttributes<HTMLButtonElement>>;
@@ -0,0 +1,40 @@
1
+ var __assign = (this && this.__assign) || function () {
2
+ __assign = Object.assign || function(t) {
3
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
4
+ s = arguments[i];
5
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
6
+ t[p] = s[p];
7
+ }
8
+ return t;
9
+ };
10
+ return __assign.apply(this, arguments);
11
+ };
12
+ var __rest = (this && this.__rest) || function (s, e) {
13
+ var t = {};
14
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
15
+ t[p] = s[p];
16
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
17
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
18
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
19
+ t[p[i]] = s[p[i]];
20
+ }
21
+ return t;
22
+ };
23
+ /*---------------------------------------------------------------------------------------------
24
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
25
+ * See LICENSE.md in the project root for license terms and full copyright notice.
26
+ *--------------------------------------------------------------------------------------------*/
27
+ import React from 'react';
28
+ import cx from 'classnames';
29
+ /**
30
+ * `CarouselDot` is the actual "dot" component used to activate a slide on clicking.
31
+ * It should be used as a child of `CarouselDotsList`.
32
+ */
33
+ export var CarouselDot = React.forwardRef(function (props, ref) {
34
+ var isActive = props.isActive, isSmaller = props.isSmaller, isSmall = props.isSmall, className = props.className, rest = __rest(props, ["isActive", "isSmaller", "isSmall", "className"]);
35
+ return (React.createElement("button", __assign({ type: 'button', role: 'tab', tabIndex: -1, className: cx('iui-carousel-navigation-dot', {
36
+ 'iui-active': isActive,
37
+ 'iui-first': isSmaller,
38
+ 'iui-second': isSmall,
39
+ }, className), "aria-selected": isActive, ref: ref }, rest)));
40
+ });
@@ -0,0 +1,32 @@
1
+ import React from 'react';
2
+ import '@itwin/itwinui-css/css/carousel.css';
3
+ /**
4
+ * The `CarouselDots` component shows a list of `CarouselDot` components which can be used to
5
+ * choose a specific slide. If used as a descendant of `Carousel`, then this component does not need
6
+ * any props or `children`.
7
+ *
8
+ * The props can be specified if this component is being used outside `Carousel`. `children` can be specified
9
+ * to override the individual dots that are shown.
10
+ *
11
+ * @example
12
+ * <Carousel>
13
+ * // ...
14
+ * <Carousel.Dots />
15
+ * </Carousel>
16
+ *
17
+ * @example
18
+ * <Carousel.Dots
19
+ * length={10}
20
+ * maxCount={3}
21
+ * currentIndex={current}
22
+ * onSlideChange={(i) => setCurrent(i)}
23
+ * />
24
+ */
25
+ export declare const CarouselDotsList: React.ForwardRefExoticComponent<{
26
+ /** Number of total dots/slides in the carousel. Will be inferred from Carousel context or children. Otherwise, it is required to be passed. */
27
+ length?: number | undefined;
28
+ /** Index of currently active dot. Will be inferred from Carousel context, or else default to 0. */
29
+ currentIndex?: number | undefined;
30
+ /** Callback fired when any of the dots are clicked. */
31
+ onSlideChange?: ((index: number) => void) | undefined;
32
+ } & Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & React.RefAttributes<HTMLDivElement>>;
@@ -0,0 +1,126 @@
1
+ var __assign = (this && this.__assign) || function () {
2
+ __assign = Object.assign || function(t) {
3
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
4
+ s = arguments[i];
5
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
6
+ t[p] = s[p];
7
+ }
8
+ return t;
9
+ };
10
+ return __assign.apply(this, arguments);
11
+ };
12
+ var __rest = (this && this.__rest) || function (s, e) {
13
+ var t = {};
14
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
15
+ t[p] = s[p];
16
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
17
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
18
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
19
+ t[p[i]] = s[p[i]];
20
+ }
21
+ return t;
22
+ };
23
+ /*---------------------------------------------------------------------------------------------
24
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
25
+ * See LICENSE.md in the project root for license terms and full copyright notice.
26
+ *--------------------------------------------------------------------------------------------*/
27
+ import React from 'react';
28
+ import cx from 'classnames';
29
+ import { CarouselContext } from './CarouselContext';
30
+ import { getBoundedValue, getWindow, useMergedRefs, useResizeObserver, useTheme, } from '../utils';
31
+ import { CarouselDot } from './CarouselDot';
32
+ import '@itwin/itwinui-css/css/carousel.css';
33
+ /**
34
+ * The `CarouselDots` component shows a list of `CarouselDot` components which can be used to
35
+ * choose a specific slide. If used as a descendant of `Carousel`, then this component does not need
36
+ * any props or `children`.
37
+ *
38
+ * The props can be specified if this component is being used outside `Carousel`. `children` can be specified
39
+ * to override the individual dots that are shown.
40
+ *
41
+ * @example
42
+ * <Carousel>
43
+ * // ...
44
+ * <Carousel.Dots />
45
+ * </Carousel>
46
+ *
47
+ * @example
48
+ * <Carousel.Dots
49
+ * length={10}
50
+ * maxCount={3}
51
+ * currentIndex={current}
52
+ * onSlideChange={(i) => setCurrent(i)}
53
+ * />
54
+ */
55
+ export var CarouselDotsList = React.forwardRef(function (props, ref) {
56
+ var _a, _b, _c;
57
+ var userCurrentIndex = props.currentIndex, length = props.length, className = props.className, onSlideChange = props.onSlideChange, children = props.children, rest = __rest(props, ["currentIndex", "length", "className", "onSlideChange", "children"]);
58
+ useTheme();
59
+ var context = React.useContext(CarouselContext);
60
+ var slideCount = (_a = length !== null && length !== void 0 ? length : context === null || context === void 0 ? void 0 : context.slideCount) !== null && _a !== void 0 ? _a : React.Children.count(children);
61
+ var currentIndex = (_b = userCurrentIndex !== null && userCurrentIndex !== void 0 ? userCurrentIndex : context === null || context === void 0 ? void 0 : context.currentIndex) !== null && _b !== void 0 ? _b : 0;
62
+ var idPrefix = (_c = props.id) !== null && _c !== void 0 ? _c : context === null || context === void 0 ? void 0 : context.idPrefix;
63
+ var handleSlideChange = React.useCallback(function (index) {
64
+ if (context) {
65
+ context.setCurrentIndex(index);
66
+ }
67
+ onSlideChange === null || onSlideChange === void 0 ? void 0 : onSlideChange(index);
68
+ }, [context, onSlideChange]);
69
+ var justMounted = React.useRef(true);
70
+ var _d = React.useState(slideCount), visibleCount = _d[0], setVisibleCount = _d[1];
71
+ var listRef = React.useRef(null);
72
+ var _e = React.useState(), width = _e[0], setWidth = _e[1];
73
+ var _f = useResizeObserver(function (_a) {
74
+ var width = _a.width;
75
+ if (!listRef.current) {
76
+ return;
77
+ }
78
+ setWidth(width);
79
+ var dotWidth = listRef.current.children[0].offsetWidth;
80
+ setVisibleCount(Math.floor(width / dotWidth));
81
+ }), resizeRef = _f[0], resizeObserver = _f[1];
82
+ React.useEffect(function () { return resizeObserver === null || resizeObserver === void 0 ? void 0 : resizeObserver.disconnect(); }, [resizeObserver]);
83
+ var refs = useMergedRefs(ref, resizeRef, listRef);
84
+ var firstVisibleDotIndex = React.useMemo(function () {
85
+ return getBoundedValue(currentIndex - Math.ceil(visibleCount / 2) + 1, 0, slideCount - visibleCount);
86
+ }, [currentIndex, slideCount, visibleCount]);
87
+ var lastVisibleDotIndex = React.useMemo(function () {
88
+ return getBoundedValue(currentIndex + Math.floor(visibleCount / 2), visibleCount - 1, slideCount - 1);
89
+ }, [currentIndex, slideCount, visibleCount]);
90
+ var dots = React.useMemo(function () {
91
+ return Array(slideCount)
92
+ .fill(null)
93
+ .map(function (_, index) {
94
+ var isFirstSmallDot = (index === firstVisibleDotIndex && index !== 0) ||
95
+ (index === lastVisibleDotIndex && index !== slideCount - 1);
96
+ var isSecondSmallDot = (index === firstVisibleDotIndex + 1 && index !== 1) ||
97
+ (index === lastVisibleDotIndex - 1 && index !== slideCount - 2);
98
+ var isClipped = index < firstVisibleDotIndex || index > lastVisibleDotIndex;
99
+ return (React.createElement(CarouselDot, { key: index, "aria-label": "Slide " + index, isActive: index === currentIndex, onClick: function () { return handleSlideChange(index); }, isSmall: isSecondSmallDot, isSmaller: isFirstSmallDot || isClipped, id: idPrefix && idPrefix + "--dot-" + index, "aria-controls": idPrefix && idPrefix + "--slide-" + index }));
100
+ });
101
+ }, [
102
+ slideCount,
103
+ firstVisibleDotIndex,
104
+ lastVisibleDotIndex,
105
+ currentIndex,
106
+ idPrefix,
107
+ handleSlideChange,
108
+ ]);
109
+ React.useEffect(function () {
110
+ var _a, _b, _c;
111
+ var firstDot = (_a = listRef.current) === null || _a === void 0 ? void 0 : _a.children[firstVisibleDotIndex];
112
+ if (!listRef.current || !firstDot) {
113
+ return;
114
+ }
115
+ var motionOk = (_c = (_b = getWindow()) === null || _b === void 0 ? void 0 : _b.matchMedia('(prefers-reduced-motion: no-preference)')) === null || _c === void 0 ? void 0 : _c.matches;
116
+ listRef.current.scrollTo({
117
+ left: firstDot.offsetLeft - listRef.current.offsetLeft,
118
+ behavior: motionOk && !justMounted.current ? 'smooth' : 'auto',
119
+ });
120
+ if (justMounted.current) {
121
+ justMounted.current = false;
122
+ }
123
+ }, [currentIndex, firstVisibleDotIndex, slideCount, visibleCount, width]);
124
+ return (React.createElement(React.Fragment, null,
125
+ React.createElement("div", __assign({ className: cx('iui-carousel-navigation-dots', className), role: 'tablist', "aria-label": 'Slides', ref: refs }, rest), children !== null && children !== void 0 ? children : dots)));
126
+ });
@@ -0,0 +1,15 @@
1
+ import React from 'react';
2
+ /**
3
+ * The `CarouselNavigation` component by default consists of the `PreviousButton` and `NextButton`
4
+ * shown on the left and right, and the `CarouselDotsList` component shown in the middle.
5
+ *
6
+ * `children` can be specified to override what is shown in this navigation section.
7
+ */
8
+ export declare const CarouselNavigation: React.ForwardRefExoticComponent<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement>, "key" | keyof React.HTMLAttributes<HTMLElement>> & React.RefAttributes<HTMLElement>> & {
9
+ PreviousButton: React.ForwardRefExoticComponent<{
10
+ isActive?: boolean | undefined;
11
+ } & Omit<import("../Buttons").ButtonProps<"button">, "startIcon" | "endIcon"> & React.RefAttributes<HTMLButtonElement>>;
12
+ NextButton: React.ForwardRefExoticComponent<{
13
+ isActive?: boolean | undefined;
14
+ } & Omit<import("../Buttons").ButtonProps<"button">, "startIcon" | "endIcon"> & React.RefAttributes<HTMLButtonElement>>;
15
+ };