@transferwise/components 46.38.0 → 46.40.0

package/src/chips/Chips.story.tsx

@@ -1,4 +1,4 @@
-import { Story, Meta } from '@storybook/react';
+import { StoryFn, Meta } from '@storybook/react';
 import { useState } from 'react';
 
 import Chips, { ChipsProps, ChipValue } from './Chips';
@@ -10,7 +10,9 @@ const meta: Meta<typeof Chips> = {
 };
 export default meta;
 
-const FilterTemplate: Story<ChipsProps> = (args: ChipsProps) => {
+type Story = StoryFn<ChipsProps>;
+
+const FilterTemplate: Story = (args: ChipsProps) => {
   const [selected, setSelected] = useState<readonly ChipValue[]>(
     args.selected == null || Array.isArray(args.selected) ? args.selected : [args.selected],
   );
@@ -31,7 +33,7 @@ const FilterTemplate: Story<ChipsProps> = (args: ChipsProps) => {
   );
 };
 
-const ChoiceTemplate: Story<ChipsProps> = (args: ChipsProps) => {
+const ChoiceTemplate: Story = (args: ChipsProps) => {
   const [selected, setSelected] = useState<ChipValue>(args.selected as ChipValue);
   return (
     <Chips

package/src/circularButton/CircularButton.spec.tsx

@@ -1,4 +1,3 @@
-import '@testing-library/jest-dom';
 import { Plus } from '@transferwise/icons';
 
 import { ControlType, Priority } from '../common';
@@ -54,17 +53,17 @@ describe('CircularButton', () => {
   });
 
   describe('onClick', () => {
-    it('calls onClick when clicked', () => {
+    it('calls onClick when clicked', async () => {
       const onClick = jest.fn();
       render(<CircularButton {...props} onClick={onClick} />);
-      userEvent.click(screen.getByRole('button'));
+      await userEvent.click(screen.getByRole('button'));
       expect(onClick).toHaveBeenCalledTimes(1);
     });
 
-    it('does not call onClick when clicked if disabled', () => {
+    it('does not call onClick when clicked if disabled', async () => {
       const onClick = jest.fn();
       render(<CircularButton {...props} disabled onClick={onClick} />);
-      userEvent.click(screen.getByRole('button'));
+      await userEvent.click(screen.getByRole('button'));
       expect(onClick).toHaveBeenCalledTimes(0);
     });
   });

package/src/common/RadioButton/RadioButton.spec.tsx

@@ -21,7 +21,7 @@ describe('Radio button', () => {
     expect(container).toMatchSnapshot();
   });
 
-  it('responds to user input', () => {
+  it('responds to user input', async () => {
     const onChange = jest.fn();
     render(
       <label htmlFor="an-id">
@@ -29,7 +29,7 @@ describe('Radio button', () => {
       </label>,
     );
 
-    userEvent.click(screen.getByLabelText('A radio'));
+    await userEvent.click(screen.getByLabelText('A radio'));
 
     expect(onChange).toHaveBeenCalledWith('a-value');
   });

package/src/common/card/Card.story.tsx

@@ -23,5 +23,6 @@ export const Default: Story = {
         {lorem10}
       </>
     ),
+    onDismiss: () => {},
   },
 };

package/src/common/closeButton/CloseButton.spec.tsx

@@ -1,4 +1,3 @@
-import '@testing-library/jest-dom';
 import { render } from '../../test-utils';
 
 import { CloseButton } from '.';

package/src/common/flowHeader/FlowHeader.spec.tsx

@@ -1,4 +1,3 @@
-import '@testing-library/jest-dom';
 import { render } from '@testing-library/react';
 
 import { Layout } from '../propsValues/layouts';

package/src/dateInput/DateInput.story.tsx

@@ -1,13 +1,10 @@
 import { Meta, StoryObj } from '@storybook/react';
 import { userEvent, within } from '@storybook/test';
-import * as React from 'react';
 
 import { DateInput, DateMode, Info, InlineAlert, Title, Typography } from '..';
 import { lorem10, storyConfig } from '../test-utils';
 
-import { DateInputProps } from './DateInput';
-
-export default {
+const meta = {
   component: DateInput,
   title: 'Forms/DateInput',
   args: {
@@ -20,16 +17,24 @@ export default {
   tags: ['autodocs'],
 } satisfies Meta<typeof DateInput>;
 
-type Story = StoryObj<DateInputProps>;
+export default meta;
 
-export const Basic: StoryObj = {};
+type Story = StoryObj<typeof meta>;
 
-Basic.play = async ({ canvasElement }) => {
-  const canvas = within(canvasElement);
-  await userEvent.click(canvas.getByRole('button'));
-};
+export const Basic = {
+  args: {
+    onChange: () => {},
+  },
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement);
+    await userEvent.click(canvas.getByRole('button'));
+  },
+} satisfies Story;
 
-export const WithLabel: Story = {
+export const WithLabel = {
+  args: {
+    onChange: () => {},
+  },
   render: (args) => {
     const id1 = 'date-input-group-label-1';
     const label = 'Date of Birth';
@@ -71,11 +76,11 @@ export const WithLabel: Story = {
       </>
     );
   },
-};
+} satisfies Story;
 
-export const BasicMobile: Story = storyConfig(Basic, { variants: ['mobile'] });
+export const BasicMobile = storyConfig(Basic, { variants: ['mobile'] });
 
-export const InputError: Story = {
+export const InputError = {
   ...Basic,
   render: (args) => (
     <div className="form-group has-error">
@@ -83,6 +88,6 @@ export const InputError: Story = {
       <InlineAlert type="error">{lorem10}</InlineAlert>
     </div>
   ),
-};
+} satisfies Story;
 
-export const InputErrorMobile: Story = storyConfig(InputError, { variants: ['mobile'] });
+export const InputErrorMobile = storyConfig(InputError, { variants: ['mobile'] });

package/src/dateLookup/DateLookup.rtl.spec.tsx

@@ -4,6 +4,8 @@ import DateLookup, { DateLookupProps } from './DateLookup';
 
 import { act } from 'react';
 
+const user = userEvent.setup({ advanceTimers: jest.advanceTimersByTimeAsync });
+
 mockMatchMedia();
 mockResizeObserver();
 
@@ -36,12 +38,12 @@ describe('DateLookup', () => {
     async (text) => {
       render(<DateLookup value={initialValue} onChange={() => {}} />);
 
-      userEvent.tab();
-      userEvent.keyboard(text);
+      await user.tab();
+      await user.keyboard(text);
 
       expect(screen.getByRole('button', { name: /next/iu })).toBeInTheDocument();
 
-      userEvent.keyboard('{Escape}');
+      await user.keyboard('{Escape}');
       await act(async () => {
         await jest.runOnlyPendingTimersAsync();
       });
@@ -53,7 +55,7 @@ describe('DateLookup', () => {
   const setupAndOpenWithMouse = async (props: Partial<DateLookupProps> = {}) => {
     const view = render(<DateLookup value={initialValue} onChange={() => {}} {...props} />);
 
-    userEvent.click(screen.getByRole('button'));
+    await user.click(screen.getByRole('button'));
     await act(async () => {
       await jest.runOnlyPendingTimersAsync();
     });
@@ -68,7 +70,7 @@ describe('DateLookup', () => {
 
     const dimmerElement = screen.getByRole('dialog').parentElement?.parentElement;
     if (dimmerElement != null) {
-      userEvent.click(dimmerElement);
+      await user.click(dimmerElement);
     }
     await act(async () => {
       await jest.runOnlyPendingTimersAsync();
@@ -89,13 +91,13 @@ describe('DateLookup', () => {
 
       expect(handleChange).not.toHaveBeenCalled();
 
-      userEvent.keyboard(text);
+      await user.keyboard(text);
 
       const value = new Date(initialValue);
       value.setDate(initialValue.getDate() + step);
       expect(handleChange).toHaveBeenCalledWith(value);
 
-      userEvent.keyboard('{Escape}');
+      await user.keyboard('{Escape}');
       await act(async () => {
         await jest.runOnlyPendingTimersAsync();
       });
@@ -114,20 +116,20 @@ describe('DateLookup', () => {
       const handleChange = jest.fn();
       await setupAndOpenWithMouse({ onChange: handleChange });
 
-      userEvent.click(screen.getByRole('button', { name: /year view/iu }));
+      await user.click(screen.getByRole('button', { name: /year view/iu }));
       await act(async () => {
         await jest.runOnlyPendingTimersAsync();
       });
 
       expect(handleChange).not.toHaveBeenCalled();
 
-      userEvent.keyboard(text);
+      await user.keyboard(text);
 
       const value = new Date(initialValue);
       value.setFullYear(initialValue.getFullYear() + step);
       expect(handleChange).toHaveBeenCalledWith(value);
 
-      userEvent.keyboard('{Escape}');
+      await user.keyboard('{Escape}');
       await act(async () => {
         await jest.runOnlyPendingTimersAsync();
       });
@@ -146,24 +148,24 @@ describe('DateLookup', () => {
       const handleChange = jest.fn();
       await setupAndOpenWithMouse({ onChange: handleChange });
 
-      userEvent.click(screen.getByRole('button', { name: /year view/iu }));
+      await user.click(screen.getByRole('button', { name: /year view/iu }));
       await act(async () => {
         await jest.runOnlyPendingTimersAsync();
       });
-      userEvent.keyboard(' ');
+      await user.keyboard(' ');
       await act(async () => {
         await jest.runOnlyPendingTimersAsync();
       });
 
       expect(handleChange).not.toHaveBeenCalled();
 
-      userEvent.keyboard(text);
+      await user.keyboard(text);
 
       const value = new Date(initialValue);
       value.setMonth(initialValue.getMonth() + step);
       expect(handleChange).toHaveBeenCalledWith(value);
 
-      userEvent.keyboard('{Escape}');
+      await user.keyboard('{Escape}');
       await act(async () => {
         await jest.runOnlyPendingTimersAsync();
       });
@@ -178,7 +180,7 @@ describe('DateLookup', () => {
     const handleChange = jest.fn();
     await setupAndOpenWithMouse({ min, onChange: handleChange });
 
-    userEvent.keyboard('{ArrowLeft}{ArrowLeft}');
+    await user.keyboard('{ArrowLeft}{ArrowLeft}');
 
     expect(handleChange).toHaveBeenCalledWith(min);
   });
@@ -189,7 +191,7 @@ describe('DateLookup', () => {
     const handleChange = jest.fn();
     await setupAndOpenWithMouse({ max, onChange: handleChange });
 
-    userEvent.keyboard('{ArrowRight}{ArrowRight}');
+    await user.keyboard('{ArrowRight}{ArrowRight}');
 
     expect(handleChange).toHaveBeenCalledWith(max);
   });

package/src/dateLookup/DateLookup.testingLibrary.spec.js

@@ -1,5 +1,4 @@
-import '@testing-library/jest-dom';
-import user from '@testing-library/user-event';
+import { userEvent } from '@testing-library/user-event';
 import { act } from 'react';
 
 import { render, screen, mockMatchMedia } from '../test-utils';
@@ -55,103 +54,103 @@ describe('DateLookup (events)', () => {
 
     it('switches to years', async () => {
       const view = await setup();
-      openDateLookup(view);
-      clickDateButton(view);
+      await openDateLookup(view);
+      await clickDateButton(view);
 
       expect(getActiveYearButton(view)).toHaveFocus();
 
-      closeDateLookup(view);
+      await closeDateLookup(view);
     });
 
     it('has aria-label for 20 years', async () => {
       const view = await setup();
-      openDateLookup(view);
-      clickDateButton(view);
+      await openDateLookup(view);
+      await clickDateButton(view);
 
       expect(getButtonByAriaLabel('next 20 years')).toBeInTheDocument();
       expect(getButtonByAriaLabel('previous 20 years')).toBeInTheDocument();
 
-      closeDateLookup(view);
+      await closeDateLookup(view);
     });
 
     it('switches to months', async () => {
       const view = await setup();
-      openDateLookup(view);
-      clickDateButton(view);
-      user.click(getActiveYearButton(view));
+      await openDateLookup(view);
+      await clickDateButton(view);
+      await userEvent.click(getActiveYearButton(view));
 
       expect(getActiveMonthButton(view)).toHaveFocus();
 
-      closeDateLookup(view);
+      await closeDateLookup(view);
     });
 
     it('has aria label for year', async () => {
       const view = await setup();
-      openDateLookup(view);
-      clickDateButton(view);
-      user.click(getActiveYearButton(view));
+      await openDateLookup(view);
+      await clickDateButton(view);
+      await userEvent.click(getActiveYearButton(view));
 
       expect(getButtonByAriaLabel('next year')).toBeInTheDocument();
       expect(getButtonByAriaLabel('previous year')).toBeInTheDocument();
 
-      closeDateLookup(view);
+      await closeDateLookup(view);
     });
 
     it('switches to days', async () => {
       const view = await setup();
-      openDateLookup(view);
-      clickDateButton(view);
-      user.click(getActiveYearButton(view));
-      user.click(getActiveMonthButton(view));
+      await openDateLookup(view);
+      await clickDateButton(view);
+      await userEvent.click(getActiveYearButton(view));
+      await userEvent.click(getActiveMonthButton(view));
 
       expect(getActiveDayButton(view)).toHaveFocus();
 
-      closeDateLookup(view);
+      await closeDateLookup(view);
     });
 
     it('has aria label for month', async () => {
       const view = await setup();
-      openDateLookup(view);
-      clickDateButton(view);
-      user.click(getActiveYearButton(view));
-      user.click(getActiveMonthButton(view));
+      await openDateLookup(view);
+      await clickDateButton(view);
+      await userEvent.click(getActiveYearButton(view));
+      await userEvent.click(getActiveMonthButton(view));
 
       expect(getButtonByAriaLabel('next month')).toBeInTheDocument();
       expect(getButtonByAriaLabel('previous month')).toBeInTheDocument();
 
-      closeDateLookup(view);
+      await closeDateLookup(view);
     });
 
     it('updates selected date and closes', async () => {
       const view = await setup();
-      openDateLookup(view);
+      await openDateLookup(view);
       const d = new Date(2018, 11, 28);
       const newDay = screen.getByText(d.getDate().toString());
-      user.click(newDay);
+      await userEvent.click(newDay);
 
       expect(handleChange).toHaveBeenCalledWith(d);
       expect(getOpenButton(view)).toHaveFocus();
 
-      closeDateLookup(view);
+      await closeDateLookup(view);
     });
 
     it('has aria label on selected date', async () => {
       const view = await setup();
-      openDateLookup(view);
+      await openDateLookup(view);
       const d = new Date(2018, 11, 28);
       const newDay = screen.getByText(d.getDate().toString());
-      user.click(newDay);
-      openDateLookup(view);
+      await userEvent.click(newDay);
+      await openDateLookup(view);
       expect(screen.getByRole('button', { name: /selected day/i })).toBeInTheDocument();
 
-      closeDateLookup(view);
+      await closeDateLookup(view);
     });
 
     it('supports custom `aria-labelledby` attribute', async () => {
       const view = await setup();
       expect(screen.getByLabelText('Prioritized label')).toHaveClass('input-group');
 
-      closeDateLookup(view);
+      await closeDateLookup(view);
     });
   });
 
@@ -183,29 +182,33 @@ describe('DateLookup (events)', () => {
 
     it('when user clicks on clear the focus returns to btn', async () => {
       const view = await setup();
-      clickClearButton(view);
+      await clickClearButton(view);
       expect(getOpenButton(view)).toHaveFocus();
     });
 
     it('onChange gets called with null when reset button is clicked', async () => {
       const view = await setup();
-      clickClearButton(view);
+      await clickClearButton(view);
       expect(props.onChange).toHaveBeenCalledWith(null);
     });
   });
 
-  const openDateLookup = (/** @type {import('@testing-library/react').RenderResult} */ view) =>
-    user.click(getOpenButton(view));
+  const openDateLookup = async (
+    /** @type {import('@testing-library/react').RenderResult} */ view,
+  ) => userEvent.click(getOpenButton(view));
 
-  const clickDateButton = (/** @type {import('@testing-library/react').RenderResult} */ view) =>
-    user.click(getDateButton(view));
+  const clickDateButton = async (
+    /** @type {import('@testing-library/react').RenderResult} */ view,
+  ) => userEvent.click(getDateButton(view));
 
   // Close dateLookup and removes events attached to documents.
-  const closeDateLookup = (/** @type {import('@testing-library/react').RenderResult} */ view) =>
-    user.click(view.container);
+  const closeDateLookup = async (
+    /** @type {import('@testing-library/react').RenderResult} */ view,
+  ) => userEvent.click(view.container);
 
-  const clickClearButton = (/** @type {import('@testing-library/react').RenderResult} */ view) =>
-    user.click(getClearButton(view));
+  const clickClearButton = async (
+    /** @type {import('@testing-library/react').RenderResult} */ view,
+  ) => userEvent.click(getClearButton(view));
 
   const getActiveYearButton = (
     /** @type {import('@testing-library/react').RenderResult} */ view,

package/src/dateLookup/DateLookup.tests.story.tsx

@@ -1,4 +1,4 @@
-import { Story } from '@storybook/react';
+import { StoryFn } from '@storybook/react';
 import { expect, userEvent, within } from '@storybook/test';
 import { useState } from 'react';
 
@@ -9,7 +9,9 @@ export default {
   title: 'Forms/DateLookup/Tests',
 };
 
-const Template: Story<typeof DateLookup> = () => {
+type Story = StoryFn<typeof DateLookup>;
+
+const Template: Story = () => {
   const [value, setValue] = useState<Date | null>(new Date(1987, 0, 10, 12, 0, 0));
 
   return (

package/src/decision/Decision.spec.js

@@ -1,5 +1,3 @@
-import '@testing-library/jest-dom';
-
 import Avatar from '../avatar';
 import { Breakpoint, Size } from '../common';
 import { mockMatchMedia } from '../mocks';

package/src/dimmer/Dimmer.rtl.spec.js

@@ -25,42 +25,42 @@ describe('Dimmer', () => {
   });
 
   describe('closing behaviour', () => {
-    it('calls onClose if the dimmer is clicked', () => {
+    it('calls onClose if the dimmer is clicked', async () => {
       const onClose = jest.fn();
       render(<Dimmer {...props} onClose={onClose} />);
-      userEvent.click(screen.getByRole('presentation'));
+      await userEvent.click(screen.getByRole('presentation'));
       expect(onClose).toHaveBeenCalledTimes(1);
     });
 
-    it('does not call onClose if the dimmer content is clicked', () => {
+    it('does not call onClose if the dimmer content is clicked', async () => {
       const onClose = jest.fn();
       render(
         <Dimmer {...props} onClose={onClose}>
           <Button onClick={() => {}}>McClicky</Button>
         </Dimmer>,
       );
-      userEvent.click(screen.getByRole('button'));
+      await userEvent.click(screen.getByRole('button'));
       expect(onClose).toHaveBeenCalledTimes(0);
     });
 
-    it('does not call onClose when clicked if disableClickToClose is true', () => {
+    it('does not call onClose when clicked if disableClickToClose is true', async () => {
       const onClose = jest.fn();
       render(<Dimmer {...props} disableClickToClose onClose={onClose} />);
-      userEvent.click(screen.getByRole('presentation'));
+      await userEvent.click(screen.getByRole('presentation'));
       expect(onClose).toHaveBeenCalledTimes(0);
     });
 
-    it('calls onClose if the escape key is pressed', () => {
+    it('calls onClose if the escape key is pressed', async () => {
       const onClose = jest.fn();
       render(<Dimmer {...props} onClose={onClose} />);
-      userEvent.keyboard('{esc}');
+      await userEvent.keyboard('{Escape}');
       expect(onClose).toHaveBeenCalledTimes(1);
     });
 
-    it('does not call onClose if the escape key is pressed when disableClickToClose is true', () => {
+    it('does not call onClose if the escape key is pressed when disableClickToClose is true', async () => {
       const onClose = jest.fn();
       render(<Dimmer {...props} disableClickToClose onClose={onClose} />);
-      userEvent.keyboard('{esc}');
+      await userEvent.keyboard('{Escape}');
       expect(onClose).toHaveBeenCalledTimes(1);
     });
   });

package/src/drawer/Drawer.rtl.spec.tsx

@@ -48,10 +48,10 @@ describe('Drawer', () => {
     expect(container).toMatchSnapshot();
   });
 
-  it('calls onClose when user clicks close button', () => {
+  it('calls onClose when user clicks close button', async () => {
     render(<Drawer {...props}>content</Drawer>);
     expect(props.onClose).not.toHaveBeenCalled();
-    userEvent.click(getCloseButton());
+    await userEvent.click(getCloseButton());
     expect(props.onClose).toHaveBeenCalledTimes(1);
   });
 

package/src/emphasis/Emphasis.spec.tsx

@@ -1,4 +1,3 @@
-import '@testing-library/jest-dom';
 import { render } from '../test-utils';
 
 import Emphasis from './Emphasis';

package/src/field/Field.spec.tsx

@@ -73,7 +73,7 @@ describe('Field', () => {
     button.addEventListener('click', handleClick);
 
     const label = screen.getByText('Phone number');
-    userEvent.click(label);
+    await userEvent.click(label);
 
     expect(handleClick).not.toHaveBeenCalled();
   });
@@ -90,6 +90,6 @@ describe('Field', () => {
     expect(screen.getByRole('textbox')).not.toHaveAttribute('id');
 
     const label = screen.getByText('Phone number');
-    userEvent.click(label);
+    await userEvent.click(label);
   });
 });

package/src/flowNavigation/FlowNavigation.spec.js

@@ -1,5 +1,3 @@
-import '@testing-library/jest-dom';
-
 import Avatar, { AvatarType } from '../avatar';
 import { Breakpoint, Size } from '../common';
 import { mockMatchMedia, render, screen } from '../test-utils';

package/src/flowNavigation/animatedLabel/AnimatedLabel.spec.js

@@ -1,4 +1,3 @@
-import '@testing-library/jest-dom';
 import { render, screen } from '../../test-utils';
 
 import AnimatedLabel from '.';

package/src/flowNavigation/backButton/BackButton.tsx

@@ -0,0 +1,29 @@
+import { ArrowLeft as ArrowLeftIcon } from '@transferwise/icons';
+import classNames from 'classnames';
+
+import Avatar, { AvatarType } from '../../avatar';
+
+export interface BackButtonProps {
+  'aria-label': string;
+  className?: string;
+  onClick?: React.MouseEventHandler<HTMLButtonElement>;
+}
+
+export default function BackButton({
+  className,
+  onClick,
+  'aria-label': ariaLabel,
+}: BackButtonProps) {
+  return (
+    <Avatar type={AvatarType.ICON} size={40}>
+      <button
+        type="button"
+        aria-label={ariaLabel}
+        className={classNames('np-back-button', 'btn-unstyled', className)}
+        onClick={onClick}
+      >
+        <ArrowLeftIcon size={24} />
+      </button>
+    </Avatar>
+  );
+}

package/src/flowNavigation/backButton/index.ts

@@ -0,0 +1,2 @@
+export { default } from './BackButton';
+export type { BackButtonProps } from './BackButton';