@pixum/combobox 5.10.4 → 5.10.6
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/lib/ComboBox.d.ts +32 -6
- package/lib/ComboBox.js +212 -77
- package/lib/ComboBox.js.map +1 -1
- package/lib/ComboBox.module.css +1 -0
- package/lib/ComboboxOptions/Options.d.ts +1 -0
- package/lib/ComboboxOptions/Options.js +22 -17
- package/lib/ComboboxOptions/Options.js.map +1 -1
- package/lib/ComboboxOptions/OptionsGroup.d.ts +1 -0
- package/lib/ComboboxOptions/OptionsGroup.js +48 -7
- package/lib/ComboboxOptions/OptionsGroup.js.map +1 -1
- package/lib/ComboboxOptions/index.js +61 -16
- package/lib/ComboboxOptions/index.js.map +1 -1
- package/lib/helper/calculateListMaxHeight.js +9 -5
- package/lib/helper/calculateListMaxHeight.js.map +1 -1
- package/lib/helper/index.d.ts +2 -0
- package/lib/helper/index.js +3 -0
- package/lib/helper/index.js.map +1 -0
- package/lib/helper/scrollOptionToViewport.js +12 -9
- package/lib/helper/scrollOptionToViewport.js.map +1 -1
- package/lib/helper/useIsDesktopScreenWidth.js +11 -9
- package/lib/helper/useIsDesktopScreenWidth.js.map +1 -1
- package/lib/hooks/index.d.ts +2 -0
- package/lib/hooks/index.js +2 -0
- package/lib/hooks/index.js.map +1 -1
- package/lib/hooks/useComboBox.d.ts +60 -0
- package/lib/hooks/useComboBox.js +226 -0
- package/lib/hooks/useComboBox.js.map +1 -0
- package/lib/hooks/useComboBoxFocus.d.ts +35 -0
- package/lib/hooks/useComboBoxFocus.js +49 -0
- package/lib/hooks/useComboBoxFocus.js.map +1 -0
- package/lib/hooks/useIsDesktopScreenWidth.d.ts +5 -0
- package/lib/hooks/useIsDesktopScreenWidth.js +34 -24
- package/lib/hooks/useIsDesktopScreenWidth.js.map +1 -1
- package/lib/index.d.ts +4 -4
- package/lib/index.js +2 -3
- package/lib/index.js.map +1 -1
- package/lib/partials/ComboBoxGroupedOptions.d.ts +13 -0
- package/lib/partials/ComboBoxGroupedOptions.js +10 -0
- package/lib/partials/ComboBoxGroupedOptions.js.map +1 -0
- package/lib/partials/ComboBoxMenu.d.ts +3 -0
- package/lib/partials/ComboBoxMenu.js +22 -0
- package/lib/partials/ComboBoxMenu.js.map +1 -0
- package/lib/partials/ComboBoxNoResults.d.ts +14 -0
- package/lib/partials/ComboBoxNoResults.js +18 -0
- package/lib/partials/ComboBoxNoResults.js.map +1 -0
- package/lib/partials/ComboBoxOptions.d.ts +16 -5
- package/lib/partials/ComboBoxOptions.js +25 -21
- package/lib/partials/ComboBoxOptions.js.map +1 -1
- package/lib/partials/ComboBoxOptionsGroup.d.ts +15 -0
- package/lib/partials/ComboBoxOptionsGroup.js +31 -0
- package/lib/partials/ComboBoxOptionsGroup.js.map +1 -0
- package/lib/partials/ComboBoxOptionsItems.d.ts +32 -17
- package/lib/partials/ComboBoxOptionsItems.js +46 -14
- package/lib/partials/ComboBoxOptionsItems.js.map +1 -1
- package/lib/partials/ComboBoxOptionsSlot.d.ts +17 -16
- package/lib/partials/ComboBoxOptionsSlot.js +26 -11
- package/lib/partials/ComboBoxOptionsSlot.js.map +1 -1
- package/lib/partials/index.d.ts +2 -1
- package/lib/partials/index.js +2 -1
- package/lib/partials/index.js.map +1 -1
- package/lib/types.d.ts +183 -45
- package/lib/utils/index.d.ts +1 -2
- package/lib/utils/index.js +1 -2
- package/lib/utils/index.js.map +1 -1
- package/lib/utils/options.d.ts +77 -0
- package/lib/utils/options.js +145 -0
- package/lib/utils/options.js.map +1 -0
- package/package.json +8 -8
|
@@ -1,32 +1,47 @@
|
|
|
1
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
2
|
+
var t = {};
|
|
3
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
4
|
+
t[p] = s[p];
|
|
5
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
6
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
7
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
8
|
+
t[p[i]] = s[p[i]];
|
|
9
|
+
}
|
|
10
|
+
return t;
|
|
11
|
+
};
|
|
1
12
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
-
import '../styles.css';
|
|
3
13
|
import Menu from '@pixum/menu';
|
|
4
14
|
import clsx from 'clsx';
|
|
15
|
+
import styles from '../ComboBox.module.css';
|
|
5
16
|
/**
|
|
6
|
-
* Styled container for optionsSlot content.
|
|
17
|
+
* Styled container for `optionsSlot` content.
|
|
7
18
|
*
|
|
8
|
-
* Applies the standard ComboBox dropdown appearance
|
|
9
|
-
* border
|
|
10
|
-
*
|
|
19
|
+
* Applies the standard ComboBox dropdown appearance - background, border,
|
|
20
|
+
* border radius, box shadow and top margin - so consumers do not have to
|
|
21
|
+
* replicate it in every `optionsSlot` implementation. Every other prop
|
|
22
|
+
* (`role`, `aria-*`, ...) is forwarded, because the slot content owns its own
|
|
23
|
+
* accessibility semantics.
|
|
11
24
|
*
|
|
12
|
-
*
|
|
25
|
+
* A slot replaces the built-in options list and therefore also its keyboard
|
|
26
|
+
* navigation: content rendered here has to bring its own key handling.
|
|
13
27
|
*
|
|
14
28
|
* ```tsx
|
|
15
29
|
* import ComboBox, { ComboBoxOptionsSlot } from '@pixum/combobox'
|
|
16
30
|
*
|
|
17
31
|
* <ComboBox
|
|
18
32
|
* optionsSlot={
|
|
19
|
-
* <ComboBoxOptionsSlot>
|
|
33
|
+
* <ComboBoxOptionsSlot role="listbox" aria-label="Pickup points">
|
|
20
34
|
* <MyCustomOptionsList />
|
|
21
35
|
* </ComboBoxOptionsSlot>
|
|
22
36
|
* }
|
|
23
37
|
* />
|
|
24
38
|
* ```
|
|
25
39
|
*
|
|
26
|
-
* @param
|
|
27
|
-
* @returns A styled wrapper
|
|
40
|
+
* @param props - The props for the ComboBoxOptionsSlot component
|
|
41
|
+
* @returns A styled wrapper matching the ComboBox dropdown look
|
|
28
42
|
*/
|
|
29
|
-
export function ComboBoxOptionsSlot(
|
|
30
|
-
|
|
43
|
+
export function ComboBoxOptionsSlot(_a) {
|
|
44
|
+
var { children, className, tag = 'ul' } = _a, rest = __rest(_a, ["children", "className", "tag"]);
|
|
45
|
+
return (_jsx(Menu, Object.assign({ tag: tag, className: clsx(styles.optionsSlot, className) }, rest, { children: children })));
|
|
31
46
|
}
|
|
32
47
|
//# sourceMappingURL=ComboBoxOptionsSlot.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ComboBoxOptionsSlot.js","sourceRoot":"","sources":["../../src/partials/ComboBoxOptionsSlot.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ComboBoxOptionsSlot.js","sourceRoot":"","sources":["../../src/partials/ComboBoxOptionsSlot.tsx"],"names":[],"mappings":";;;;;;;;;;;;AACA,OAAO,IAAI,MAAM,aAAa,CAAA;AAC9B,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAU3C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,mBAAmB,CAAC,EAKT;QALS,EAClC,QAAQ,EACR,SAAS,EACT,GAAG,GAAG,IAAI,OAEe,EADtB,IAAI,cAJ2B,gCAKnC,CADQ;IAEP,OAAO,CACL,KAAC,IAAI,kBAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,IAAM,IAAI,cACrE,QAAQ,IACJ,CACR,CAAA;AACH,CAAC"}
|
package/lib/partials/index.d.ts
CHANGED
package/lib/partials/index.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
export * from './ComboBoxOptions';
|
|
2
|
-
export * from './
|
|
2
|
+
export * from './ComboBoxOptionsGroup';
|
|
3
3
|
export * from './ComboBoxOptionsItems';
|
|
4
4
|
export * from './ComboBoxOptionsSlot';
|
|
5
|
+
export * from './ComboBoxNoResults';
|
|
5
6
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/partials/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/partials/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,qBAAqB,CAAA"}
|
package/lib/types.d.ts
CHANGED
|
@@ -1,78 +1,216 @@
|
|
|
1
|
-
import { LeadingType, MenuItemProps } from '@pixum/menu-item';
|
|
2
|
-
import { ThemeType } from '@pixum/theme-provider';
|
|
3
|
-
import { InputModesType } from '@pixum/web-input';
|
|
1
|
+
import type { LeadingType, MenuItemProps } from '@pixum/menu-item';
|
|
2
|
+
import type { ThemeType } from '@pixum/theme-provider';
|
|
3
|
+
import type { InputModesType } from '@pixum/web-input';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* An option as handed in by the consumer.
|
|
6
|
+
*
|
|
7
|
+
* Everything a `MenuItem` understands is accepted and forwarded unchanged -
|
|
8
|
+
* the ComboBox only adds `key` and `disabled` on top. That keeps existing
|
|
9
|
+
* consumers working: they pass their MenuItem props as they always did, and
|
|
10
|
+
* props the ComboBox does not know about still reach the `MenuItem`.
|
|
11
|
+
*/
|
|
12
|
+
export interface ComboBoxOptionItemProps extends MenuItemProps {
|
|
13
|
+
/** Unique key for the option item */
|
|
14
|
+
key?: string;
|
|
15
|
+
/**
|
|
16
|
+
* Disabled options are rendered, but skipped by mouse and keyboard.
|
|
17
|
+
*
|
|
18
|
+
* Newly added. Consumer types that already carry a `disabled` field of a
|
|
19
|
+
* different type (e.g. `disabled: 'true' | 'false'`) are no longer
|
|
20
|
+
* assignable - widen it to `boolean` on the consumer side.
|
|
21
|
+
*/
|
|
22
|
+
disabled?: boolean;
|
|
23
|
+
}
|
|
24
|
+
/** Options are accepted either as a flat list or grouped by a group headline. */
|
|
25
|
+
export type ComboBoxOptionsInput = ComboBoxOptionItemProps[] | Record<string, ComboBoxOptionItemProps[]>;
|
|
26
|
+
/**
|
|
27
|
+
* An option after normalisation. Flat and grouped options are reduced to this
|
|
28
|
+
* shape once, so keyboard navigation, rendering and ARIA ids all work on the
|
|
29
|
+
* very same list in the very same order.
|
|
30
|
+
*/
|
|
31
|
+
export interface ComboBoxOption {
|
|
32
|
+
/** The original option as handed in by the consumer. */
|
|
33
|
+
item: ComboBoxOptionItemProps;
|
|
34
|
+
/**
|
|
35
|
+
* Stable value of the option, reported by `onOptionItemClick` and compared
|
|
36
|
+
* against `value`. Resolved by `resolveOptionValue`: the option's `text` when
|
|
37
|
+
* it is a string, otherwise `key`, otherwise the render index.
|
|
38
|
+
*/
|
|
39
|
+
value: string;
|
|
40
|
+
/** Position in render order. Drives the DOM id and the keyboard navigation. */
|
|
41
|
+
index: number;
|
|
42
|
+
/** DOM id, referenced by `aria-activedescendant`. */
|
|
43
|
+
id: string;
|
|
44
|
+
/** Group headline the option belongs to, `undefined` for flat lists. */
|
|
45
|
+
group?: string;
|
|
46
|
+
/** Whether the option can be activated. */
|
|
47
|
+
disabled: boolean;
|
|
48
|
+
}
|
|
49
|
+
/** Options of one render group, produced by `groupOptions`. */
|
|
50
|
+
export interface ComboBoxOptionGroup {
|
|
51
|
+
/** Group headline, `undefined` for flat lists. */
|
|
52
|
+
group?: string;
|
|
53
|
+
/** Options of this group, still carrying their global render index. */
|
|
54
|
+
options: ComboBoxOption[];
|
|
55
|
+
}
|
|
56
|
+
/** ARIA props for the element that owns the `combobox` role. */
|
|
57
|
+
export interface ComboBoxAriaProps {
|
|
58
|
+
role: 'combobox';
|
|
59
|
+
'aria-expanded': boolean;
|
|
60
|
+
'aria-haspopup': 'listbox';
|
|
61
|
+
'aria-controls': string | undefined;
|
|
62
|
+
'aria-activedescendant': string | undefined;
|
|
63
|
+
'aria-autocomplete': 'list' | 'none';
|
|
64
|
+
}
|
|
65
|
+
/** ARIA props for the element that owns the `listbox` role. */
|
|
66
|
+
export interface ListboxAriaProps {
|
|
67
|
+
role: 'listbox';
|
|
68
|
+
id: string;
|
|
69
|
+
/** Only set for multi select; single select listboxes omit it. */
|
|
70
|
+
'aria-multiselectable'?: boolean;
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* Public options contract, kept for backwards compatibility.
|
|
74
|
+
*
|
|
75
|
+
* In the previous version this interface was the base of `ComboBoxProps` and
|
|
76
|
+
* the prop type of
|
|
77
|
+
* the exported options component. It describes the options as the *consumer*
|
|
78
|
+
* hands them in - not the normalised list the internal panel renders. The
|
|
79
|
+
* internal shape now lives in `ComboBoxOptionsPanelProps`.
|
|
80
|
+
*
|
|
81
|
+
* @deprecated Use `ComboBoxProps` (or `Pick<ComboBoxProps, 'options'>`)
|
|
82
|
+
* directly. Kept so existing imports do not silently change meaning; will be
|
|
83
|
+
* removed in the next major.
|
|
6
84
|
*/
|
|
7
85
|
export interface ComboBoxOptionsProps {
|
|
8
|
-
/** Options to display
|
|
9
|
-
options:
|
|
10
|
-
/**
|
|
86
|
+
/** Options to display, either flat or grouped. */
|
|
87
|
+
options: ComboBoxOptionsInput;
|
|
88
|
+
/**
|
|
89
|
+
* Currently selected option value.
|
|
90
|
+
*
|
|
91
|
+
* @deprecated Use `value`. When both are set, `value` wins.
|
|
92
|
+
*/
|
|
11
93
|
selectedOption?: string;
|
|
12
|
-
/**
|
|
94
|
+
/**
|
|
95
|
+
* Callback fired when an option is clicked.
|
|
96
|
+
*
|
|
97
|
+
* @deprecated Use `onOptionItemClick`. On `ComboBoxProps` this prop is
|
|
98
|
+
* narrowed to the trigger click handler `() => void`.
|
|
99
|
+
*/
|
|
13
100
|
onClick?: (value: string) => void;
|
|
14
|
-
/** Type of leading element to display (icon, avatar,
|
|
101
|
+
/** Type of leading element to display (icon, avatar, checkbox …). */
|
|
102
|
+
leadingType?: LeadingType;
|
|
103
|
+
/** Additional details rendered below the options. */
|
|
104
|
+
optionDetails?: React.ReactNode;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Props of the rendered options panel - the internal, normalised shape.
|
|
108
|
+
*
|
|
109
|
+
* This is what `ComboBoxOptions` consumes. It is exported so custom panels can
|
|
110
|
+
* be typed against it, but it is not part of the consumer-facing API and may
|
|
111
|
+
* change without a major bump.
|
|
112
|
+
*/
|
|
113
|
+
export interface ComboBoxOptionsPanelProps {
|
|
114
|
+
/** Normalised options in render order. */
|
|
115
|
+
options: ComboBoxOption[];
|
|
116
|
+
/** ARIA props of the listbox element. */
|
|
117
|
+
listboxAriaProps: ListboxAriaProps;
|
|
118
|
+
/** Values that are currently selected. */
|
|
119
|
+
selectedValues: string[];
|
|
120
|
+
/** DOM id of the active option (`aria-activedescendant`). */
|
|
121
|
+
activeOptionId?: string;
|
|
122
|
+
/** Type of the leading element, e.g. a checkbox for multi select. */
|
|
15
123
|
leadingType?: LeadingType;
|
|
16
|
-
/** Additional details
|
|
124
|
+
/** Additional details rendered as a sticky footer below the options. */
|
|
17
125
|
optionDetails?: React.ReactNode;
|
|
126
|
+
/** Called with the value of the clicked option. */
|
|
127
|
+
onOptionClick: (value: string) => void;
|
|
18
128
|
}
|
|
19
129
|
/**
|
|
20
|
-
* Props
|
|
130
|
+
* Props of the ComboBox component.
|
|
131
|
+
*
|
|
132
|
+
* Extends the deprecated `ComboBoxOptionsProps` so that consumers who built
|
|
133
|
+
* their own prop types on top of it keep compiling.
|
|
21
134
|
*/
|
|
22
135
|
export interface ComboBoxProps extends ComboBoxOptionsProps {
|
|
23
|
-
/** Additional CSS class name for the
|
|
136
|
+
/** Additional CSS class name for the trigger field. */
|
|
24
137
|
className?: string;
|
|
25
|
-
/** Name attribute for the input field */
|
|
138
|
+
/** Name attribute for the input field. */
|
|
26
139
|
name?: string;
|
|
27
|
-
/**
|
|
140
|
+
/**
|
|
141
|
+
* ID attribute for the input field.
|
|
142
|
+
*
|
|
143
|
+
* @deprecated The trigger generates its own ids for the ARIA wiring; `id` is
|
|
144
|
+
* forwarded to the underlying input untouched and no longer used internally.
|
|
145
|
+
*/
|
|
146
|
+
id?: string;
|
|
147
|
+
/** Headline text displayed in the mobile bottom sheet. */
|
|
28
148
|
headline?: string;
|
|
29
|
-
/** Helper text displayed below the input */
|
|
149
|
+
/** Helper text displayed below the input field. */
|
|
30
150
|
helperText?: string;
|
|
31
|
-
/**
|
|
32
|
-
id?: string;
|
|
33
|
-
/** Label text for the input field */
|
|
151
|
+
/** Label text for the input field. */
|
|
34
152
|
label?: string;
|
|
35
|
-
/**
|
|
153
|
+
/** Options to display, either flat or grouped. */
|
|
154
|
+
options: ComboBoxOptionsInput;
|
|
155
|
+
/** Whether the popover / bottom sheet is currently open. */
|
|
36
156
|
isOpen: boolean;
|
|
37
|
-
/** State setter
|
|
157
|
+
/** State setter that controls the open state. */
|
|
38
158
|
setIsOpen: React.Dispatch<React.SetStateAction<boolean>>;
|
|
39
|
-
/**
|
|
40
|
-
|
|
41
|
-
|
|
159
|
+
/**
|
|
160
|
+
* Selected value: a string for single select, an array of strings when
|
|
161
|
+
* `multiple` is set.
|
|
162
|
+
*
|
|
163
|
+
* The array member is new in this version. Code that *reads* this prop back
|
|
164
|
+
* out of
|
|
165
|
+
* a props object has to narrow it (`Array.isArray(value)`).
|
|
166
|
+
*/
|
|
167
|
+
value?: string | string[];
|
|
168
|
+
/** Allows selecting several options; combine with a checkbox `leadingType`. */
|
|
169
|
+
multiple?: boolean;
|
|
170
|
+
/** Called with the value of the selected (in multi select: toggled) option. */
|
|
42
171
|
onOptionItemClick?: (value: string) => void;
|
|
43
|
-
/**
|
|
172
|
+
/** Called when the search input value changes. */
|
|
173
|
+
onChange?: (value: string) => void;
|
|
174
|
+
/** Called when the user clicks outside of the component. */
|
|
44
175
|
onOutsideClick?: () => void;
|
|
45
|
-
/**
|
|
176
|
+
/** Called when the trigger field is clicked. */
|
|
46
177
|
onClick?: () => void;
|
|
47
|
-
/**
|
|
178
|
+
/** Called when the bottom sheet has been closed. */
|
|
48
179
|
onSheetClose?: () => void;
|
|
49
|
-
/** Placeholder text for the input field */
|
|
180
|
+
/** Placeholder text for the input field. */
|
|
50
181
|
placeholder?: string;
|
|
51
|
-
/** Search pattern
|
|
182
|
+
/** Search pattern for input validation. */
|
|
52
183
|
searchPattern?: string;
|
|
53
|
-
/**
|
|
54
|
-
value?: string;
|
|
55
|
-
/** Text to display when no results are found */
|
|
184
|
+
/** Text to display when there is no option to show. */
|
|
56
185
|
noResultsText?: string;
|
|
57
|
-
/** Input mode for mobile keyboards
|
|
186
|
+
/** Input mode for mobile keyboards. */
|
|
58
187
|
inputMode?: InputModesType;
|
|
59
|
-
/**
|
|
188
|
+
/** Renders a search input inside the popover / bottom sheet. */
|
|
60
189
|
withSearch?: boolean;
|
|
61
|
-
/**
|
|
190
|
+
/** Enter opens the closed list. Disable it inside forms with implicit submit. */
|
|
191
|
+
openOnEnter?: boolean;
|
|
192
|
+
/** Whether the combobox is disabled. */
|
|
62
193
|
disabled?: boolean;
|
|
63
|
-
/**
|
|
194
|
+
/** Disabled style plus shimmer animation while content is loading. */
|
|
64
195
|
loading?: boolean;
|
|
65
|
-
/**
|
|
196
|
+
/** Type of the leading element of an option (icon, avatar, checkbox …). */
|
|
197
|
+
leadingType?: LeadingType;
|
|
198
|
+
/** Additional details rendered below the options. */
|
|
199
|
+
optionDetails?: React.ReactNode;
|
|
200
|
+
/** Theme configuration for the component. */
|
|
66
201
|
theme?: ThemeType;
|
|
67
|
-
/** Custom slot that replaces the standard options/no-results block */
|
|
202
|
+
/** Custom slot that replaces the standard options / no-results block. */
|
|
68
203
|
optionsSlot?: React.ReactNode;
|
|
69
|
-
/**
|
|
204
|
+
/**
|
|
205
|
+
* Icon element displayed at the leading side of the trigger input.
|
|
206
|
+
*
|
|
207
|
+
* Deliberately `ReactNode`, not `ReactElement`: fragments, strings and
|
|
208
|
+
* conditional `false` have always been accepted here.
|
|
209
|
+
*/
|
|
70
210
|
leadingIcon?: React.ReactNode;
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
/** Unique key for the option item */
|
|
77
|
-
key?: string;
|
|
211
|
+
/**
|
|
212
|
+
* Formats the selected values for the trigger field.
|
|
213
|
+
* Defaults to the labels of the selected options joined by a comma.
|
|
214
|
+
*/
|
|
215
|
+
renderValue?: (labels: string[]) => string;
|
|
78
216
|
}
|
package/lib/utils/index.d.ts
CHANGED
|
@@ -1,2 +1 @@
|
|
|
1
|
-
export * from './
|
|
2
|
-
export * from './scrollOptionToViewport';
|
|
1
|
+
export * from './options';
|
package/lib/utils/index.js
CHANGED
package/lib/utils/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import type { MenuItemProps } from '@pixum/menu-item';
|
|
2
|
+
import type { ComboBoxOption, ComboBoxOptionGroup, ComboBoxOptionItemProps, ComboBoxOptionsInput } from '../types';
|
|
3
|
+
/**
|
|
4
|
+
* Resolves the stable value of an option.
|
|
5
|
+
*
|
|
6
|
+
* `MenuItemProps` does not guarantee a plain string `text`, so the value is
|
|
7
|
+
* resolved in three steps: the visible label first - that is the value existing
|
|
8
|
+
* consumers pass in as `value` and get back from `onOptionItemClick` -, then
|
|
9
|
+
* the explicit `key`, and finally the render index as a last resort so that
|
|
10
|
+
* options without a label still get a unique value.
|
|
11
|
+
*
|
|
12
|
+
* @param item - The option as handed in by the consumer
|
|
13
|
+
* @param index - Position of the option in render order
|
|
14
|
+
* @returns The stable value of the option
|
|
15
|
+
*/
|
|
16
|
+
export declare function resolveOptionValue(item: ComboBoxOptionItemProps, index: number): string;
|
|
17
|
+
/**
|
|
18
|
+
* Returns the label of an option for the trigger field.
|
|
19
|
+
*
|
|
20
|
+
* Falls back to the resolved value when the option renders a custom node
|
|
21
|
+
* instead of a plain string.
|
|
22
|
+
*
|
|
23
|
+
* @param option - A normalised option
|
|
24
|
+
* @returns The label to display in the trigger field
|
|
25
|
+
*/
|
|
26
|
+
export declare function getOptionLabel(option: ComboBoxOption): string;
|
|
27
|
+
/**
|
|
28
|
+
* Strips the ComboBox specific props from an option so the rest can be spread
|
|
29
|
+
* onto the `MenuItem`.
|
|
30
|
+
*
|
|
31
|
+
* `key` is a reserved React prop and `disabled` is handled by the option
|
|
32
|
+
* wrapper (`aria-disabled` plus the click guard); everything else belongs to
|
|
33
|
+
* `MenuItem` and is forwarded untouched.
|
|
34
|
+
*
|
|
35
|
+
* @param item - The option as handed in by the consumer
|
|
36
|
+
* @returns The props meant for the `MenuItem`
|
|
37
|
+
*/
|
|
38
|
+
export declare function toMenuItemProps({ key, disabled, ...menuItemProps }: ComboBoxOptionItemProps): MenuItemProps;
|
|
39
|
+
/**
|
|
40
|
+
* Normalises flat and grouped options into one list in render order.
|
|
41
|
+
*
|
|
42
|
+
* The index of an entry is identical for both input shapes and is therefore
|
|
43
|
+
* used as the option DOM id that `aria-activedescendant` points at. Doing this
|
|
44
|
+
* once removes the offset arithmetic that grouped rendering used to need.
|
|
45
|
+
*
|
|
46
|
+
* @param options - Flat or grouped options as passed in by the consumer
|
|
47
|
+
* @param listboxId - Id of the listbox, used as prefix for the option ids
|
|
48
|
+
* @returns The normalised options in render order
|
|
49
|
+
*/
|
|
50
|
+
export declare function normaliseOptions(options: ComboBoxOptionsInput, listboxId: string): ComboBoxOption[];
|
|
51
|
+
/**
|
|
52
|
+
* Splits normalised options back into their render groups while keeping the
|
|
53
|
+
* global indices intact, so that the list can be rendered with a single code
|
|
54
|
+
* path for flat and grouped options.
|
|
55
|
+
*
|
|
56
|
+
* @param options - Normalised options in render order
|
|
57
|
+
* @returns One entry per consecutive group
|
|
58
|
+
*/
|
|
59
|
+
export declare function groupOptions(options: ComboBoxOption[]): ComboBoxOptionGroup[];
|
|
60
|
+
/**
|
|
61
|
+
* Normalises the `value` prop to an array, so that single and multi select
|
|
62
|
+
* share the same selection logic.
|
|
63
|
+
*
|
|
64
|
+
* @param value - Selected value(s) or `undefined`
|
|
65
|
+
* @returns The selected values as an array
|
|
66
|
+
*/
|
|
67
|
+
export declare function toValueArray(value: string | string[] | undefined): string[];
|
|
68
|
+
/**
|
|
69
|
+
* Finds the first option that can be activated, starting at `start` and moving
|
|
70
|
+
* by `delta` with wrap-around. Disabled options are skipped.
|
|
71
|
+
*
|
|
72
|
+
* @param options - Normalised options
|
|
73
|
+
* @param start - Index to start from; use `-1` to start before the first option
|
|
74
|
+
* @param delta - Step width, negative values move backwards
|
|
75
|
+
* @returns The index of the next enabled option, or `null` when there is none
|
|
76
|
+
*/
|
|
77
|
+
export declare function findEnabledIndex(options: ComboBoxOption[], start: number, delta: number): number | null;
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
2
|
+
var t = {};
|
|
3
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
4
|
+
t[p] = s[p];
|
|
5
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
6
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
7
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
8
|
+
t[p[i]] = s[p[i]];
|
|
9
|
+
}
|
|
10
|
+
return t;
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* Resolves the stable value of an option.
|
|
14
|
+
*
|
|
15
|
+
* `MenuItemProps` does not guarantee a plain string `text`, so the value is
|
|
16
|
+
* resolved in three steps: the visible label first - that is the value existing
|
|
17
|
+
* consumers pass in as `value` and get back from `onOptionItemClick` -, then
|
|
18
|
+
* the explicit `key`, and finally the render index as a last resort so that
|
|
19
|
+
* options without a label still get a unique value.
|
|
20
|
+
*
|
|
21
|
+
* @param item - The option as handed in by the consumer
|
|
22
|
+
* @param index - Position of the option in render order
|
|
23
|
+
* @returns The stable value of the option
|
|
24
|
+
*/
|
|
25
|
+
export function resolveOptionValue(item, index) {
|
|
26
|
+
if (typeof item.text === 'string' && item.text)
|
|
27
|
+
return item.text;
|
|
28
|
+
if (item.key)
|
|
29
|
+
return item.key;
|
|
30
|
+
return `option-${index}`;
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Returns the label of an option for the trigger field.
|
|
34
|
+
*
|
|
35
|
+
* Falls back to the resolved value when the option renders a custom node
|
|
36
|
+
* instead of a plain string.
|
|
37
|
+
*
|
|
38
|
+
* @param option - A normalised option
|
|
39
|
+
* @returns The label to display in the trigger field
|
|
40
|
+
*/
|
|
41
|
+
export function getOptionLabel(option) {
|
|
42
|
+
if (typeof option.item.text === 'string' && option.item.text) {
|
|
43
|
+
return option.item.text;
|
|
44
|
+
}
|
|
45
|
+
return option.value;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* Strips the ComboBox specific props from an option so the rest can be spread
|
|
49
|
+
* onto the `MenuItem`.
|
|
50
|
+
*
|
|
51
|
+
* `key` is a reserved React prop and `disabled` is handled by the option
|
|
52
|
+
* wrapper (`aria-disabled` plus the click guard); everything else belongs to
|
|
53
|
+
* `MenuItem` and is forwarded untouched.
|
|
54
|
+
*
|
|
55
|
+
* @param item - The option as handed in by the consumer
|
|
56
|
+
* @returns The props meant for the `MenuItem`
|
|
57
|
+
*/
|
|
58
|
+
export function toMenuItemProps(_a) {
|
|
59
|
+
var { key, disabled } = _a, menuItemProps = __rest(_a, ["key", "disabled"]);
|
|
60
|
+
return menuItemProps;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Normalises flat and grouped options into one list in render order.
|
|
64
|
+
*
|
|
65
|
+
* The index of an entry is identical for both input shapes and is therefore
|
|
66
|
+
* used as the option DOM id that `aria-activedescendant` points at. Doing this
|
|
67
|
+
* once removes the offset arithmetic that grouped rendering used to need.
|
|
68
|
+
*
|
|
69
|
+
* @param options - Flat or grouped options as passed in by the consumer
|
|
70
|
+
* @param listboxId - Id of the listbox, used as prefix for the option ids
|
|
71
|
+
* @returns The normalised options in render order
|
|
72
|
+
*/
|
|
73
|
+
export function normaliseOptions(options, listboxId) {
|
|
74
|
+
const groups = Array.isArray(options)
|
|
75
|
+
? [['', options]]
|
|
76
|
+
: Object.entries(options);
|
|
77
|
+
const normalised = [];
|
|
78
|
+
groups.forEach(([group, items]) => {
|
|
79
|
+
items.forEach(item => {
|
|
80
|
+
const index = normalised.length;
|
|
81
|
+
normalised.push({
|
|
82
|
+
item,
|
|
83
|
+
group: group || undefined,
|
|
84
|
+
value: resolveOptionValue(item, index),
|
|
85
|
+
index,
|
|
86
|
+
id: `${listboxId}-option-${index}`,
|
|
87
|
+
disabled: item.disabled === true,
|
|
88
|
+
});
|
|
89
|
+
});
|
|
90
|
+
});
|
|
91
|
+
return normalised;
|
|
92
|
+
}
|
|
93
|
+
/**
|
|
94
|
+
* Splits normalised options back into their render groups while keeping the
|
|
95
|
+
* global indices intact, so that the list can be rendered with a single code
|
|
96
|
+
* path for flat and grouped options.
|
|
97
|
+
*
|
|
98
|
+
* @param options - Normalised options in render order
|
|
99
|
+
* @returns One entry per consecutive group
|
|
100
|
+
*/
|
|
101
|
+
export function groupOptions(options) {
|
|
102
|
+
return options.reduce((groups, option) => {
|
|
103
|
+
const current = groups[groups.length - 1];
|
|
104
|
+
if (current && current.group === option.group) {
|
|
105
|
+
current.options.push(option);
|
|
106
|
+
return groups;
|
|
107
|
+
}
|
|
108
|
+
groups.push({ group: option.group, options: [option] });
|
|
109
|
+
return groups;
|
|
110
|
+
}, []);
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Normalises the `value` prop to an array, so that single and multi select
|
|
114
|
+
* share the same selection logic.
|
|
115
|
+
*
|
|
116
|
+
* @param value - Selected value(s) or `undefined`
|
|
117
|
+
* @returns The selected values as an array
|
|
118
|
+
*/
|
|
119
|
+
export function toValueArray(value) {
|
|
120
|
+
if (Array.isArray(value))
|
|
121
|
+
return value;
|
|
122
|
+
return value ? [value] : [];
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Finds the first option that can be activated, starting at `start` and moving
|
|
126
|
+
* by `delta` with wrap-around. Disabled options are skipped.
|
|
127
|
+
*
|
|
128
|
+
* @param options - Normalised options
|
|
129
|
+
* @param start - Index to start from; use `-1` to start before the first option
|
|
130
|
+
* @param delta - Step width, negative values move backwards
|
|
131
|
+
* @returns The index of the next enabled option, or `null` when there is none
|
|
132
|
+
*/
|
|
133
|
+
export function findEnabledIndex(options, start, delta) {
|
|
134
|
+
const { length } = options;
|
|
135
|
+
if (length === 0)
|
|
136
|
+
return null;
|
|
137
|
+
let index = start;
|
|
138
|
+
for (let step = 0; step < length; step += 1) {
|
|
139
|
+
index = (index + delta + length) % length;
|
|
140
|
+
if (!options[index].disabled)
|
|
141
|
+
return index;
|
|
142
|
+
}
|
|
143
|
+
return null;
|
|
144
|
+
}
|
|
145
|
+
//# sourceMappingURL=options.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/utils/options.ts"],"names":[],"mappings":";;;;;;;;;;;AAQA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAA6B,EAC7B,KAAa;IAEb,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC,IAAI,CAAA;IAChE,IAAI,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC,GAAG,CAAA;IAE7B,OAAO,UAAU,KAAK,EAAE,CAAA;AAC1B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,MAAsB;IACnD,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAC7D,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;IACzB,CAAC;IAED,OAAO,MAAM,CAAC,KAAK,CAAA;AACrB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,eAAe,CAAC,EAIN;QAJM,EAC9B,GAAG,EACH,QAAQ,OAEgB,EADrB,aAAa,cAHc,mBAI/B,CADiB;IAEhB,OAAO,aAAa,CAAA;AACtB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAA6B,EAC7B,SAAiB;IAEjB,MAAM,MAAM,GAA0C,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;QAC1E,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACjB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAE3B,MAAM,UAAU,GAAqB,EAAE,CAAA;IAEvC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE;QAChC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACnB,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAA;YAE/B,UAAU,CAAC,IAAI,CAAC;gBACd,IAAI;gBACJ,KAAK,EAAE,KAAK,IAAI,SAAS;gBACzB,KAAK,EAAE,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC;gBACtC,KAAK;gBACL,EAAE,EAAE,GAAG,SAAS,WAAW,KAAK,EAAE;gBAClC,QAAQ,EAAE,IAAI,CAAC,QAAQ,KAAK,IAAI;aACjC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,OAAyB;IACpD,OAAO,OAAO,CAAC,MAAM,CAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;QAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAEzC,IAAI,OAAO,IAAI,OAAO,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC;YAC9C,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;YAE5B,OAAO,MAAM,CAAA;QACf,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAEvD,OAAO,MAAM,CAAA;IACf,CAAC,EAAE,EAAE,CAAC,CAAA;AACR,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,KAAoC;IAC/D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAA;IAEtC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAC7B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAyB,EACzB,KAAa,EACb,KAAa;IAEb,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;IAC1B,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IAE7B,IAAI,KAAK,GAAG,KAAK,CAAA;IAEjB,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,MAAM,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC;QAC5C,KAAK,GAAG,CAAC,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC,GAAG,MAAM,CAAA;QAEzC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ;YAAE,OAAO,KAAK,CAAA;IAC5C,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pixum/combobox",
|
|
3
|
-
"version": "5.10.
|
|
3
|
+
"version": "5.10.6",
|
|
4
4
|
"main": "lib/index.js",
|
|
5
5
|
"module": "lib/index.js",
|
|
6
6
|
"license": "UNLICENSED",
|
|
7
7
|
"peerDependencies": {
|
|
8
|
-
"@pixum/bottom-sheet": "
|
|
9
|
-
"@pixum/menu": "
|
|
10
|
-
"@pixum/menu-item": "
|
|
11
|
-
"@pixum/text": "
|
|
12
|
-
"@pixum/theme-provider": "
|
|
13
|
-
"@pixum/web-input": "2.
|
|
8
|
+
"@pixum/bottom-sheet": "4.9.0",
|
|
9
|
+
"@pixum/menu": "4.4.0",
|
|
10
|
+
"@pixum/menu-item": "3.4.1",
|
|
11
|
+
"@pixum/text": "3.7.0",
|
|
12
|
+
"@pixum/theme-provider": "5.6.0",
|
|
13
|
+
"@pixum/web-input": "2.5.4"
|
|
14
14
|
},
|
|
15
15
|
"files": [
|
|
16
16
|
"lib"
|
|
@@ -18,5 +18,5 @@
|
|
|
18
18
|
"sideEffects": [
|
|
19
19
|
"*.css"
|
|
20
20
|
],
|
|
21
|
-
"gitHead": "
|
|
21
|
+
"gitHead": "11fc8bfc6bb1bad524fb54585d1e63d8399da7c9"
|
|
22
22
|
}
|