@transferwise/components 0.0.0-experimental-6f38fd8 → 0.0.0-experimental-37df6fe

package/src/item/Item.story.tsx

@@ -0,0 +1,188 @@
+import Item, { Props as ItemProps } from './Item';
+import { Meta, StoryObj } from '@storybook/react';
+import React, { useState } from 'react';
+import { Plus } from '@transferwise/icons';
+
+import { lorem10, lorem20, lorem40, lorem5 } from '../test-utils';
+import { Flag } from '@wise/art';
+
+export default {
+  component: Item,
+  title: 'Content/Item',
+} satisfies Meta<ItemProps>;
+
+type Story = StoryObj<ItemProps>;
+
+// TODO: delete this story later when we have more peace of the List Item puzzle
+export const TempPlayground: Story = {
+  render: () => {
+    const [checked, setChecked] = useState(false);
+
+    return (
+      <div>
+        <Item
+          media={
+            <Item.AvatarView badge={{ type: 'action' }}>
+              <Flag code="BBD" />
+            </Item.AvatarView>
+          }
+          title="Test title"
+          subtitle="Test subtitle"
+          additionalInfo={<Item.AdditionalInfo>{lorem10}</Item.AdditionalInfo>}
+        />
+        <Item
+          media={
+            <Item.AvatarLayout
+              avatars={[{ asset: <Flag code="BBD" /> }, { asset: <Flag code="MXN" /> }]}
+            />
+          }
+          title="Test title"
+          subtitle={lorem10}
+          additionalInfo={<Item.AdditionalInfo>{lorem20}</Item.AdditionalInfo>}
+        />
+        <Item
+          media={
+            <Item.AvatarLayout
+              size={72}
+              orientation="diagonal"
+              avatars={[{ asset: <Flag code="BBD" /> }, { asset: <Flag code="MXN" /> }]}
+            />
+          }
+          title="Test title"
+          subtitle={lorem10}
+          valueTitle="100 GBP"
+          valueSubtitle="100 USD"
+          additionalInfo={<Item.AdditionalInfo>{lorem20}</Item.AdditionalInfo>}
+        />
+        <Item
+          media={<Item.AvatarView profileType="BUSINESS" notification />}
+          title="Test title"
+          subtitle="Test subtitle"
+          additionalInfo={
+            <Item.AdditionalInfo
+              action={{ label: 'Learn more', href: 'https://wise.com', target: '_blank' }}
+            >
+              {lorem10}
+            </Item.AdditionalInfo>
+          }
+          prompt={<Item.Prompt type="negative">You have done something wrong</Item.Prompt>}
+        />
+        <Item
+          media={<Item.AvatarView imgSrc="../avatar-square-dude.webp" selected />}
+          title="Test title"
+          additionalInfo={<Item.AdditionalInfo>{lorem10}</Item.AdditionalInfo>}
+          prompt={
+            <Item.Prompt
+              type="discount"
+              action={{
+                href: 'https://wise.com',
+                target: '_blank',
+                'aria-label': 'clickable prompt',
+              }}
+            >
+              The whole prompt is secretly clickable
+            </Item.Prompt>
+          }
+        />
+
+        <Item
+          media={<Item.Image src="../apple-pay-logo.svg" />}
+          title="Accepting Apple Pay"
+          subtitle={lorem10}
+        />
+
+        <Item
+          media={<Item.Image src="../wise-card.svg" />}
+          title="Wise Business Card"
+          subtitle={lorem5}
+        />
+
+        <Item
+          title="Test title"
+          disabled
+          subtitle={lorem10}
+          additionalInfo={<Item.AdditionalInfo>{lorem20}</Item.AdditionalInfo>}
+          control={<Item.Button priority="secondary-neutral">as Button</Item.Button>}
+        />
+        <Item
+          title="Test title"
+          disabled
+          subtitle={lorem10}
+          additionalInfo={<Item.AdditionalInfo>{lorem20}</Item.AdditionalInfo>}
+          control={
+            <Item.IconButton>
+              <Plus />
+            </Item.IconButton>
+          }
+        />
+
+        <Item
+          title="Test title"
+          subtitle={lorem10}
+          additionalInfo={<Item.AdditionalInfo>{lorem20}</Item.AdditionalInfo>}
+          control={
+            <Item.Button
+              priority="secondary-neutral"
+              as="a"
+              target="dfdf"
+              aria-label="adsfasfd"
+              href="wise.com"
+            >
+              as Link
+            </Item.Button>
+          }
+        />
+
+        <Item
+          title="Test title"
+          subtitle={lorem10}
+          additionalInfo={<Item.AdditionalInfo>{lorem20}</Item.AdditionalInfo>}
+          control={<Item.Checkbox indeterminate />}
+        />
+
+        <Item
+          title="Test title"
+          subtitle={lorem10}
+          additionalInfo={<Item.AdditionalInfo>{lorem20}</Item.AdditionalInfo>}
+          control={
+            <Item.Switch
+              checked={checked}
+              onClick={() => {
+                setChecked(!checked);
+              }}
+            />
+          }
+        />
+      </div>
+    );
+  },
+};
+
+export const ItemRadio: Story = {
+  render: () => (
+    <div>
+      {/* Basic */}
+      {/* with additional info */}
+      {/* with prompt */}
+      {/* Disabled */}
+      {/* Spotlight */}
+      {/* Active */}
+    </div>
+  ),
+};
+
+export const ItemButton: Story = {
+  render: () => (
+    <div>
+      {/* Basic */}
+      {/* with additional info */}
+      {/* with prompt */}
+      {/* partially interactive */}
+      {/* Disabled */}
+      {/* Spotlight */}
+      {/* Active */}
+    </div>
+  ),
+};
+
+// add intaces with dark mode

