@skyscanner/backpack-web 9.1.0 → 9.2.0-beta.3

package/bpk-component-graphic-promotion/README.md

@@ -8,25 +8,25 @@ npm install bpk-component-graphic-promotion --save-dev
 
 ## Usage
 
-```js
+```tsx
 import React from 'react';
 import BpkGraphicPromo from 'bpk-component-graphic-promotion';
 
 export default () => (
   <BpkGraphicPromo
+    buttonText="Learn more"
     contentId="graphic-promo-1"
-    tagline="Tagline"
     headline="Ride your wave"
-    subheading="Portugal and 6 more countries have just been added to the UK travel green list"
+    invertVertically
+    onClick={() => redirect("https://www.sponsor-name.com/promotion")}
     sponsor={{
       label: 'Sponsored',
       logo: './path/to/sponsor/logo.png',
       altText: 'Sponsor Name',
     }}
-    buttonText="Learn more"
-    onClick={() => redirect("https://www.sponsor-name.com/promotion")}
+    subheading="Portugal and 6 more countries have just been added to the UK travel green list"
+    tagline="Tagline"
     textAlign={TEXT_ALIGN.start}
-    invertVertically
   />
 );
 ```
@@ -35,17 +35,17 @@ export default () => (
 
 | Property         | PropType          | Required | Default Value |
 | ---------------- | ----------------- | -------- | ------------- |
-| contentId        | string            | false    | null          |
 | buttonText       | string            | true     | -             |
 | headline         | string            | true     | -             |
-| invertVertically | bool              | true     | -             |
 | onClick          | func              | true     | -             |
 | textAlign        | oneOf(TEXT_ALIGN) | true     | -             |
 | className        | string            | false    | null          |
-| style            | object            | false    | {}            |
-| tagline          | string            | false    | null          |
+| contentId        | string            | false    | null          |
+| invertVertically | bool              | false    | false         |
 | sponsor          | object            | false    | null          |
+| style            | object            | false    | {}            |
 | subheading       | string            | false    | null          |
+| tagline          | string            | false    | null          |
 
 ### Prop Details
 
@@ -61,7 +61,7 @@ The object consists of the following fields:
 
 ##### Example
 
-```typescript
+```ts
 const sponsor = {
   label: 'Sponsored',
   altText: 'Skyscanner',

package/bpk-component-graphic-promotion/{index.js → index.ts}

@@ -15,7 +15,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/* @flow strict */
 
 import BpkGraphicPromo, {
   type Props as BpkGraphicPromoProps,

package/bpk-component-graphic-promotion/package.json

@@ -8,7 +8,7 @@
     "url": "git@github.com:Skyscanner/backpack.git"
   },
   "author": "Backpack Design System <backpack@skyscanner.net>",
-  "main": "index.js",
+  "main": "index.ts",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
@@ -16,8 +16,7 @@
     "bpk-component-button": "^7.0.1",
     "bpk-component-text": "^8.0.1",
     "bpk-mixins": "^31.4.0",
-    "bpk-react-utils": "^7.0.0",
-    "prop-types": "^15.5.8"
+    "bpk-react-utils": "^7.0.0"
   },
   "peerDependencies": {
     "react": "^17.0.2"

package/bpk-component-graphic-promotion/src/BpkGraphicPromo-test.tsx

@@ -0,0 +1,133 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2022 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 React from 'react';
+import { fireEvent, render } from '@testing-library/react';
+
+// @ts-expect-error Untyped import. Not added as a stub declaration so consumers still have the suppression in their node_modules when shipped untranspiled.
+import { cssModules } from '../../bpk-react-utils';
+
+import BpkGraphicPromo, { TEXT_ALIGN } from './BpkGraphicPromo';
+import type { Props } from './BpkGraphicPromo';
+import STYLES from './BpkGraphicPromo.module.scss';
+
+const getClassName = cssModules(STYLES);
+
+const props: Props = {
+  buttonText: 'Learn more',
+  headline: 'Ride your wave',
+  invertVertically: false,
+  onClick: jest.fn(),
+  sponsor: {
+    label: 'Sponsored',
+    logo: 'path/to/logo.png',
+    altText: 'Airline Name',
+  },
+  subheading:
+    'Portugal and 6 more countries have just been added to the UK travel green list',
+  tagline: 'Tagline',
+  textAlign: TEXT_ALIGN.start,
+};
+
+describe('BpkGraphicPromo', () => {
+  beforeEach(() => {
+    (props.onClick as jest.MockedFunction<Props['onClick']>).mockReset();
+  });
+
+  it('should render correctly with all properties set', () => {
+    const { asFragment } = render(<BpkGraphicPromo {...props} />);
+
+    expect(asFragment()).toMatchSnapshot();
+  });
+
+  it('should support custom class names', () => {
+    const { asFragment } = render(
+      <BpkGraphicPromo className="custom-classname" {...props} />,
+    );
+
+    expect(asFragment()).toMatchSnapshot();
+  });
+
+  it('should render correctly when centre aligned', () => {
+    const customProps = { ...props, textAlign: TEXT_ALIGN.center };
+    const { asFragment } = render(<BpkGraphicPromo {...customProps} />);
+
+    expect(asFragment()).toMatchSnapshot();
+  });
+
+  it('should render correctly when right aligned', () => {
+    const customProps = { ...props, textAlign: TEXT_ALIGN.end };
+    const { asFragment } = render(<BpkGraphicPromo {...customProps} />);
+
+    expect(asFragment()).toMatchSnapshot();
+  });
+
+  it('should render correctly when inverted portrait', () => {
+    const customProps = { ...props, invertVertically: true };
+    const { asFragment } = render(<BpkGraphicPromo {...customProps} />);
+
+    expect(asFragment()).toMatchSnapshot();
+  });
+
+  it('should not display tagline or subheading when not provided', () => {
+    const customProps = { ...props };
+    delete customProps.tagline;
+    delete customProps.subheading;
+    const { asFragment } = render(<BpkGraphicPromo {...customProps} />);
+
+    expect(asFragment()).toMatchSnapshot();
+  });
+
+  it('should display the tagline and no sponsor for non-sponsored ad', () => {
+    const customProps = { ...props };
+    delete customProps.sponsor;
+    const { asFragment } = render(<BpkGraphicPromo {...customProps} />);
+
+    expect(asFragment()).toMatchSnapshot();
+  });
+
+  it('should redirect us to link when card is clicked', () => {
+    render(<BpkGraphicPromo {...props} />);
+
+    const graphicPromo = document.getElementsByClassName(
+      getClassName('bpk-graphic-promo'),
+    )[0];
+    fireEvent.click(graphicPromo);
+
+    expect(props.onClick).toHaveBeenCalledTimes(1);
+  });
+
+  it('should redirect us to link when button is clicked', () => {
+    render(<BpkGraphicPromo {...props} />);
+
+    const graphicPromoCTA = document.getElementsByClassName(
+      getClassName('bpk-graphic-promo__cta'),
+    )[0];
+    fireEvent.click(graphicPromoCTA);
+
+    expect(props.onClick).toHaveBeenCalledTimes(1);
+  });
+
+  it('should render correctly with a content ID', () => {
+    const { asFragment } = render(
+      <BpkGraphicPromo contentId="content-id" {...props} />,
+    );
+
+    expect(asFragment()).toMatchSnapshot();
+  });
+});

package/bpk-component-graphic-promotion/src/{BpkGraphicPromo.js → BpkGraphicPromo.tsx}

@@ -15,13 +15,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/* @flow strict */
 
-import PropTypes from 'prop-types';
 import React from 'react';
 
+// @ts-expect-error Untyped import. Not added as a stub declaration so consumers still have the suppression in their node_modules when shipped untranspiled.
 import { cssModules } from '../../bpk-react-utils';
+// @ts-expect-error Untyped import. Not added as a stub declaration so consumers still have the suppression in their node_modules when shipped untranspiled.
 import BpkText from '../../bpk-component-text';
+// @ts-expect-error Untyped import. Not added as a stub declaration so consumers still have the suppression in their node_modules when shipped untranspiled.
 import BpkButton from '../../bpk-component-button';
 
 import STYLES from './BpkGraphicPromo.module.scss';
@@ -41,64 +42,66 @@ export const TEXT_ALIGN = {
   start: 'start',
   center: 'center',
   end: 'end',
-};
+} as const;
 
 export type Props = {
-  className: ?string,
-  contentId: ?string,
-  tagline: ?string,
-  headline: string,
-  subheading: ?string,
-  sponsor: ?{
-    label: string,
-    logo: string,
-    altText: string,
-  },
-  buttonText: string,
-  onClick: () => void,
-  invertVertically: boolean,
-  textAlign: TEXT_ALIGN,
-  style: ?{},
+  buttonText: string;
+  className?: string | null;
+  contentId?: string | null;
+  headline: string;
+  invertVertically?: boolean;
+  onClick: () => void;
+  sponsor?: {
+    label: string;
+    logo: string;
+    altText: string;
+  } | null;
+  style?: {};
+  subheading?: string | null;
+  tagline?: string | null;
+  textAlign: typeof TEXT_ALIGN[keyof typeof TEXT_ALIGN];
 };
 
-const constructAriaLabel = ({
-  buttonText,
-  headline,
-  sponsor,
-  subheading,
-  tagline,
-}: Props) => {
-  const text = [];
-  const addText = (value) => value && text.push(value);
+const constructAriaLabel = (
+  buttonText: Props['buttonText'],
+  headline: Props['headline'],
+  sponsor: Props['sponsor'],
+  subheading: Props['subheading'],
+  tagline: Props['tagline'],
+) => {
+  const text: string[] = [];
+  const addText = (value: string) => value && text.push(value);
 
   if (sponsor) {
     addText(sponsor.label);
     addText(sponsor.altText);
-  } else {
+  } else if (tagline) {
     addText(tagline);
   }
+
   addText(headline);
-  addText(subheading);
+
+  if (subheading) {
+    addText(subheading);
+  }
   addText(buttonText);
 
   return text.join('. ');
 };
 
-const BpkGraphicPromo = (props: Props) => {
-  const {
-    buttonText,
-    className,
-    contentId,
-    headline,
-    invertVertically,
-    onClick,
-    sponsor,
-    style,
-    subheading,
-    tagline,
-    textAlign,
-  } = props;
-
+const BpkGraphicPromo = ({
+  buttonText,
+  className = null,
+  contentId,
+  headline,
+  invertVertically = false,
+  onClick,
+  sponsor = null,
+  style = {},
+  subheading = null,
+  tagline = null,
+  textAlign,
+}: Props) => {
   // FIXME: Use useCallback() here when React is updated.
   const onClickWrapper = (event: React.MouseEvent<HTMLElement>) => {
     event.stopPropagation();
@@ -122,17 +125,23 @@ const BpkGraphicPromo = (props: Props) => {
     // clicks and key presses (Enter/Space) for the whole component, as described here:
     // https://developer.mozilla.org/en-US/docs/Web/Accessibility/Keyboard-navigable_JavaScript_widgets
     <div
-      id={contentId}
+      id={contentId || ''}
       className={cardClasses}
       style={style}
       role="link"
-      aria-label={constructAriaLabel(props)}
+      aria-label={constructAriaLabel(
+        buttonText,
+        headline,
+        sponsor,
+        subheading,
+        tagline,
+      )}
       tabIndex={0}
       onClick={onClickWrapper}
       onKeyDown={onKeyWrapper}
     >
       <div
-        id={contentId && `${contentId}__content`}
+        id={(contentId && `${contentId}__content`) || ''}
         className={containerClasses}
         aria-hidden
       >
@@ -190,30 +199,4 @@ const BpkGraphicPromo = (props: Props) => {
   );
 };
 
-BpkGraphicPromo.propTypes = {
-  className: PropTypes.string,
-  tagline: PropTypes.string,
-  headline: PropTypes.string.isRequired,
-  subheading: PropTypes.string,
-  sponsor: PropTypes.shape({
-    label: PropTypes.string,
-    logo: PropTypes.string,
-    altText: PropTypes.string,
-  }),
-  buttonText: PropTypes.string.isRequired,
-  onClick: PropTypes.func.isRequired,
-  invertVertically: PropTypes.bool,
-  textAlign: PropTypes.oneOf(Object.values(TEXT_ALIGN)).isRequired,
-  style: PropTypes.shape({ [PropTypes.string]: PropTypes.string }),
-};
-
-BpkGraphicPromo.defaultProps = {
-  className: null,
-  tagline: null,
-  subheading: null,
-  sponsor: null,
-  invertVertically: false,
-  style: {},
-};
-
 export default BpkGraphicPromo;

package/bpk-component-graphic-promotion/src/accessibility-test.tsx

@@ -0,0 +1,147 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2022 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 React from 'react';
+import { render } from '@testing-library/react';
+import { axe } from 'jest-axe';
+
+import BpkGraphicPromo, { TEXT_ALIGN } from './BpkGraphicPromo';
+
+const sponsor = {
+  label: 'Sponsored',
+  logo: 'path/to/logo.png',
+  altText: 'Airline Name',
+};
+const buttonText = 'Learn more';
+const onClick = () => {
+  window.location.href = 'https://www.skyscanner.net';
+};
+
+const tagline = 'Tagline';
+const headline = 'Ride your wave';
+const subheading =
+  'Portugal and 6 more countries have just been added to the UK travel green list';
+
+describe('BpkGraphicPromo accessibility tests', () => {
+  // TODO: Temporarily disabling tests due to a newer version of jest-axe which causes tests to fail when using nested interactive elements
+
+  it('should not have programmatically-detectable accessibility issues', async () => {
+    const { container } = render(
+      <BpkGraphicPromo
+        buttonText={buttonText}
+        className="test"
+        headline={headline}
+        invertVertically={false}
+        onClick={onClick}
+        sponsor={sponsor}
+        subheading={subheading}
+        tagline={tagline}
+        textAlign={TEXT_ALIGN.start}
+      />,
+    );
+
+    const results = await axe(container);
+    expect(results).toHaveNoViolations();
+  });
+
+  it('should not have programmatically-detectable accessibility issues in centre aligned', async () => {
+    const { container } = render(
+      <BpkGraphicPromo
+        buttonText={buttonText}
+        headline={headline}
+        invertVertically={false}
+        onClick={onClick}
+        sponsor={sponsor}
+        subheading={subheading}
+        tagline={tagline}
+        textAlign={TEXT_ALIGN.center}
+      />,
+    );
+
+    const results = await axe(container);
+    expect(results).toHaveNoViolations();
+  });
+
+  it('should not have programmatically-detectable accessibility issues in right aligned', async () => {
+    const { container } = render(
+      <BpkGraphicPromo
+        buttonText={buttonText}
+        headline={headline}
+        invertVertically={false}
+        onClick={onClick}
+        sponsor={sponsor}
+        subheading={subheading}
+        tagline={tagline}
+        textAlign={TEXT_ALIGN.end}
+      />,
+    );
+
+    const results = await axe(container);
+    expect(results).toHaveNoViolations();
+  });
+
+  it('should not have programmatically-detectable accessibility issues in inverted portrait', async () => {
+    const { container } = render(
+      <BpkGraphicPromo
+        buttonText={buttonText}
+        headline={headline}
+        invertVertically
+        onClick={onClick}
+        sponsor={sponsor}
+        subheading={subheading}
+        tagline={tagline}
+        textAlign={TEXT_ALIGN.start}
+      />,
+    );
+
+    const results = await axe(container);
+    expect(results).toHaveNoViolations();
+  });
+
+  it('should not have programmatically-detectable accessibility issues when optional text is missing', async () => {
+    const { container } = render(
+      <BpkGraphicPromo
+        buttonText={buttonText}
+        headline={headline}
+        invertVertically={false}
+        onClick={onClick}
+        sponsor={sponsor}
+        textAlign={TEXT_ALIGN.start}
+      />,
+    );
+
+    const results = await axe(container);
+    expect(results).toHaveNoViolations();
+  });
+
+  it('should not have programmatically-detectable accessibility issues in non-sponsored', async () => {
+    const { container } = render(
+      <BpkGraphicPromo
+        buttonText={buttonText}
+        headline={headline}
+        invertVertically={false}
+        onClick={onClick}
+        subheading={subheading}
+        tagline={tagline}
+        textAlign={TEXT_ALIGN.start}
+      />,
+    );
+
+    const results = await axe(container);
+    expect(results).toHaveNoViolations();
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyscanner/backpack-web",
-  "version": "9.1.0",
+  "version": "9.2.0-beta.3",
   "description": "Backpack Design System web library",
   "repository": {
     "type": "git",