@skyscanner/backpack-web 9.2.0 → 11.0.0

package/bpk-component-datatable/src/BpkDataTableHeader.js

@@ -0,0 +1,143 @@
+/*
+ * 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 from 'react';
+
+import { cssModules } from '../../bpk-react-utils';
+import BpkSmallArrowDownIcon from '../../bpk-component-icon/sm/arrow-down';
+import BpkSmallArrowUpIcon from '../../bpk-component-icon/sm/arrow-up';
+import { withRtlSupport } from '../../bpk-component-icon';
+
+import { SORT_DIRECTION_TYPES } from './sort-types';
+import STYLES from './BpkDataTableHeader.module.scss';
+import { type ColumnType } from './common-types';
+
+const DownIcon = withRtlSupport(BpkSmallArrowDownIcon);
+const UpIcon = withRtlSupport(BpkSmallArrowUpIcon);
+
+const getClassName = cssModules(STYLES);
+
+const KEYCODES = {
+  ENTER: 13,
+  SPACEBAR: 32,
+};
+
+const BpkDataTableHeader = ({ column }: { column: ColumnType }) => {
+  const {
+    defaultSortDirection,
+    disableSortBy,
+    flexGrow,
+    headerClassName,
+    headerStyle,
+    isSorted,
+    isSortedDesc,
+    label,
+    minWidth,
+    sortDirection,
+    width,
+  } = column;
+
+  const onHeaderClick = () => {
+    if (disableSortBy === true) {
+      return;
+    }
+    let isDescending;
+
+    if (isSorted) {
+      isDescending = isSortedDesc === false;
+    } else if (sortDirection) {
+      isDescending = sortDirection === SORT_DIRECTION_TYPES.DESC;
+    } else if (defaultSortDirection) {
+      isDescending = defaultSortDirection === SORT_DIRECTION_TYPES.DESC;
+    } else {
+      isDescending = false;
+    }
+
+    column.toggleSortBy(isDescending);
+  };
+
+  const handleKeyboardEvent = (event: React.KeyboardEvent<HTMLElement>) => {
+    if (
+      event.keyCode === KEYCODES.ENTER ||
+      event.keyCode === KEYCODES.SPACEBAR
+    ) {
+      event.preventDefault();
+      onHeaderClick();
+    }
+  };
+
+  const headerClassNames = getClassName(
+    'bpk-data-table-column__header',
+    headerClassName,
+  );
+  const upIconClassNames = getClassName(
+    'bpk-data-table-column__sort-icon--up',
+    'bpk-data-table-column__sort-icon',
+    isSorted && !isSortedDesc && 'bpk-data-table-column__sort-icon--selected',
+  );
+
+  const downIconClassNames = getClassName(
+    'bpk-data-table-column__sort-icon--down',
+    'bpk-data-table-column__sort-icon',
+    isSorted && isSortedDesc && 'bpk-data-table-column__sort-icon--selected',
+  );
+
+  return (
+    <div
+      {...column.getHeaderProps({
+        style: {
+          width,
+          minWidth,
+          flexGrow,
+          ...headerStyle,
+        },
+        className: headerClassNames,
+      })}
+    >
+      <span
+        onClick={onHeaderClick}
+        onKeyDown={handleKeyboardEvent}
+        aria-label={label}
+        aria-pressed={isSorted}
+        role="button"
+        tabIndex={0}
+      >
+        {column.render('Header')}
+      </span>
+      {!disableSortBy && (
+        <div
+          className={getClassName('bpk-data-table-column__sort-icons')}
+          key="sort"
+          aria-hidden
+        >
+          <UpIcon
+            onClick={() => column.toggleSortBy(false)}
+            className={upIconClassNames}
+          />
+          <DownIcon
+            onClick={() => column.toggleSortBy(true)}
+            className={downIconClassNames}
+          />
+        </div>
+      )}
+    </div>
+  );
+};
+
+export default BpkDataTableHeader;

package/bpk-component-datatable/src/{BpkDataTableColumn.module.scss → BpkDataTableHeader.module.scss}

@@ -16,24 +16,25 @@
  * limitations under the License.
  */
 
-@import '~bpk-mixins/index';
+@import '~bpk-mixins';
 
 $bpk-spacing-v2: true;
 
 $bpk-margin-size-sort-icons: bpk-spacing-sm() + bpk-spacing-md();
 