package/src/item/Item.tsx

@@ -0,0 +1,174 @@
+import { createContext, ReactNode, useId, useMemo, useState } from 'react';
+import { Typography } from '../common';
+import Body from '../body';
+import { AdditionalInfo } from './ItemAdditionalInfo';
+import { IconButton } from './ItemIconButton';
+import { Checkbox } from './ItemCheckbox';
+import { Navigation } from './ItemNavigation';
+import { clsx } from 'clsx';
+import { Button } from './ItemButton';
+import { Switch } from './ItemSwitch';
+import { AvatarLayout, AvatarView, Image } from './ItemMedia';
+import Prompt from './prompt/Prompt';
+
+export type ItemTypes =
+  | 'non-interactive'
+  | 'navigation'
+  | 'radio'
+  | 'checkbox'
+  | 'switch'
+  | 'button'
+  | 'icon-button';
+
+export type Props = {
+  as?: 'li' | 'div' | 'span';
+  inverted?: boolean;
+  disabled?: boolean;
+  spotlight?: 'active' | 'inactive';
+  title: ReactNode;
+  subtitle?: ReactNode;
+  additionalInfo?: ReactNode;
+  valueTitle?: ReactNode;
+  valueSubtitle?: ReactNode;
+  media?: ReactNode;
+  control?: ReactNode;
+  prompt?: ReactNode;
+};
+
+export type ItemContextData = {
+  setControlType: (type: ItemTypes) => void;
+  ids: {
+    label: string;
+    additionalInfo: string;
+    value: string;
+    control: string;
+    prompt: string;
+  };
+  props: Pick<Props, 'as' | 'disabled' | 'inverted'>;
+};
+
+// @ts-expect-error for now let's mock it with `null` value
+// but actually by default we should specify `setControlType('none')`
+export const ItemContext = createContext<ItemContextData>(null);
+
+export const Item = ({
+  as: View = 'li',
+  title,
+  subtitle,
+  additionalInfo,
+  prompt,
+  inverted,
+  media,
+  spotlight = undefined,
+  valueTitle,
+  valueSubtitle,
+  control = null,
+  disabled,
+}: Props) => {
+  /*
+  const returnType = (): ReactNode => {
+    switch (type) {
+      case 'Navigation':
+        return <Chevron orientation={Position.RIGHT} disabled />;
+      case 'Radio':
+        return <RadioButton name="Hello" checked />;
+      case 'Checkbox':
+        return <CheckboxButton name="Hello" checked />;
+      case 'Switch':
+        return <Switch onClick={() => console.log('clicked')} />;
+      case 'Button':
+        return <Button v2>Hello</Button>;
+      case 'IconButton':
+        return (
+          <IconButton size={40} priority="minimal">
+            <InfoCircle />
+          </IconButton>
+        );
+    }
+  };
+  */
+  const idPrefix = useId();
+
+  const [controlType, setControlType] = useState<ItemTypes>('non-interactive');
+  const ids = {
+    label: `${idPrefix}_label`,
+    value: `${idPrefix}_value`,
+    control: `${idPrefix}_control`,
+    prompt: `${idPrefix}_prompt`,
+    additionalInfo: `${idPrefix}_additional-info`,
+  };
+
+  const itemCtx = useMemo(
+    () => ({ setControlType, ids, props: { as: View, disabled, inverted } }),
+    [],
+  );
+
+  return (
+    <ItemContext.Provider value={itemCtx}>
+      <View
+        className={clsx(
+          'np-item',
+          { 'np-item-interactive': controlType !== 'non-interactive' },
+          `np-item-${controlType}`,
+          'd-flex flex-row',
+          { 'align-items-center': !subtitle },
+          {
+            [`np-item-spotlight-${spotlight}`]: !!spotlight,
+          },
+        )}
+        aria-describedby={[ids.additionalInfo].join(' ')}
+      >
+        {media && <div className="np-item-media">{media}</div>}
+
+        {/* Title + Subtitle + Values + Additional Info - Group */}
+        <div>
+          {/* Title + Subtitle + Values - Group */}
+          <div className="d-flex justify-content-between">
+            <span>
+              {/* @ts-expect-error div can have role and aria-lavel props */}
+              <Body
+                type={Typography.BODY_LARGE_BOLD}
+                className="np-item-title"
+                // for a11y this needs to be a header but for SEO it shouldn't be `h*` tag
+                // so we enable header semantics via `role` and `aria-level` attrs
+                role="heading"
+                aria-level="4"
+              >
+                {title}
+              </Body>
+              <Body className="np-item-subtitle">{subtitle}</Body>
+            </span>
+            {(valueTitle || valueSubtitle) && (
+              <span id={ids.value} className="np-item-value">
+                <Body type={Typography.BODY_LARGE_BOLD} className="np-item-title-value">
+                  {valueTitle}
+                </Body>
+                <Body className="np-item-subtitle-value">{valueSubtitle}</Body>
+              </span>
+            )}
+          </div>
+
+          {/* Additional Info and Prompt here */}
+          {Boolean(subtitle) && additionalInfo}
+        </div>
+        {control === null ? null : <Body className="np-item-control">{control}</Body>}
+        {prompt}
+      </View>
+    </ItemContext.Provider>
+  );
+};
+
+/* eslint-disable functional/immutable-data */
+Item.Image = Image;
+Item.AvatarView = AvatarView;
+Item.AvatarLayout = AvatarLayout;
+Item.AdditionalInfo = AdditionalInfo;
+Item.Checkbox = Checkbox;
+Item.IconButton = IconButton;
+Item.Navigation = Navigation;
+Item.Button = Button;
+Item.Switch = Switch;
+Item.Prompt = Prompt;
+/* eslint-enable functional/immutable-data */
+
+export default Item;

