@itwin/itwinui-react 1.43.1 → 1.44.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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.44.0](https://www.github.com/iTwin/iTwinUI-react/compare/v1.43.1...v1.44.0) (2022-08-23)
4
+
5
+ ### What's new
6
+
7
+ * **Select:** Multiple selection support ([#700](https://www.github.com/iTwin/iTwinUI-react/issues/700)) ([b7d34c1](https://www.github.com/iTwin/iTwinUI-react/commit/b7d34c1702ae416d969bed21098270f7aa7731a9))
8
+
9
+ ### Fixes
10
+
11
+ * **Table:** Show correct icon on hover for columns with `sortDescFirst` ([#779](https://www.github.com/iTwin/iTwinUI-react/issues/779)) ([acf19a2](https://www.github.com/iTwin/iTwinUI-react/commit/acf19a23d4680e6e1c1789e45b8e76e0848d8166))
12
+
3
13
  ### [1.43.1](https://www.github.com/iTwin/iTwinUI-react/compare/v1.43.0...v1.43.1) (2022-08-18)
4
14
 
5
15
  ### Fixes
@@ -43,9 +43,6 @@ exports.Menu = react_1.default.forwardRef(function (props, ref) {
43
43
  var _c = react_1.default.useState(), focusedIndex = _c[0], setFocusedIndex = _c[1];
44
44
  var menuRef = react_1.default.useRef(null);
45
45
  var refs = (0, utils_1.useMergedRefs)(menuRef, ref);
46
- react_1.default.useEffect(function () {
47
- setFocusedIndex(null);
48
- }, [children]);
49
46
  var getFocusableNodes = react_1.default.useCallback(function () {
50
47
  var focusableItems = (0, utils_1.getFocusableElements)(menuRef.current);
51
48
  // Filter out focusable elements that are inside each menu item, e.g. checkbox, anchor
@@ -44,19 +44,38 @@ export declare type SelectOption<T> = {
44
44
  */
45
45
  [key: string]: unknown;
46
46
  } & CommonProps;
47
- export declare type SelectProps<T> = {
47
+ export declare type SelectValueChangeEvent = 'added' | 'removed';
48
+ export declare type SelectMultipleTypeProps<T> = {
48
49
  /**
49
- * Array of options that populates the select menu.
50
+ * Enable multiple selection.
51
+ * @default false
50
52
  */
51
- options: SelectOption<T>[];
53
+ multiple?: false;
54
+ /**
55
+ * Custom renderer for the selected item in select.
56
+ * If `multiple` is enabled, it will give array of options to render.
57
+ */
58
+ selectedItemRenderer?: (option: SelectOption<T>) => JSX.Element;
52
59
  /**
53
60
  * Selected option value.
61
+ * If `multiple` is enabled, it is an array of values.
54
62
  */
55
63
  value?: T;
56
64
  /**
57
65
  * Callback function handling change event on select.
58
66
  */
59
67
  onChange?: (value: T) => void;
68
+ } | {
69
+ multiple: true;
70
+ selectedItemRenderer?: (options: SelectOption<T>[]) => JSX.Element;
71
+ value?: T[];
72
+ onChange?: (value: T, event: SelectValueChangeEvent) => void;
73
+ };
74
+ export declare type SelectProps<T> = {
75
+ /**
76
+ * Array of options that populates the select menu.
77
+ */
78
+ options: SelectOption<T>[];
60
79
  /**
61
80
  * Placeholder when no item is selected.
62
81
  */
@@ -79,10 +98,6 @@ export declare type SelectProps<T> = {
79
98
  * Custom renderer for an item in the dropdown list. `MenuItem` item props are going to be populated if not provided.
80
99
  */
81
100
  itemRenderer?: (option: SelectOption<T>, itemProps: ItemRendererProps) => JSX.Element;
82
- /**
83
- * Custom renderer for the selected item in select.
84
- */
85
- selectedItemRenderer?: (option: SelectOption<T>) => JSX.Element;
86
101
  /**
87
102
  * Custom class for menu.
88
103
  */
@@ -96,7 +111,7 @@ export declare type SelectProps<T> = {
96
111
  * @see [tippy.js props](https://atomiks.github.io/tippyjs/v6/all-props/)
97
112
  */
98
113
  popoverProps?: Omit<PopoverProps, 'onShow' | 'onHide' | 'disabled'>;
99
- } & Pick<PopoverProps, 'onShow' | 'onHide'> & Omit<React.ComponentPropsWithoutRef<'div'>, 'size' | 'disabled' | 'placeholder' | 'onChange'>;
114
+ } & SelectMultipleTypeProps<T> & Pick<PopoverProps, 'onShow' | 'onHide'> & Omit<React.ComponentPropsWithoutRef<'div'>, 'size' | 'disabled' | 'placeholder' | 'onChange'>;
100
115
  /**
101
116
  * Select component to select value from options.
102
117
  * Generic type is used for value. It prevents you from mistakenly using other types in `options`, `value` and `onChange`.
@@ -37,6 +37,14 @@ var MenuItem_1 = require("../Menu/MenuItem");
37
37
  var utils_1 = require("../utils");
38
38
  require("@itwin/itwinui-css/css/inputs.css");
39
39
  var CaretDownSmall_1 = __importDefault(require("@itwin/itwinui-icons-react/cjs/icons/CaretDownSmall"));
40
+ var SelectTag_1 = __importDefault(require("./SelectTag"));
41
+ var isMultipleEnabled = function (variable, multiple) {
42
+ return multiple;
43
+ };
44
+ // Type guard for multiple did not work
45
+ var isSingleOnChange = function (onChange, multiple) {
46
+ return !multiple;
47
+ };
40
48
  /**
41
49
  * Select component to select value from options.
42
50
  * Generic type is used for value. It prevents you from mistakenly using other types in `options`, `value` and `onChange`.
@@ -89,13 +97,13 @@ var CaretDownSmall_1 = __importDefault(require("@itwin/itwinui-icons-react/cjs/i
89
97
  var Select = function (props) {
90
98
  var _a;
91
99
  var _b;
92
- var options = props.options, value = props.value, onChange = props.onChange, placeholder = props.placeholder, _c = props.disabled, disabled = _c === void 0 ? false : _c, size = props.size, _d = props.setFocus, setFocus = _d === void 0 ? false : _d, itemRenderer = props.itemRenderer, selectedItemRenderer = props.selectedItemRenderer, className = props.className, style = props.style, menuClassName = props.menuClassName, menuStyle = props.menuStyle, onShow = props.onShow, onHide = props.onHide, popoverProps = props.popoverProps, rest = __rest(props, ["options", "value", "onChange", "placeholder", "disabled", "size", "setFocus", "itemRenderer", "selectedItemRenderer", "className", "style", "menuClassName", "menuStyle", "onShow", "onHide", "popoverProps"]);
100
+ var options = props.options, value = props.value, onChange = props.onChange, placeholder = props.placeholder, _c = props.disabled, disabled = _c === void 0 ? false : _c, size = props.size, _d = props.setFocus, setFocus = _d === void 0 ? false : _d, itemRenderer = props.itemRenderer, selectedItemRenderer = props.selectedItemRenderer, className = props.className, style = props.style, menuClassName = props.menuClassName, menuStyle = props.menuStyle, onShow = props.onShow, onHide = props.onHide, popoverProps = props.popoverProps, _e = props.multiple, multiple = _e === void 0 ? false : _e, rest = __rest(props, ["options", "value", "onChange", "placeholder", "disabled", "size", "setFocus", "itemRenderer", "selectedItemRenderer", "className", "style", "menuClassName", "menuStyle", "onShow", "onHide", "popoverProps", "multiple"]);
93
101
  (0, utils_1.useTheme)();
94
- var _e = react_1.default.useState((_b = popoverProps === null || popoverProps === void 0 ? void 0 : popoverProps.visible) !== null && _b !== void 0 ? _b : false), isOpen = _e[0], setIsOpen = _e[1];
102
+ var _f = react_1.default.useState((_b = popoverProps === null || popoverProps === void 0 ? void 0 : popoverProps.visible) !== null && _b !== void 0 ? _b : false), isOpen = _f[0], setIsOpen = _f[1];
95
103
  react_1.default.useEffect(function () {
96
104
  setIsOpen(function (open) { var _a; return (_a = popoverProps === null || popoverProps === void 0 ? void 0 : popoverProps.visible) !== null && _a !== void 0 ? _a : open; });
97
105
  }, [popoverProps]);
98
- var _f = react_1.default.useState(0), minWidth = _f[0], setMinWidth = _f[1];
106
+ var _g = react_1.default.useState(0), minWidth = _g[0], setMinWidth = _g[1];
99
107
  var toggle = function () { return setIsOpen(function (open) { return !open; }); };
100
108
  var selectRef = react_1.default.useRef(null);
101
109
  var toggleButtonRef = react_1.default.useRef(null);
@@ -122,8 +130,10 @@ var Select = function (props) {
122
130
  case 'Enter':
123
131
  case ' ':
124
132
  case 'Spacebar':
125
- toggle();
126
- event.preventDefault();
133
+ if (event.target === selectRef.current) {
134
+ toggle();
135
+ event.preventDefault();
136
+ }
127
137
  break;
128
138
  default:
129
139
  break;
@@ -131,20 +141,41 @@ var Select = function (props) {
131
141
  };
132
142
  var menuItems = react_1.default.useCallback(function (close) {
133
143
  return options.map(function (option, index) {
134
- var isSelected = value === option.value;
144
+ var _a;
145
+ var isSelected = isMultipleEnabled(value, multiple)
146
+ ? (_a = value === null || value === void 0 ? void 0 : value.includes(option.value)) !== null && _a !== void 0 ? _a : false
147
+ : value === option.value;
135
148
  var menuItem = itemRenderer ? (itemRenderer(option, { close: close, isSelected: isSelected })) : (react_1.default.createElement(MenuItem_1.MenuItem, null, option.label));
136
- return react_1.default.cloneElement(menuItem, __assign(__assign({ key: "".concat(option.label, "-").concat(index), isSelected: isSelected, onClick: function () {
137
- !option.disabled && (onChange === null || onChange === void 0 ? void 0 : onChange(option.value));
138
- close();
139
- }, ref: function (el) { return isSelected && (el === null || el === void 0 ? void 0 : el.scrollIntoView()); }, role: 'option' }, option), menuItem.props));
149
+ var label = option.label, restOption = __rest(option, ["label"]);
150
+ return react_1.default.cloneElement(menuItem, __assign(__assign({ key: "".concat(label, "-").concat(index), isSelected: isSelected, onClick: function () {
151
+ if (option.disabled) {
152
+ return;
153
+ }
154
+ if (isSingleOnChange(onChange, multiple)) {
155
+ onChange === null || onChange === void 0 ? void 0 : onChange(option.value);
156
+ close();
157
+ }
158
+ else {
159
+ onChange === null || onChange === void 0 ? void 0 : onChange(option.value, isSelected ? 'removed' : 'added');
160
+ }
161
+ }, ref: function (el) {
162
+ if (isSelected && !multiple) {
163
+ el === null || el === void 0 ? void 0 : el.scrollIntoView();
164
+ }
165
+ }, role: 'option' }, restOption), menuItem.props));
140
166
  });
141
- }, [itemRenderer, onChange, options, value]);
142
- var selectedItem = react_1.default.useMemo(function () {
167
+ }, [itemRenderer, multiple, onChange, options, value]);
168
+ var selectedItems = react_1.default.useMemo(function () {
143
169
  if (value == null) {
144
170
  return undefined;
145
171
  }
146
- return options.find(function (option) { return option.value === value; });
147
- }, [options, value]);
172
+ return isMultipleEnabled(value, multiple)
173
+ ? options.filter(function (option) { return value.some(function (val) { return val === option.value; }); })
174
+ : options.find(function (option) { return option.value === value; });
175
+ }, [multiple, options, value]);
176
+ var tagRenderer = react_1.default.useCallback(function (item) {
177
+ return react_1.default.createElement(SelectTag_1.default, { key: item.label, label: item.label });
178
+ }, []);
148
179
  return (react_1.default.createElement("div", __assign({ className: (0, classnames_1.default)('iui-input-with-icon', className), "aria-expanded": isOpen, "aria-haspopup": 'listbox', style: style }, rest),
149
180
  react_1.default.createElement(DropdownMenu_1.DropdownMenu, __assign({ menuItems: menuItems, placement: 'bottom-start', className: (0, classnames_1.default)('iui-scroll', menuClassName), style: __assign({ minWidth: minWidth, maxWidth: "min(".concat(minWidth * 2, "px, 90vw)"), maxHeight: 315 }, menuStyle), role: 'listbox', onShow: onShowHandler, onHide: onHideHandler, disabled: disabled }, popoverProps, { visible: isOpen, onClickOutside: function (_, _a) {
150
181
  var _b;
@@ -154,21 +185,13 @@ var Select = function (props) {
154
185
  }
155
186
  } }),
156
187
  react_1.default.createElement("div", { ref: selectRef, className: (0, classnames_1.default)('iui-select-button', (_a = {
157
- 'iui-placeholder': !selectedItem && !!placeholder,
188
+ 'iui-placeholder': (!selectedItems || selectedItems.length === 0) && !!placeholder,
158
189
  'iui-disabled': disabled
159
190
  },
160
191
  _a["iui-".concat(size)] = !!size,
161
192
  _a)), onClick: function () { return !disabled && toggle(); }, onKeyDown: function (e) { return !disabled && onKeyDown(e, toggle); }, tabIndex: !disabled ? 0 : undefined },
162
- !selectedItem && react_1.default.createElement("span", { className: 'iui-content' }, placeholder),
163
- selectedItem &&
164
- selectedItemRenderer &&
165
- selectedItemRenderer(selectedItem),
166
- selectedItem && !selectedItemRenderer && (react_1.default.createElement(react_1.default.Fragment, null,
167
- (selectedItem === null || selectedItem === void 0 ? void 0 : selectedItem.icon) &&
168
- react_1.default.cloneElement(selectedItem.icon, {
169
- className: (0, classnames_1.default)(selectedItem === null || selectedItem === void 0 ? void 0 : selectedItem.icon.props.className, 'iui-icon'),
170
- }),
171
- react_1.default.createElement("span", { className: 'iui-content' }, selectedItem.label))))),
193
+ (!selectedItems || selectedItems.length === 0) && (react_1.default.createElement("span", { className: 'iui-content' }, placeholder)),
194
+ isMultipleEnabled(selectedItems, multiple) ? (react_1.default.createElement(MultipleSelectButton, { selectedItems: selectedItems, selectedItemsRenderer: selectedItemRenderer, tagRenderer: tagRenderer })) : (react_1.default.createElement(SingleSelectButton, { selectedItem: selectedItems, selectedItemRenderer: selectedItemRenderer })))),
172
195
  react_1.default.createElement("span", { ref: toggleButtonRef, className: (0, classnames_1.default)('iui-end-icon', {
173
196
  'iui-actionable': !disabled,
174
197
  'iui-disabled': disabled,
@@ -177,4 +200,38 @@ var Select = function (props) {
177
200
  react_1.default.createElement(CaretDownSmall_1.default, { "aria-hidden": true }))));
178
201
  };
179
202
  exports.Select = Select;
203
+ var SingleSelectButton = function (_a) {
204
+ var selectedItem = _a.selectedItem, selectedItemRenderer = _a.selectedItemRenderer;
205
+ return (react_1.default.createElement(react_1.default.Fragment, null,
206
+ selectedItem &&
207
+ selectedItemRenderer &&
208
+ selectedItemRenderer(selectedItem),
209
+ selectedItem && !selectedItemRenderer && (react_1.default.createElement(react_1.default.Fragment, null,
210
+ selectedItem.icon &&
211
+ react_1.default.cloneElement(selectedItem.icon, {
212
+ className: (0, classnames_1.default)(selectedItem.icon.props.className, 'iui-icon'),
213
+ }),
214
+ react_1.default.createElement("span", { className: 'iui-content' }, selectedItem.label)))));
215
+ };
216
+ var MultipleSelectButton = function (_a) {
217
+ var selectedItems = _a.selectedItems, selectedItemsRenderer = _a.selectedItemsRenderer, tagRenderer = _a.tagRenderer;
218
+ var selectedItemsElements = react_1.default.useMemo(function () {
219
+ if (!selectedItems) {
220
+ return [];
221
+ }
222
+ return selectedItems.map(function (item) { return tagRenderer(item); });
223
+ }, [selectedItems, tagRenderer]);
224
+ var _b = (0, utils_1.useOverflow)(selectedItemsElements), containerRef = _b[0], visibleCount = _b[1];
225
+ return (react_1.default.createElement(react_1.default.Fragment, null,
226
+ selectedItems &&
227
+ selectedItemsRenderer &&
228
+ selectedItemsRenderer(selectedItems),
229
+ selectedItems && !selectedItemsRenderer && (react_1.default.createElement("span", { className: 'iui-content' },
230
+ react_1.default.createElement("div", { className: 'iui-select-tag-container', ref: containerRef },
231
+ react_1.default.createElement(react_1.default.Fragment, null,
232
+ visibleCount < selectedItemsElements.length
233
+ ? selectedItemsElements.slice(0, visibleCount - 1)
234
+ : selectedItemsElements,
235
+ visibleCount < selectedItemsElements.length && (react_1.default.createElement(SelectTag_1.default, { label: "+".concat(selectedItemsElements.length - visibleCount + 1, " item(s)") }))))))));
236
+ };
180
237
  exports.default = exports.Select;
@@ -0,0 +1,15 @@
1
+ /// <reference types="react" />
2
+ import { CommonProps } from '../utils';
3
+ import '@itwin/itwinui-css/css/inputs.css';
4
+ export declare type SelectTagProps = {
5
+ /**
6
+ * Text inside the tag.
7
+ */
8
+ label: string;
9
+ } & CommonProps;
10
+ /**
11
+ * Tag for showing selected value in `Select`.
12
+ * @private
13
+ */
14
+ export declare const SelectTag: (props: SelectTagProps) => JSX.Element;
15
+ export default SelectTag;
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+ var __assign = (this && this.__assign) || function () {
3
+ __assign = Object.assign || function(t) {
4
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
5
+ s = arguments[i];
6
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
+ t[p] = s[p];
8
+ }
9
+ return t;
10
+ };
11
+ return __assign.apply(this, arguments);
12
+ };
13
+ var __rest = (this && this.__rest) || function (s, e) {
14
+ var t = {};
15
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
16
+ t[p] = s[p];
17
+ if (s != null && typeof Object.getOwnPropertySymbols === "function")
18
+ for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
19
+ if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
20
+ t[p[i]] = s[p[i]];
21
+ }
22
+ return t;
23
+ };
24
+ var __importDefault = (this && this.__importDefault) || function (mod) {
25
+ return (mod && mod.__esModule) ? mod : { "default": mod };
26
+ };
27
+ Object.defineProperty(exports, "__esModule", { value: true });
28
+ exports.SelectTag = void 0;
29
+ /*---------------------------------------------------------------------------------------------
30
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
31
+ * See LICENSE.md in the project root for license terms and full copyright notice.
32
+ *--------------------------------------------------------------------------------------------*/
33
+ var classnames_1 = __importDefault(require("classnames"));
34
+ var react_1 = __importDefault(require("react"));
35
+ var utils_1 = require("../utils");
36
+ require("@itwin/itwinui-css/css/inputs.css");
37
+ /**
38
+ * Tag for showing selected value in `Select`.
39
+ * @private
40
+ */
41
+ var SelectTag = function (props) {
42
+ var className = props.className, label = props.label, rest = __rest(props, ["className", "label"]);
43
+ (0, utils_1.useTheme)();
44
+ return (react_1.default.createElement("span", __assign({ className: (0, classnames_1.default)('iui-select-tag', className) }, rest),
45
+ react_1.default.createElement("span", { className: 'iui-select-tag-label' }, label)));
46
+ };
47
+ exports.SelectTag = SelectTag;
48
+ exports.default = exports.SelectTag;
@@ -1,4 +1,4 @@
1
1
  export { Select } from './Select';
2
- export type { SelectProps, SelectOption, ItemRendererProps } from './Select';
2
+ export type { SelectProps, SelectOption, ItemRendererProps, SelectValueChangeEvent, } from './Select';
3
3
  declare const _default: "./Select";
4
4
  export default _default;
@@ -359,7 +359,8 @@ var Table = function (props) {
359
359
  (showFilterButton(column) ||
360
360
  showSortButton(column)) && (react_1.default.createElement("div", { className: 'iui-table-header-actions-container' },
361
361
  showFilterButton(column) && (react_1.default.createElement(filters_1.FilterToggle, { column: column, ownerDocument: ownerDocument })),
362
- showSortButton(column) && (react_1.default.createElement("div", { className: 'iui-cell-end-icon' }, column.isSorted && column.isSortedDesc ? (react_1.default.createElement(SortDown_1.default, { className: 'iui-icon iui-sort', "aria-hidden": true })) : (react_1.default.createElement(SortUp_1.default, { className: 'iui-icon iui-sort', "aria-hidden": true })))))),
362
+ showSortButton(column) && (react_1.default.createElement("div", { className: 'iui-cell-end-icon' }, column.isSortedDesc ||
363
+ (!column.isSorted && column.sortDescFirst) ? (react_1.default.createElement(SortDown_1.default, { className: 'iui-icon iui-sort', "aria-hidden": true })) : (react_1.default.createElement(SortUp_1.default, { className: 'iui-icon iui-sort', "aria-hidden": true })))))),
363
364
  isResizable &&
364
365
  column.isResizerVisible &&
365
366
  index !== headerGroup.headers.length - 1 && (react_1.default.createElement("div", __assign({}, column.getResizerProps(), { className: 'iui-resizer' }),
@@ -61,7 +61,7 @@ export type { RadioProps } from './Radio';
61
61
  export { RadioTile, RadioTileGroup } from './RadioTiles';
62
62
  export type { RadioTileGroupProps, RadioTileProps } from './RadioTiles';
63
63
  export { Select } from './Select';
64
- export type { SelectProps, SelectOption, ItemRendererProps } from './Select';
64
+ export type { SelectProps, SelectOption, ItemRendererProps, SelectValueChangeEvent, } from './Select';
65
65
  export { SideNavigation, SidenavButton, SidenavSubmenu, SidenavSubmenuHeader, } from './SideNavigation';
66
66
  export type { SideNavigationProps, SidenavButtonProps, SidenavSubmenuProps, SidenavSubmenuHeaderProps, } from './SideNavigation';
67
67
  export { SkipToContentLink } from './SkipToContentLink';
@@ -76,7 +76,10 @@ var useOverflow = function (items, disabled, orientation) {
76
76
  }
77
77
  else if (needsFullRerender.current) {
78
78
  var childrenSize = Array.from(containerRef.current.children).reduce(function (sum, child) { return sum + child["offset".concat(dimension)]; }, 0);
79
- var avgItemSize = childrenSize / visibleCount;
79
+ // Previous `useEffect` might have updated visible count, but we still have old one
80
+ // If it is 0, lets try to update it with items length.
81
+ var currentVisibleCount = visibleCount || Math.min(items.length, STARTING_MAX_ITEMS_COUNT);
82
+ var avgItemSize = childrenSize / currentVisibleCount;
80
83
  var visibleItems = Math.floor(availableSize / avgItemSize);
81
84
  if (!isNaN(visibleItems)) {
82
85
  // Doubling the visible items to overflow the container. Just to be safe.
@@ -37,9 +37,6 @@ export var Menu = React.forwardRef(function (props, ref) {
37
37
  var _c = React.useState(), focusedIndex = _c[0], setFocusedIndex = _c[1];
38
38
  var menuRef = React.useRef(null);
39
39
  var refs = useMergedRefs(menuRef, ref);
40
- React.useEffect(function () {
41
- setFocusedIndex(null);
42
- }, [children]);
43
40
  var getFocusableNodes = React.useCallback(function () {
44
41
  var focusableItems = getFocusableElements(menuRef.current);
45
42
  // Filter out focusable elements that are inside each menu item, e.g. checkbox, anchor
@@ -44,19 +44,38 @@ export declare type SelectOption<T> = {
44
44
  */
45
45
  [key: string]: unknown;
46
46
  } & CommonProps;
47
- export declare type SelectProps<T> = {
47
+ export declare type SelectValueChangeEvent = 'added' | 'removed';
48
+ export declare type SelectMultipleTypeProps<T> = {
48
49
  /**
49
- * Array of options that populates the select menu.
50
+ * Enable multiple selection.
51
+ * @default false
50
52
  */
51
- options: SelectOption<T>[];
53
+ multiple?: false;
54
+ /**
55
+ * Custom renderer for the selected item in select.
56
+ * If `multiple` is enabled, it will give array of options to render.
57
+ */
58
+ selectedItemRenderer?: (option: SelectOption<T>) => JSX.Element;
52
59
  /**
53
60
  * Selected option value.
61
+ * If `multiple` is enabled, it is an array of values.
54
62
  */
55
63
  value?: T;
56
64
  /**
57
65
  * Callback function handling change event on select.
58
66
  */
59
67
  onChange?: (value: T) => void;
68
+ } | {
69
+ multiple: true;
70
+ selectedItemRenderer?: (options: SelectOption<T>[]) => JSX.Element;
71
+ value?: T[];
72
+ onChange?: (value: T, event: SelectValueChangeEvent) => void;
73
+ };
74
+ export declare type SelectProps<T> = {
75
+ /**
76
+ * Array of options that populates the select menu.
77
+ */
78
+ options: SelectOption<T>[];
60
79
  /**
61
80
  * Placeholder when no item is selected.
62
81
  */
@@ -79,10 +98,6 @@ export declare type SelectProps<T> = {
79
98
  * Custom renderer for an item in the dropdown list. `MenuItem` item props are going to be populated if not provided.
80
99
  */
81
100
  itemRenderer?: (option: SelectOption<T>, itemProps: ItemRendererProps) => JSX.Element;
82
- /**
83
- * Custom renderer for the selected item in select.
84
- */
85
- selectedItemRenderer?: (option: SelectOption<T>) => JSX.Element;
86
101
  /**
87
102
  * Custom class for menu.
88
103
  */
@@ -96,7 +111,7 @@ export declare type SelectProps<T> = {
96
111
  * @see [tippy.js props](https://atomiks.github.io/tippyjs/v6/all-props/)
97
112
  */
98
113
  popoverProps?: Omit<PopoverProps, 'onShow' | 'onHide' | 'disabled'>;
99
- } & Pick<PopoverProps, 'onShow' | 'onHide'> & Omit<React.ComponentPropsWithoutRef<'div'>, 'size' | 'disabled' | 'placeholder' | 'onChange'>;
114
+ } & SelectMultipleTypeProps<T> & Pick<PopoverProps, 'onShow' | 'onHide'> & Omit<React.ComponentPropsWithoutRef<'div'>, 'size' | 'disabled' | 'placeholder' | 'onChange'>;
100
115
  /**
101
116
  * Select component to select value from options.
102
117
  * Generic type is used for value. It prevents you from mistakenly using other types in `options`, `value` and `onChange`.
@@ -28,9 +28,17 @@ import React from 'react';
28
28
  import cx from 'classnames';
29
29
  import { DropdownMenu } from '../DropdownMenu';
30
30
  import { MenuItem } from '../Menu/MenuItem';
31
- import { useTheme } from '../utils';
31
+ import { useTheme, useOverflow, } from '../utils';
32
32
  import '@itwin/itwinui-css/css/inputs.css';
33
33
  import SvgCaretDownSmall from '@itwin/itwinui-icons-react/cjs/icons/CaretDownSmall';
34
+ import SelectTag from './SelectTag';
35
+ var isMultipleEnabled = function (variable, multiple) {
36
+ return multiple;
37
+ };
38
+ // Type guard for multiple did not work
39
+ var isSingleOnChange = function (onChange, multiple) {
40
+ return !multiple;
41
+ };
34
42
  /**
35
43
  * Select component to select value from options.
36
44
  * Generic type is used for value. It prevents you from mistakenly using other types in `options`, `value` and `onChange`.
@@ -83,13 +91,13 @@ import SvgCaretDownSmall from '@itwin/itwinui-icons-react/cjs/icons/CaretDownSma
83
91
  export var Select = function (props) {
84
92
  var _a;
85
93
  var _b;
86
- var options = props.options, value = props.value, onChange = props.onChange, placeholder = props.placeholder, _c = props.disabled, disabled = _c === void 0 ? false : _c, size = props.size, _d = props.setFocus, setFocus = _d === void 0 ? false : _d, itemRenderer = props.itemRenderer, selectedItemRenderer = props.selectedItemRenderer, className = props.className, style = props.style, menuClassName = props.menuClassName, menuStyle = props.menuStyle, onShow = props.onShow, onHide = props.onHide, popoverProps = props.popoverProps, rest = __rest(props, ["options", "value", "onChange", "placeholder", "disabled", "size", "setFocus", "itemRenderer", "selectedItemRenderer", "className", "style", "menuClassName", "menuStyle", "onShow", "onHide", "popoverProps"]);
94
+ var options = props.options, value = props.value, onChange = props.onChange, placeholder = props.placeholder, _c = props.disabled, disabled = _c === void 0 ? false : _c, size = props.size, _d = props.setFocus, setFocus = _d === void 0 ? false : _d, itemRenderer = props.itemRenderer, selectedItemRenderer = props.selectedItemRenderer, className = props.className, style = props.style, menuClassName = props.menuClassName, menuStyle = props.menuStyle, onShow = props.onShow, onHide = props.onHide, popoverProps = props.popoverProps, _e = props.multiple, multiple = _e === void 0 ? false : _e, rest = __rest(props, ["options", "value", "onChange", "placeholder", "disabled", "size", "setFocus", "itemRenderer", "selectedItemRenderer", "className", "style", "menuClassName", "menuStyle", "onShow", "onHide", "popoverProps", "multiple"]);
87
95
  useTheme();
88
- var _e = React.useState((_b = popoverProps === null || popoverProps === void 0 ? void 0 : popoverProps.visible) !== null && _b !== void 0 ? _b : false), isOpen = _e[0], setIsOpen = _e[1];
96
+ var _f = React.useState((_b = popoverProps === null || popoverProps === void 0 ? void 0 : popoverProps.visible) !== null && _b !== void 0 ? _b : false), isOpen = _f[0], setIsOpen = _f[1];
89
97
  React.useEffect(function () {
90
98
  setIsOpen(function (open) { var _a; return (_a = popoverProps === null || popoverProps === void 0 ? void 0 : popoverProps.visible) !== null && _a !== void 0 ? _a : open; });
91
99
  }, [popoverProps]);
92
- var _f = React.useState(0), minWidth = _f[0], setMinWidth = _f[1];
100
+ var _g = React.useState(0), minWidth = _g[0], setMinWidth = _g[1];
93
101
  var toggle = function () { return setIsOpen(function (open) { return !open; }); };
94
102
  var selectRef = React.useRef(null);
95
103
  var toggleButtonRef = React.useRef(null);
@@ -116,8 +124,10 @@ export var Select = function (props) {
116
124
  case 'Enter':
117
125
  case ' ':
118
126
  case 'Spacebar':
119
- toggle();
120
- event.preventDefault();
127
+ if (event.target === selectRef.current) {
128
+ toggle();
129
+ event.preventDefault();
130
+ }
121
131
  break;
122
132
  default:
123
133
  break;
@@ -125,20 +135,41 @@ export var Select = function (props) {
125
135
  };
126
136
  var menuItems = React.useCallback(function (close) {
127
137
  return options.map(function (option, index) {
128
- var isSelected = value === option.value;
138
+ var _a;
139
+ var isSelected = isMultipleEnabled(value, multiple)
140
+ ? (_a = value === null || value === void 0 ? void 0 : value.includes(option.value)) !== null && _a !== void 0 ? _a : false
141
+ : value === option.value;
129
142
  var menuItem = itemRenderer ? (itemRenderer(option, { close: close, isSelected: isSelected })) : (React.createElement(MenuItem, null, option.label));
130
- return React.cloneElement(menuItem, __assign(__assign({ key: "".concat(option.label, "-").concat(index), isSelected: isSelected, onClick: function () {
131
- !option.disabled && (onChange === null || onChange === void 0 ? void 0 : onChange(option.value));
132
- close();
133
- }, ref: function (el) { return isSelected && (el === null || el === void 0 ? void 0 : el.scrollIntoView()); }, role: 'option' }, option), menuItem.props));
143
+ var label = option.label, restOption = __rest(option, ["label"]);
144
+ return React.cloneElement(menuItem, __assign(__assign({ key: "".concat(label, "-").concat(index), isSelected: isSelected, onClick: function () {
145
+ if (option.disabled) {
146
+ return;
147
+ }
148
+ if (isSingleOnChange(onChange, multiple)) {
149
+ onChange === null || onChange === void 0 ? void 0 : onChange(option.value);
150
+ close();
151
+ }
152
+ else {
153
+ onChange === null || onChange === void 0 ? void 0 : onChange(option.value, isSelected ? 'removed' : 'added');
154
+ }
155
+ }, ref: function (el) {
156
+ if (isSelected && !multiple) {
157
+ el === null || el === void 0 ? void 0 : el.scrollIntoView();
158
+ }
159
+ }, role: 'option' }, restOption), menuItem.props));
134
160
  });
135
- }, [itemRenderer, onChange, options, value]);
136
- var selectedItem = React.useMemo(function () {
161
+ }, [itemRenderer, multiple, onChange, options, value]);
162
+ var selectedItems = React.useMemo(function () {
137
163
  if (value == null) {
138
164
  return undefined;
139
165
  }
140
- return options.find(function (option) { return option.value === value; });
141
- }, [options, value]);
166
+ return isMultipleEnabled(value, multiple)
167
+ ? options.filter(function (option) { return value.some(function (val) { return val === option.value; }); })
168
+ : options.find(function (option) { return option.value === value; });
169
+ }, [multiple, options, value]);
170
+ var tagRenderer = React.useCallback(function (item) {
171
+ return React.createElement(SelectTag, { key: item.label, label: item.label });
172
+ }, []);
142
173
  return (React.createElement("div", __assign({ className: cx('iui-input-with-icon', className), "aria-expanded": isOpen, "aria-haspopup": 'listbox', style: style }, rest),
143
174
  React.createElement(DropdownMenu, __assign({ menuItems: menuItems, placement: 'bottom-start', className: cx('iui-scroll', menuClassName), style: __assign({ minWidth: minWidth, maxWidth: "min(".concat(minWidth * 2, "px, 90vw)"), maxHeight: 315 }, menuStyle), role: 'listbox', onShow: onShowHandler, onHide: onHideHandler, disabled: disabled }, popoverProps, { visible: isOpen, onClickOutside: function (_, _a) {
144
175
  var _b;
@@ -148,21 +179,13 @@ export var Select = function (props) {
148
179
  }
149
180
  } }),
150
181
  React.createElement("div", { ref: selectRef, className: cx('iui-select-button', (_a = {
151
- 'iui-placeholder': !selectedItem && !!placeholder,
182
+ 'iui-placeholder': (!selectedItems || selectedItems.length === 0) && !!placeholder,
152
183
  'iui-disabled': disabled
153
184
  },
154
185
  _a["iui-".concat(size)] = !!size,
155
186
  _a)), onClick: function () { return !disabled && toggle(); }, onKeyDown: function (e) { return !disabled && onKeyDown(e, toggle); }, tabIndex: !disabled ? 0 : undefined },
156
- !selectedItem && React.createElement("span", { className: 'iui-content' }, placeholder),
157
- selectedItem &&
158
- selectedItemRenderer &&
159
- selectedItemRenderer(selectedItem),
160
- selectedItem && !selectedItemRenderer && (React.createElement(React.Fragment, null,
161
- (selectedItem === null || selectedItem === void 0 ? void 0 : selectedItem.icon) &&
162
- React.cloneElement(selectedItem.icon, {
163
- className: cx(selectedItem === null || selectedItem === void 0 ? void 0 : selectedItem.icon.props.className, 'iui-icon'),
164
- }),
165
- React.createElement("span", { className: 'iui-content' }, selectedItem.label))))),
187
+ (!selectedItems || selectedItems.length === 0) && (React.createElement("span", { className: 'iui-content' }, placeholder)),
188
+ isMultipleEnabled(selectedItems, multiple) ? (React.createElement(MultipleSelectButton, { selectedItems: selectedItems, selectedItemsRenderer: selectedItemRenderer, tagRenderer: tagRenderer })) : (React.createElement(SingleSelectButton, { selectedItem: selectedItems, selectedItemRenderer: selectedItemRenderer })))),
166
189
  React.createElement("span", { ref: toggleButtonRef, className: cx('iui-end-icon', {
167
190
  'iui-actionable': !disabled,
168
191
  'iui-disabled': disabled,
@@ -170,4 +193,38 @@ export var Select = function (props) {
170
193
  }), onClick: function () { return !disabled && toggle(); } },
171
194
  React.createElement(SvgCaretDownSmall, { "aria-hidden": true }))));
172
195
  };
196
+ var SingleSelectButton = function (_a) {
197
+ var selectedItem = _a.selectedItem, selectedItemRenderer = _a.selectedItemRenderer;
198
+ return (React.createElement(React.Fragment, null,
199
+ selectedItem &&
200
+ selectedItemRenderer &&
201
+ selectedItemRenderer(selectedItem),
202
+ selectedItem && !selectedItemRenderer && (React.createElement(React.Fragment, null,
203
+ selectedItem.icon &&
204
+ React.cloneElement(selectedItem.icon, {
205
+ className: cx(selectedItem.icon.props.className, 'iui-icon'),
206
+ }),
207
+ React.createElement("span", { className: 'iui-content' }, selectedItem.label)))));
208
+ };
209
+ var MultipleSelectButton = function (_a) {
210
+ var selectedItems = _a.selectedItems, selectedItemsRenderer = _a.selectedItemsRenderer, tagRenderer = _a.tagRenderer;
211
+ var selectedItemsElements = React.useMemo(function () {
212
+ if (!selectedItems) {
213
+ return [];
214
+ }
215
+ return selectedItems.map(function (item) { return tagRenderer(item); });
216
+ }, [selectedItems, tagRenderer]);
217
+ var _b = useOverflow(selectedItemsElements), containerRef = _b[0], visibleCount = _b[1];
218
+ return (React.createElement(React.Fragment, null,
219
+ selectedItems &&
220
+ selectedItemsRenderer &&
221
+ selectedItemsRenderer(selectedItems),
222
+ selectedItems && !selectedItemsRenderer && (React.createElement("span", { className: 'iui-content' },
223
+ React.createElement("div", { className: 'iui-select-tag-container', ref: containerRef },
224
+ React.createElement(React.Fragment, null,
225
+ visibleCount < selectedItemsElements.length
226
+ ? selectedItemsElements.slice(0, visibleCount - 1)
227
+ : selectedItemsElements,
228
+ visibleCount < selectedItemsElements.length && (React.createElement(SelectTag, { label: "+".concat(selectedItemsElements.length - visibleCount + 1, " item(s)") }))))))));
229
+ };
173
230
  export default Select;
@@ -0,0 +1,15 @@
1
+ /// <reference types="react" />
2
+ import { CommonProps } from '../utils';
3
+ import '@itwin/itwinui-css/css/inputs.css';
4
+ export declare type SelectTagProps = {
5
+ /**
6
+ * Text inside the tag.
7
+ */
8
+ label: string;
9
+ } & CommonProps;
10
+ /**
11
+ * Tag for showing selected value in `Select`.
12
+ * @private
13
+ */
14
+ export declare const SelectTag: (props: SelectTagProps) => JSX.Element;
15
+ export default SelectTag;
@@ -0,0 +1,41 @@
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 cx from 'classnames';
28
+ import React from 'react';
29
+ import { useTheme } from '../utils';
30
+ import '@itwin/itwinui-css/css/inputs.css';
31
+ /**
32
+ * Tag for showing selected value in `Select`.
33
+ * @private
34
+ */
35
+ export var SelectTag = function (props) {
36
+ var className = props.className, label = props.label, rest = __rest(props, ["className", "label"]);
37
+ useTheme();
38
+ return (React.createElement("span", __assign({ className: cx('iui-select-tag', className) }, rest),
39
+ React.createElement("span", { className: 'iui-select-tag-label' }, label)));
40
+ };
41
+ export default SelectTag;
@@ -1,4 +1,4 @@
1
1
  export { Select } from './Select';
2
- export type { SelectProps, SelectOption, ItemRendererProps } from './Select';
2
+ export type { SelectProps, SelectOption, ItemRendererProps, SelectValueChangeEvent, } from './Select';
3
3
  declare const _default: "./Select";
4
4
  export default _default;
@@ -353,7 +353,8 @@ export var Table = function (props) {
353
353
  (showFilterButton(column) ||
354
354
  showSortButton(column)) && (React.createElement("div", { className: 'iui-table-header-actions-container' },
355
355
  showFilterButton(column) && (React.createElement(FilterToggle, { column: column, ownerDocument: ownerDocument })),
356
- showSortButton(column) && (React.createElement("div", { className: 'iui-cell-end-icon' }, column.isSorted && column.isSortedDesc ? (React.createElement(SvgSortDown, { className: 'iui-icon iui-sort', "aria-hidden": true })) : (React.createElement(SvgSortUp, { className: 'iui-icon iui-sort', "aria-hidden": true })))))),
356
+ showSortButton(column) && (React.createElement("div", { className: 'iui-cell-end-icon' }, column.isSortedDesc ||
357
+ (!column.isSorted && column.sortDescFirst) ? (React.createElement(SvgSortDown, { className: 'iui-icon iui-sort', "aria-hidden": true })) : (React.createElement(SvgSortUp, { className: 'iui-icon iui-sort', "aria-hidden": true })))))),
357
358
  isResizable &&
358
359
  column.isResizerVisible &&
359
360
  index !== headerGroup.headers.length - 1 && (React.createElement("div", __assign({}, column.getResizerProps(), { className: 'iui-resizer' }),
@@ -61,7 +61,7 @@ export type { RadioProps } from './Radio';
61
61
  export { RadioTile, RadioTileGroup } from './RadioTiles';
62
62
  export type { RadioTileGroupProps, RadioTileProps } from './RadioTiles';
63
63
  export { Select } from './Select';
64
- export type { SelectProps, SelectOption, ItemRendererProps } from './Select';
64
+ export type { SelectProps, SelectOption, ItemRendererProps, SelectValueChangeEvent, } from './Select';
65
65
  export { SideNavigation, SidenavButton, SidenavSubmenu, SidenavSubmenuHeader, } from './SideNavigation';
66
66
  export type { SideNavigationProps, SidenavButtonProps, SidenavSubmenuProps, SidenavSubmenuHeaderProps, } from './SideNavigation';
67
67
  export { SkipToContentLink } from './SkipToContentLink';
@@ -70,7 +70,10 @@ export var useOverflow = function (items, disabled, orientation) {
70
70
  }
71
71
  else if (needsFullRerender.current) {
72
72
  var childrenSize = Array.from(containerRef.current.children).reduce(function (sum, child) { return sum + child["offset".concat(dimension)]; }, 0);
73
- var avgItemSize = childrenSize / visibleCount;
73
+ // Previous `useEffect` might have updated visible count, but we still have old one
74
+ // If it is 0, lets try to update it with items length.
75
+ var currentVisibleCount = visibleCount || Math.min(items.length, STARTING_MAX_ITEMS_COUNT);
76
+ var avgItemSize = childrenSize / currentVisibleCount;
74
77
  var visibleItems = Math.floor(availableSize / avgItemSize);
75
78
  if (!isNaN(visibleItems)) {
76
79
  // Doubling the visible items to overflow the container. Just to be safe.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@itwin/itwinui-react",
3
- "version": "1.43.1",
3
+ "version": "1.44.0",
4
4
  "author": "Bentley Systems",
5
5
  "license": "MIT",
6
6
  "main": "cjs/index.js",