@skyscanner/backpack-web 23.2.2 → 23.3.0

package/bpk-scrim-utils/src/scroll-utils.js

@@ -29,7 +29,7 @@ const getScrollBarWidth = () => {
   let scrollBarWidth = 0;
   const window = getWindow();
   const body = getBodyElement();
-  if (body === null && window === null) {
+  if (body === null || window === null) {
     return '';
   }
   const bodyIsOverflowing = body.clientWidth < window.innerWidth;

package/bpk-scrim-utils/src/withScrim.d.ts

@@ -0,0 +1,95 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { ComponentType, RefObject } from 'react';
+type BaseProps = {
+    onClose?: () => void | null;
+    isIphone?: boolean;
+    isIpad?: boolean;
+};
+type HOCProps = {
+    getApplicationElement: () => HTMLElement;
+    containerClassName?: string;
+    closeOnScrimClick?: boolean;
+};
+declare const withScrim: <P extends BaseProps>(WrappedComponent: string | ComponentType<P>) => {
+    new (props: (P & HOCProps & BaseProps) | Readonly<P & HOCProps & BaseProps>): {
+        dialogElement?: RefObject<HTMLElement> | undefined;
+        componentDidMount(): void;
+        componentWillUnmount(): void;
+        dialogRef: (ref: RefObject<HTMLElement>) => void;
+        render(): JSX.Element;
+        context: any;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<P & HOCProps & BaseProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<P & HOCProps & BaseProps> & Readonly<{
+            children?: import("react").ReactNode;
+        }>;
+        state: Readonly<{}>;
+        refs: {
+            [key: string]: import("react").ReactInstance;
+        };
+        shouldComponentUpdate?(nextProps: Readonly<P & HOCProps & BaseProps>, nextState: Readonly<{}>, nextContext: any): boolean;
+        componentDidCatch?(error: Error, errorInfo: import("react").ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<P & HOCProps & BaseProps>, prevState: Readonly<{}>): any;
+        componentDidUpdate?(prevProps: Readonly<P & HOCProps & BaseProps>, prevState: Readonly<{}>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<P & HOCProps & BaseProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<P & HOCProps & BaseProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<P & HOCProps & BaseProps>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<P & HOCProps & BaseProps>, nextState: Readonly<{}>, nextContext: any): void;
+    };
+    new (props: P & HOCProps & BaseProps, context: any): {
+        dialogElement?: RefObject<HTMLElement> | undefined;
+        componentDidMount(): void;
+        componentWillUnmount(): void;
+        dialogRef: (ref: RefObject<HTMLElement>) => void;
+        render(): JSX.Element;
+        context: any;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<P & HOCProps & BaseProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<P & HOCProps & BaseProps> & Readonly<{
+            children?: import("react").ReactNode;
+        }>;
+        state: Readonly<{}>;
+        refs: {
+            [key: string]: import("react").ReactInstance;
+        };
+        shouldComponentUpdate?(nextProps: Readonly<P & HOCProps & BaseProps>, nextState: Readonly<{}>, nextContext: any): boolean;
+        componentDidCatch?(error: Error, errorInfo: import("react").ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<P & HOCProps & BaseProps>, prevState: Readonly<{}>): any;
+        componentDidUpdate?(prevProps: Readonly<P & HOCProps & BaseProps>, prevState: Readonly<{}>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<P & HOCProps & BaseProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<P & HOCProps & BaseProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<P & HOCProps & BaseProps>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<P & HOCProps & BaseProps>, nextState: Readonly<{}>, nextContext: any): void;
+    };
+    displayName: string;
+    defaultProps: {
+        onClose: null;
+        isIphone: boolean;
+        isIpad: boolean;
+        containerClassName: null;
+        closeOnScrimClick: boolean;
+    };
+    contextType?: import("react").Context<any> | undefined;
+};
+export default withScrim;

package/bpk-scrim-utils/src/withScrim.js

@@ -6,13 +6,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _a11yFocusScope = _interopRequireDefault(require("a11y-focus-scope"));
 var _a11yFocusStore = _interopRequireDefault(require("a11y-focus-store"));
-var _propTypes = _interopRequireDefault(require("prop-types"));
 var _react = require("react");
 var _bpkReactUtils = require("../../bpk-react-utils");
 var _BpkScrim = _interopRequireDefault(require("./BpkScrim"));
 var _scrollUtils = require("./scroll-utils");
 var _bpkScrimContentModule = _interopRequireDefault(require("./bpk-scrim-content.module.css"));
-var _customPropTypes = require("./customPropTypes");
 var _jsxRuntime = require("react/jsx-runtime");
 const _excluded = ["closeOnScrimClick", "containerClassName", "getApplicationElement", "isIpad", "isIphone", "onClose"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -38,12 +36,14 @@ function _toPrimitive(input, hint) { if (typeof input !== "object" || input ===
                                                                                                                                                                                                                                                                                                                                                                                            * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
                                                                                                                                                                                                                                                                                                                                                                                            * See the License for the specific language governing permissions and
                                                                                                                                                                                                                                                                                                                                                                                            * limitations under the License.
-                                                                                                                                                                                                                                                                                                                                                                                           */
+                                                                                                                                                                                                                                                                                                                                                                                           */ // @ts-expect-error Untyped import. See `decisions/imports-ts-suppressions.md`.
+// @ts-expect-error Untyped import. See `decisions/imports-ts-suppressions.md`.
 const getClassName = (0, _bpkReactUtils.cssModules)(_bpkScrimContentModule.default);
 const withScrim = WrappedComponent => {
   class WithScrim extends _react.Component {
     constructor(...args) {
       super(...args);
+      _defineProperty(this, "dialogElement", void 0);
       _defineProperty(this, "dialogRef", ref => {
         this.dialogElement = ref;
       });
@@ -123,7 +123,7 @@ const withScrim = WrappedComponent => {
       return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", {
         className: classNames.join(' '),
         children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_BpkScrim.default, {
-          onClose: closeOnScrimClick ? onClose : null
+          onClose: closeOnScrimClick ? onClose : undefined
         }), /*#__PURE__*/(0, _jsxRuntime.jsx)(WrappedComponent, _objectSpread(_objectSpread({}, rest), {}, {
           isIphone: isIphone,
           isIpad: isIpad,
@@ -133,14 +133,7 @@ const withScrim = WrappedComponent => {
       });
     }
   }
-  _defineProperty(WithScrim, "propTypes", {
-    getApplicationElement: _propTypes.default.func.isRequired,
-    onClose: _customPropTypes.onClosePropType,
-    isIphone: _propTypes.default.bool,
-    isIpad: _propTypes.default.bool,
-    containerClassName: _propTypes.default.string,
-    closeOnScrimClick: _propTypes.default.bool
-  });
+  _defineProperty(WithScrim, "displayName", void 0);
   _defineProperty(WithScrim, "defaultProps", {
     onClose: null,
     isIphone: (0, _bpkReactUtils.isDeviceIphone)(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyscanner/backpack-web",
-  "version": "23.2.2",
+  "version": "23.3.0",
   "description": "Backpack Design System web library",
   "repository": {
     "type": "git",