package/src/item/ItemAdditionalInfo.tsx

@@ -0,0 +1,31 @@
+import { PropsWithChildren, useContext } from 'react';
+import { ItemContext, ItemContextData } from './Item';
+import Body from '../body';
+import Link, { LinkProps } from '../link';
+import { Typography } from '../common';
+
+export type ItemAdditionalInfoProps = PropsWithChildren<{
+  action?: Pick<LinkProps, 'href' | 'onClick' | 'target'> & { label?: string };
+}>;
+
+export const AdditionalInfo = function ({ children, action }: ItemAdditionalInfoProps) {
+  const { ids } = useContext<ItemContextData>(ItemContext);
+
+  return (
+    <Body
+      type={Typography.BODY_DEFAULT}
+      id={ids.additionalInfo}
+      className="np-item-additional-info"
+    >
+      {children}
+      {action ? (
+        <>
+          {' '}
+          <Link href={action.href} target={action.target} onClick={action.onClick}>
+            {action.label}
+          </Link>
+        </>
+      ) : null}
+    </Body>
+  );
+};

package/src/item/ItemButton.spec.tsx

@@ -0,0 +1,90 @@
+import { render, screen, mockMatchMedia } from '../test-utils';
+import { Button as ItemButton } from './ItemButton';
+import { ButtonPriority } from '../button/Button.types';
+import { ItemContext } from './Item';
+
+mockMatchMedia();
+
+describe('ItemButton', () => {
+  const mockSetControlType = jest.fn();
+
+  const renderWithItemContext = (ui: React.ReactNode) => {
+    return render(
+      <ItemContext.Provider
+        value={{
+          setControlType: mockSetControlType,
+          ids: {
+            label: 'label',
+            additionalInfo: 'additional Info',
+            value: 'value',
+            control: 'control',
+            prompt: 'prompt',
+          },
+          props: {},
+        }}
+      >
+        {ui}
+      </ItemContext.Provider>,
+    );
+  };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('always sets v2 to true', () => {
+    renderWithItemContext(<ItemButton priority="primary">Test Button</ItemButton>);
+    const button = screen.getByRole('button');
+    expect(button).toBeInTheDocument();
+    expect(mockSetControlType).toHaveBeenCalledWith('button');
+  });
+
+  it('always sets size to "md"', () => {
+    renderWithItemContext(<ItemButton priority="primary">Test Button</ItemButton>);
+    const button = screen.getByRole('button');
+    expect(button).toHaveClass('wds-Button--medium');
+  });
+
+  it('supports all priorities', () => {
+    const priorities: ButtonPriority[] = ['primary', 'secondary', 'tertiary'];
+    priorities.forEach((priority) => {
+      renderWithItemContext(<ItemButton priority={priority}>Test {priority}</ItemButton>);
+      const button = screen.getByRole('button', { name: `Test ${priority}` });
+      expect(button).toBeInTheDocument();
+    });
+  });
+
+  it('renders as a button by default', () => {
+    renderWithItemContext(<ItemButton>Click me</ItemButton>);
+    const button = screen.getByRole('button');
+    expect(button).toBeInTheDocument();
+    expect(button.tagName).toBe('BUTTON');
+  });
+
+  it('renders as an anchor when href is provided', () => {
+    renderWithItemContext(<ItemButton href="https://example.com">Go to Example</ItemButton>);
+    const link = screen.getByRole('link', { name: 'Go to Example' });
+    expect(link).toBeInTheDocument();
+    expect(link.tagName).toBe('A');
+    expect(link).toHaveAttribute('href', 'https://example.com');
+  });
+
+  it('spreads additional props to the button', () => {
+    renderWithItemContext(<ItemButton aria-label="Custom Button">Custom</ItemButton>);
+    const button = screen.getByRole('button', { name: 'Custom Button' });
+    expect(button).toBeInTheDocument();
+    expect(button).toHaveAttribute('aria-label', 'Custom Button');
+  });
+
+  it('spreads additional props to the anchor', () => {
+    renderWithItemContext(
+      <ItemButton href="https://example.com" target="_blank" aria-label="Custom Link">
+        Custom Link
+      </ItemButton>,
+    );
+    const link = screen.getByRole('link', { name: 'Custom Link' });
+    expect(link).toBeInTheDocument();
+    expect(link).toHaveAttribute('href', 'https://example.com');
+    expect(link).toHaveAttribute('target', '_blank');
+  });
+});

