@transferwise/components 0.0.0-experimental-bc13343 → 0.0.0-experimental-739bfcf

package/src/button/Button.tsx

@@ -1,154 +1,110 @@
-import { clsx } from 'clsx';
-import { ElementType, forwardRef, MouseEvent } from 'react';
-import { useIntl } from 'react-intl';
-
-import {
-  Size,
-  ControlType,
-  Priority,
-  ControlTypeAccent,
-  ControlTypeNegative,
-  ControlTypePositive,
-  PriorityPrimary,
-  PrioritySecondary,
-  PriorityTertiary,
-  SizeExtraSmall,
-  SizeSmall,
-  SizeMedium,
-  SizeLarge,
-} from '../common';
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+import { forwardRef } from 'react';
+import { ButtonProps as NewButtonProps } from './Button.types';
+import { PrimitiveAnchor, PrimitiveButton } from '../primitives';
+import AvatarLayout from '../avatarLayout';
 import ProcessIndicator from '../processIndicator';
+import { clsx } from 'clsx';
+import { Typography } from '../common';
+import Body from '../body';
 
-import messages from '../i18n/commonMessages/Button.messages';
-import { typeClassMap, priorityClassMap } from './classMap';
-import { establishNewPriority, establishNewType, logDeprecationNotices } from './legacyUtils';
-
-/** @deprecated */
-type DeprecatedTypes = 'primary' | 'pay' | 'secondary' | 'danger' | 'link';
-
-/** @deprecated */
-type DeprecatedSizes = SizeExtraSmall;
-
-type CommonProps = {
-  block?: boolean;
-  disabled?: boolean;
-  loading?: boolean;
-  type?: ControlTypeAccent | ControlTypeNegative | ControlTypePositive | DeprecatedTypes | null;
-  priority?: PriorityPrimary | PrioritySecondary | PriorityTertiary | null;
-  size?: SizeSmall | SizeMedium | SizeLarge | DeprecatedSizes;
-};
-
-type ButtonProps = CommonProps &
-  Omit<React.ComponentPropsWithRef<'button'>, 'type'> & {
-    as?: 'button';
-    htmlType?: 'submit' | 'reset' | 'button';
-  };
-
-type AnchorProps = CommonProps &
-  Omit<React.ComponentPropsWithRef<'a'>, 'type'> & {
-    as?: 'a';
-  };
-
-export type Props = ButtonProps | AnchorProps;
-
-export type ButtonReferenceType = HTMLButtonElement | HTMLAnchorElement;
-
-const Button = forwardRef<ButtonReferenceType, Props>(
+const Button = forwardRef<HTMLButtonElement | HTMLAnchorElement, NewButtonProps>(
   (
     {
-      as: component,
-      block = false,
+      as = 'button',
       children,
       className,
-      disabled,
+      size = 'lg',
+      href,
+      disabled = false,
+      priority = 'primary',
+      sentiment = 'default',
+      iconStart: IconStart,
+      iconEnd: IconEnd,
+      avatars,
+      type = 'button',
       loading = false,
-      priority = Priority.PRIMARY,
-      size = Size.MEDIUM,
-      type = ControlType.ACCENT,
-      onClick,
-      ...rest
-    }: Props,
-    reference,
+      block = false,
+      ...props
+    },
+    ref,
   ) => {
-    const intl = useIntl();
-
-    logDeprecationNotices({ size, type });
-
-    const newType = establishNewType(type);
-    const newPriority = establishNewPriority(priority, type);
-
-    const classes = clsx(
-      `btn btn-${size}`,
-      `np-btn np-btn-${size}`,
+    const classNames = clsx(
+      'wds-Button',
       {
-        'btn-loading': loading,
-        'btn-block np-btn-block': block,
-        disabled,
+        [`wds-Button--block`]: block,
+        [`wds-Button--disabled`]: disabled,
+        [`wds-Button--loading`]: loading,
       },
-      // @ts-expect-error fix when refactor `typeClassMap` to TypeScript
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-      typeClassMap[newType],
-      // @ts-expect-error fix when refactor `typeClassMap` to TypeScript
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-      priorityClassMap[newPriority],
+      `wds-Button--${{ sm: 'small', md: 'medium', lg: 'large' }[size]}`,
+      `wds-Button--${priority}`,
+      `wds-Button--${sentiment}`,
       className,
     );
 
-    function processIndicatorSize() {
-      return ['sm', 'xs'].includes(size) ? 'xxs' : 'xs';
-    }
-
-    const Element = (component as ElementType) ?? 'button';
-    let props;
-
-    if (Element === 'button') {
-      const { htmlType = 'button', ...restProps } = rest as ButtonProps;
-      props = {
-        ...restProps,
-        disabled,
-        'aria-disabled': loading,
-        type: htmlType,
-      };
-    } else {
-      props = {
-        ...rest,
-        'aria-disabled': loading,
-      } as AnchorProps;
-    }
-
-    /**
-     * Ensures that the button cannot be activated in loading or disabled mode,
-     * when `aria-disabled` might be used over the `disabled` HTML attribute
-     */
-    const handleClick =
-      (handler: Props['onClick']) =>
-      (event: MouseEvent<HTMLButtonElement> & MouseEvent<HTMLAnchorElement>) => {
-        if (disabled || loading) {
-          event.preventDefault();
-        } else if (typeof handler === 'function') {
-          handler(event);
-        }
-      };
+    const contentClassNames = clsx('wds-Button-content', {
+      [`wds-Button-content--loading`]: loading,
+    });
 
-    return (
-      <Element
-        ref={reference}
-        className={classes}
-        onClick={handleClick(onClick)}
-        {...props}
-        aria-live={loading ? 'polite' : 'off'}
-        aria-busy={loading}
-        aria-label={loading ? intl.formatMessage(messages.loadingAriaLabel) : rest['aria-label']}
+    const content = (
+      <Body
+        as="span"
+        type={size === 'sm' ? Typography.BODY_DEFAULT_BOLD : Typography.BODY_LARGE_BOLD}
+        className={contentClassNames}
       >
-        {children}
         {loading && (
           <ProcessIndicator
-            size={processIndicatorSize()}
-            className="btn-loader"
-            data-testid="ButtonProgressIndicator"
+            size="xs"
+            className="wds-Button-loader"
+            data-testid="button-loader-indicator"
           />
         )}
-      </Element>
+        <span className="wds-Button-label" aria-hidden={loading}>
+          {size === 'lg' ? (
+            children
+          ) : (
+            <>
+              {size === 'md' && avatars && (
+                <span className="wds-Button-avatars">
+                  <AvatarLayout orientation="horizontal" avatars={avatars} size={24} />
+                </span>
+              )}
+              {!avatars && IconStart && (
+                <IconStart className="wds-Button-icon wds-Button-icon--start" />
+              )}
+              {children}
+              {IconEnd && <IconEnd className="wds-Button-icon wds-Button-icon--end" />}
+            </>
+          )}
+        </span>
+      </Body>
+    );
+
+    if (as === 'a') {
+      return (
+        <PrimitiveAnchor
+          ref={ref as React.Ref<HTMLAnchorElement>}
+          {...(props as any)}
+          href={href}
+          className={classNames}
+          disabled={disabled}
+        >
+          {content}
+        </PrimitiveAnchor>
+      );
+    }
+
+    return (
+      <PrimitiveButton
+        ref={ref as React.Ref<HTMLButtonElement>}
+        {...(props as any)}
+        className={classNames}
+        disabled={disabled}
+        loading={loading}
+        type={type}
+      >
+        {content}
+      </PrimitiveButton>
     );
   },
 );

package/src/button/Button.types.ts

@@ -0,0 +1,86 @@
+import { ReactNode } from 'react';
+import type {
+  PrimitiveButtonProps,
+  PrimitiveAnchorProps,
+  PrimitiveButtonElementRef,
+  PrimitiveAnchorElementRef,
+} from '../primitives';
+import type { SingleAvatarType } from '../avatarLayout';
+
+export type ButtonSentiment = 'default' | 'negative';
+export type ButtonPriority = 'primary' | 'secondary' | 'tertiary' | 'minimal';
+export type ButtonType = 'button' | 'submit' | 'reset';
+export type ButtonSize = 'sm' | 'md' | 'lg';
+export type ButtonRefType = PrimitiveButtonElementRef | PrimitiveAnchorElementRef;
+
+/**
+ * Common properties for the Button component.
+ */
+export interface CommonButtonProps {
+  /**
+   * If set, toggles the new Button API
+   * @default false
+   * */
+  v2?: boolean;
+
+  /**
+   * The HTML element to render
+   * @default 'button'
+   **/
+  as?: 'button' | 'a' | null;
+
+  /** Additional class name(s) to apply to the button */
+  className?: string;
+
+  /**
+   * @default false
+   **/
+  disabled?: boolean;
+
+  href?: string;
+
+  /**
+   * @default false
+   * */
+  loading?: boolean;
+
+  /** Whether the button should take up the full width of its container */
+  block?: boolean;
+
+  /**
+   * Size of the button
+   * @default lg
+   * */
+  size?: ButtonSize;
+
+  /**
+   * Priority of the button
+   * @default "primary"
+   */
+  priority?: ButtonPriority;
+
+  /**
+   * Sentiment of the button
+   * @default default
+   */
+  sentiment?: ButtonSentiment;
+
+  /** Icon to be displayed on the left side of the button */
+  iconStart?: React.ElementType;
+
+  /** Icon to be displayed on the right side of the button */
+  iconEnd?: React.ElementType;
+
+  /** Media to be displayed on the left side of the button */
+  avatars?: SingleAvatarType[];
+
+  /** Optional property to provide component Ref */
+  ref?: ButtonRefType;
+
+  /** Content to be displayed inside the button */
+  children?: ReactNode;
+}
+
+export type ButtonElementProps = PrimitiveButtonProps & CommonButtonProps;
+export type AnchorElementProps = PrimitiveAnchorProps & CommonButtonProps;
+export type ButtonProps = ButtonElementProps | AnchorElementProps;

package/src/button/Button.vars.css

@@ -0,0 +1,38 @@
+.wds-Button {
+  --Button-background: var(--color-interactive-accent);
+  --Button-background-hover: var(--color-interactive-accent-hover);
+  --Button-background-active: var(--color-interactive-accent-active);
+  --Button-color: var(--color-interactive-control);
+  --Button-padding: var(--size-8) var(--size-12);
+  --Button-border-radius: var(--radius-full);
+  --Button-size-small-padding: 5px var(--size-12);
+  --Button-size-medium-padding: var(--size-8) var(--size-12);
+  --Button-size-large-padding: var(--size-12) var(--size-16);
+  --Button-transition-duration: 150ms;
+  --Button-transition-easing: ease-in-out;
+  --Button-secondary-background: var(--color-interactive-neutral);
+  --Button-secondary-background-hover: var(--color-interactive-neutral-hover);
+  --Button-secondary-background-active: var(--color-interactive-neutral-active);
+  --Button-secondary-color: var(--color-interactive-primary);
+  --Button-tertiary-background: var(--color-background-neutral);
+  --Button-tertiary-background-hover: var(--color-background-neutral-hover);
+  --Button-tertiary-background-active: var(--color-background-neutral-active);
+  --Button-tertiary-color: var(--color-content-primary);
+  --Button-minimal-background: transparent;
+  --Button-minimal-background-hover: var(--color-background-screen-hover);
+  --Button-minimal-background-active: var(--color-background-screen-active);
+  --Button-minimal-color: var(--color-interactive-primary);
+  --Button-primary-negative-background: var(--color-sentiment-negative-primary);
+  --Button-primary-negative-background-hover: var(--color-sentiment-negative-primary-hover);
+  --Button-primary-negative-background-active: var(--color-sentiment-negative-primary-active);
+  --Button-primary-negative-color: var(--color-contrast);
+  --Button-secondary-negative-background: var(--color-sentiment-negative-secondary);
+  --Button-secondary-negative-background-hover: var(--color-sentiment-negative-secondary-hover);
+  --Button-secondary-negative-background-active: var(--color-sentiment-negative-secondary-active);
+  --Button-secondary-negative-color: var(--color-sentiment-negative-primary);
+}
+.np-theme-personal--bright-green .wds-Button {
+  --color-contrast: #FFFFFF;
+  --Button-secondary-color: var(--color-interactive-control);
+  --Button-secondary-negative-color: var(--color-contrast);
+}

package/src/button/Button.vars.less

@@ -0,0 +1,46 @@
+.wds-Button {
+  --Button-background: var(--color-interactive-accent);
+  --Button-background-hover: var(--color-interactive-accent-hover);
+  --Button-background-active: var(--color-interactive-accent-active);
+  --Button-color: var(--color-interactive-control);
+  --Button-padding: var(--size-8) var(--size-12);
+  --Button-border-radius: var(--radius-full);
+  --Button-size-small-padding: 5px var(--size-12);
+  --Button-size-medium-padding: var(--size-8) var(--size-12);
+  --Button-size-large-padding: var(--size-12) var(--size-16);
+  --Button-transition-duration: 150ms;
+  --Button-transition-easing: ease-in-out;
+
+  --Button-secondary-background: var(--color-interactive-neutral);
+  --Button-secondary-background-hover: var(--color-interactive-neutral-hover);
+  --Button-secondary-background-active: var(--color-interactive-neutral-active);
+  --Button-secondary-color: var(--color-interactive-primary);
+
+  --Button-tertiary-background: var(--color-background-neutral);
+  --Button-tertiary-background-hover: var(--color-background-neutral-hover);
+  --Button-tertiary-background-active: var(--color-background-neutral-active);
+  --Button-tertiary-color: var(--color-content-primary);
+
+  --Button-minimal-background: transparent;
+  --Button-minimal-background-hover: var(--color-background-screen-hover);
+  --Button-minimal-background-active: var(--color-background-screen-active);
+  --Button-minimal-color: var(--color-interactive-primary);
+
+  --Button-primary-negative-background: var(--color-sentiment-negative-primary);
+  --Button-primary-negative-background-hover: var(--color-sentiment-negative-primary-hover);
+  --Button-primary-negative-background-active: var(--color-sentiment-negative-primary-active);
+  --Button-primary-negative-color: var(--color-contrast);
+
+  --Button-secondary-negative-background: var(--color-sentiment-negative-secondary);
+  --Button-secondary-negative-background-hover: var(--color-sentiment-negative-secondary-hover);
+  --Button-secondary-negative-background-active: var(--color-sentiment-negative-secondary-active);
+  --Button-secondary-negative-color: var(--color-sentiment-negative-primary);
+}
+
+.np-theme-personal--bright-green {
+  .wds-Button {
+    --color-contrast: #FFFFFF;
+    --Button-secondary-color: var(--color-interactive-control);
+    --Button-secondary-negative-color: var(--color-contrast);
+  }
+}

package/src/button/LegacyButton.css

@@ -0,0 +1,23 @@
+.np-btn {
+  position: relative;
+}
+.np-btn.np-btn-block > span.btn-loader {
+  position: absolute;
+  left: 24px;
+  left: var(--size-24);
+}
+[dir="rtl"] .np-btn.np-btn-block > span.btn-loader {
+  right: 24px;
+  right: var(--size-24);
+  left: auto;
+  left: initial;
+}
+.np-btn.np-btn-xs > span.btn-loader {
+  background-size: 16px 16px;
+}
+.np-btn.np-btn-xs.btn-block > span.btn-loader {
+  top: 0;
+}
+.np-btn.disabled[class] {
+  pointer-events: auto;
+}

package/src/button/LegacyButton.less

@@ -0,0 +1,24 @@
+@import (reference) "../../node_modules/@transferwise/neptune-css/src/less/mixins/_logical-properties.less";
+
+.np-btn {
+  position: relative;
+
+  &.np-btn-block > span.btn-loader {
+    position: absolute;
+    .left(var(--size-24));
+  }
+
+  &.np-btn-xs > span.btn-loader {
+    background-size: 16px 16px;
+  }
+
+  &.np-btn-xs.btn-block > span.btn-loader {
+    top: 0;
+  }
+
+  // we do not want pointer events disabled as that
+  // prevents the custom cursor to be shown
+  &.disabled[class] {
+    pointer-events: auto;
+  }
+}

package/src/button/LegacyButton.spec.tsx

@@ -0,0 +1,146 @@
+import { createRef } from 'react';
+
+import { render, screen, userEvent } from '../test-utils';
+
+import LegacyButton, { ButtonReferenceType } from './LegacyButton';
+import messages from '../i18n/commonMessages/Button.messages';
+
+describe('LegacyButton', () => {
+  // eslint-disable-next-line no-console
+  const originalWarn = console.warn;
+  let mockedWarn: typeof originalWarn;
+
+  const props = {
+    onClick: jest.fn(),
+    onFocus: jest.fn(),
+    onBlur: jest.fn(),
+    children: 'Send money',
+  };
+
+  beforeAll(() => {
+    mockedWarn = jest.fn().mockImplementation((args) => {
+      if (typeof args !== 'string' || !args.startsWith('Button has deprecated the')) {
+        originalWarn(args);
+      }
+    });
+    // eslint-disable-next-line no-console
+    console.warn = mockedWarn;
+  });
+
+  beforeEach(jest.clearAllMocks);
+
+  afterAll(() => {
+    // eslint-disable-next-line no-console
+    console.warn = originalWarn;
+  });
+
+  describe('by default', () => {
+    it('renders the text', () => {
+      render(<LegacyButton {...props} />);
+      expect(screen.getByText(props.children)).toBeInTheDocument();
+    });
+
+    it('set `ref` to be true on Button', () => {
+      const reference = createRef<ButtonReferenceType>();
+
+      expect(reference.current).toBeFalsy();
+      render(<LegacyButton ref={reference}>Click me!</LegacyButton>);
+      expect(reference.current).toBeTruthy();
+    });
+
+    it('is not disabled', () => {
+      render(<LegacyButton {...props} />);
+      expect(screen.getByRole('button')).toBeEnabled();
+    });
+  });
+
+  describe('button attributes', () => {
+    it('sets the htmlType if set', () => {
+      render(<LegacyButton {...props} htmlType="submit" />);
+      expect(screen.getByRole('button')).toHaveAttribute('type', 'submit');
+    });
+
+    it('passes through custom classes if set', () => {
+      render(<LegacyButton {...props} className="donkeysarethebest" />);
+      expect(screen.getByRole('button')).toHaveClass('donkeysarethebest');
+    });
+
+    it('passes through aria-label if set', () => {
+      render(<LegacyButton {...props} aria-label="unique label" />);
+      const loadingButton = screen.getByLabelText('unique label');
+      expect(loadingButton).toBeInTheDocument();
+    });
+  });
+
+  describe('onClick', () => {
+    it('calls onClick when clicked', async () => {
+      render(<LegacyButton {...props} />);
+      await userEvent.click(screen.getByRole('button'));
+      expect(props.onClick).toHaveBeenCalledTimes(1);
+    });
+
+    it('does not call onClick when clicked if disabled', async () => {
+      render(<LegacyButton {...props} disabled />);
+      await userEvent.click(screen.getByRole('button'));
+      expect(props.onClick).toHaveBeenCalledTimes(0);
+    });
+
+    it('does not call onClick when clicked if loading', async () => {
+      render(<LegacyButton {...props} loading />);
+      await userEvent.click(screen.getByRole('button'));
+      expect(props.onClick).toHaveBeenCalledTimes(0);
+    });
+  });
+
+  describe('onFocus and onBlur', () => {
+    it('calls both handlers by default', async () => {
+      render(<LegacyButton {...props} />);
+      await userEvent.tab();
+      expect(props.onFocus).toHaveBeenCalledTimes(1);
+      await userEvent.tab();
+      expect(props.onFocus).toHaveBeenCalledTimes(1);
+    });
+
+    it('does not call either handler if disabled', async () => {
+      render(<LegacyButton {...props} disabled />);
+      await userEvent.tab();
+      expect(props.onFocus).not.toHaveBeenCalled();
+      await userEvent.tab();
+      expect(props.onFocus).not.toHaveBeenCalled();
+    });
+
+    it('calls both handlers if loading', async () => {
+      render(<LegacyButton {...props} loading />);
+      await userEvent.tab();
+      expect(props.onFocus).toHaveBeenCalledTimes(1);
+      await userEvent.tab();
+      expect(props.onFocus).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  describe('other states', () => {
+    it('renders as loading if `loading` is true', () => {
+      render(<LegacyButton {...props} loading />);
+      const button = screen.queryByRole('button', {
+        name: messages.loadingAriaLabel.defaultMessage,
+      });
+      expect(button).toBeInTheDocument();
+      expect(button).toBeEnabled();
+      expect(button).toHaveClass('btn-loading');
+      expect(button).toHaveAttribute('aria-disabled', 'true');
+      expect(button).toHaveAttribute('aria-busy', 'true');
+      expect(button).toHaveAttribute('aria-live', 'polite');
+      expect(screen.getByTestId('ButtonProgressIndicator')).toBeInTheDocument();
+    });
+
+    it('disables the button', () => {
+      render(<LegacyButton {...props} disabled />);
+      const button = screen.queryByRole('button');
+      expect(button).toBeDisabled();
+      expect(button).toHaveClass('disabled');
+      expect(button).toHaveAttribute('aria-disabled', 'false');
+      expect(button).toHaveAttribute('aria-busy', 'false');
+      expect(button).toHaveAttribute('aria-live', 'off');
+    });
+  });
+});