@linzjs/lui 21.51.1 → 21.52.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [21.52.0](https://github.com/linz/lui/compare/v21.51.1...v21.52.0) (2024-11-03)
+
+
+### Features
+
+* Adding onNavigateOutOfBounds callback to LuiListBox ([#1168](https://github.com/linz/lui/issues/1168)) ([1146b6f](https://github.com/linz/lui/commit/1146b6f719be86b206687862ca8043958e44c211))
+
 ## [21.51.1](https://github.com/linz/lui/compare/v21.51.0...v21.51.1) (2024-10-31)
 
 

package/dist/components/LuiListBox/LuiListBox.d.ts

@@ -44,5 +44,6 @@ export interface ILuiListBoxProps<T = ILuiListBoxItem> extends Omit<HTMLAttribut
     getLabel?: LabelGetter<T>;
     loadingIndicator?: () => ReactNode;
     emptyIndicator?: () => ReactNode;
+    onNavigateOutOfBounds?: (bound: 'start' | 'end') => void;
 }
-export declare function LuiListBox<T extends object = ILuiListBoxItem>({ ariaLabel, ariaLabelledBy, itemRenderer, groupHeadingRenderer, loadingIndicator, emptyIndicator, selectionMode, selectionBehavior, disabled, disabledKeys, items, value, onChange, getKey, getGroup, getLabel, ariaProps, className, ...ulProps }: ILuiListBoxProps<T>): JSX.Element;
+export declare function LuiListBox<T extends object = ILuiListBoxItem>({ ariaLabel, ariaLabelledBy, itemRenderer, groupHeadingRenderer, loadingIndicator, emptyIndicator, selectionMode, selectionBehavior, disabled, disabledKeys, items, value, onChange, getKey, getGroup, getLabel, ariaProps, className, onNavigateOutOfBounds, ...ulProps }: ILuiListBoxProps<T>): JSX.Element;

package/dist/index.js

@@ -55177,7 +55177,7 @@ function useLuiListBox(_a) {
         if (!onChange) {
             return;
         }
-        onChange(keys === 'all' ? items.map(function (item) { return getKey(item); }) : Array.from(keys), keys === 'all' ? items : items.filter(function (item) { return keys.has(getKey(item)); }));
+        onChange(keys === 'all' ? items.map(getKey) : Array.from(keys), keys === 'all' ? items : items.filter(function (item) { return keys.has(getKey(item)); }));
     }, [items, onChange, getKey]);
     var nodes = React.useMemo(function () { return mapItemsToNodes(items, getKey, getGroup, getLabel); }, [items, getKey, getGroup, getLabel]);
     return __assign(__assign({}, ariaProps), { items: nodes, selectionMode: selectionMode, selectionBehavior: selectionBehavior, selectedKeys: (Array.isArray(value) ? value : [value]).filter(Boolean), children: children, onSelectionChange: onSelectionChange, disabledKeys: disabled ? items.map(getKey) : disabledKeys });
@@ -58331,7 +58331,7 @@ function LuiListBoxGroup(_a) {
 }
 
 function LuiListBox(_a) {
-    var ariaLabel = _a.ariaLabel, ariaLabelledBy = _a.ariaLabelledBy, _b = _a.itemRenderer, itemRenderer = _b === void 0 ? DefaultItemRenderer : _b, _c = _a.groupHeadingRenderer, groupHeadingRenderer = _c === void 0 ? DefaultGroupHeadingRenderer : _c, _d = _a.loadingIndicator, loadingIndicator = _d === void 0 ? DefaultLoadingIndicator : _d, _e = _a.emptyIndicator, emptyIndicator = _e === void 0 ? DefaultEmptyIndicator : _e, _f = _a.selectionMode, selectionMode = _f === void 0 ? 'single' : _f, _g = _a.selectionBehavior, selectionBehavior = _g === void 0 ? 'toggle' : _g, _h = _a.disabled, disabled = _h === void 0 ? false : _h, _j = _a.disabledKeys, disabledKeys = _j === void 0 ? [] : _j, items = _a.items, value = _a.value, onChange = _a.onChange, getKey = _a.getKey, getGroup = _a.getGroup, getLabel = _a.getLabel, ariaProps = _a.ariaProps, className = _a.className, ulProps = __rest(_a, ["ariaLabel", "ariaLabelledBy", "itemRenderer", "groupHeadingRenderer", "loadingIndicator", "emptyIndicator", "selectionMode", "selectionBehavior", "disabled", "disabledKeys", "items", "value", "onChange", "getKey", "getGroup", "getLabel", "ariaProps", "className"]);
+    var ariaLabel = _a.ariaLabel, ariaLabelledBy = _a.ariaLabelledBy, _b = _a.itemRenderer, itemRenderer = _b === void 0 ? DefaultItemRenderer : _b, _c = _a.groupHeadingRenderer, groupHeadingRenderer = _c === void 0 ? DefaultGroupHeadingRenderer : _c, _d = _a.loadingIndicator, loadingIndicator = _d === void 0 ? DefaultLoadingIndicator : _d, _e = _a.emptyIndicator, emptyIndicator = _e === void 0 ? DefaultEmptyIndicator : _e, _f = _a.selectionMode, selectionMode = _f === void 0 ? 'single' : _f, _g = _a.selectionBehavior, selectionBehavior = _g === void 0 ? 'toggle' : _g, _h = _a.disabled, disabled = _h === void 0 ? false : _h, _j = _a.disabledKeys, disabledKeys = _j === void 0 ? [] : _j, items = _a.items, value = _a.value, onChange = _a.onChange, getKey = _a.getKey, getGroup = _a.getGroup, getLabel = _a.getLabel, ariaProps = _a.ariaProps, className = _a.className, onNavigateOutOfBounds = _a.onNavigateOutOfBounds, ulProps = __rest(_a, ["ariaLabel", "ariaLabelledBy", "itemRenderer", "groupHeadingRenderer", "loadingIndicator", "emptyIndicator", "selectionMode", "selectionBehavior", "disabled", "disabledKeys", "items", "value", "onChange", "getKey", "getGroup", "getLabel", "ariaProps", "className", "onNavigateOutOfBounds"]);
     var listProps = useLuiListBox({
         selectionMode: selectionMode,
         selectionBehavior: selectionBehavior,
@@ -58349,7 +58349,24 @@ function LuiListBox(_a) {
     var ref = React.useRef(null);
     var state = $e72dd72e1c76a225$export$2f645645f7bca764(listProps);
     var listBoxProps = $c132121280ec012d$export$50eacbbf140a3141(ariaListBoxProps, state, ref).listBoxProps;
-    return (React__default["default"].createElement("ul", __assign({}, ulProps, listBoxProps, { ref: ref, className: clsx('LuiListBox', className) }),
+    var onKeyDown = function (e) {
+        var _a, _b;
+        var lastFocusedKey = state.selectionManager.focusedKey;
+        (_a = listBoxProps.onKeyDown) === null || _a === void 0 ? void 0 : _a.call(listBoxProps, e);
+        (_b = ulProps.onKeyDown) === null || _b === void 0 ? void 0 : _b.call(ulProps, e);
+        var currentFocusedKey = state.selectionManager.focusedKey;
+        // Events can bubble through portals, ensure we are dealing with an element in this list (not a modal or menu rendered by an item in the list)
+        if (!e.currentTarget.contains(e.target)) {
+            return;
+        }
+        if (e.key === 'ArrowUp' && lastFocusedKey === currentFocusedKey) {
+            onNavigateOutOfBounds === null || onNavigateOutOfBounds === void 0 ? void 0 : onNavigateOutOfBounds('start');
+        }
+        if (e.key === 'ArrowDown' && lastFocusedKey === currentFocusedKey) {
+            onNavigateOutOfBounds === null || onNavigateOutOfBounds === void 0 ? void 0 : onNavigateOutOfBounds('end');
+        }
+    };
+    return (React__default["default"].createElement("ul", __assign({}, ulProps, listBoxProps, { onKeyDown: onKeyDown, ref: ref, className: clsx('LuiListBox', className) }),
         !items && loadingIndicator(),
         (items === null || items === void 0 ? void 0 : items.length) === 0 && emptyIndicator(),
         Array.from(state.collection).map(function (node) {