-.bpk-data-table-column {
+.bpk-data-table-column__header {
+  display: flex;
+  height: 100%;
   margin: bpk-spacing-base();
-  text-overflow: ellipsis;
-  white-space: nowrap;
-  overflow: hidden;
-}
+  flex-direction: row;
+  align-items: center;
+  outline-offset: -(bpk-spacing-sm());
 
-.bpk-data-table-column__header {
-  display: inline-block;
-  max-width: 100%;
-  text-overflow: ellipsis;
-  overflow: hidden;
+  @include bpk-label-2;
+
+  &:hover {
+    cursor: pointer;
+  }
 }
 
 .bpk-data-table-column__sort-icons {

package/bpk-component-datatable/src/common-types.js

@@ -17,34 +17,56 @@
  */
 
 /* @flow strict */
-import type { ChildrenArray, Element } from 'react';
-
-import BpkDataTableColumn from './BpkDataTableColumn';
 import type {
   SortDirectionType as _SortDirectionType,
   SortProps as _SortProps,
 } from './sort-types';
 
-export type ColumnType = {
-  toColumn(column: any, key: string): any,
-};
-
-export type DataTableProps = {
+type CommonColumnProps = {
+  defaultSortDirection: _SortDirectionType,
+  flexGrow: number,
   headerClassName: ?string,
-  rowClassName: ?string,
+  headerStyle: ?{},
+  label: ?string,
+  minWidth: ?number,
+  width: number,
 };
 
 export type Props<Row> = {
-  ...$Exact<DataTableProps>,
   rows: Array<Row>,
-  children: ChildrenArray<Element<typeof BpkDataTableColumn> & ColumnType>,
+  children: Node,
+  height: number,
   width: ?number,
   headerHeight: number,
+  rowHeight: number,
   className: ?string,
   defaultColumnSortIndex: number,
+  headerClassName: ?string,
+  rowClassName: ?string,
   onRowClick: (Row) => mixed,
   ...$Exact<_SortProps>,
 };
 
+export type ColumnType = {
+  disableSortBy: boolean,
+  getHeaderProps: Function,
+  isSorted: boolean,
+  isSortedDesc: boolean,
+  render: Function,
+  sortDirection: _SortDirectionType,
+  toggleSortBy: Function,
+  ...$Exact<CommonColumnProps>,
+};
+
+export type BpkDataTableColumnProps = {
+  cellDataGetter: ?Function,
+  cellRenderer: ?Function,
+  className: ?string,
+  dataKey: string,
+  disableSort: boolean,
+  headerRenderer: ?Function,
+  ...$Exact<CommonColumnProps>,
+};
+
 export type SortDirectionType = _SortDirectionType;
 export type SortProps = _SortProps;

package/bpk-component-datatable/src/sort-types.js

@@ -20,6 +20,12 @@
 
 // This file exists to break a cycle that would otherwise happen between
 // BpkDataTableColumn.js and common-types.js
+
+export const SORT_DIRECTION_TYPES = {
+  ASC: 'ASC',
+  DESC: 'DESC',
+};
+
 export type SortDirectionType = 'ASC' | ' DESC';
 
 export type SortProps = {

package/bpk-component-datatable/src/utils.js

@@ -17,14 +17,71 @@
  */
 /* @flow strict */
 
+// TODO: Remove these functions once we want to change the API to match the react-table library API
+// To maintain backwards compatibility with the old API of BpkDataTable which takes columns as children
+// The `react-table` library however expects columns as an array of objects
 // eslint-disable-next-line import/prefer-default-export
-export const hasClassName = (node: ?Element, className: ?string): boolean => {
-  if (node == null) {
-    return false;
-  }
+export const getColumns = (columns) =>
+  columns.map((column) => {
+    const { cellDataGetter, cellRenderer, headerRenderer } = column.props;
+    // To maintain backwards compatibility with the old API of BpkDataTable we rename the parameters
+    // And create an interface so that the function signature doesn't depend on the underlying library
+    const columnCellRenderer = ({
+      column: { id: dataKey },
+      columns: columnsData,
+      row: { id: rowID, values: rowData },
+      sortedRows,
+      value: cellData,
+    }) => {
+      const columnIndex = columnsData.map((col) => col.id).indexOf(dataKey);
+      const rowIndex = sortedRows.map((row) => row.id).indexOf(rowID);
 
-  const nodeClassName = node.getAttribute('class');
-  return (
-    nodeClassName != null && nodeClassName.split(' ').indexOf(className) !== -1
-  );
-};
+      return cellRenderer({
+        cellData,
+        columnIndex,
+        dataKey,
+        rowData,
+        rowIndex,
+      });
+    };
+
+    const columnCellDataGetter = ({
+      column: { id: dataKey },
+      row: { values: rowData },
+    }) => cellDataGetter({ dataKey, rowData });
+
+    const columnHeaderRenderer = ({
+      column: { disableSortBy: disableSort, id: dataKey, label },
+    }) => headerRenderer({ dataKey, label, disableSort });
+
+    const {
+      className,
+      dataKey,
+      defaultSortDirection,
+      disableSort,
+      flexGrow,
+      headerClassName,
+      headerStyle,
+      label,
+      minWidth,
+      style,
+      width,
+    } = column.props;
+    return {
+      Header: headerRenderer ? columnHeaderRenderer : label,
+      accessor: dataKey,
+      ...((cellRenderer || cellDataGetter) && {
+        Cell: columnCellRenderer || columnCellDataGetter,
+      }),
+      className,
+      disableSortBy: disableSort,
+      defaultSortDirection,
+      flexGrow,
+      headerClassName,
+      headerStyle,
+      label,
+      minWidth,
+      style,
+      width,
+    };
+  });

package/bpk-component-datepicker/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpk-component-datepicker",
-  "version": "18.0.2",
+  "version": "18.0.4",
   "description": "Backpack datepicker component.",
   "license": "Apache-2.0",
   "repository": {
@@ -14,12 +14,12 @@
   },
   "gitHead": "f9f94f86d7cfc75e43bc6ad5eb01b23e62a89cc8",
   "dependencies": {
-    "bpk-component-breakpoint": "^5.0.2",
-    "bpk-component-calendar": "^12.0.2",
-    "bpk-component-input": "^7.0.2",
-    "bpk-component-modal": "^6.0.2",
-    "bpk-component-popover": "^8.0.2",
-    "bpk-mixins": "^31.5.0",
+    "bpk-component-breakpoint": "^5.0.4",
+    "bpk-component-calendar": "^13.0.1",
+    "bpk-component-input": "^7.0.4",
+    "bpk-component-modal": "^6.0.4",
+    "bpk-component-popover": "^8.0.4",
+    "bpk-mixins": "^31.6.3",
     "bpk-react-utils": "^7.0.0",
     "prop-types": "^15.7.2"
   },
@@ -27,7 +27,7 @@
     "react": "^17.0.2"
   },
   "devDependencies": {
-    "@skyscanner/bpk-foundations-web": "^9.0.0",
-    "bpk-storybook-utils": "^2.0.2"
+    "@skyscanner/bpk-foundations-web": "^9.3.0",
+    "bpk-storybook-utils": "^2.0.4"
   }
 }

package/bpk-component-description-list/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpk-component-description-list",
-  "version": "4.0.2",
+  "version": "4.0.4",
   "description": "Backpack description list component.",
   "license": "Apache-2.0",
   "repository": {
@@ -14,7 +14,7 @@
   },
   "gitHead": "5c156b97cb0ba5e75851d3c763334578714c895e",
   "dependencies": {
-    "bpk-mixins": "^31.5.0",
+    "bpk-mixins": "^31.6.3",
     "bpk-react-utils": "^7.0.0",
     "prop-types": "^15.7.2"
   },

package/bpk-component-dialog/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpk-component-dialog",
-  "version": "7.0.2",
+  "version": "7.0.4",
   "description": "Backpack dialog component.",
   "license": "Apache-2.0",
   "repository": {
@@ -14,19 +14,19 @@
   },
   "gitHead": "f9f94f86d7cfc75e43bc6ad5eb01b23e62a89cc8",
   "dependencies": {
-    "bpk-component-close-button": "^4.0.2",
-    "bpk-component-flare": "^3.0.2",
-    "bpk-mixins": "^31.5.0",
+    "bpk-component-close-button": "^4.0.4",
+    "bpk-component-flare": "^3.0.4",
+    "bpk-mixins": "^31.6.3",
     "bpk-react-utils": "^7.0.0",
-    "bpk-scrim-utils": "^6.0.2",
+    "bpk-scrim-utils": "^6.0.4",
     "prop-types": "^15.7.2"
   },
   "peerDependencies": {
     "react": "^17.0.2"
   },
   "devDependencies": {
-    "bpk-component-button": "^7.0.2",
-    "bpk-component-icon": "^10.0.2",
-    "bpk-component-text": "^8.0.2"
+    "bpk-component-button": "^7.0.4",
+    "bpk-component-icon": "^10.0.4",
+    "bpk-component-text": "^8.0.4"
   }
 }

package/bpk-component-drawer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpk-component-drawer",
-  "version": "7.0.2",
+  "version": "7.0.4",
   "description": "Backpack drawer component.",
   "license": "Apache-2.0",
   "repository": {
@@ -14,13 +14,13 @@
   },
   "gitHead": "f9f94f86d7cfc75e43bc6ad5eb01b23e62a89cc8",
   "dependencies": {
-    "@skyscanner/bpk-foundations-web": "^9.0.0",
-    "bpk-component-close-button": "^4.0.2",
-    "bpk-component-icon": "^10.0.2",
-    "bpk-component-link": "^4.0.2",
-    "bpk-mixins": "^31.5.0",
+    "@skyscanner/bpk-foundations-web": "^9.3.0",
+    "bpk-component-close-button": "^4.0.4",
+    "bpk-component-icon": "^10.0.4",
+    "bpk-component-link": "^4.0.4",
+    "bpk-mixins": "^31.6.3",
     "bpk-react-utils": "^7.0.0",
-    "bpk-scrim-utils": "^6.0.2",
+    "bpk-scrim-utils": "^6.0.4",
     "prop-types": "^15.7.2",
     "react-transition-group": "^2.5.3"
   },
@@ -28,7 +28,7 @@
     "react": "^17.0.2"
   },
   "devDependencies": {
-    "bpk-component-button": "^7.0.2",
-    "bpk-component-text": "^8.0.2"
+    "bpk-component-button": "^7.0.4",
+    "bpk-component-text": "^8.0.4"
   }
 }