package/src/item/ItemButton.tsx

@@ -0,0 +1,18 @@
+import { default as ButtonComp, NewButtonProps } from '../button';
+import { useItemControl } from './useItemControl';
+
+export type ItemButtonProps = Omit<NewButtonProps, 'v2' | 'size' | 'disabled'>;
+
+export const Button = ({ priority = 'secondary', ...props }: ItemButtonProps) => {
+  const { baseItemProps } = useItemControl('button');
+
+  const commonProps = {
+    ...props,
+    priority,
+    v2: true,
+    size: 'md',
+    disabled: baseItemProps.disabled,
+  };
+
+  return <ButtonComp {...(commonProps as NewButtonProps)} />;
+};

package/src/item/ItemCheckbox.tsx

@@ -0,0 +1,11 @@
+import CheckboxButton from '../checkboxButton';
+import { CheckboxButtonProps } from '../checkboxButton/CheckboxButton';
+import { useItemControl } from './useItemControl';
+
+export type ItemCheckboxProps = Pick<CheckboxButtonProps, 'checked' | 'indeterminate' | 'onChange'>;
+
+export const Checkbox = function (props: ItemCheckboxProps) {
+  const { baseItemProps } = useItemControl('checkbox');
+
+  return <CheckboxButton disabled={baseItemProps.disabled} {...props} />;
+};

