@pixum/combobox 5.10.5 → 5.10.7

package/lib/utils/options.d.ts

@@ -0,0 +1,77 @@
+import type { MenuItemProps } from '@pixum/menu-item';
+import type { ComboBoxOption, ComboBoxOptionGroup, ComboBoxOptionItemProps, ComboBoxOptionsInput } from '../types';
+/**
+ * Resolves the stable value of an option.
+ *
+ * `MenuItemProps` does not guarantee a plain string `text`, so the value is
+ * resolved in three steps: the visible label first - that is the value existing
+ * consumers pass in as `value` and get back from `onOptionItemClick` -, then
+ * the explicit `key`, and finally the render index as a last resort so that
+ * options without a label still get a unique value.
+ *
+ * @param item - The option as handed in by the consumer
+ * @param index - Position of the option in render order
+ * @returns The stable value of the option
+ */
+export declare function resolveOptionValue(item: ComboBoxOptionItemProps, index: number): string;
+/**
+ * Returns the label of an option for the trigger field.
+ *
+ * Falls back to the resolved value when the option renders a custom node
+ * instead of a plain string.
+ *
+ * @param option - A normalised option
+ * @returns The label to display in the trigger field
+ */
+export declare function getOptionLabel(option: ComboBoxOption): string;
+/**
+ * Strips the ComboBox specific props from an option so the rest can be spread
+ * onto the `MenuItem`.
+ *
+ * `key` is a reserved React prop and `disabled` is handled by the option
+ * wrapper (`aria-disabled` plus the click guard); everything else belongs to
+ * `MenuItem` and is forwarded untouched.
+ *
+ * @param item - The option as handed in by the consumer
+ * @returns The props meant for the `MenuItem`
+ */
+export declare function toMenuItemProps({ key, disabled, ...menuItemProps }: ComboBoxOptionItemProps): MenuItemProps;
+/**
+ * Normalises flat and grouped options into one list in render order.
+ *
+ * The index of an entry is identical for both input shapes and is therefore
+ * used as the option DOM id that `aria-activedescendant` points at. Doing this
+ * once removes the offset arithmetic that grouped rendering used to need.
+ *
+ * @param options - Flat or grouped options as passed in by the consumer
+ * @param listboxId - Id of the listbox, used as prefix for the option ids
+ * @returns The normalised options in render order
+ */
+export declare function normaliseOptions(options: ComboBoxOptionsInput, listboxId: string): ComboBoxOption[];
+/**
+ * Splits normalised options back into their render groups while keeping the
+ * global indices intact, so that the list can be rendered with a single code
+ * path for flat and grouped options.
+ *
+ * @param options - Normalised options in render order
+ * @returns One entry per consecutive group
+ */
+export declare function groupOptions(options: ComboBoxOption[]): ComboBoxOptionGroup[];
+/**
+ * Normalises the `value` prop to an array, so that single and multi select
+ * share the same selection logic.
+ *
+ * @param value - Selected value(s) or `undefined`
+ * @returns The selected values as an array
+ */
+export declare function toValueArray(value: string | string[] | undefined): string[];
+/**
+ * Finds the first option that can be activated, starting at `start` and moving
+ * by `delta` with wrap-around. Disabled options are skipped.
+ *
+ * @param options - Normalised options
+ * @param start - Index to start from; use `-1` to start before the first option
+ * @param delta - Step width, negative values move backwards
+ * @returns The index of the next enabled option, or `null` when there is none
+ */
+export declare function findEnabledIndex(options: ComboBoxOption[], start: number, delta: number): number | null;

package/lib/utils/options.js