package/bpk-component-fieldset/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpk-component-fieldset",
-  "version": "5.0.2",
+  "version": "5.0.4",
   "description": "Backpack fieldset component.",
   "license": "Apache-2.0",
   "repository": {
@@ -14,9 +14,9 @@
   },
   "gitHead": "4e4ec9add28e1db54d6a38a10c331bbd163f2926",
   "dependencies": {
-    "bpk-component-form-validation": "^5.0.2",
-    "bpk-component-label": "^6.0.2",
-    "bpk-mixins": "^31.5.0",
+    "bpk-component-form-validation": "^5.0.4",
+    "bpk-component-label": "^6.0.4",
+    "bpk-mixins": "^31.6.3",
     "bpk-react-utils": "^7.0.0",
     "prop-types": "^15.7.2"
   },
@@ -24,13 +24,13 @@
     "react": "^17.0.2"
   },
   "devDependencies": {
-    "bpk-component-autosuggest": "^7.0.2",
-    "bpk-component-button": "^7.0.2",
-    "bpk-component-calendar": "^12.0.2",
-    "bpk-component-checkbox": "^5.0.2",
-    "bpk-component-datepicker": "^18.0.2",
-    "bpk-component-input": "^7.0.2",
-    "bpk-component-select": "^6.0.2",
-    "bpk-component-textarea": "^5.0.2"
+    "bpk-component-autosuggest": "^7.0.4",
+    "bpk-component-button": "^7.0.4",
+    "bpk-component-calendar": "^13.0.1",
+    "bpk-component-checkbox": "^5.0.4",
+    "bpk-component-datepicker": "^18.0.4",
+    "bpk-component-input": "^7.0.4",
+    "bpk-component-select": "^6.0.4",
+    "bpk-component-textarea": "^5.0.4"
   }
 }

