@linzjs/lui 23.6.1 → 23.7.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [23.7.0](https://github.com/linz/lui/compare/v23.6.2...v23.7.0) (2025-07-23)
+
+
+### Features
+
+* Drawer ([#1083](https://github.com/linz/lui/issues/1083)) ([f6f5609](https://github.com/linz/lui/commit/f6f56098fe4be1a2f1b49cfbc266cada5d07bb18))
+
+## [23.6.2](https://github.com/linz/lui/compare/v23.6.1...v23.6.2) (2025-07-09)
+
+
+### Bug Fixes
+
+* remove console log ([#1237](https://github.com/linz/lui/issues/1237)) ([80e2282](https://github.com/linz/lui/commit/80e2282e03bc1fe474b7582fb8ed69318e9894c5))
+
 ## [23.6.1](https://github.com/linz/lui/compare/v23.6.0...v23.6.1) (2025-07-07)
 
 

package/dist/components/Drawer/Drawer.d.ts

@@ -0,0 +1,44 @@
+import React, { ComponentProps, PropsWithChildren } from 'react';
+import { Splitter } from '../Splitter/Splitter';
+import './Drawer.scss';
+import { UseDisableParentScroll } from './utils';
+type Position = 'top' | 'bottom' | 'left' | 'right';
+export type DrawerProps = PropsWithChildren<{
+    /** It's not recommended to make this prop dynamic during runtime as it might affect the opening animation. See the `Positions` story for more info. */
+    position?: Position;
+    /** Drawer open state is fully handled by the parent */
+    isOpen: boolean;
+    /** Allows the Drawer to request closing itself (must be handled by the parent). For accessibility reasons, you must pass this prop unless you implement your custom close button, `closeOnEsc` and `closeOnClickOutside` functionality. */
+    onRequestClose: () => void;
+    /** Enables resizing the drawer via UI. `true` by default. Note: the drawer is always resizeable programmatically. */
+    resizeable?: boolean;
+    /** Pressing `ESC` calls `onRequestClose` */
+    closeOnEsc?: boolean;
+    /** Clicking `div.overlay` calls `onRequestClose`.
+     *
+     * Must be used in conjunction with `passThroughOverlayClick={false}`.*/
+    closeOnClickOutside?: boolean;
+    /** Allows pointer events through the non-content panel. If you set this to `false`, it is recommended that you style `div.overlay` to dim the background.
+     *
+     * Must be set to false to enable `closeOnClickOutside`.
+     */
+    passThroughOverlayClick?: boolean;
+    /** Controls the drawer size. Valid values are from `0` to `100`, in percent of screen width or height occupied by content.
+     *
+     * If `undefined`, the drawer will be uncontrolled, and resizeable purely via DOM/CSS.
+     *
+     * Note: if `resizeable` is true, the drawer will revert to the value of the `size` prop when rerendered. If you use both `size` and `resizeable` make sure the parent updates `size` via `onResized`*/
+    size?: number;
+    /** `0` to `100`, in percent of screen width or height occupied by content. If `undefined`, the drawer will take up half the screen when first mounting. */
+    initialSize?: number;
+    /** Disables scrolling the document or the parent element when the drawer is open.*/
+    disableScroll?: UseDisableParentScroll['mode'];
+    /** A close button is visible by default. Use this if you're implementing a custom button. */
+    hideCloseButton?: boolean;
+    /** By default, `children` is mounted when the drawer opens for the first time. */
+    mountChildrenOn?: 'mount' | 'first-open';
+    /** Called when the drawer is resized either manually or programmatically.  */
+    onResized?: ComponentProps<typeof Splitter>['onResized'];
+}> & Omit<ComponentProps<typeof Splitter>, 'ratio' | 'orientation' | 'onResized'>;
+export declare const Drawer: React.ForwardRefExoticComponent<Pick<DrawerProps, "onResized" | "parts" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "placeholder" | "slot" | "spellCheck" | "style" | "tabIndex" | "title" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "startAt" | "min" | "max" | "key" | "isOpen" | "onRequestClose" | "position" | "size" | "initialSize" | "resizeable" | "passThroughOverlayClick" | "closeOnClickOutside" | "closeOnEsc" | "disableScroll" | "hideCloseButton" | "mountChildrenOn"> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/components/Drawer/DrawerContext.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export type DrawerContext = {
+    isOpen: boolean;
+    requestClose: () => void | Promise<void>;
+};
+export declare const DrawerContext: import("react").Context<DrawerContext | null>;
+export declare const useDrawerContext: () => DrawerContext;

package/dist/components/Drawer/DrawerGlobal.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { DrawerProps } from './Drawer';
+import './Drawer.scss';
+type DrawerGlobalProps = Omit<DrawerProps, 'isOpen' | 'onRequestClose'> & {
+    /** Uniquely identifies your drawer undet the global context. It's extremely important that `id` be unique, as it will also be attached to the DOM element. */
+    id: string;
+    /** Return `false` to prevent the drawer from closing. Useful for controlling flow, or for side-effects.
+     *
+     * Unlike in the vanilla `Drawer`, where the consumer must handle the open/close state, here state is handled by `DrawerGlobalContext`. */
+    onBeforeClose?: () => boolean | Promise<boolean>;
+};
+export declare const DrawerGlobal: React.ForwardRefExoticComponent<Pick<DrawerGlobalProps, "onResized" | "parts" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "hidden" | "id" | "lang" | "placeholder" | "slot" | "spellCheck" | "style" | "tabIndex" | "title" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "startAt" | "min" | "max" | "key" | "position" | "size" | "initialSize" | "resizeable" | "passThroughOverlayClick" | "closeOnClickOutside" | "closeOnEsc" | "disableScroll" | "hideCloseButton" | "mountChildrenOn" | "onBeforeClose"> & React.RefAttributes<HTMLDivElement>>;
+export {};

package/dist/components/Drawer/DrawerGlobalContext.d.ts

@@ -0,0 +1,14 @@
+import React, { FC, PropsWithChildren } from 'react';
+export type DrawerGlobalContext = {
+    /** Tracks the currently open `DrawerGlobal`. Multiple `DrawerGlobal`s can be mounted/rendered simultaneoulsy but only a single one can be open at any time. */
+    currentOpenId?: string;
+    /** Imperatively opens a drawer mounted with a specific `id`. */
+    requestOpen: (drawerId?: string) => void | Promise<void>;
+    /** Imperatively closes a drawer mounted with a specific `id`. Note that usually a given drawer should only be able to close itself, but you can pass an arbitrary `drawerId` or even `forceClose` for more complex use cases. */
+    requestClose: (drawerId?: string, 
+    /** Closes currently open drawer regardless of `drawerId`. */
+    forceClose?: boolean) => void | Promise<void>;
+};
+export declare const DrawerGlobalContext: React.Context<DrawerGlobalContext | null>;
+export declare const useDrawerGlobalContext: () => DrawerGlobalContext;
+export declare const DrawerGlobalProvider: FC<PropsWithChildren<{}>>;

package/dist/components/Drawer/utils.d.ts

@@ -0,0 +1,7 @@
+import { MutableRefObject } from 'react';
+export type UseDisableParentScroll = {
+    shouldDisable?: boolean;
+    parentRef?: MutableRefObject<HTMLElement | null>;
+    mode?: 'body' | 'parent';
+};
+export declare const useDisableParentScroll: ({ shouldDisable, mode, parentRef, }: UseDisableParentScroll) => void;

package/dist/components/common/Hooks.d.ts

@@ -1,10 +1,11 @@
-/// <reference types="react" />
+import { MutableRefObject } from 'react';
 /**
  * A hook which allows you to register a handler when the escape key is pressed
  *
  * @param onEscape the handler function
+ * @param elRef a react ref to the element that should listen to the key event. If this argument is `undefined` it means the consumer wants to attach the listener to `document`. If this argument is a ref to `null` no event listener will be added.
  */
-export declare const useEscapeFunction: (onEscape: (e: KeyboardEvent) => void | Promise<void>, trigger?: 'keyup' | 'keydown') => void;
+export declare const useEscapeFunction: (onEscape: (e: KeyboardEvent) => void | Promise<void>, trigger?: 'keyup' | 'keydown', elRef?: MutableRefObject<HTMLElement | null>) => void;
 /**
  * A hook which allows handling of click event anywhere on the page.
  * Provides a way of handling clicks done inside or outside the element bound to the returned react ref.
@@ -14,6 +15,8 @@ export declare const useEscapeFunction: (onEscape: (e: KeyboardEvent) => void |
  * @return a react ref which can be bound to an html element
  */
 export declare const usePageClickFunction: <H extends Element>(onClickInsideArg: (event: MouseEvent) => void, onClickOutsideArg: (event: MouseEvent) => void) => import("react").RefObject<H>;
+/** Disables scrolling on an specified element */
+export declare const useDisableScroll: (el?: HTMLElement | null, shouldDisable?: boolean) => void;
 /**
  * Provides a stable ID across renders, can be replaced in react 18+ by native implementation
  */

package/dist/index.js

@@ -7202,7 +7202,6 @@ var LuiTextAreaInput = React__default["default"].forwardRef(function (props, ref
     var _a, _b;
     var id = useGenerateOrDefaultId((_a = props.inputProps) === null || _a === void 0 ? void 0 : _a.id);
     var rows = props.rows !== undefined ? props.rows : 5;
-    console.log('🚀 ~ rows:', rows);
     return (React__default["default"].createElement("div", { className: clsx('LuiTextAreaInput', ((_b = props.inputProps) === null || _b === void 0 ? void 0 : _b.disabled) ? 'isDisabled' : '', props.error ? 'hasError' : '', props.warning ? 'hasWarning' : '') },
         React__default["default"].createElement("label", { htmlFor: id },
             props.mandatory && (React__default["default"].createElement("span", { className: "LuiTextAreaInput-mandatory" }, "*")),
@@ -15098,14 +15097,23 @@ var motif = 'data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0id
  * A hook which allows you to register a handler when the escape key is pressed
  *
  * @param onEscape the handler function
+ * @param elRef a react ref to the element that should listen to the key event. If this argument is `undefined` it means the consumer wants to attach the listener to `document`. If this argument is a ref to `null` no event listener will be added.
  */
-var useEscapeFunction = function (onEscape, trigger) {
+var useEscapeFunction = function (onEscape, trigger, elRef) {
     if (trigger === void 0) { trigger = 'keydown'; }
-    var escFunction = React.useCallback(function (event) { return event.key === 'Escape' && onEscape(event); }, [onEscape]);
+    var escFunction = React.useCallback(function (event) {
+        if (event.keyCode === 27) {
+            onEscape(event);
+        }
+    }, [onEscape]);
     React.useEffect(function () {
-        document.addEventListener(trigger, escFunction);
-        return function () { return document.removeEventListener(trigger, escFunction); };
-    }, [escFunction]);
+        var _a;
+        if ((elRef === null || elRef === void 0 ? void 0 : elRef.current) === null)
+            return;
+        var el = (_a = elRef === null || elRef === void 0 ? void 0 : elRef.current) !== null && _a !== void 0 ? _a : document;
+        el.addEventListener(trigger, escFunction, false);
+        return function () { return el.removeEventListener(trigger, escFunction, false); };
+    }, [escFunction, elRef === null || elRef === void 0 ? void 0 : elRef.current]);
 };
 /**
  * A hook which allows handling of click event anywhere on the page.