@skyscanner/backpack-web 17.0.1 → 17.1.0-beta.1

package/bpk-component-image/src/BpkImage.js

@@ -1,60 +1,39 @@
-/*
- * 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.
- */
-/* @flow strict */
-
-import React, { type Node, Component } from 'react';
-import PropTypes from 'prop-types';
-import CSSTransition from 'react-transition-group/CSSTransition';
-import { animations } from '@skyscanner/bpk-foundations-web/tokens/base.es6';
-
-import { cssModules, deprecated } from '../../bpk-react-utils';
-import { BpkSpinner } from '../../bpk-component-spinner';
-
-import { widthHeightAspectRatioPropType } from './customPropTypes';
-import STYLES from './BpkImage.module.scss';
-import BORDER_RADIUS_STYLES from './BpkImageBorderRadiusStyles';
-
-const getClassName = cssModules(STYLES);
-
-type ImageProps = {
-  altText: string,
-  hidden: ?boolean,
-  onImageLoad: () => mixed,
-};
-
-class Image extends Component<ImageProps> {
-  img: ?HTMLImageElement;
-
-  static propTypes = {
-    altText: PropTypes.string.isRequired,
-    hidden: PropTypes.bool,
-    onImageLoad: PropTypes.func.isRequired,
-  };
-
-  static defaultProps = {
-    hidden: false,
-  };
-
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _CSSTransition = _interopRequireDefault(require("react-transition-group/CSSTransition"));
+var _base = require("@skyscanner/bpk-foundations-web/tokens/base.es6");
+var _bpkReactUtils = require("../../bpk-react-utils");
+var _bpkComponentSpinner = require("../../bpk-component-spinner");
+var _customPropTypes = require("./customPropTypes");
+var _BpkImageModule = _interopRequireDefault(require("./BpkImage.module.css"));
+var _BpkImageBorderRadiusStyles = _interopRequireDefault(require("./BpkImageBorderRadiusStyles"));
+const _excluded = ["altText", "hidden", "onImageLoad"],
+  _excluded2 = ["altText", "aspectRatio", "borderRadiusStyle", "className", "height", "inView", "loading", "onLoad", "style", "width"];
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+const getClassName = (0, _bpkReactUtils.cssModules)(_BpkImageModule.default);
+class Image extends _react.Component {
   constructor(props) {
     super(props);
+    _defineProperty(this, "img", void 0);
+    _defineProperty(this, "setImgRef", el => {
+      this.img = el;
+    });
     this.img = null;
   }
-
   componentDidMount() {
     if (this.img && this.img.src && this.img.complete) {
       if (this.props.onImageLoad) {
@@ -62,192 +41,145 @@ class Image extends Component<ImageProps> {
       }
     }
   }
-
-  setImgRef = (el) => {
-    this.img = el;
-  };
-
   render() {
-    const { altText, hidden, onImageLoad, ...rest } = this.props;
-
+    const _this$props = this.props,
+      {
+        altText,
+        hidden,
+        onImageLoad
+      } = _this$props,
+      rest = _objectWithoutProperties(_this$props, _excluded);
     const imgClassNames = [getClassName('bpk-image__img')];
-
     if (hidden) {
       imgClassNames.push(getClassName('bpk-image__img--hidden'));
     }
-
     return (
+      /*#__PURE__*/
       // $FlowFixMe[cannot-spread-inexact] - inexact rest. See 'decisions/flowfixme.md'.
-      <img
-        className={imgClassNames.join(' ')}
-        alt={altText}
-        onLoad={onImageLoad}
-        ref={this.setImgRef}
-        {...rest}
-      />
+      _react.default.createElement("img", _extends({
+        className: imgClassNames.join(' '),
+        alt: altText,
+        onLoad: onImageLoad,
+        ref: this.setImgRef
+      }, rest))
     );
   }
 }
-
-type BpkImageProps = {
-  altText: string,
-  aspectRatio: ?number,
-  height: ?number,
-  inView: boolean,
-  loading: boolean,
-  src: string,
-  width: ?number,
-  borderRadiusStyle: $Keys<typeof BORDER_RADIUS_STYLES>,
-  className: ?string,
-  onLoad: ?() => mixed,
-  style: ?{},
-  suppressHydrationWarning: boolean,
-};
-
-class BpkImage extends Component<BpkImageProps> {
-  onImageLoad: () => mixed;
-
-  placeholder: ?HTMLElement;
-
-  static propTypes = {
-    altText: PropTypes.string.isRequired,
-    src: PropTypes.string.isRequired,
-    aspectRatio: widthHeightAspectRatioPropType,
-    borderRadiusStyle: PropTypes.oneOf(Object.keys(BORDER_RADIUS_STYLES)),
-    className: PropTypes.string,
-    inView: PropTypes.bool,
-    loading: PropTypes.bool,
-    onLoad: PropTypes.func,
-    style: PropTypes.object, // eslint-disable-line react/forbid-prop-types
-    suppressHydrationWarning: PropTypes.bool,
-    height: deprecated(
-      widthHeightAspectRatioPropType,
-      'Use "aspectRatio" instead of "width" and "height".',
-    ),
-    width: deprecated(
-      widthHeightAspectRatioPropType,
-      'Use "aspectRatio" instead of "width" and "height".',
-    ),
-  };
-
-  static defaultProps = {
-    aspectRatio: null,
-    borderRadiusStyle: BORDER_RADIUS_STYLES.none,
-    className: null,
-    height: null,
-    inView: true,
-    loading: false,
-    onLoad: null,
-    style: {},
-    suppressHydrationWarning: false,
-    width: null,
-  };
-
-  onImageLoad = (): void => {
-    if (this.props.onLoad) {
-      this.props.onLoad();
-    }
-  };
-
-  getAspectRatio = () => {
-    if (this.props.aspectRatio) {
-      return this.props.aspectRatio;
-    }
-    if (this.props.width && this.props.height) {
-      return this.props.width / this.props.height;
-    }
-    return 1;
-  };
-
-  render(): Node {
-    const {
-      altText,
-      aspectRatio,
-      borderRadiusStyle,
-      className,
-      height,
-      inView,
-      loading,
-      onLoad,
-      style,
-      width,
-      ...rest
-    } = this.props;
-
+_defineProperty(Image, "propTypes", {
+  altText: _propTypes.default.string.isRequired,
+  hidden: _propTypes.default.bool,
+  onImageLoad: _propTypes.default.func.isRequired
+});
+_defineProperty(Image, "defaultProps", {
+  hidden: false
+});
+class BpkImage extends _react.Component {
+  constructor(...args) {
+    super(...args);
+    _defineProperty(this, "onImageLoad", void 0);
+    _defineProperty(this, "placeholder", void 0);
+    _defineProperty(this, "onImageLoad", () => {
+      if (this.props.onLoad) {
+        this.props.onLoad();
+      }
+    });
+    _defineProperty(this, "getAspectRatio", () => {
+      if (this.props.aspectRatio) {
+        return this.props.aspectRatio;
+      }
+      if (this.props.width && this.props.height) {
+        return this.props.width / this.props.height;
+      }
+      return 1;
+    });
+  }
+  render() {
+    const _this$props2 = this.props,
+      {
+        altText,
+        aspectRatio,
+        borderRadiusStyle,
+        className,
+        height,
+        inView,
+        loading,
+        onLoad,
+        style,
+        width
+      } = _this$props2,
+      rest = _objectWithoutProperties(_this$props2, _excluded2);
     const classNames = [getClassName('bpk-image')];
-
     const aspectRatioPercentage = `${100 / this.getAspectRatio()}%`;
-
     if (!loading) {
       classNames.push(getClassName('bpk-image--no-background'));
     }
-
-    if (borderRadiusStyle !== BORDER_RADIUS_STYLES.none) {
-      classNames.push(
-        getClassName(
-          `bpk-image--border-radius-${BORDER_RADIUS_STYLES[borderRadiusStyle]}`,
-        ),
-      );
+    if (borderRadiusStyle !== _BpkImageBorderRadiusStyles.default.none) {
+      classNames.push(getClassName(`bpk-image--border-radius-${_BpkImageBorderRadiusStyles.default[borderRadiusStyle]}`));
     }
 
     // wraps a div with maxWidth and maxHeight set iff full-width is no required.
     // This ensures that the css / html do not reserve too much spacing
     // when width 100% is not being used
-    return (
-      <div style={style} className={className}>
-        <div
-          ref={(div) => {
-            this.placeholder = div;
-          }}
-          style={{ height: 0, paddingBottom: aspectRatioPercentage }}
-          className={classNames.join(' ')}
-          suppressHydrationWarning={this.props.suppressHydrationWarning}
-        >
-          {/*
-            Image needs to come before the spinner to avoid a problem where
-            some images would not fully render in mobile Safari when running
-            on a slow network.
-
-            The closest to an explanation that I can come up is that putting
-            the image first means it is rendered first so it has priority,
-            which seems to be enough to fix it.
-          */}
-          {inView && (
-            // $FlowFixMe[cannot-spread-inexact] - inexact rest. See 'decisions/flowfixme.md'.
-            <Image
-              hidden={loading}
-              altText={altText}
-              onImageLoad={this.onImageLoad}
-              {...rest}
-            />
-          )}
-          {loading && (
-            <CSSTransition
-              classNames={{
-                exit: getClassName('bpk-image__spinner--shown'),
-                exitActive: getClassName('bpk-image__spinner--hidden'),
-              }}
-              timeout={parseInt(animations.durationBase, 10)}
-            >
-              <div className={getClassName('bpk-image__spinner')}>
-                <BpkSpinner />
-              </div>
-            </CSSTransition>
-          )}
-          {typeof window === 'undefined' && (!inView || loading) && (
-            <noscript>
-              {/* $FlowFixMe[cannot-spread-inexact] - inexact rest. See 'decisions/flowfixme.md'. */}
-              <Image
-                altText={altText}
-                onImageLoad={this.onImageLoad}
-                {...rest}
-              />
-            </noscript>
-          )}
-        </div>
-      </div>
-    );
+    return /*#__PURE__*/_react.default.createElement("div", {
+      style: style,
+      className: className
+    }, /*#__PURE__*/_react.default.createElement("div", {
+      ref: div => {
+        this.placeholder = div;
+      },
+      style: {
+        height: 0,
+        paddingBottom: aspectRatioPercentage
+      },
+      className: classNames.join(' '),
+      suppressHydrationWarning: this.props.suppressHydrationWarning
+    }, inView &&
+    /*#__PURE__*/
+    // $FlowFixMe[cannot-spread-inexact] - inexact rest. See 'decisions/flowfixme.md'.
+    _react.default.createElement(Image, _extends({
+      hidden: loading,
+      altText: altText,
+      onImageLoad: this.onImageLoad
+    }, rest)), loading && /*#__PURE__*/_react.default.createElement(_CSSTransition.default, {
+      classNames: {
+        exit: getClassName('bpk-image__spinner--shown'),
+        exitActive: getClassName('bpk-image__spinner--hidden')
+      },
+      timeout: parseInt(_base.animations.durationBase, 10)
+    }, /*#__PURE__*/_react.default.createElement("div", {
+      className: getClassName('bpk-image__spinner')
+    }, /*#__PURE__*/_react.default.createElement(_bpkComponentSpinner.BpkSpinner, null))), typeof window === 'undefined' && (!inView || loading) && /*#__PURE__*/_react.default.createElement("noscript", null, /*#__PURE__*/_react.default.createElement(Image, _extends({
+      altText: altText,
+      onImageLoad: this.onImageLoad
+    }, rest)))));
   }
 }
-
-export default BpkImage;
+_defineProperty(BpkImage, "propTypes", {
+  altText: _propTypes.default.string.isRequired,
+  src: _propTypes.default.string.isRequired,
+  aspectRatio: _customPropTypes.widthHeightAspectRatioPropType,
+  borderRadiusStyle: _propTypes.default.oneOf(Object.keys(_BpkImageBorderRadiusStyles.default)),
+  className: _propTypes.default.string,
+  inView: _propTypes.default.bool,
+  loading: _propTypes.default.bool,
+  onLoad: _propTypes.default.func,
+  style: _propTypes.default.object,
+  // eslint-disable-line react/forbid-prop-types
+  suppressHydrationWarning: _propTypes.default.bool,
+  height: (0, _bpkReactUtils.deprecated)(_customPropTypes.widthHeightAspectRatioPropType, 'Use "aspectRatio" instead of "width" and "height".'),
+  width: (0, _bpkReactUtils.deprecated)(_customPropTypes.widthHeightAspectRatioPropType, 'Use "aspectRatio" instead of "width" and "height".')
+});
+_defineProperty(BpkImage, "defaultProps", {
+  aspectRatio: null,
+  borderRadiusStyle: _BpkImageBorderRadiusStyles.default.none,
+  className: null,
+  height: null,
+  inView: true,
+  loading: false,
+  onLoad: null,
+  style: {},
+  suppressHydrationWarning: false,
+  width: null
+});
+var _default = BpkImage;
+exports.default = _default;

package/bpk-component-image/src/BpkImage.module.css

@@ -15,4 +15,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
 */
-@keyframes bpk-keyframe-spin{100%{transform:rotate(1turn)}}.bpk-image{opacity:1;position:relative;display:block;max-width:100%;transition:background-color 400ms ease-in-out;background-color:#dddde5;overflow:hidden;transition-delay:400ms}.bpk-image__img{position:absolute;top:0;right:0;bottom:0;left:0;display:block;width:100%;transition:opacity 400ms ease-in-out}.bpk-image__img--hidden{opacity:0}.bpk-image__spinner{position:absolute;top:50%;left:50%;display:block;align-items:center;transform:translate(-50%, -50%)}.bpk-image__spinner--hidden{transition:opacity 400ms ease-in-out;opacity:0}.bpk-image__spinner--shown{transition:opacity 400ms ease-in-out;opacity:1}.bpk-image--no-background{background-color:transparent}.bpk-image--border-radius-sm{border-radius:.375rem}
+@keyframes bpk-keyframe-spin{100%{transform:rotate(1turn)}}.bpk-image{opacity:1;position:relative;display:block;max-width:100%;transition:background-color 400ms ease-in-out;background-color:#e0e3e5;overflow:hidden;transition-delay:400ms}.bpk-image__img{position:absolute;top:0;right:0;bottom:0;left:0;display:block;width:100%;transition:opacity 400ms ease-in-out}.bpk-image__img--hidden{opacity:0}.bpk-image__spinner{position:absolute;top:50%;left:50%;display:block;align-items:center;transform:translate(-50%, -50%)}.bpk-image__spinner--hidden{transition:opacity 400ms ease-in-out;opacity:0}.bpk-image__spinner--shown{transition:opacity 400ms ease-in-out;opacity:1}.bpk-image--no-background{background-color:#05203c}.bpk-image--border-radius-sm{border-radius:.375rem}

package/bpk-component-image/src/BpkImageBorderRadiusStyles.js

@@ -1,3 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
 /*
  * Backpack - Skyscanner's Design System
  *
@@ -14,10 +20,9 @@
  * 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.
- */
-
-/* @flow */
-
-const BORDER_RADIUS_STYLES = { none: 'none', sm: 'sm' };
-
-export default BORDER_RADIUS_STYLES;
+ */const BORDER_RADIUS_STYLES = {
+  none: 'none',
+  sm: 'sm'
+};
+var _default = BORDER_RADIUS_STYLES;
+exports.default = _default;

package/bpk-component-image/src/customPropTypes.js

@@ -1,3 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.widthHeightAspectRatioPropType = void 0;
 /*
  * Backpack - Skyscanner's Design System
  *
@@ -14,24 +20,13 @@
  * 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.
- */
-
-/* @flow strict */
-
-// eslint-disable-next-line import/prefer-default-export
-export const widthHeightAspectRatioPropType = (
-  props: Object,
-  propName: string,
-  componentName: string,
-): ?Error => {
+ */ // eslint-disable-next-line import/prefer-default-export
+const widthHeightAspectRatioPropType = (props, propName, componentName) => {
   const usingWidthHeight = props.width && props.height;
   const usingAspectRatio = !!props.aspectRatio;
-
   if (!usingWidthHeight && !usingAspectRatio) {
-    return new Error(
-      `Invalid prop \`${propName}\` supplied to \`${componentName}\`. You must either specify "width" and "height" or you must specify "aspectRatio".`,
-    );
+    return new Error(`Invalid prop \`${propName}\` supplied to \`${componentName}\`. You must either specify "width" and "height" or you must specify "aspectRatio".`);
   }
-
   return null;
 };
+exports.widthHeightAspectRatioPropType = widthHeightAspectRatioPropType;