package/bpk-component-flare/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpk-component-flare",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "description": "Backpack FlareBar and ContentBubble component.",
   "license": "Apache-2.0",
   "repository": {
@@ -17,9 +17,9 @@
   },
   "gitHead": "f9f94f86d7cfc75e43bc6ad5eb01b23e62a89cc8",
   "dependencies": {
-    "bpk-component-label": "^6.0.2",
-    "bpk-component-text": "^8.0.2",
-    "bpk-mixins": "^31.5.0",
+    "bpk-component-label": "^6.0.4",
+    "bpk-component-text": "^8.0.4",
+    "bpk-mixins": "^31.6.3",
     "bpk-react-utils": "^7.0.0",
     "prop-types": "^15.7.2"
   },

package/bpk-component-floating-notification/README.md

@@ -16,7 +16,6 @@ import BpkIconHeart from '../../packages/bpk-component-icon/sm/heart';
 export default () => (
   <BpkFloatingNotification
     ctaText="View"
-    type={TYPE.dark}
     icon={BpkIconHeart}
     onClick={() => {}}
     text="Killer Combo saved to New York and Miami 🎉"
@@ -37,7 +36,6 @@ export default () => (
 | onClick        | func         | false    | null          |
 | onExit         | func         | false    | null          |
 | text           | string       | true     | -             |
-| type           | oneOf(TYPE)  | false    | TYPE.light    |
 
 ### Prop Details
 
@@ -50,9 +48,3 @@ The default value is 4 seconds (4000 milliseconds).
 #### onExit
 
 Execute a function after the component has finished the exit animation.
-
-#### type
-
-By default the component is rendered in the light theme (`TYPE.light`) which uses a dark background and white text for the notification. This contrasts against a white page.
-
-The dark theme (`TYPE.dark`) displays the notification with a white background and black text. This contrasts against a dark page.

package/bpk-component-floating-notification/index.js

@@ -19,9 +19,7 @@
 
 import BpkFloatingNotification, {
   type Props as BpkFloatingNotificationProps,
-  TYPE,
 } from './src/BpkFloatingNotification';
 
 export type { BpkFloatingNotificationProps };
-export { TYPE };
 export default BpkFloatingNotification;

package/bpk-component-floating-notification/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpk-component-floating-notification",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "description": "Backpack floating-notification component.",
   "license": "Apache-2.0",
   "repository": {
@@ -13,10 +13,10 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "bpk-component-aria-live": "^3.0.2",
-    "bpk-component-button": "^7.0.2",
-    "bpk-component-text": "^8.0.2",
-    "bpk-mixins": "^31.5.0",
+    "bpk-component-aria-live": "^3.1.1",
+    "bpk-component-button": "^7.0.4",
+    "bpk-component-text": "^8.0.4",
+    "bpk-mixins": "^31.6.3",
     "bpk-react-utils": "^7.0.0",
     "prop-types": "^15.5.8"
   },

package/bpk-component-floating-notification/src/BpkFloatingNotification.js

@@ -30,11 +30,6 @@ import STYLES from './BpkFloatingNotification.module.scss';
 
 const getClassName = cssModules(STYLES);
 
-export const TYPE = {
-  light: 'light',
-  dark: 'dark',
-};
-
 type Props = {
   animateOnEnter: ?boolean,
   animateOnExit: ?boolean,
@@ -45,7 +40,6 @@ type Props = {
   onClick: ?() => void,
   onExit: ?() => void,
   text: string,
-  type: ?TYPE,
 };
 
 const BpkFloatingNotification = (props: Props) => {
@@ -61,25 +55,10 @@ const BpkFloatingNotification = (props: Props) => {
     onClick,
     onExit,
     text,
-    type,
     ...rest
   } = props;
 
-  const classNames = getClassName(
-    'bpk-floating-notification',
-    type === TYPE.dark && 'bpk-floating-notification--dark',
-    className,
-  );
-
-  const iconClassNames = getClassName(
-    'bpk-floating-notification__icon',
-    type === TYPE.dark && 'bpk-floating-notification__icon--dark',
-  );
-
-  const buttonClassNames = getClassName(
-    'bpk-floating-notification__button',
-    type === TYPE.dark && 'bpk-floating-notification__button--dark',
-  );
+  const classNames = getClassName('bpk-floating-notification', className);
 
   useEffect(() => {
     let timer;
@@ -107,7 +86,7 @@ const BpkFloatingNotification = (props: Props) => {
     >
       <div className={classNames} {...rest}>
         {Icon && (
-          <div className={iconClassNames}>
+          <div className={getClassName('bpk-floating-notification__icon')}>
             <Icon aria-hidden />
           </div>
         )}
@@ -120,7 +99,11 @@ const BpkFloatingNotification = (props: Props) => {
         </BpkText>
         <BpkAriaLive aria-hidden>{text}</BpkAriaLive>
         {ctaText && (
-          <BpkButton link onClick={onClick} className={buttonClassNames}>
+          <BpkButton
+            link
+            onClick={onClick}
+            className={getClassName('bpk-floating-notification__button')}
+          >
             {ctaText}
           </BpkButton>
         )}
@@ -139,7 +122,6 @@ BpkFloatingNotification.propTypes = {
   onClick: PropTypes.func,
   onExit: PropTypes.func,
   text: PropTypes.string.isRequired,
-  type: PropTypes.oneOf(Object.values(TYPE)),
 };
 
 BpkFloatingNotification.defaultProps = {
@@ -151,7 +133,6 @@ BpkFloatingNotification.defaultProps = {
   icon: null,
   onClick: null,
   onExit: null,
-  type: TYPE.light,
 };
 
 export default BpkFloatingNotification;