@loomhq/lens 10.47.2 → 10.48.1

package/dist/components/modal/modal.d.ts

@@ -1,8 +1,14 @@
-import Backdrop from '../backdrop/backdrop';
 import React from 'react';
-declare const ModalCardWrapper: import("@emotion/styled-base").StyledComponent<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, ModalCardProps, object>;
-export declare const ModalCard: ({ children, onCloseClick, maxWidth, ...props }: ModalCardProps & React.ComponentProps<typeof ModalCardWrapper>) => JSX.Element;
-declare const Modal: ({ children, isOpen, mainButton, secondaryButton, alternativeButton, title, onCloseClick, onBackgroundClick, onKeyDown, hasDividers, maxWidth, zIndex, ...props }: ModalProps & React.ComponentProps<typeof Backdrop>) => JSX.Element;
+declare const ModalCardWrapper: import("@emotion/styled-base").StyledComponent<React.DetailedHTMLProps<React.DialogHTMLAttributes<HTMLDialogElement>, HTMLDialogElement>, ModalCardProps, object>;
+export declare const ModalCard: ({ children, onCloseClick, isOpen, maxWidth, ref, ...props }: ModalCardProps & React.ComponentProps<typeof ModalCardWrapper>) => JSX.Element;
+declare const Modal: React.ForwardRefExoticComponent<Pick<ModalProps & {
+    isOpen?: boolean;
+    children?: React.ReactNode;
+    zIndex?: number;
+    backgroundColor?: string;
+} & React.ClassAttributes<HTMLDivElement> & React.HTMLAttributes<HTMLDivElement> & {
+    theme?: object;
+}, "key" | "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" | "css" | "backgroundColor" | "maxWidth" | "zIndex" | "theme" | "isOpen" | "onCloseClick" | "hasDividers" | "mainButton" | "secondaryButton" | "alternativeButton" | "onBackgroundClick"> & React.RefAttributes<HTMLDialogElement>>;
 declare type ModalProps = {
     children?: React.ReactNode;
     isOpen?: boolean;
@@ -19,6 +25,7 @@ declare type ModalProps = {
 };
 declare type ModalCardProps = {
     children?: React.ReactNode;
+    isOpen?: boolean;
     onCloseClick?: React.ReactEventHandler;
     maxWidth?: number | string;
 };

package/dist/components/modal/modal.js

@@ -9,11 +9,12 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
+import FocusTrap from 'focus-trap-react';
 import { getColorValue, getRadius, getShadow, getSize, u, } from '../../utilities';
 import Backdrop from '../backdrop/backdrop';
 import Container from '../container/container';
 import IconButton from '../icon-button/icon-button';
-import React from 'react';
+import React, { useEffect } from 'react';
 import Spacer from '../spacer/spacer';
 import { SvgClose } from '../icon/available-icons';
 import Text from '../text/text';
@@ -25,7 +26,7 @@ const ContentWrapper = styled.div `
   position: relative;
   max-height: ${modalCardHeight};
 `;
-const ModalCardWrapper = styled.div `
+const ModalCardWrapper = styled.dialog `
   max-height: ${modalCardHeight};
   top: 15vh;
   background-color: ${getColorValue('overlay')};
@@ -35,6 +36,12 @@ const ModalCardWrapper = styled.div `
   margin: 0 auto;
   position: relative;
   overflow: auto;
+  // TODO: LNS-150: Bake dialog resets into native resets file
+  border: 0;
+  padding: 0;
+  &::backdrop {
+    background: var(--lns-color-overlay);
+  }
 `;
 const CloseIconSection = styled.div `
   position: absolute;
@@ -87,18 +94,38 @@ const ModalCardChildrenSection = styled.div `
   }
 `;
 export const ModalCard = (_a) => {
-    var { children, onCloseClick, maxWidth = 60 } = _a, props = __rest(_a, ["children", "onCloseClick", "maxWidth"]);
-    return (React.createElement(ModalCardWrapper, Object.assign({ maxWidth: maxWidth, onClick: e => e.stopPropagation() }, props),
-        onCloseClick && (React.createElement(CloseIconSection, null,
-            React.createElement(IconButton, { altText: "Close", icon: React.createElement(SvgClose, null), onClick: onCloseClick }))),
-        React.createElement(ModalCardChildrenSection, null, children)));
+    // TODO: LNS-151: Abstract into useKeyDown hook for reuse
+    var { children, onCloseClick, isOpen, maxWidth = 60, ref } = _a, props = __rest(_a, ["children", "onCloseClick", "isOpen", "maxWidth", "ref"]);
+    useEffect(() => {
+        if (!isOpen) {
+            return;
+        }
+        const keyListener = e => {
+            if (e.key === 'Escape') {
+                e.preventDefault();
+                onCloseClick(e);
+            }
+        };
+        window.addEventListener('keydown', keyListener);
+        return () => {
+            window.removeEventListener('keydown', keyListener);
+        };
+    }, [isOpen, onCloseClick]);
+    return (React.createElement(FocusTrap, { active: isOpen },
+        React.createElement(ModalCardWrapper, Object.assign({ open: isOpen, maxWidth: maxWidth, onClick: e => e.stopPropagation(), ref: ref }, props),
+            onCloseClick && (React.createElement(CloseIconSection, null,
+                React.createElement(IconButton, { altText: "Close", icon: React.createElement(SvgClose, null), onClick: onCloseClick }))),
+            React.createElement(ModalCardChildrenSection, null, children))));
 };
-const Modal = (_a) => {
+const Modal = React.forwardRef((_a, ref) => {
     var { children, isOpen, mainButton, secondaryButton, alternativeButton, title, onCloseClick, onBackgroundClick, onKeyDown, hasDividers, maxWidth = 60, zIndex = 1000 } = _a, props = __rest(_a, ["children", "isOpen", "mainButton", "secondaryButton", "alternativeButton", "title", "onCloseClick", "onBackgroundClick", "onKeyDown", "hasDividers", "maxWidth", "zIndex"]);
     const hasButtons = mainButton || secondaryButton || alternativeButton ? true : false;
     return (React.createElement(Backdrop, Object.assign({ isOpen: isOpen, zIndex: zIndex }, props),
         React.createElement(Container, { height: "100%", onClick: onBackgroundClick, onKeyDown: onKeyDown },
-            React.createElement(ModalCard, Object.assign({ maxWidth: maxWidth, onCloseClick: onCloseClick }, props),
+            React.createElement(ModalCard, { ref: ref, 
+                // TODO: LNS-148: Add aria labelling for screenreader support
+                // ariaLabelledBy={title}
+                isOpen: isOpen, maxWidth: maxWidth, onCloseClick: onCloseClick },
                 React.createElement(ContentWrapper, { rows: `${title ? 'auto ' : ''} ${children ? '1fr ' : ''} ${hasButtons ? 'auto' : ''}` },
                     title && (React.createElement(TitleSection, { bottom: children
                             ? 'var(--lns-space-medium)'
@@ -110,5 +137,5 @@ const Modal = (_a) => {
                         React.createElement(RightButtonsSection, null,
                             secondaryButton && (React.createElement(Spacer, { right: "small", isInline: true }, secondaryButton)),
                             mainButton))))))));
-};
+});
 export default Modal;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loomhq/lens",
-  "version": "10.47.2",
+  "version": "10.48.1",
   "scripts": {
     "dev": "next",
     "build:next": "next build",
@@ -13,7 +13,8 @@
     "lint:ts": "tsc -p tsconfig.build.json --noEmit",
     "lint:all": "yarn lint && yarn lint:ts",
     "test": "echo \"no tests\"",
-    "semantic-release": "semantic-release"
+    "semantic-release": "semantic-release",
+    "prepare": "husky install"
   },
   "release": {
     "branches": [
@@ -25,6 +26,7 @@
   "dependencies": {
     "@floating-ui/react-dom": "^0.6.3",
     "downshift": "^5.4.7",
+    "focus-trap-react": "^10.0.0",
     "lodash": "^4.17.21",
     "react-color": "^2.19.3",
     "react-laag": "^2.0.3",
@@ -58,6 +60,8 @@
     "babel-loader": "8.0.6",
     "babel-plugin-react-docgen": "^4.2.1",
     "babel-plugin-transform-remove-console": "^6.9.4",
+    "commitlint": "^17.1.2",
+    "conventional-changelog-conventionalcommits": "^5.0.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.10.0",
     "eslint-import-resolver-alias": "^1.1.2",
@@ -66,7 +70,7 @@
     "eslint-plugin-prettier": "^3.1.2",
     "eslint-plugin-react": "^7.18.0",
     "eslint-plugin-react-hooks": "^2.3.0",
-    "husky": "^4.2.1",
+    "husky": "^8.0.0",
     "lint-staged": "^10.0.6",
     "mousetrap": "^1.6.5",
     "next": "12",
@@ -102,14 +106,9 @@
   },
   "homepage": "https://github.com/loomhq/lens#readme",
   "lint-staged": {
-    "src/*.js": [
+    "src/**/*.{js,jsx,mdx,ts,tsx}": [
       "eslint src --fix",
       "git add"
     ]
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
   }
 }