@skyscanner/backpack-web 0.0.1

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

@@ -0,0 +1,252 @@
+/*
+ * 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 { cssModules, deprecated } from 'bpk-react-utils';
+import { BpkSpinner } from 'bpk-component-spinner';
+import CSSTransition from 'react-transition-group/CSSTransition';
+import { animations } from '@skyscanner/bpk-foundations-web/tokens/base.es6';
+
+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,
+  };
+
+  constructor(props) {
+    super(props);
+    this.img = null;
+  }
+
+  componentDidMount() {
+    if (this.img && this.img.src && this.img.complete) {
+      if (this.props.onImageLoad) {
+        this.props.onImageLoad();
+      }
+    }
+  }
+
+  setImgRef = (el) => {
+    this.img = el;
+  };
+
+  render() {
+    const { altText, hidden, onImageLoad, ...rest } = this.props;
+
+    const imgClassNames = [getClassName('bpk-image__img')];
+
+    if (hidden) {
+      imgClassNames.push(getClassName('bpk-image__img--hidden'));
+    }
+
+    return (
+      // $FlowFixMe[cannot-spread-inexact] - inexact rest. See 'decisions/flowfixme.md'.
+      <img
+        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;
+
+    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]}`,
+        ),
+      );
+    }
+
+    // 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>
+    );
+  }
+}
+
+export default BpkImage;

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

@@ -0,0 +1,18 @@
+/*
+ * 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.
+*/
+@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}

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

@@ -0,0 +1,89 @@
+/*
+ * 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 '~bpk-mixins/index';
+
+@mixin bpk-image__spinner {
+  position: absolute;
+  top: 50%;
+  left: 50%;
+  display: block;
+  align-items: center;
+  transform: translate(-50%, -50%);
+
+  &--hidden {
+    transition: opacity $bpk-duration-base ease-in-out;
+    opacity: 0;
+  }
+
+  &--shown {
+    transition: opacity $bpk-duration-base ease-in-out;
+    opacity: 1;
+  }
+}
+
+@mixin bpk-image__img {
+  position: absolute;
+  top: 0;
+  right: 0;
+  bottom: 0;
+  left: 0;
+  display: block;
+  width: 100%;
+  transition: opacity $bpk-duration-base ease-in-out;
+
+  &--hidden {
+    opacity: 0;
+  }
+}
+
+@mixin bpk-image--no-background {
+  background-color: transparent;
+}
+
+@mixin bpk-image {
+  position: relative;
+  display: block;
+  max-width: 100%;
+  transition: background-color $bpk-duration-base ease-in-out;
+  background-color: $bpk-color-sky-gray-tint-06;
+  overflow: hidden;
+  transition-delay: $bpk-duration-base;
+}
+
+.bpk-image {
+  opacity: 1;
+
+  @include bpk-image;
+
+  &__img {
+    @include bpk-image__img;
+  }
+
+  &__spinner {
+    @include bpk-image__spinner;
+  }
+
+  &--no-background {
+    @include bpk-image--no-background;
+  }
+
+  &--border-radius-sm {
+    @include bpk-border-radius-sm;
+  }
+}

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

@@ -0,0 +1,23 @@
+/*
+ * 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 */
+
+const BORDER_RADIUS_STYLES = { none: 'none', sm: 'sm' };
+
+export default BORDER_RADIUS_STYLES;

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

@@ -0,0 +1,37 @@
+/*
+ * 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 */
+
+// eslint-disable-next-line import/prefer-default-export
+export const widthHeightAspectRatioPropType = (
+  props: Object,
+  propName: string,
+  componentName: string,
+): ?Error => {
+  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 null;
+};

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