package/src/item/ItemIconButton.tsx

@@ -0,0 +1,13 @@
+import { default as IconButtonComp, IconButtonProps } from '../iconButton';
+import { useItemControl } from './useItemControl';
+import { ReactNode } from 'react';
+
+export type ItemIconButtonProps = Pick<IconButtonProps, 'onClick' | 'href' | 'target'> & {
+  children: ReactNode;
+};
+
+export const IconButton = function (props: ItemIconButtonProps) {
+  const { baseItemProps } = useItemControl('icon-button');
+
+  return <IconButtonComp {...props} size={32} disabled={baseItemProps.disabled} />;
+};

package/src/item/ItemMedia.tsx

@@ -0,0 +1,52 @@
+import { default as AvatarViewComp, AvatarViewProps } from '../avatarView';
+import { default as AvatarLayoutComp, AvatarLayoutProps } from '../avatarLayout';
+import { default as ImageComp, ImageProps } from '../image/Image';
+import { clsx } from 'clsx';
+
+type SizeProp = { size?: 32 | 40 | 48 | 56 | 72 };
+
+export type ItemAvatarViewProps = Omit<AvatarViewProps, 'size' | 'interactive'> & SizeProp;
+
+export const AvatarView = ({ className, size = 48, ...props }: ItemAvatarViewProps) => {
+  return (
+    <AvatarViewComp
+      {...props}
+      size={size}
+      className={clsx('np-item-media-avatar-view', className)}
+    />
+  );
+};
+
+export type ItemAvatarLayoutProps = Omit<AvatarLayoutProps, 'size' | 'interactive'> & SizeProp;
+
+export const AvatarLayout = ({ className, size = 48, ...props }: ItemAvatarLayoutProps) => {
+  return (
+    <AvatarLayoutComp
+      {...props}
+      size={size}
+      className={clsx('np-item-media-avatar-layout', className)}
+    />
+  );
+};
+
+export type ItemImageProps = Omit<ImageProps, 'stretch' | 'shrink' | 'id' | 'alt'> &
+  SizeProp & {
+    alt?: string;
+  };
+
+/**
+ * TODO: mention that image is for rare cases not for DS illustrations, they discouraged
+ */
+export const Image = ({ alt = '', size = 48, ...props }: ItemImageProps) => {
+  return (
+    <div
+      className={clsx('np-item-media-image')}
+      style={{
+        // @ts-expect-error CSS custom props allowed
+        '--item-media-image-size': `${size}px`,
+      }}
+    >
+      <ImageComp {...props} alt={alt} />
+    </div>
+  );
+};

package/src/item/ItemNavigation.tsx

