@entur/dropdown 9.3.1 → 9.4.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.
@@ -48,10 +48,33 @@ export type MultiSelectProps<ValueType> = Omit<DropdownProps<ValueType>, 'select
48
48
  * @default "valgte"
49
49
  */
50
50
  ariaLabelChosenPlural?: string;
51
- /** Tekst for skjemleser for å hoppe til input-feltet
52
- * @default `${selectedItems.length} valgte elementer, trykk for å hoppe til tekstfeltet`
51
+ /** @deprecated Brukes ikke lenger. De valgte elementene er ikke med i
52
+ * tab-rekkefølgen, men nås med piltastene fra tekstfeltet.
53
53
  */
54
54
  ariaLabelJumpToInput?: string;
55
+ /** Tekst for skjermleser i tekstfeltet om hvordan man når de valgte elementene
56
+ * @default `${selectedItems.length} valgte, bruk venstre piltast for å gå til dem`
57
+ */
58
+ ariaLabelNavigateToSelected?: string;
59
+ /** Tekst for skjermleser når ett valgt element fjernes, f.eks. «Oslo fjernet»
60
+ * @default "fjernet"
61
+ */
62
+ ariaLabelRemovedSingular?: string;
63
+ /** Tekst for skjermleser når flere valgte elementer fjernes samtidig,
64
+ * f.eks. «5 valg fjernet»
65
+ * @default "valg fjernet"
66
+ */
67
+ ariaLabelRemovedPlural?: string;
68
+ /** Tekst for skjermleser når flere elementer velges samtidig,
69
+ * f.eks. «5 lagt til, 8 valgte totalt»
70
+ * @default "lagt til"
71
+ */
72
+ ariaLabelAddedPlural?: string;
73
+ /** Tekst for skjermleser om hvor mange som er valgt totalt når flere
74
+ * elementer velges samtidig, f.eks. «5 lagt til, 8 valgte totalt»
75
+ * @default "valgte totalt"
76
+ */
77
+ ariaLabelChosenTotal?: string;
55
78
  /** Callback som kalles når brukeren går ut av input-feltet */
56
79
  onBlur?: (event: React.FocusEvent<HTMLInputElement>) => void;
57
80
  /** Callback når komponenten klikkes */