@@ -0,0 +1,181 @@
+/*
+ * 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, type ComponentType } from 'react';
+import PropTypes from 'prop-types';
+import { wrapDisplayName } from 'bpk-react-utils';
+import throttle from 'lodash/throttle';
+
+type WithLazyLoadingProps = {
+  className: ?string,
+  style: ?{},
+};
+
+type WithLazyLoadingState = {
+  inView: boolean,
+};
+
+export default function withLazyLoading(
+  Component: ComponentType<any>,
+  documentRef: typeof window,
+): ComponentType<any> {
+  class WithLazyLoading extends React.Component<
+    WithLazyLoadingProps,
+    WithLazyLoadingState,
+  > {
+    checkInView: () => void;
+
+    element: ?HTMLElement;
+
+    isInViewPort: () => boolean;
+
+    placeholderReference: string;
+
+    removeEventListeners: () => void;
+
+    setInView: () => void;
+
+    state: WithLazyLoadingState;
+
+    supportsPassiveEvents: () => boolean;
+
+    static propTypes = {
+      style: PropTypes.object, // eslint-disable-line react/forbid-prop-types
+      className: PropTypes.string,
+    };
+
+    static defaultProps = {
+      style: null,
+      className: null,
+    };
+
+    constructor(): void {
+      super();
+
+      this.state = {
+        inView: false,
+      };
+    }
+
+    componentDidMount(): void {
+      documentRef.addEventListener('scroll', this.checkInView, {
+        ...this.getPassiveArgs(),
+      });
+      documentRef.addEventListener('resize', this.checkInView);
+      documentRef.addEventListener('orientationchange', this.checkInView);
+      documentRef.addEventListener('fullscreenchange', this.checkInView);
+      // call checkInView immediately incase the
+      // component is already in view prior to scrolling
+      this.checkInView();
+    }
+
+    componentWillUnmount(): void {
+      this.removeEventListeners();
+    }
+
+    setInView = (): void => {
+      this.setState(() => ({
+        inView: true,
+      }));
+      this.removeEventListeners();
+    };
+
+    getPassiveArgs(): { capture: boolean } {
+      return this.supportsPassiveEvents()
+        ? { capture: true, passive: true }
+        : { capture: true };
+    }
+
+    removeEventListeners = (): void => {
+      documentRef.removeEventListener('scroll', this.checkInView, {
+        ...this.getPassiveArgs(),
+      });
+      documentRef.removeEventListener('resize', this.checkInView);
+      documentRef.removeEventListener('orientationchange', this.checkInView);
+      documentRef.removeEventListener('fullscreenchange', this.checkInView);
+    };
+
+    checkInView = throttle(() => {
+      if (this.isInViewPort()) {
+        this.setInView();
+      }
+    }, 250);
+
+    // This function is taken from modernizr
+    // See https://github.com/modernizr/modernizr
+    supportsPassiveEvents = (): boolean => {
+      let supportsPassiveOption = false;
+      try {
+        const opts = Object.defineProperty({}, 'passive', {
+          get() {
+            supportsPassiveOption = true;
+            return supportsPassiveOption;
+          },
+        });
+        window.addEventListener('test', null, opts);
+        window.removeEventListener('test');
+      } catch (e) {
+        return false;
+      }
+      return supportsPassiveOption;
+    };
+
+    isInViewPort = (): boolean => {
+      if (!this.element) return false;
+      const rect = this.element.getBoundingClientRect();
+
+      const viewPortHeight = Math.max(
+        window.innerHeight,
+        documentRef.documentElement.clientHeight,
+      );
+      const viewPortWidth = Math.max(
+        window.innerWidth,
+        documentRef.documentElement.clientWidth,
+      );
+
+      return (
+        rect.bottom >= 0 &&
+        rect.right >= 0 &&
+        rect.top < viewPortHeight &&
+        rect.left < viewPortWidth
+      );
+    };
+
+    render(): Node {
+      const { className, style, ...rest } = this.props;
+
+      return (
+        <div
+          id={this.placeholderReference}
+          ref={(element) => {
+            this.element = element;
+          }}
+          style={style}
+          className={className}
+        >
+          {/* $FlowFixMe[cannot-spread-inexact] - inexact rest. See 'decisions/flowfixme.md'. */}
+          <Component inView={this.state.inView} {...rest} />
+        </div>
+      );
+    }
+  }
+  WithLazyLoading.displayName = wrapDisplayName(Component, 'withLazyLoading');
+
+  return WithLazyLoading;
+}

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

@@ -0,0 +1,65 @@
+/*
+ * 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 */
+
+import React, { type AbstractComponent } from 'react';
+import { wrapDisplayName } from 'bpk-react-utils';
+
+type InjectedProps = {|
+  onLoad: () => mixed,
+  loading: boolean,
+|};
+
+export default function withLoadingBehavior<Config>(
+  Component: AbstractComponent<{| ...Config, ...InjectedProps |}>,
+): AbstractComponent<Config> {
+  class WithLoadingBehavior<C: Config> extends React.Component<
+    C,
+    {| loading: boolean |},
+  > {
+    constructor() {
+      super();
+
+      this.state = {
+        loading: true,
+      };
+    }
+
+    onLoad = () => {
+      this.setState(() => ({
+        loading: false,
+      }));
+    };
+
+    render() {
+      return (
+        <Component
+          onLoad={this.onLoad}
+          loading={this.state.loading}
+          {...this.props}
+        />
+      );
+    }
+  }
+  WithLoadingBehavior.displayName = wrapDisplayName(
+    Component,
+    'withLoadingBehavior',
+  );
+
+  return WithLoadingBehavior;
+}