@@ -0,0 +1,11 @@
+import { ChevronRight, BillSplit as Disabled } from '@transferwise/icons';
+import { ButtonProps } from '../button/Button.types';
+import { useItemControl } from './useItemControl';
+
+export type ItemNavigationProps = Pick<ButtonProps, 'onClick' | 'href'>;
+
+export const Navigation = function Navigation({ onClick }: ItemNavigationProps) {
+  const { baseItemProps } = useItemControl('navigation');
+
+  return baseItemProps.disabled ? <Disabled size={24} /> : <ChevronRight size={24} />;
+};

package/src/item/ItemSwitch.tsx

@@ -0,0 +1,8 @@
+import { default as SwitchComp, SwitchProps } from '../switch';
+import { useItemControl } from './useItemControl';
+
+export const Switch = function (props: SwitchProps) {
+  const { baseItemProps } = useItemControl('switch');
+
+  return <SwitchComp disabled={baseItemProps.disabled} {...props} />;
+};

package/src/item/index.ts

@@ -0,0 +1,6 @@
+export type { Props as ItemProps } from './Item';
+export type { ItemAdditionalInfoProps } from './ItemAdditionalInfo';
+export type { ItemCheckboxProps } from './ItemCheckbox';
+export type { ItemImageProps, ItemAvatarViewProps, ItemAvatarLayoutProps } from './ItemMedia';
+
+export { default } from './Item';

package/src/item/prompt/Prompt.spec.tsx

@@ -0,0 +1,77 @@
+import { render, screen, mockMatchMedia } from '../../test-utils';
+import { ItemPrompt } from './Prompt';
+import { Sentiment } from '../../common';
+
+mockMatchMedia();
+
+describe('ItemPrompt', () => {
+  it('renders the aria-label when provided', () => {
+    const ariaLabel = 'Test aria-label';
+    render(
+      <ItemPrompt
+        type={Sentiment.POSITIVE}
+        action={{ 'aria-label': ariaLabel, href: 'https://example.com' }}
+      >
+        Positive prompt
+      </ItemPrompt>,
+    );
+
+    expect(screen.getByLabelText(ariaLabel)).toBeInTheDocument();
+  });
+
+  it('applies the interactive class when href is provided', () => {
+    render(
+      <ItemPrompt
+        type={Sentiment.POSITIVE}
+        action={{ href: 'https://example.com', 'aria-label': 'Interactive link' }}
+      >
+        Interactive link
+      </ItemPrompt>,
+    );
+
+    expect(screen.getByRole('link')).toHaveClass('np-prompt-interactive');
+  });
+
+  it('applies the interactive class when onClick is provided', () => {
+    render(
+      <ItemPrompt
+        type={Sentiment.POSITIVE}
+        action={{ onClick: jest.fn(), 'aria-label': 'Interactive button' }}
+      >
+        Interactive button
+      </ItemPrompt>,
+    );
+
+    expect(screen.getByRole('button')).toHaveClass('np-prompt-interactive');
+  });
+
+  it('does not apply the interactive class when no action is provided', () => {
+    render(<ItemPrompt type={Sentiment.POSITIVE}>Non-interactive prompt</ItemPrompt>);
+
+    expect(screen.getByText('Non-interactive prompt')).not.toHaveClass('np-prompt-interactive');
+  });
+
+  it('renders the children content', () => {
+    render(<ItemPrompt type={Sentiment.POSITIVE}>This is a child prompt</ItemPrompt>);
+
+    expect(screen.getByText('This is a child prompt')).toBeInTheDocument();
+  });
+
+  it('spreads additional props to the wrapper element', () => {
+    render(
+      <ItemPrompt
+        type={Sentiment.POSITIVE}
+        action={{
+          href: 'https://example.com',
+          target: '_blank',
+          'aria-label': 'Custom props prompt',
+        }}
+      >
+        Custom props prompt
+      </ItemPrompt>,
+    );
+
+    const link = screen.getByRole('link');
+    expect(link).toHaveAttribute('target', '_blank');
+  });
+});