@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,36 +1,46 @@
|
|
|
1
|
-
|
|
1
|
+
'use client';
|
|
2
|
+
import { useSyncExternalStore } from 'react';
|
|
3
|
+
const DESKTOP_MEDIA_QUERY = '(min-width: 960px)';
|
|
2
4
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
+
* Subscribes to the MediaQueryList. Using `change` instead of `resize` means
|
|
6
|
+
* there is only one re-render when the breakpoint is actually crossed.
|
|
5
7
|
*
|
|
6
|
-
* @
|
|
8
|
+
* @param onStoreChange - Callback invoked when the breakpoint match changes
|
|
9
|
+
* @returns An unsubscribe function that removes the listener
|
|
7
10
|
*/
|
|
8
|
-
function
|
|
9
|
-
|
|
11
|
+
function subscribe(onStoreChange) {
|
|
12
|
+
if (typeof window === 'undefined' || !window.matchMedia) {
|
|
13
|
+
return () => { };
|
|
14
|
+
}
|
|
15
|
+
const mediaQueryList = window.matchMedia(DESKTOP_MEDIA_QUERY);
|
|
16
|
+
mediaQueryList.addEventListener('change', onStoreChange);
|
|
17
|
+
return () => mediaQueryList.removeEventListener('change', onStoreChange);
|
|
10
18
|
}
|
|
11
19
|
/**
|
|
12
|
-
*
|
|
20
|
+
* Client snapshot: the current match state of the desktop breakpoint.
|
|
13
21
|
*
|
|
14
|
-
* @returns True if the
|
|
22
|
+
* @returns True if the desktop breakpoint currently matches, false otherwise
|
|
15
23
|
*/
|
|
16
|
-
function
|
|
17
|
-
if (
|
|
18
|
-
return
|
|
19
|
-
|
|
24
|
+
function getSnapshot() {
|
|
25
|
+
if (typeof window === 'undefined' || !window.matchMedia)
|
|
26
|
+
return false;
|
|
27
|
+
return window.matchMedia(DESKTOP_MEDIA_QUERY).matches;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Server snapshot: deliberately `false` (mobile first), so that the server
|
|
31
|
+
* render and the first client render match deterministically.
|
|
32
|
+
*
|
|
33
|
+
* @returns Always false
|
|
34
|
+
*/
|
|
35
|
+
function getServerSnapshot() {
|
|
20
36
|
return false;
|
|
21
37
|
}
|
|
38
|
+
/**
|
|
39
|
+
* Custom hook that detects whether the viewport width is desktop size (>= 960px).
|
|
40
|
+
*
|
|
41
|
+
* @returns True if the viewport width is 960px or greater, false otherwise
|
|
42
|
+
*/
|
|
22
43
|
export function useIsDesktopScreenWidth() {
|
|
23
|
-
|
|
24
|
-
useEffect(() => {
|
|
25
|
-
const checkScreenSize = () => {
|
|
26
|
-
setIsDesktop(window.innerWidth >= 960);
|
|
27
|
-
};
|
|
28
|
-
checkScreenSize();
|
|
29
|
-
window.addEventListener('resize', checkScreenSize);
|
|
30
|
-
return () => {
|
|
31
|
-
window.removeEventListener('resize', checkScreenSize);
|
|
32
|
-
};
|
|
33
|
-
}, []);
|
|
34
|
-
return isDesktop;
|
|
44
|
+
return useSyncExternalStore(subscribe, getSnapshot, getServerSnapshot);
|
|
35
45
|
}
|
|
36
46
|
//# sourceMappingURL=useIsDesktopScreenWidth.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useIsDesktopScreenWidth.js","sourceRoot":"","sources":["../../src/hooks/useIsDesktopScreenWidth.ts"],"names":[],"mappings":"AAAA,
|
|
1
|
+
{"version":3,"file":"useIsDesktopScreenWidth.js","sourceRoot":"","sources":["../../src/hooks/useIsDesktopScreenWidth.ts"],"names":[],"mappings":"AAAA,YAAY,CAAA;AAEZ,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAA;AAE5C,MAAM,mBAAmB,GAAG,oBAAoB,CAAA;AAEhD;;;;;;GAMG;AACH,SAAS,SAAS,CAAC,aAAyB;IAC1C,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACxD,OAAO,GAAG,EAAE,GAAE,CAAC,CAAA;IACjB,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAA;IAC7D,cAAc,CAAC,gBAAgB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IAExD,OAAO,GAAG,EAAE,CAAC,cAAc,CAAC,mBAAmB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;AAC1E,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW;IAClB,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,UAAU;QAAE,OAAO,KAAK,CAAA;IAErE,OAAO,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAAA;AACvD,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB;IACxB,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB;IACrC,OAAO,oBAAoB,CAAC,SAAS,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAA;AACxE,CAAC"}
|
package/lib/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export
|
|
3
|
-
export
|
|
4
|
-
export {
|
|
1
|
+
export { ComboBox, default } from './ComboBox';
|
|
2
|
+
export { ComboBoxOptionsSlot, type ComboBoxOptionsSlotProps } from './partials';
|
|
3
|
+
export { useComboBox, useIsDesktopScreenWidth } from './hooks';
|
|
4
|
+
export type { ComboBoxAriaProps, ComboBoxOption, ComboBoxOptionGroup, ComboBoxOptionItemProps, ComboBoxOptionsInput, ComboBoxOptionsProps, ComboBoxOptionsPanelProps, ComboBoxProps, ListboxAriaProps, } from './types';
|
package/lib/index.js
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
export default ComboBox;
|
|
3
|
-
export * from './types';
|
|
1
|
+
export { ComboBox, default } from './ComboBox';
|
|
4
2
|
export { ComboBoxOptionsSlot } from './partials';
|
|
3
|
+
export { useComboBox, useIsDesktopScreenWidth } from './hooks';
|
|
5
4
|
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,EAAE,mBAAmB,EAAiC,MAAM,YAAY,CAAA;AAC/E,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { LeadingType } from '@pixum/menu-item';
|
|
2
|
+
import React from 'react';
|
|
3
|
+
import { ComboBoxOptionProps } from '../types';
|
|
4
|
+
interface ComboBoxGroupedOptionsProps {
|
|
5
|
+
group: string;
|
|
6
|
+
items: ComboBoxOptionProps[];
|
|
7
|
+
selectedOption?: string;
|
|
8
|
+
onClick?: (value: string) => void;
|
|
9
|
+
onKeyDown: (e: React.KeyboardEvent, value: string) => void;
|
|
10
|
+
leadingType?: LeadingType;
|
|
11
|
+
}
|
|
12
|
+
export declare function ComboBoxGroupedOptions(props: ComboBoxGroupedOptionsProps): React.JSX.Element;
|
|
13
|
+
export {};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import Text, { TextVariant } from '@pixum/text';
|
|
2
|
+
import React from 'react';
|
|
3
|
+
import { ComboBoxOptions } from './ComboBoxOptions';
|
|
4
|
+
export function ComboBoxGroupedOptions(props) {
|
|
5
|
+
const { group, items, selectedOption, onClick, onKeyDown, leadingType } = props;
|
|
6
|
+
return (React.createElement("div", { className: "combobox__options-group", key: `combobox__options-group-${group}` },
|
|
7
|
+
React.createElement(Text, { variant: TextVariant.HEADLINE, className: "combobox__sticky-header" }, group),
|
|
8
|
+
React.createElement(ComboBoxOptions, { items: items, selectedOption: selectedOption, onClick: onClick, onKeyDown: onKeyDown, leadingType: leadingType })));
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=ComboBoxGroupedOptions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ComboBoxGroupedOptions.js","sourceRoot":"","sources":["../../src/partials/ComboBoxGroupedOptions.tsx"],"names":[],"mappings":"AACA,OAAO,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAYnD,MAAM,UAAU,sBAAsB,CAAC,KAAkC;IACvE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,GACrE,KAAK,CAAA;IACP,OAAO,CACL,6BACE,SAAS,EAAC,yBAAyB,EACnC,GAAG,EAAE,2BAA2B,KAAK,EAAE;QAEvC,oBAAC,IAAI,IAAC,OAAO,EAAE,WAAW,CAAC,QAAQ,EAAE,SAAS,EAAC,yBAAyB,IACrE,KAAK,CACD;QACP,oBAAC,eAAe,IACd,KAAK,EAAE,KAAK,EACZ,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,SAAS,EACpB,WAAW,EAAE,WAAW,GACxB,CACE,CACP,CAAA;AACH,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import React, { useEffect } from 'react';
|
|
2
|
+
import Menu from '@pixum/menu';
|
|
3
|
+
import { scrollOptionToViewport } from '../helper';
|
|
4
|
+
import { ComboBoxOptions } from './ComboBoxOptions';
|
|
5
|
+
import { ComboBoxGroupedOptions } from './ComboBoxGroupedOptions';
|
|
6
|
+
import { useIsDesktopScreenWidth } from '../hooks';
|
|
7
|
+
export function ComboBoxMenu(props) {
|
|
8
|
+
const { options, onClick, selectedOption, leadingType, optionDetails } = props;
|
|
9
|
+
const isDesktop = useIsDesktopScreenWidth();
|
|
10
|
+
const handleOnKeyDown = (e, value) => {
|
|
11
|
+
if (e.key === 'Enter') {
|
|
12
|
+
onClick === null || onClick === void 0 ? void 0 : onClick(value);
|
|
13
|
+
}
|
|
14
|
+
};
|
|
15
|
+
useEffect(() => {
|
|
16
|
+
scrollOptionToViewport(isDesktop);
|
|
17
|
+
}, [isDesktop]);
|
|
18
|
+
return (React.createElement(Menu, { className: "combobox__options" },
|
|
19
|
+
Array.isArray(options) ? (React.createElement(ComboBoxOptions, { items: options, selectedOption: selectedOption, onClick: onClick, onKeyDown: handleOnKeyDown, leadingType: leadingType })) : (React.createElement(React.Fragment, null, Object.entries(options).map(([group, items]) => (React.createElement(ComboBoxGroupedOptions, { group: group, items: items, selectedOption: selectedOption, onClick: onClick, onKeyDown: handleOnKeyDown, leadingType: leadingType }))))),
|
|
20
|
+
optionDetails && (React.createElement("div", { className: "combobox__option-details text--caption" }, optionDetails))));
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=ComboBoxMenu.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ComboBoxMenu.js","sourceRoot":"","sources":["../../src/partials/ComboBoxMenu.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACxC,OAAO,IAAI,MAAM,aAAa,CAAA;AAC9B,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAElD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AACjE,OAAO,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAElD,MAAM,UAAU,YAAY,CAAC,KAA2B;IACtD,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,KAAK,CAAA;IAC9E,MAAM,SAAS,GAAG,uBAAuB,EAAE,CAAA;IAE3C,MAAM,eAAe,GAAG,CAAC,CAAsB,EAAE,KAAa,EAAE,EAAE;QAChE,IAAI,CAAC,CAAC,GAAG,KAAK,OAAO,EAAE,CAAC;YACtB,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAG,KAAK,CAAC,CAAA;QAClB,CAAC;IACH,CAAC,CAAA;IAED,SAAS,CAAC,GAAG,EAAE;QACb,sBAAsB,CAAC,SAAS,CAAC,CAAA;IACnC,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,CAAA;IAEf,OAAO,CACL,oBAAC,IAAI,IAAC,SAAS,EAAC,mBAAmB;QAChC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CACxB,oBAAC,eAAe,IACd,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,eAAe,EAC1B,WAAW,EAAE,WAAW,GACxB,CACH,CAAC,CAAC,CAAC,CACF,0CACG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAC/C,oBAAC,sBAAsB,IACrB,KAAK,EAAE,KAAK,EACZ,KAAK,EAAE,KAAK,EACZ,cAAc,EAAE,cAAc,EAC9B,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,eAAe,EAC1B,WAAW,EAAE,WAAW,GACxB,CACH,CAAC,CACD,CACJ;QACA,aAAa,IAAI,CAChB,6BAAK,SAAS,EAAC,wCAAwC,IACpD,aAAa,CACV,CACP,CACI,CACR,CAAA;AACH,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export interface ComboBoxNoResultsProps {
|
|
2
|
+
/** Message shown when no option matches the search. */
|
|
3
|
+
text?: string;
|
|
4
|
+
}
|
|
5
|
+
/**
|
|
6
|
+
* Empty state of the options list.
|
|
7
|
+
*
|
|
8
|
+
* `role="status"` makes screen readers announce the message when the list is
|
|
9
|
+
* filtered down to nothing.
|
|
10
|
+
*
|
|
11
|
+
* @param props - The props for the ComboBoxNoResults component
|
|
12
|
+
* @returns The no-results message
|
|
13
|
+
*/
|
|
14
|
+
export declare function ComboBoxNoResults({ text }: ComboBoxNoResultsProps): import("react/jsx-runtime").JSX.Element | null;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { jsx as _jsx } from "react/jsx-runtime";
|
|
2
|
+
import Text, { TEXT_VARIANT } from '@pixum/text';
|
|
3
|
+
import styles from '../ComboBox.module.css';
|
|
4
|
+
/**
|
|
5
|
+
* Empty state of the options list.
|
|
6
|
+
*
|
|
7
|
+
* `role="status"` makes screen readers announce the message when the list is
|
|
8
|
+
* filtered down to nothing.
|
|
9
|
+
*
|
|
10
|
+
* @param props - The props for the ComboBoxNoResults component
|
|
11
|
+
* @returns The no-results message
|
|
12
|
+
*/
|
|
13
|
+
export function ComboBoxNoResults({ text }) {
|
|
14
|
+
if (!text)
|
|
15
|
+
return null;
|
|
16
|
+
return (_jsx(Text, { variant: TEXT_VARIANT.SUBHEADLINE, className: styles.noResults, children: text }));
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=ComboBoxNoResults.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ComboBoxNoResults.js","sourceRoot":"","sources":["../../src/partials/ComboBoxNoResults.tsx"],"names":[],"mappings":";AAAA,OAAO,IAAI,EAAE,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAO3C;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAAE,IAAI,EAA0B;IAChE,IAAI,CAAC,IAAI;QAAE,OAAO,IAAI,CAAA;IAEtB,OAAO,CACL,KAAC,IAAI,IAAC,OAAO,EAAE,YAAY,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,YACjE,IAAI,GACA,CACR,CAAA;AACH,CAAC"}
|
|
@@ -1,10 +1,21 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { ComboBoxOptionsPanelProps } from '../types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
3
|
+
* Renders the options panel of the ComboBox.
|
|
4
|
+
*
|
|
5
|
+
* The panel is split in two: the `Menu` provides the visible box, the element
|
|
6
|
+
* inside it carries the `listbox` role and is the only part that scrolls. That
|
|
7
|
+
* keeps `optionDetails` a real footer - it stays visible without
|
|
8
|
+
* `position: sticky` and can no longer cover the active option - and it keeps
|
|
9
|
+
* the listbox free of anything that is not an option or a group, as ARIA
|
|
10
|
+
* requires.
|
|
11
|
+
*
|
|
12
|
+
* Flat and grouped options share one render path: the options arrive already
|
|
13
|
+
* normalised, `groupOptions` only splits them into their visual groups again.
|
|
14
|
+
* The listbox is not focusable - the focus stays in the input field, the active
|
|
15
|
+
* option is announced through `aria-activedescendant`.
|
|
5
16
|
*
|
|
6
17
|
* @param props - The props for the ComboBoxOptions component
|
|
7
|
-
* @returns
|
|
18
|
+
* @returns The options panel
|
|
8
19
|
*/
|
|
9
|
-
export declare function ComboBoxOptions({ options,
|
|
20
|
+
export declare function ComboBoxOptions({ options, listboxAriaProps, selectedValues, activeOptionId, leadingType, optionDetails, onOptionClick, }: ComboBoxOptionsPanelProps): import("react/jsx-runtime").JSX.Element;
|
|
10
21
|
export default ComboBoxOptions;
|
|
@@ -1,29 +1,33 @@
|
|
|
1
|
-
import { jsx as _jsx,
|
|
2
|
-
import { useEffect } from 'react';
|
|
1
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
3
2
|
import Menu from '@pixum/menu';
|
|
4
|
-
import {
|
|
5
|
-
import
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
3
|
+
import Text, { TEXT_VARIANT } from '@pixum/text';
|
|
4
|
+
import clsx from 'clsx';
|
|
5
|
+
import { groupOptions } from '../utils';
|
|
6
|
+
import { ComboBoxOptionsGroup } from './ComboBoxOptionsGroup';
|
|
7
|
+
import styles from '../ComboBox.module.css';
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
10
|
-
*
|
|
9
|
+
* Renders the options panel of the ComboBox.
|
|
10
|
+
*
|
|
11
|
+
* The panel is split in two: the `Menu` provides the visible box, the element
|
|
12
|
+
* inside it carries the `listbox` role and is the only part that scrolls. That
|
|
13
|
+
* keeps `optionDetails` a real footer - it stays visible without
|
|
14
|
+
* `position: sticky` and can no longer cover the active option - and it keeps
|
|
15
|
+
* the listbox free of anything that is not an option or a group, as ARIA
|
|
16
|
+
* requires.
|
|
17
|
+
*
|
|
18
|
+
* Flat and grouped options share one render path: the options arrive already
|
|
19
|
+
* normalised, `groupOptions` only splits them into their visual groups again.
|
|
20
|
+
* The listbox is not focusable - the focus stays in the input field, the active
|
|
21
|
+
* option is announced through `aria-activedescendant`.
|
|
11
22
|
*
|
|
12
23
|
* @param props - The props for the ComboBoxOptions component
|
|
13
|
-
* @returns
|
|
24
|
+
* @returns The options panel
|
|
14
25
|
*/
|
|
15
|
-
export function ComboBoxOptions({ options,
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
// Wait for next browser frame to ensure DOM is fully rendered
|
|
21
|
-
const frameId = requestAnimationFrame(() => {
|
|
22
|
-
scrollOptionToViewport(isDesktop);
|
|
23
|
-
});
|
|
24
|
-
return () => cancelAnimationFrame(frameId);
|
|
25
|
-
}, [isDesktop, selectedOption]);
|
|
26
|
-
return (_jsxs(Menu, { className: "combobox__options scrollable", "data-tappable": "true", children: [optionsWithoutGroup ? (_jsx(ComboBoxOptionsItems, { items: options, selectedOption: selectedOption, onClick: onClick, leadingType: leadingType })) : (_jsx(_Fragment, { children: optionsWithGroup.map(([group, items]) => (_jsx(ComboxBoxOptionsWithGrouping, { group: group, items: items, selectedOption: selectedOption, onClick: onClick, leadingType: leadingType }, `combobox__options-group-${group}`))) })), optionDetails && (_jsx("div", { className: "combobox__option-details text--caption", children: optionDetails }))] }));
|
|
26
|
+
export function ComboBoxOptions({ options, listboxAriaProps, selectedValues, activeOptionId, leadingType, optionDetails, onOptionClick, }) {
|
|
27
|
+
return (_jsxs(Menu, { className: styles.panel, "data-tappable": "true", children: [_jsx("div", Object.assign({ className: clsx(styles.options, 'scrollable'), tabIndex: -1 }, listboxAriaProps, { children: groupOptions(options).map(group => {
|
|
28
|
+
var _a;
|
|
29
|
+
return (_jsx(ComboBoxOptionsGroup, { group: group.group, options: group.options, selectedValues: selectedValues, activeOptionId: activeOptionId, leadingType: leadingType, onOptionClick: onOptionClick }, `combobox__options-group-${(_a = group.group) !== null && _a !== void 0 ? _a : 'default'}`));
|
|
30
|
+
}) })), optionDetails && (_jsx(Text, { variant: TEXT_VARIANT.CAPTION, className: styles.optionDetails, children: optionDetails }))] }));
|
|
27
31
|
}
|
|
28
32
|
export default ComboBoxOptions;
|
|
29
33
|
//# sourceMappingURL=ComboBoxOptions.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ComboBoxOptions.js","sourceRoot":"","sources":["../../src/partials/ComboBoxOptions.tsx"],"names":[],"mappings":";AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"ComboBoxOptions.js","sourceRoot":"","sources":["../../src/partials/ComboBoxOptions.tsx"],"names":[],"mappings":";AAAA,OAAO,IAAI,MAAM,aAAa,CAAA;AAC9B,OAAO,IAAI,EAAE,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAG3C;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,eAAe,CAAC,EAC9B,OAAO,EACP,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,WAAW,EACX,aAAa,EACb,aAAa,GACa;IAC1B,OAAO,CACL,MAAC,IAAI,IAAC,SAAS,EAAE,MAAM,CAAC,KAAK,mBAAgB,MAAM,aACjD,4BACE,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,EAC7C,QAAQ,EAAE,CAAC,CAAC,IACR,gBAAgB,cAEnB,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;;oBAAC,OAAA,CAClC,KAAC,oBAAoB,IAEnB,KAAK,EAAE,KAAK,CAAC,KAAK,EAClB,OAAO,EAAE,KAAK,CAAC,OAAO,EACtB,cAAc,EAAE,cAAc,EAC9B,cAAc,EAAE,cAAc,EAC9B,WAAW,EAAE,WAAW,EACxB,aAAa,EAAE,aAAa,IANvB,2BAA2B,MAAA,KAAK,CAAC,KAAK,mCAAI,SAAS,EAAE,CAO1D,CACH,CAAA;iBAAA,CAAC,IACE,EAEL,aAAa,IAAI,CAChB,KAAC,IAAI,IAAC,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,aAAa,YACjE,aAAa,GACT,CACR,IACI,CACR,CAAA;AACH,CAAC;AAED,eAAe,eAAe,CAAA"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { ComboBoxOptionsItemsProps } from './ComboBoxOptionsItems';
|
|
2
|
+
export interface ComboBoxOptionsGroupProps extends ComboBoxOptionsItemsProps {
|
|
3
|
+
/** Group headline. Without it the options are rendered without a header. */
|
|
4
|
+
group?: string;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Renders one group of options with an optional sticky headline.
|
|
8
|
+
*
|
|
9
|
+
* Flat lists use the same component with `group` left undefined, so there is
|
|
10
|
+
* only one place that renders options.
|
|
11
|
+
*
|
|
12
|
+
* @param props - The props for the ComboBoxOptionsGroup component
|
|
13
|
+
* @returns A group container with an optional header and its options
|
|
14
|
+
*/
|
|
15
|
+
export declare function ComboBoxOptionsGroup({ group, ...itemProps }: ComboBoxOptionsGroupProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,31 @@
|
|
|
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
|
+
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
13
|
+
import Text, { TEXT_VARIANT } from '@pixum/text';
|
|
14
|
+
import { ComboBoxOptionsItems } from './ComboBoxOptionsItems';
|
|
15
|
+
import styles from '../ComboBox.module.css';
|
|
16
|
+
/**
|
|
17
|
+
* Renders one group of options with an optional sticky headline.
|
|
18
|
+
*
|
|
19
|
+
* Flat lists use the same component with `group` left undefined, so there is
|
|
20
|
+
* only one place that renders options.
|
|
21
|
+
*
|
|
22
|
+
* @param props - The props for the ComboBoxOptionsGroup component
|
|
23
|
+
* @returns A group container with an optional header and its options
|
|
24
|
+
*/
|
|
25
|
+
export function ComboBoxOptionsGroup(_a) {
|
|
26
|
+
var { group } = _a, itemProps = __rest(_a, ["group"]);
|
|
27
|
+
if (!group)
|
|
28
|
+
return _jsx(ComboBoxOptionsItems, Object.assign({}, itemProps));
|
|
29
|
+
return (_jsxs("div", { role: "group", "aria-label": group, children: [_jsx(Text, { variant: TEXT_VARIANT.HEADLINE, className: styles.stickyHeader, children: group }), _jsx(ComboBoxOptionsItems, Object.assign({}, itemProps))] }));
|
|
30
|
+
}
|
|
31
|
+
//# sourceMappingURL=ComboBoxOptionsGroup.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ComboBoxOptionsGroup.js","sourceRoot":"","sources":["../../src/partials/ComboBoxOptionsGroup.tsx"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,IAAI,EAAE,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAQ3C;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,EAGT;QAHS,EACnC,KAAK,OAEqB,EADvB,SAAS,cAFuB,SAGpC,CADa;IAEZ,IAAI,CAAC,KAAK;QAAE,OAAO,KAAC,oBAAoB,oBAAK,SAAS,EAAI,CAAA;IAE1D,OAAO,CACL,eAAK,IAAI,EAAC,OAAO,gBAAa,KAAK,aACjC,KAAC,IAAI,IAAC,OAAO,EAAE,YAAY,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,YAAY,YACjE,KAAK,GACD,EACP,KAAC,oBAAoB,oBAAK,SAAS,EAAI,IACnC,CACP,CAAA;AACH,CAAC"}
|
|
@@ -1,24 +1,39 @@
|
|
|
1
1
|
import { LeadingType } from '@pixum/menu-item';
|
|
2
|
-
import type {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
/** Callback fired when an option is clicked */
|
|
12
|
-
onClick?: (value: string) => void;
|
|
13
|
-
/** Type of leading element to display (icon, avatar, etc.) */
|
|
2
|
+
import type { ComboBoxOption } from '../types';
|
|
3
|
+
export interface ComboBoxOptionsItemsProps {
|
|
4
|
+
/** Normalised options to render. */
|
|
5
|
+
options: ComboBoxOption[];
|
|
6
|
+
/** Values that are currently selected. */
|
|
7
|
+
selectedValues: string[];
|
|
8
|
+
/** DOM id of the active option (`aria-activedescendant`). */
|
|
9
|
+
activeOptionId?: string;
|
|
10
|
+
/** Type of the leading element, e.g. a checkbox for multi select. */
|
|
14
11
|
leadingType?: LeadingType;
|
|
12
|
+
/** Called with the value of the clicked option. */
|
|
13
|
+
onOptionClick: (value: string) => void;
|
|
15
14
|
}
|
|
16
15
|
/**
|
|
17
|
-
*
|
|
18
|
-
*
|
|
16
|
+
* Renders the individual options.
|
|
17
|
+
*
|
|
18
|
+
* The options are deliberately not focusable: the focus stays in the input
|
|
19
|
+
* field and the highlight is driven by `aria-activedescendant`. Checkbox
|
|
20
|
+
* options are ordinary options with `aria-selected` - inside a listbox that is
|
|
21
|
+
* the state screen readers announce, and it keeps mouse and keyboard selection
|
|
22
|
+
* on exactly the same code path.
|
|
23
|
+
*
|
|
24
|
+
* An option is a `MenuItemProps` object, so everything except the ComboBox
|
|
25
|
+
* specific `key` and `disabled` is spread onto the `MenuItem` unchanged.
|
|
26
|
+
* Consumers that pass further MenuItem props keep working without the ComboBox
|
|
27
|
+
* having to know about them; only `selected`, `tabIndex` and the keyboard
|
|
28
|
+
* handling are owned by the ComboBox and therefore not overridable.
|
|
29
|
+
*
|
|
30
|
+
* Styling hooks: every option carries its state as a data attribute
|
|
31
|
+
* (`data-selected`, `data-active`, `data-disabled`), so consumers can style
|
|
32
|
+
* options without knowing the hashed module class names. The selection state is
|
|
33
|
+
* left to `MenuItem` itself - the component does not add a `selected` class of
|
|
34
|
+
* its own, which would be impossible to override from the outside.
|
|
19
35
|
*
|
|
20
36
|
* @param props - The props for the ComboBoxOptionsItems component
|
|
21
|
-
* @returns A list of
|
|
37
|
+
* @returns A list of selectable options
|
|
22
38
|
*/
|
|
23
|
-
export declare function ComboBoxOptionsItems({
|
|
24
|
-
export {};
|
|
39
|
+
export declare function ComboBoxOptionsItems({ options, selectedValues, activeOptionId, leadingType, onOptionClick, }: ComboBoxOptionsItemsProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -1,24 +1,56 @@
|
|
|
1
1
|
import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
|
|
2
|
-
import MenuItem from '@pixum/menu-item';
|
|
2
|
+
import MenuItem, { LeadingType } from '@pixum/menu-item';
|
|
3
3
|
import clsx from 'clsx';
|
|
4
|
+
import { toMenuItemProps } from '../utils';
|
|
5
|
+
import styles from '../ComboBox.module.css';
|
|
4
6
|
/**
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
+
* Renders the individual options.
|
|
8
|
+
*
|
|
9
|
+
* The options are deliberately not focusable: the focus stays in the input
|
|
10
|
+
* field and the highlight is driven by `aria-activedescendant`. Checkbox
|
|
11
|
+
* options are ordinary options with `aria-selected` - inside a listbox that is
|
|
12
|
+
* the state screen readers announce, and it keeps mouse and keyboard selection
|
|
13
|
+
* on exactly the same code path.
|
|
14
|
+
*
|
|
15
|
+
* An option is a `MenuItemProps` object, so everything except the ComboBox
|
|
16
|
+
* specific `key` and `disabled` is spread onto the `MenuItem` unchanged.
|
|
17
|
+
* Consumers that pass further MenuItem props keep working without the ComboBox
|
|
18
|
+
* having to know about them; only `selected`, `tabIndex` and the keyboard
|
|
19
|
+
* handling are owned by the ComboBox and therefore not overridable.
|
|
20
|
+
*
|
|
21
|
+
* Styling hooks: every option carries its state as a data attribute
|
|
22
|
+
* (`data-selected`, `data-active`, `data-disabled`), so consumers can style
|
|
23
|
+
* options without knowing the hashed module class names. The selection state is
|
|
24
|
+
* left to `MenuItem` itself - the component does not add a `selected` class of
|
|
25
|
+
* its own, which would be impossible to override from the outside.
|
|
7
26
|
*
|
|
8
27
|
* @param props - The props for the ComboBoxOptionsItems component
|
|
9
|
-
* @returns A list of
|
|
28
|
+
* @returns A list of selectable options
|
|
10
29
|
*/
|
|
11
|
-
export function ComboBoxOptionsItems({
|
|
12
|
-
|
|
30
|
+
export function ComboBoxOptionsItems({ options, selectedValues, activeOptionId, leadingType, onOptionClick, }) {
|
|
31
|
+
const isCheckbox = leadingType === LeadingType.CheckBox;
|
|
32
|
+
return (_jsx(_Fragment, { children: options.map(({ item, id, value, disabled }) => {
|
|
13
33
|
var _a;
|
|
14
|
-
const
|
|
15
|
-
const
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
34
|
+
const isSelected = selectedValues.includes(value);
|
|
35
|
+
const isActive = id === activeOptionId;
|
|
36
|
+
const menuItemProps = toMenuItemProps(item);
|
|
37
|
+
return (_jsx("div", { id: id, className: clsx(styles.option, isCheckbox && styles.optionCheckbox, isActive && styles.optionActive), role: "option", "aria-selected": isSelected, "aria-disabled": disabled || undefined, "data-selected": isSelected, "data-active": isActive, "data-disabled": disabled || undefined, onMouseDown: event => {
|
|
38
|
+
// Keeps the focus in the input field ...
|
|
39
|
+
event.preventDefault();
|
|
40
|
+
// ... and keeps the bottom sheet's drag handler out of it.
|
|
41
|
+
event.stopPropagation();
|
|
42
|
+
}, onPointerDown: event => event.stopPropagation(),
|
|
43
|
+
// No preventDefault on touchstart, scrolling in the sheet must work.
|
|
44
|
+
onTouchStart: event => event.stopPropagation(), onClickCapture: event => {
|
|
45
|
+
event.stopPropagation();
|
|
46
|
+
if (disabled)
|
|
47
|
+
return;
|
|
48
|
+
onOptionClick(value);
|
|
49
|
+
}, children: _jsx(MenuItem, Object.assign({}, menuItemProps, { tabIndex: -1, disableKeyboardNav: true,
|
|
50
|
+
// A leading type set on the ComboBox wins over the option's own
|
|
51
|
+
// one: it is what makes multi select look like a checkbox list.
|
|
52
|
+
leadingProps: leadingType
|
|
53
|
+
? Object.assign(Object.assign({}, menuItemProps.leadingProps), { name: value, type: leadingType }) : menuItemProps.leadingProps, selected: isSelected })) }, (_a = item.key) !== null && _a !== void 0 ? _a : `combobox-item-wrapper-${id}`));
|
|
22
54
|
}) }));
|
|
23
55
|
}
|
|
24
56
|
//# sourceMappingURL=ComboBoxOptionsItems.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ComboBoxOptionsItems.js","sourceRoot":"","sources":["../../src/partials/ComboBoxOptionsItems.tsx"],"names":[],"mappings":";AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"ComboBoxOptionsItems.js","sourceRoot":"","sources":["../../src/partials/ComboBoxOptionsItems.tsx"],"names":[],"mappings":";AAAA,OAAO,QAAQ,EAAE,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAC1C,OAAO,MAAM,MAAM,wBAAwB,CAAA;AAgB3C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,oBAAoB,CAAC,EACnC,OAAO,EACP,cAAc,EACd,cAAc,EACd,WAAW,EACX,aAAa,GACa;IAC1B,MAAM,UAAU,GAAG,WAAW,KAAK,WAAW,CAAC,QAAQ,CAAA;IAEvD,OAAO,CACL,4BACG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE;;YAC7C,MAAM,UAAU,GAAG,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YACjD,MAAM,QAAQ,GAAG,EAAE,KAAK,cAAc,CAAA;YACtC,MAAM,aAAa,GAAG,eAAe,CAAC,IAAI,CAAC,CAAA;YAE3C,OAAO,CACL,cAEE,EAAE,EAAE,EAAE,EACN,SAAS,EAAE,IAAI,CACb,MAAM,CAAC,MAAM,EACb,UAAU,IAAI,MAAM,CAAC,cAAc,EACnC,QAAQ,IAAI,MAAM,CAAC,YAAY,CAChC,EACD,IAAI,EAAC,QAAQ,mBACE,UAAU,mBACV,QAAQ,IAAI,SAAS,mBACrB,UAAU,iBACZ,QAAQ,mBACN,QAAQ,IAAI,SAAS,EACpC,WAAW,EAAE,KAAK,CAAC,EAAE;oBACnB,yCAAyC;oBACzC,KAAK,CAAC,cAAc,EAAE,CAAA;oBACtB,2DAA2D;oBAC3D,KAAK,CAAC,eAAe,EAAE,CAAA;gBACzB,CAAC,EACD,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE;gBAC/C,qEAAqE;gBACrE,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,EAC9C,cAAc,EAAE,KAAK,CAAC,EAAE;oBACtB,KAAK,CAAC,eAAe,EAAE,CAAA;oBAEvB,IAAI,QAAQ;wBAAE,OAAM;oBAEpB,aAAa,CAAC,KAAK,CAAC,CAAA;gBACtB,CAAC,YAED,KAAC,QAAQ,oBACH,aAAa,IACjB,QAAQ,EAAE,CAAC,CAAC,EACZ,kBAAkB;oBAClB,gEAAgE;oBAChE,gEAAgE;oBAChE,YAAY,EACV,WAAW;wBACT,CAAC,iCACM,aAAa,CAAC,YAAY,KAC7B,IAAI,EAAE,KAAK,EACX,IAAI,EAAE,WAAW,IAErB,CAAC,CAAC,aAAa,CAAC,YAAY,EAEhC,QAAQ,EAAE,UAAU,IACpB,IA9CG,MAAA,IAAI,CAAC,GAAG,mCAAI,yBAAyB,EAAE,EAAE,CA+C1C,CACP,CAAA;QACH,CAAC,CAAC,GACD,CACJ,CAAA;AACH,CAAC"}
|
|
@@ -1,34 +1,35 @@
|
|
|
1
|
-
import type { ReactNode } from 'react';
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
/** The content to render inside the options slot */
|
|
1
|
+
import type { ElementType, HTMLAttributes, ReactNode } from 'react';
|
|
2
|
+
export interface ComboBoxOptionsSlotProps extends HTMLAttributes<HTMLElement> {
|
|
3
|
+
/** The content to render inside the options slot. */
|
|
5
4
|
children: ReactNode;
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
tag?: 'div' | 'ul' | 'ol' | 'dl';
|
|
5
|
+
/** Element the slot renders as. */
|
|
6
|
+
tag?: Extract<ElementType, 'div' | 'ul' | 'ol' | 'dl'>;
|
|
9
7
|
}
|
|
10
8
|
/**
|
|
11
|
-
* Styled container for optionsSlot content.
|
|
9
|
+
* Styled container for `optionsSlot` content.
|
|
12
10
|
*
|
|
13
|
-
* Applies the standard ComboBox dropdown appearance
|
|
14
|
-
* border
|
|
15
|
-
*
|
|
11
|
+
* Applies the standard ComboBox dropdown appearance - background, border,
|
|
12
|
+
* border radius, box shadow and top margin - so consumers do not have to
|
|
13
|
+
* replicate it in every `optionsSlot` implementation. Every other prop
|
|
14
|
+
* (`role`, `aria-*`, ...) is forwarded, because the slot content owns its own
|
|
15
|
+
* accessibility semantics.
|
|
16
16
|
*
|
|
17
|
-
*
|
|
17
|
+
* A slot replaces the built-in options list and therefore also its keyboard
|
|
18
|
+
* navigation: content rendered here has to bring its own key handling.
|
|
18
19
|
*
|
|
19
20
|
* ```tsx
|
|
20
21
|
* import ComboBox, { ComboBoxOptionsSlot } from '@pixum/combobox'
|
|
21
22
|
*
|
|
22
23
|
* <ComboBox
|
|
23
24
|
* optionsSlot={
|
|
24
|
-
* <ComboBoxOptionsSlot>
|
|
25
|
+
* <ComboBoxOptionsSlot role="listbox" aria-label="Pickup points">
|
|
25
26
|
* <MyCustomOptionsList />
|
|
26
27
|
* </ComboBoxOptionsSlot>
|
|
27
28
|
* }
|
|
28
29
|
* />
|
|
29
30
|
* ```
|
|
30
31
|
*
|
|
31
|
-
* @param
|
|
32
|
-
* @returns A styled wrapper
|
|
32
|
+
* @param props - The props for the ComboBoxOptionsSlot component
|
|
33
|
+
* @returns A styled wrapper matching the ComboBox dropdown look
|
|
33
34
|
*/
|
|
34
|
-
export declare function ComboBoxOptionsSlot({ children, className,
|
|
35
|
+
export declare function ComboBoxOptionsSlot({ children, className, tag, ...rest }: ComboBoxOptionsSlotProps): import("react/jsx-runtime").JSX.Element;
|