@@ -0,0 +1,145 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+/**
+ * Resolves the stable value of an option.
+ *
+ * `MenuItemProps` does not guarantee a plain string `text`, so the value is
+ * resolved in three steps: the visible label first - that is the value existing
+ * consumers pass in as `value` and get back from `onOptionItemClick` -, then
+ * the explicit `key`, and finally the render index as a last resort so that
+ * options without a label still get a unique value.
+ *
+ * @param item - The option as handed in by the consumer
+ * @param index - Position of the option in render order
+ * @returns The stable value of the option
+ */
+export function resolveOptionValue(item, index) {
+    if (typeof item.text === 'string' && item.text)
+        return item.text;
+    if (item.key)
+        return item.key;
+    return `option-${index}`;
+}
+/**
+ * Returns the label of an option for the trigger field.
+ *
+ * Falls back to the resolved value when the option renders a custom node
+ * instead of a plain string.
+ *
+ * @param option - A normalised option
+ * @returns The label to display in the trigger field
+ */
+export function getOptionLabel(option) {
+    if (typeof option.item.text === 'string' && option.item.text) {
+        return option.item.text;
+    }
+    return option.value;
+}
+/**
+ * Strips the ComboBox specific props from an option so the rest can be spread
+ * onto the `MenuItem`.
+ *
+ * `key` is a reserved React prop and `disabled` is handled by the option
+ * wrapper (`aria-disabled` plus the click guard); everything else belongs to
+ * `MenuItem` and is forwarded untouched.
+ *
+ * @param item - The option as handed in by the consumer
+ * @returns The props meant for the `MenuItem`
+ */
+export function toMenuItemProps(_a) {
+    var { key, disabled } = _a, menuItemProps = __rest(_a, ["key", "disabled"]);
+    return menuItemProps;
+}
+/**
+ * Normalises flat and grouped options into one list in render order.
+ *
+ * The index of an entry is identical for both input shapes and is therefore
+ * used as the option DOM id that `aria-activedescendant` points at. Doing this
+ * once removes the offset arithmetic that grouped rendering used to need.
+ *
+ * @param options - Flat or grouped options as passed in by the consumer
+ * @param listboxId - Id of the listbox, used as prefix for the option ids
+ * @returns The normalised options in render order
+ */
+export function normaliseOptions(options, listboxId) {
+    const groups = Array.isArray(options)
+        ? [['', options]]
+        : Object.entries(options);
+    const normalised = [];
+    groups.forEach(([group, items]) => {
+        items.forEach(item => {
+            const index = normalised.length;
+            normalised.push({
+                item,
+                group: group || undefined,
+                value: resolveOptionValue(item, index),
+                index,
+                id: `${listboxId}-option-${index}`,
+                disabled: item.disabled === true,
+            });
+        });
+    });
+    return normalised;
+}
+/**
+ * Splits normalised options back into their render groups while keeping the
+ * global indices intact, so that the list can be rendered with a single code
+ * path for flat and grouped options.
+ *
+ * @param options - Normalised options in render order
+ * @returns One entry per consecutive group
+ */
+export function groupOptions(options) {
+    return options.reduce((groups, option) => {
+        const current = groups[groups.length - 1];
+        if (current && current.group === option.group) {
+            current.options.push(option);
+            return groups;
+        }
+        groups.push({ group: option.group, options: [option] });
+        return groups;
+    }, []);
+}
+/**
+ * Normalises the `value` prop to an array, so that single and multi select
+ * share the same selection logic.
+ *
+ * @param value - Selected value(s) or `undefined`
+ * @returns The selected values as an array
+ */
+export function toValueArray(value) {
+    if (Array.isArray(value))
+        return value;
+    return value ? [value] : [];
+}
+/**
+ * Finds the first option that can be activated, starting at `start` and moving
+ * by `delta` with wrap-around. Disabled options are skipped.
+ *
+ * @param options - Normalised options
+ * @param start - Index to start from; use `-1` to start before the first option
+ * @param delta - Step width, negative values move backwards
+ * @returns The index of the next enabled option, or `null` when there is none
+ */
+export function findEnabledIndex(options, start, delta) {
+    const { length } = options;
+    if (length === 0)
+        return null;
+    let index = start;
+    for (let step = 0; step < length; step += 1) {
+        index = (index + delta + length) % length;
+        if (!options[index].disabled)
+            return index;
+    }
+    return null;
+}
+//# sourceMappingURL=options.js.map

package/lib/utils/options.js.map

@@ -0,0 +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

@@ -1,16 +1,16 @@
 {
   "name": "@pixum/combobox",
-  "version": "5.10.5",
+  "version": "5.10.7",
   "main": "lib/index.js",
   "module": "lib/index.js",
   "license": "UNLICENSED",
   "peerDependencies": {
-    "@pixum/bottom-sheet": "3.0.18",
-    "@pixum/menu": "3.0.14",
-    "@pixum/menu-item": "2.0.14",
-    "@pixum/text": ">=3.7.0",
-    "@pixum/theme-provider": "4.2.20",
-    "@pixum/web-input": "2.1.0"
+    "@pixum/bottom-sheet": "4.9.0",
+    "@pixum/menu": "4.4.2",
+    "@pixum/menu-item": "3.4.3",
+    "@pixum/text": "3.7.0",
+    "@pixum/theme-provider": "5.6.0",
+    "@pixum/web-input": "2.5.6"
   },
   "files": [
     "lib"
@@ -18,5 +18,5 @@
   "sideEffects": [
     "*.css"
   ],
-  "gitHead": "a8c339973b8474a1ae45539baf5d0f3c8efb4128"
+  "gitHead": "193f8ae1494e01582893258403bec5a13b847198"
 }