@@ -108,10 +131,33 @@ export declare const MultiSelect: <ValueType extends unknown>(props: Omit<Dropdo
108
131
  * @default "valgte"
109
132
  */
110
133
  ariaLabelChosenPlural?: string;
111
- /** Tekst for skjemleser for å hoppe til input-feltet
112
- * @default `${selectedItems.length} valgte elementer, trykk for å hoppe til tekstfeltet`
134
+ /** @deprecated Brukes ikke lenger. De valgte elementene er ikke med i
135
+ * tab-rekkefølgen, men nås med piltastene fra tekstfeltet.
113
136
  */
114
137
  ariaLabelJumpToInput?: string;
138
+ /** Tekst for skjermleser i tekstfeltet om hvordan man når de valgte elementene
139
+ * @default `${selectedItems.length} valgte, bruk venstre piltast for å gå til dem`
140
+ */
141
+ ariaLabelNavigateToSelected?: string;
142
+ /** Tekst for skjermleser når ett valgt element fjernes, f.eks. «Oslo fjernet»
143
+ * @default "fjernet"
144
+ */
145
+ ariaLabelRemovedSingular?: string;
146
+ /** Tekst for skjermleser når flere valgte elementer fjernes samtidig,
147
+ * f.eks. «5 valg fjernet»
148
+ * @default "valg fjernet"
149
+ */
150
+ ariaLabelRemovedPlural?: string;
151
+ /** Tekst for skjermleser når flere elementer velges samtidig,
152
+ * f.eks. «5 lagt til, 8 valgte totalt»
153
+ * @default "lagt til"
154
+ */
155
+ ariaLabelAddedPlural?: string;
156
+ /** Tekst for skjermleser om hvor mange som er valgt totalt når flere
157
+ * elementer velges samtidig, f.eks. «5 lagt til, 8 valgte totalt»
158
+ * @default "valgte totalt"
159
+ */
160
+ ariaLabelChosenTotal?: string;
115
161
  /** Callback som kalles når brukeren går ut av input-feltet */
116
162
  onBlur?: (event: React.FocusEvent<HTMLInputElement>) => void;
117
163
  /** Callback når komponenten klikkes */
@@ -1,12 +1,14 @@
1
1
  import { default as React } from 'react';
2
2
  import { UseComboboxGetToggleButtonPropsReturnValue, UseMultipleSelectionGetSelectedItemPropsOptions } from 'downshift';
3
3
  import { NormalizedDropdownItemType } from '../types';
4
- export declare const SelectedItemTag: <ValueType extends unknown>({ ariaLabelRemoveSelected, ariaLabelChosen, disabled, getSelectedItemProps, index, readOnly, removeSelectedItem, selectedItem, }: {
4
+ export declare const SelectedItemTag: <ValueType extends unknown>({ ariaLabelRemoveSelected, ariaLabelChosen, closeButtonRef, disabled, getSelectedItemProps, index, onKeyDown, readOnly, removeSelectedItem, selectedItem, }: {
5
5
  ariaLabelRemoveSelected: string;
6
6
  ariaLabelChosen?: string;
7
+ closeButtonRef?: React.Ref<HTMLButtonElement>;
7
8
  disabled?: boolean;
8
9
  getSelectedItemProps?: (options: UseMultipleSelectionGetSelectedItemPropsOptions<NormalizedDropdownItemType<ValueType>>) => any;
9
10
  index?: number;
11
+ onKeyDown?: (event: React.KeyboardEvent<HTMLDivElement>) => void;
10
12
  readOnly?: boolean;
11
13
  removeSelectedItem: (item: NormalizedDropdownItemType<ValueType>) => void;
12
14
  selectedItem: NormalizedDropdownItemType<ValueType>;
package/dist/dropdown.cjs CHANGED
@@ -180,19 +180,30 @@ const DropdownList = ({
180
180
  const SelectedItemTag = ({
181
181
  ariaLabelRemoveSelected,
182
182
  ariaLabelChosen = "valgt",
183
+ closeButtonRef,
183
184
  disabled,
184
185
  getSelectedItemProps,
185
186
  index,
187
+ onKeyDown,
186
188
  readOnly,
187
189
  removeSelectedItem,
188
190
  selectedItem
189
191
  }) => {
190
192
  if (!selectedItem) return null;
191
- const { tabIndex: _, ...selectedItemProps } = getSelectedItemProps?.({
193
+ const {
194
+ tabIndex: _tabIndex,
195
+ onClick: _onClick,
196
+ ...selectedItemProps
197
+ } = getSelectedItemProps?.({
192
198
  selectedItem,
193
199
  index
194
200
  }) ?? {};
195
- return /* @__PURE__ */ React.createElement(
201
+ const handleKeyDown = (e) => {
202
+ if (e.key === "Backspace" || e.key === "Delete") e.preventDefault();
203
+ selectedItemProps.onKeyDown?.(e);
204
+ onKeyDown?.(e);
205
+ };
206
+ return /* @__PURE__ */ jsxRuntime.jsx(
196
207
  chip.TagChip,
197
208
  {
198
209
  size: "small",
@@ -200,24 +211,24 @@ const SelectedItemTag = ({
200
211
  "eds-dropdown__selected-item-tag--readonly": readOnly,
201
212
  "eds-dropdown__selected-item-tag--disabled": disabled
202
213
  }),
214
+ ref: closeButtonRef,
203
215
  ...selectedItemProps,
216
+ onKeyDown: handleKeyDown,
204
217
  onClose: (e) => {
205
218
  e.stopPropagation();
206
219
  removeSelectedItem(selectedItem);
207
220
  },
208
- onClick: (e) => e.stopPropagation(),
209
221
  closeButtonAriaLabel: `${selectedItem.label} ${ariaLabelChosen}, ${ariaLabelRemoveSelected} `,
210
- key: selectedItem.value,
211
- "aria-live": "polite"
212
- },
213
- /* @__PURE__ */ jsxRuntime.jsx(
214
- "span",
215
- {
216
- "aria-hidden": "true",
217
- className: "eds-dropdown__selected-item-tag__text",
218
- children: selectedItem.label
219
- }
220
- )
222
+ closeButtonTabIndex: -1,
223
+ children: /* @__PURE__ */ jsxRuntime.jsx(
224
+ "span",
225
+ {
226
+ "aria-hidden": disabled || readOnly ? void 0 : true,
227
+ className: "eds-dropdown__selected-item-tag__text",
228
+ children: selectedItem.label
229
+ }
230
+ )
231
+ }
221
232
  );
222
233
  };
223
234
  const DropdownFieldAppendix = React.forwardRef(
@@ -523,7 +534,7 @@ const useMultiselectUtils = ({
523
534
  unselectAllListItems
524
535
  };
525
536
  };
526
- function getA11yStatusMessage(options) {
537
+ function getResultsStatusMessage(options) {
527
538
  const { isOpen, selectAllItemIncluded = false, resultCount } = options;
528
539
  if (!isOpen) {
529
540
  return "";
@@ -534,6 +545,35 @@ function getA11yStatusMessage(options) {
534
545
  }
535
546
  return `${resultCountWithoutSelectAll} resultat${resultCountWithoutSelectAll === 1 ? "" : "er"} tilgjengelig, naviger med pil opp eller ned, velg elementer med Enter.`;
536
547
  }
548
+ function getSelectionStatusMessage({
549
+ previousSelectedItems,
550
+ selectedItems,
551
+ ariaLabelChosenSingular,
552
+ ariaLabelAddedPlural,
553
+ ariaLabelChosenTotal,
554
+ ariaLabelRemovedSingular,
555
+ ariaLabelRemovedPlural
556
+ }) {
557
+ const includesValue = (items, item) => items.some((other) => other.value === item.value);
558
+ const added = selectedItems.filter(
559
+ (item) => !includesValue(previousSelectedItems, item)
560
+ );
561
+ const removed = previousSelectedItems.filter(
562
+ (item) => !includesValue(selectedItems, item)
563
+ );
564
+ const messages = [];
565
+ if (added.length === 1)
566
+ messages.push(`${added[0].label} ${ariaLabelChosenSingular}`);
567
+ else if (added.length > 1)
568
+ messages.push(
569
+ `${added.length} ${ariaLabelAddedPlural}, ${selectedItems.length} ${ariaLabelChosenTotal}`
570
+ );
571
+ if (removed.length === 1)
572
+ messages.push(`${removed[0].label} ${ariaLabelRemovedSingular}`);
573
+ else if (removed.length > 1)
574
+ messages.push(`${removed.length} ${ariaLabelRemovedPlural}`);
575
+ return messages.join(", ");
576
+ }
537
577
  const SearchableDropdown = React.forwardRef(
538
578
  ({
539
579
  ariaLabelChosenSingular,
@@ -677,7 +717,7 @@ const SearchableDropdown = React.forwardRef(
677
717
  if (highlightedIndex2 >= 0) setLastHighlightedIndex(highlightedIndex2);
678
718
  },
679
719
  // Accessibility
680
- getA11yStatusMessage: (options) => getA11yStatusMessage({ ...options, resultCount: listItems.length })
720
+ getA11yStatusMessage: (options) => getResultsStatusMessage({ ...options, resultCount: listItems.length })
681
721
  });
682
722
  React.useEffect(() => {
683
723
  if (value !== null && !inputHasFocus) {
@@ -883,10 +923,15 @@ const MultiSelect = React.forwardRef(
883
923
  selectOnTab = false,
884
924
  style,
885
925
  variant = "information",
886
- ariaLabelChosenSingular,
926
+ ariaLabelChosenSingular = "valgt",
887
927
  ariaLabelChosenPlural = "valgte",
928
+ ariaLabelRemovedSingular = "fjernet",
929
+ ariaLabelRemovedPlural = "valg fjernet",
930
+ ariaLabelAddedPlural = "lagt til",
931
+ ariaLabelChosenTotal = "valgte totalt",
888
932
  ariaLabelCloseList = "Lukk liste med valg",
889
- ariaLabelJumpToInput = `${selectedItems.length} valgte elementer, trykk for å hoppe til tekstfeltet`,
933
+ ariaLabelJumpToInput: _deprecatedAriaLabelJumpToInput,
934
+ ariaLabelNavigateToSelected = `${selectedItems.length} valgte, bruk venstre piltast for å gå til dem`,
890
935
  ariaLabelOpenList = "Åpne liste med valg",
891
936
  ariaLabelRemoveSelected = "trykk for å fjerne valg",
892
937
  ariaLabelSelectedItem,
@@ -911,6 +956,11 @@ const MultiSelect = React.forwardRef(
911
956
  fetchItems
912
957
  } = useResolvedItems(initialItems, debounceTimeout);
913
958
  const isAllNonAsyncItemsSelected = typeof initialItems !== "function" && selectedItems.length === normalizedItems.length;
959
+ const navigateToSelectedId = `eds-multiselect-navigate-to-selected${React.useId()}`;
960
+ const selectedLabelsId = `eds-multiselect-selected-labels${React.useId()}`;
961
+ const showSummary = selectedItems.length > maxChips;
962
+ const canNavigateToSelected = selectedItems.length > 0 && !disabled && !readOnly;
963
+ const summaryRef = React.useRef(null);
914
964
  const selectAllUniqueId = `select-all${React.useId()}`;
915
965
  const selectAll = React.useMemo(
916
966
  () => ({
@@ -964,11 +1014,15 @@ const MultiSelect = React.forwardRef(
964
1014
  selectAll,
965
1015
  selectedItems
966
1016
  });
1017
+ const pendingSelectionChange = React.useRef(null);
1018
+ const removalActiveIndex = React.useRef();
967
1019
  const {
1020
+ activeIndex,
968
1021
  getSelectedItemProps,
969
1022
  getDropdownProps,
970
1023
  reset,
971
1024
  removeSelectedItem,
1025
+ setActiveIndex,
972
1026
  setSelectedItems
973
1027
  } = downshift.useMultipleSelection({
974
1028
  selectedItems,
@@ -976,15 +1030,70 @@ const MultiSelect = React.forwardRef(
976
1030
  itemToString,
977
1031
  itemToKey,
978
1032
  ...environment && { environment },
979
- onSelectedItemsChange({ selectedItems: newSelectedItems }) {
1033
+ // Removing with the close button keeps focus where Backspace would. Done
1034
+ // here, in the same action, since a second dispatch would reapply the
1035
+ // controlled selectedItems and undo the removal
1036
+ stateReducer: (state, { type, changes }) => {
1037
+ if (type !== downshift.useMultipleSelection.stateChangeTypes.FunctionRemoveSelectedItem)
1038
+ return changes;
1039
+ const remaining = changes.selectedItems ?? [];
1040
+ const removedIndex = state.selectedItems.findIndex(
1041
+ (item) => !remaining.includes(item)
1042
+ );
1043
+ return {
1044
+ ...changes,
1045
+ activeIndex: remaining.length === 0 ? -1 : Math.min(removedIndex, remaining.length - 1)
1046
+ };
1047
+ },
1048
+ onSelectedItemsChange({ selectedItems: newSelectedItems = [] }) {
1049
+ pendingSelectionChange.current = {
1050
+ previousSelectedItems: selectedItems,
1051
+ requestedSelectedItems: newSelectedItems,
1052
+ previousActiveIndex: removalActiveIndex.current
1053
+ };
1054
+ removalActiveIndex.current = void 0;
980
1055
  onChange(newSelectedItems);
981
- }
1056
+ },
1057
+ // Only passed after a user action, so changes from the parent aren't
1058
+ // announced and an empty message can't cut off the result count
1059
+ getA11yStatusMessage: pendingSelectionChange.current ? (state) => {
1060
+ const {
1061
+ previousSelectedItems,
1062
+ requestedSelectedItems,
1063
+ previousActiveIndex
1064
+ } = pendingSelectionChange.current ?? {
1065
+ previousSelectedItems: state.selectedItems,
1066
+ requestedSelectedItems: state.selectedItems
1067
+ };
1068
+ pendingSelectionChange.current = null;
1069
+ const requestAccepted = requestedSelectedItems.length === state.selectedItems.length && requestedSelectedItems.every(
1070
+ (item) => state.selectedItems.some((s) => s.value === item.value)
1071
+ );
1072
+ if (!requestAccepted) return "";
1073
+ const message = getSelectionStatusMessage({
1074
+ previousSelectedItems,
1075
+ selectedItems: state.selectedItems,
1076
+ ariaLabelChosenSingular,
1077
+ ariaLabelAddedPlural,
1078
+ ariaLabelChosenTotal,
1079
+ ariaLabelRemovedSingular,
1080
+ ariaLabelRemovedPlural
1081
+ });
1082
+ const removed = previousSelectedItems.filter(
1083
+ (item) => !state.selectedItems.some((s) => s.value === item.value)
1084
+ );
1085
+ const removedIndex = removed.length === 1 ? previousSelectedItems.indexOf(removed[0]) : -1;
1086
+ const focusStayed = removedIndex >= 0 && state.activeIndex === removedIndex && (previousActiveIndex ?? removedIndex) === removedIndex;
1087
+ const focusedItem = focusStayed ? state.selectedItems[state.activeIndex] : void 0;
1088
+ return message && focusedItem ? `${message}, ${focusedItem.label}` : message;
1089
+ } : void 0
982
1090
  });
983
1091
  const stateReducer = React.useCallback(
984
1092
  (state, {
985
1093
  type,
986
1094
  changes
987
1095
  }) => {
1096
+ if (readOnly) return { ...state, isOpen: false };
988
1097
  switch (type) {
989
1098
  // keep menu open and edit input value on item selection
990
1099
  case downshift.useCombobox.stateChangeTypes.InputKeyDownEnter:
@@ -1039,7 +1148,7 @@ const MultiSelect = React.forwardRef(
1039
1148
  return changes;
1040
1149
  }
1041
1150
  },
1042
- [hideSelectAll, listItems, clearInputOnSelect]
1151
+ [hideSelectAll, listItems, clearInputOnSelect, readOnly]
1043
1152
  );
1044
1153
  const {
1045
1154
  getInputProps,
@@ -1072,7 +1181,7 @@ const MultiSelect = React.forwardRef(
1072
1181
  if (highlightedIndex2 >= 0) setLastHighlightedIndex(highlightedIndex2);
1073
1182
  },
1074
1183
  // Accessibility
1075
- getA11yStatusMessage: (options) => getA11yStatusMessage({
1184
+ getA11yStatusMessage: (options) => getResultsStatusMessage({
1076
1185
  ...options,
1077
1186
  selectAllItemIncluded: !hideSelectAll,
1078
1187
  resultCount: listItems.length
@@ -1118,12 +1227,35 @@ const MultiSelect = React.forwardRef(
1118
1227
  reset();
1119
1228
  };
1120
1229
  const dropdownProps = getDropdownProps({
1121
- preventKeyAction: isOpen,
1230
+ preventKeyAction: isOpen || readOnly,
1122
1231
  value: inputValue ?? EMPTY_INPUT,
1123
1232
  ref: utils.mergeRefs(inputRef, ref)
1124
1233
  });
1125
1234
  const inputProps = getInputProps({
1235
+ onBlur,
1236
+ onFocus: (e) => {
1237
+ if (activeIndex !== -1) setActiveIndex(-1);
1238
+ onFocus?.(e);
1239
+ },
1240
+ ...dropdownProps,
1126
1241
  onKeyDown: (e) => {
1242
+ if (readOnly) {
1243
+ if (e.key === "Backspace" || e.key === "Delete") e.preventDefault();
1244
+ return;
1245
+ }
1246
+ const caretAtStart = e.currentTarget.selectionStart === 0 && e.currentTarget.selectionEnd === 0;
1247
+ const hasModifier = e.shiftKey || e.ctrlKey || e.metaKey || e.altKey;
1248
+ if (e.key === "ArrowLeft" && !hasModifier && caretAtStart && canNavigateToSelected) {
1249
+ if (showSummary) {
1250
+ summaryRef.current?.focus();
1251
+ return;
1252
+ }
1253
+ if (isOpen) {
1254
+ setActiveIndex(selectedItems.length - 1);
1255
+ return;
1256
+ }
1257
+ }
1258
+ dropdownProps.onKeyDown?.(e);
1127
1259
  if (selectOnTab && isOpen && e.key === "Tab") {
1128
1260
  const highlitedItem = listItems[highlightedIndex];
1129
1261
  if (!highlitedItem) return;
@@ -1135,13 +1267,12 @@ const MultiSelect = React.forwardRef(
1135
1267
  });
1136
1268
  }
1137
1269
  },
1138
- onBlur,
1139
- onFocus,
1140
- ...dropdownProps,
1141
1270
  className: "eds-dropdown__input eds-form-control",
1142
- disabled: readOnly || disabled,
1271
+ disabled,
1272
+ readOnly,
1143
1273
  placeholder,
1144
- tabIndex: disabled || readOnly ? -1 : void 0
1274
+ tabIndex: disabled ? -1 : void 0,
1275
+ "aria-describedby": canNavigateToSelected ? navigateToSelectedId : readOnly && selectedItems.length > 0 ? selectedLabelsId : void 0
1145
1276
  });
1146
1277
  const labelProps = getLabelProps();
1147
1278
  const menuProps = getMenuProps({
@@ -1172,7 +1303,10 @@ const MultiSelect = React.forwardRef(
1172
1303
  labelTooltip,
1173
1304
  onClick: (e) => {
1174
1305
  if (e.target === e.currentTarget) inputProps?.onClick?.(e);
1175
- onClick?.(e);
1306
+ const clickedSelectedItem = e.target.closest(
1307
+ ".eds-dropdown__selected-item-tag"
1308
+ );
1309
+ if (!clickedSelectedItem) onClick?.(e);
1176
1310
  },
1177
1311
  onKeyDown,
1178
1312
  readOnly,
@@ -1211,8 +1345,9 @@ const MultiSelect = React.forwardRef(
1211
1345
  }
1212
1346
  ),
1213
1347
  children: [
1214
- selectedItems.length > 1 ? /* @__PURE__ */ jsxRuntime.jsx(a11y.VisuallyHidden, { onClick: () => inputRef.current?.focus(), children: ariaLabelJumpToInput }) : null,
1215
- selectedItems.length <= maxChips ? selectedItems.map((selectedItem, index) => /* @__PURE__ */ jsxRuntime.jsx(
1348
+ canNavigateToSelected ? /* @__PURE__ */ jsxRuntime.jsx(a11y.VisuallyHidden, { id: navigateToSelectedId, children: ariaLabelNavigateToSelected }) : null,
1349
+ (readOnly || disabled && showSummary) && selectedItems.length > 0 ? /* @__PURE__ */ jsxRuntime.jsx(a11y.VisuallyHidden, { id: selectedLabelsId, children: selectedItems.map((item) => item.label).join(", ") }) : null,
1350
+ !showSummary ? selectedItems.map((selectedItem, index) => /* @__PURE__ */ jsxRuntime.jsx(
1216
1351
  SelectedItemTag,
1217
1352
  {
1218
1353
  ariaLabelChosen: ariaLabelChosenSingular,
@@ -1222,18 +1357,26 @@ const MultiSelect = React.forwardRef(
1222
1357
  index,
1223
1358
  readOnly,
1224
1359
  removeSelectedItem: () => {
1360
+ removalActiveIndex.current = activeIndex;
1225
1361
  removeSelectedItem(selectedItem);
1226
- inputRef?.current?.focus();
1362
+ if (selectedItems.length === 1 && activeIndex === -1)
1363
+ inputRef.current?.focus();
1227
1364
  },
1228
1365
  selectedItem
1229
1366
  },
1230
- selectedItem?.label + (typeof selectedItem?.value === "string" ? selectedItem.value : "")
1367
+ index
1231
1368
  )) : /* @__PURE__ */ jsxRuntime.jsx(
1232
1369
  SelectedItemTag,
1233
1370
  {
1234
1371
  ariaLabelRemoveSelected: labelClearAllItems,
1235
1372
  ariaLabelChosen: "",
1373
+ closeButtonRef: summaryRef,
1236
1374
  disabled,
1375
+ onKeyDown: (e) => {
1376
+ if (e.key === "ArrowRight") inputRef.current?.focus();
1377
+ if (e.key === "Backspace" || e.key === "Delete")
1378
+ handleOnClear();
1379
+ },
1237
1380
  readOnly,
1238
1381
  removeSelectedItem: handleOnClear,
1239
1382
  selectedItem: summarySelectedItems