@transferwise/components 0.0.0-experimental-3c1222c → 0.0.0-experimental-e0993c8

package/src/header/Header.story.tsx

@@ -1,53 +1,207 @@
-import Header from './Header';
+import { Meta, StoryObj } from '@storybook/react-webpack5';
+import Header, { HeaderProps } from './Header';
+import { storyConfig } from '../test-utils';
 
-export default {
-  component: Header,
-  title: 'Typography/Header',
-};
+const withContainer = (Story: any) => (
+  <div style={{ display: 'flex', justifyContent: 'center' }}>
+    <Story />
+  </div>
+);
+
+/**
+ * Not all stories need access to all controls as it causes unnecessary UI noise.
+ */
+const hideControls = (args: string[]) =>
+  Object.fromEntries(args.map((item) => [item, { table: { disable: true } }]));
 
-export const Basic = () => {
-  return <Header title="Header title" />;
+/**
+ * Reusable render logic for wrapping `Header` in a `<fieldset>` if `as` is `legend`.
+ */
+const renderHeader = (args: HeaderProps) => {
+  if (args.as === 'legend') {
+    return (
+      <fieldset style={{ width: '100%' }}>
+        <Header {...args} />
+      </fieldset>
+    );
+  }
+  return <Header {...args} />;
 };
 
-export const WithAction = () => {
-  return (
+/**
+ * Helper to generate variants for `AllVariants` story.
+ */
+const renderVariants = () => (
+  <div
+    className="header-variants"
+    style={{ display: 'flex', flexWrap: 'wrap', gap: '16px', maxWidth: '1200px' }}
+  >
+    {(['h1', 'h2', 'h3', 'legend'] as const).map((as) => (
+      <Header key={as} as={as} title={`Header as ${as}`} />
+    ))}
+    {(['section', 'group'] as const).map((level) => (
+      <Header key={level} level={level} title={`Header level ${level}`} />
+    ))}
     <Header
-      title="Header title"
+      as="h2"
+      title="Header with Action"
       action={{
-        'aria-label': 'Magic',
-        text: 'Click me!',
-        onClick: () => alert('Action!'),
+        'aria-label': 'Action',
+        text: 'Action',
+        onClick: () => alert('Action clicked!'),
       }}
     />
-  );
-};
-
-export const WithActionAsLink = () => {
-  return (
     <Header
-      title="Header title"
+      as="h2"
+      title="Header with link"
       action={{
-        text: 'This is a link',
+        'aria-label': 'Action',
+        text: 'Action',
         href: 'https://wise.com',
       }}
     />
-  );
+  </div>
+);
+
+/**
+ * The stories below document the `Header` component, which is used to structure content and convey hierarchy. <br />
+ * For more details, refer to the [design documentation](https://wise.design/components/section-header).
+ */
+const meta: Meta<typeof Header> = {
+  component: Header,
+  title: 'Typography/Header',
+  argTypes: {
+    level: {
+      type: {
+        name: 'enum',
+        value: ['section', 'group'],
+      },
+      table: {
+        type: {
+          summary: 'HeaderLevel',
+        },
+      },
+      description: 'Defines the hierarchical level of the header.',
+    },
+    as: {
+      type: {
+        name: 'enum',
+        value: ['h1', 'h2', 'h3', 'legend'],
+      },
+      table: {
+        type: {
+          summary: 'HeaderAs',
+        },
+      },
+      description:
+        'Defines which HTML element the Header will render as. Use `legend` only as the first child of a `<fieldset>` — otherwise a warning will appear. The `action` prop is not supported with `legend`. You can also use heading tags like `h1`, `h2`, `h3`, or `header`.',
+    },
+    action: {
+      table: {
+        type: {
+          summary: 'HeaderAction',
+        },
+      },
+      description: 'Defines an optional action (e.g., button or link) associated with the header.',
+    },
+  },
+  args: {
+    title: 'Default Header',
+    level: 'group',
+    as: 'h1',
+    action: undefined,
+  },
+  tags: ['autodocs'],
+  decorators: [withContainer],
+  parameters: {
+    docs: {
+      toc: true,
+    },
+  },
 };
 
-export const WithActionAsLinkPreventingNavigationWithTracking = () => {
-  return (
-    <Header
-      title="Header title"
-      action={{
-        text: 'This is a link',
-        href: 'https://wise.com',
-        onClick: (event: React.MouseEvent<HTMLElement>) => {
-          alert('Running onClick handler');
+export default meta;
 
-          // we can stop the navigation from happening as onClick will always run before href redirect
-          event.preventDefault();
-        },
-      }}
-    />
-  );
+type Story = StoryObj<typeof Header>;
+
+export const Playground: Story = {
+  render: renderHeader,
+  args: {
+    title: 'Playground Header',
+    level: 'group',
+    as: 'h2',
+    action: {
+      'aria-label': 'Action',
+      text: 'Click me',
+      onClick: () => alert('Action clicked!'),
+    },
+  },
+};
+
+/**
+ * Demonstrates a `Header` with an associated action.
+ */
+export const Action: Story = {
+  args: {
+    title: 'Header with Action',
+    action: {
+      'aria-label': 'Action',
+      text: 'Action',
+      onClick: () => alert('Action clicked!'),
+    },
+  },
+  argTypes: hideControls(['as', 'className', 'level', 'title', 'testId']),
 };
+
+/**
+ * Demonstrates a `Header` with an associated action as a link.
+ */
+export const ActionAsLink: Story = {
+  args: {
+    title: 'Header with Action as Link',
+    action: {
+      'aria-label': 'Learn more about this section',
+      text: 'Learn more',
+      href: 'https://wise.com',
+      target: '_blank',
+    },
+  },
+  argTypes: hideControls(['as', 'className', 'level', 'title', 'testId']),
+};
+
+/**
+ * Demonstrates a `Header` rendered as a custom HTML element.
+ */
+export const CustomElement: Story = {
+  render: renderHeader,
+  args: {
+    title: 'Legend Header',
+    as: 'legend',
+  },
+  argTypes: hideControls(['action', 'className', 'level', 'testId']),
+};
+
+/**
+ * Demonstrates a `Header` with a specific hierarchical level.
+ */
+export const SectionLevel: Story = {
+  args: {
+    title: 'Section Header',
+    level: 'section',
+  },
+  argTypes: hideControls(['action', 'as', 'className', 'title', 'testId']),
+};
+
+/**
+ * Displays all variants of the `Header` component, including different levels, tags, and actions.
+ */
+export const AllVariants = storyConfig(
+  {
+    tags: ['!autodocs'],
+    parameters: {
+      padding: '0',
+    },
+    render: renderVariants,
+  },
+  { variants: ['default', 'dark', 'bright-green', 'forest-green', 'rtl'] },
+);

package/src/header/Header.tsx

@@ -1,102 +1,154 @@
 import { clsx } from 'clsx';
 
-import { ActionButtonProps } from '../actionButton/ActionButton';
-import Button from '../button';
 import { AriaLabelProperty, CommonProps, Heading, LinkProps, Typography } from '../common';
 import Link from '../link';
+import Button from '../button';
 import Title from '../title';
-import { HTMLAttributes } from 'react';
+import React, { useEffect, useRef, FunctionComponent } from 'react';
 
 type ActionProps = AriaLabelProperty & {
   text: string;
+  onClick?: () => void;
 };
 
-type ButtonActionProps = ActionProps & ActionButtonProps;
-
+type ButtonActionProps = ActionProps;
 type LinkActionProps = ActionProps & LinkProps;
 
-export type HeaderProps = CommonProps & {
+export interface HeaderProps extends CommonProps {
   /**
-   * When the `href` property is provided to the `action`, we will render a `Link` instead of a `ActionButton`.
+   * Optional prop to define the action for the header. If the `href` property
+   * is provided, a `Link` will be rendered instead of a `Button`.
    */
   action?: ButtonActionProps | LinkActionProps;
+
   /**
-   * Override the heading element rendered for the title, useful to specify the semantics of your header.
+   * Option prop to specify DOM render element of the title
+   *
+   * - When `as="legend"`, the `Header` will render as a `<legend>` element.
+   *   **Note:** `<legend>` elements must be the first child of a `<fieldset>` to comply with HTML semantics.
+   *   If this condition is not met, a warning will be logged to the console.
+   *   Additionally, the `action` prop is not supported when `as="legend"`.
    *
-   * @default "h5"
+   * - Other valid values include standard heading tags (`h1` to `h6`) or `header`.
    */
   as?: Heading | 'legend' | 'header';
+
+  /** Required prop to set the title of the Header. */
   title: string;
-} & Pick<HTMLAttributes<HTMLDivElement>, 'role' | 'id'>;
 
-const HeaderAction = ({ action }: { action: ButtonActionProps | LinkActionProps }) => {
-  const props = {
-    'aria-label': action['aria-label'],
-  };
+  /** Optional prop to specify the level of the Header */
+  level?: 'section' | 'group';
 
-  if ('href' in action) {
-    return (
-      <Link href={action.href} target={action.target} onClick={action.onClick} {...props}>
-        {action.text}
-      </Link>
-    );
-  }
-
-  return (
-    <Button
-      className="np-header__button"
-      priority="tertiary"
-      size="sm"
-      onClick={action.onClick}
-      {...props}
-    >
-      {action.text}
-    </Button>
-  );
-};
+  className?: string;
+  testId?: string;
+}
 
 /**
+ * Renders a header action which can be either a button or a link.
  *
- * Neptune Web: https://transferwise.github.io/neptune-web/components/content/Header
+ * @param {Object} props - The properties object.
+ * @param {ButtonActionProps | LinkActionProps} props.action - The action object which can be either a button or a link.
+ * @returns {JSX.Element} The rendered header action component.
+ */
+const HeaderAction = React.forwardRef(
+  (
+    { action }: { action: ButtonActionProps | LinkActionProps },
+    ref: React.Ref<HTMLButtonElement | HTMLAnchorElement>,
+  ) => {
+    const { 'aria-label': ariaLabel, text, onClick } = action;
+
+    const inner =
+      'href' in action ? (
+        <Link
+          ref={ref as React.Ref<HTMLAnchorElement>}
+          className="np-header__action-link"
+          href={action.href}
+          target={action.target}
+          aria-label={action['aria-label']}
+          onClick={action.onClick}
+        >
+          {action.text}
+        </Link>
+      ) : (
+        <Button
+          ref={ref as React.Ref<HTMLButtonElement>}
+          className="np-header__action-button"
+          priority="tertiary"
+          size="sm"
+          aria-label={action['aria-label']}
+          onClick={action.onClick}
+        >
+          {action.text}
+        </Button>
+      );
+
+    return <div className="np-header__action">{inner}</div>;
+  },
+);
+
+HeaderAction.displayName = 'HeaderAction';
+
+/**
+ * @param {ButtonActionProps | LinkActionProps} [action] - Optional prop to specify the action button or link.
+ * @param {Heading | 'legend'} [as='h5'] - Optional prop to override the heading element rendered for the title.
+ * @param {string} title - Required prop to set the title of the section header.
+ * @param {'group' | 'section'} [level='group'] - Optional prop to specify the level of the section header.
+ * @param {string} [className]
+ * @param {string} [testId]
  *
+ * @see {@link Header } for further information.
+ * @see {@link https://storybook.wise.design/?path=/docs/typography-header--docs|Storybook Wise Design}
  */
-export const Header = ({
-  id,
-  action,
-  as = 'h5',
-  title,
-  className,
-  role = undefined,
-}: HeaderProps) => {
-  if (!action) {
+const Header: FunctionComponent<HeaderProps> = React.forwardRef(
+  (
+    { as = 'h5', action, className, testId, title, level = 'group', ...props },
+    ref: React.Ref<HTMLDivElement | HTMLHeadingElement | HTMLLegendElement>,
+  ) => {
+    const internalRef = useRef<HTMLLegendElement>(null);
+    const actionRef = useRef<HTMLButtonElement | HTMLAnchorElement>(null);
+    const levelTypography =
+      level === 'group' ? Typography.TITLE_GROUP : Typography.TITLE_SUBSECTION;
+    const isLegendOrNoAction = !action || as === 'legend';
+    const headerClasses = clsx('np-header', className, {
+      'np-header--group': level === 'group',
+      'np-header__title': isLegendOrNoAction,
+    });
+
+    const commonProps = {
+      className: headerClasses,
+      'data-testid': testId,
+    };
+
+    useEffect(() => {
+      if (as === 'legend' && internalRef.current) {
+        const { parentElement } = internalRef.current;
+        if (!parentElement || parentElement.tagName.toLowerCase() !== 'fieldset') {
+          console.warn(
+            'Legends should be the first child in a fieldset, and this is not possible when including an action',
+          );
+        }
+      }
+    }, [as]);
+
+    if (!action) {
+      return (
+        <Title ref={internalRef} as={as} type={levelTypography} {...commonProps} {...props}>
+          {title}
+        </Title>
+      );
+    }
+
     return (
-      <Title
-        as={as}
-        id={id}
-        role={role}
-        type={Typography.TITLE_GROUP}
-        className={clsx('np-header', 'np-header__title', className)}
-      >
-        {title}
-      </Title>
+      <div {...commonProps} {...props} ref={ref as React.Ref<HTMLDivElement>}>
+        <Title as={as} type={levelTypography} className="np-header__title">
+          {title}
+        </Title>
+        <HeaderAction ref={actionRef} action={action} />
+      </div>
     );
-  }
+  },
+);
 
-  if (as === 'legend') {
-    // eslint-disable-next-line no-console
-    console.warn(
-      'Legends should be the first child in a fieldset, and this is not possible when including an action',
-    );
-  }
-
-  return (
-    <div className={clsx('np-header', className)}>
-      <Title as={as} type={Typography.TITLE_GROUP} id={id} className="np-header__title">
-        {title}
-      </Title>
-      <HeaderAction action={action} />
-    </div>
-  );
-};
+Header.displayName = 'Header';
 
 export default Header;

package/src/header/index.ts

@@ -1 +1,2 @@
 export { default } from './Header';
+export type { HeaderProps } from './Header';

package/src/index.ts

@@ -31,6 +31,7 @@ export type { DefinitionListProps, DefinitionListDefinition } from './definition
 export type { DimmerProps } from './dimmer';
 export type { DrawerProps } from './drawer';
 export type { DividerProps } from './divider';
+export type { HeaderProps } from './header';
 export type { EmphasisProps } from './emphasis';
 export type { FieldProps } from './field/Field';
 export type { InfoProps } from './info';

package/src/main.css

@@ -2433,30 +2433,48 @@ html:not([dir="rtl"]) .np-flow-navigation--sm .np-flow-navigation__stepper {
   fill: var(--color-interactive-primary);
 }
 .np-header {
-  display: flex;
-  justify-content: space-between;
-  align-items: flex-end;
+  display: grid;
+  grid-template-columns: 1fr auto;
+  grid-column-gap: 24px;
+  grid-column-gap: var(--size-24);
+  -moz-column-gap: 24px;
+       column-gap: 24px;
+  -moz-column-gap: var(--size-24);
+       column-gap: var(--size-24);
+  align-items: center;
+  margin-bottom: 8px;
+  margin-bottom: var(--size-8);
   max-width: 100%;
   padding: 8px 0;
   padding: var(--size-8) 0;
+  width: 100%;
+}
+.np-header--group {
+  align-items: flex-end;
   border-bottom: 1px solid rgba(0,0,0,0.10196);
   border-bottom: 1px solid var(--color-border-neutral);
-  margin-bottom: 8px;
-  margin-bottom: var(--size-8);
-  -moz-column-gap: 24px;
-       column-gap: 24px;
-  -moz-column-gap: var(--size-24);
-       column-gap: var(--size-24);
 }
 .np-header__title {
   color: #5d7079;
   color: var(--color-content-secondary);
+  margin: 0;
 }
-.np-header__button {
-  margin-inline: calc(16px * -1);
-  margin-inline: calc(var(--size-16) * -1);
-  margin-bottom: calc(4px * -1);
-  margin-bottom: calc(var(--size-4) * -1);
+.np-header__action {
+  margin: 0;
+  height: 20px;
+  display: flex;
+  align-items: center;
+}
+.np-header__action-link {
+  margin-bottom: -0.5px;
+}
+.np-header__action-button {
+  margin-right: -17px;
+}
+@media (max-width: 320px) {
+  .np-header__action-button {
+    margin-right: -12.5px;
+  }
 }
 .tw-image {
   max-width: none;

package/src/title/Title.tsx

@@ -1,5 +1,5 @@
 import { clsx } from 'clsx';
-import { LabelHTMLAttributes, LiHTMLAttributes, ReactHTML } from 'react';
+import React, { forwardRef, LabelHTMLAttributes, LiHTMLAttributes } from 'react';
 
 import { TitleTypes, Typography, Heading } from '../common';
 
@@ -25,16 +25,29 @@ type Props = LabelHTMLAttributes<HTMLHeadingElement | HTMLSpanElement | HTMLLabe
     type?: TitleTypes;
   };
 
-function Title({ as, type = DEFAULT_TYPE, className, ...props }: Props) {
-  const mapping = titleTypeMapping[type];
-  const isTypeSupported = mapping !== undefined;
-
-  if (isTypeSupported) {
-    const HeaderTag = as ?? mapping;
-    return <HeaderTag {...props} className={clsx(`np-text-${type}`, className)} />;
-  }
-  const HeaderTag = as ?? titleTypeMapping[DEFAULT_TYPE];
-  return <HeaderTag {...props} className={clsx(`np-text-${DEFAULT_TYPE}`, className)} />;
-}
+const Title = React.forwardRef<HTMLHeadingElement | HTMLSpanElement | HTMLLabelElement, Props>(
+  ({ as, type = DEFAULT_TYPE, className, ...props }, ref) => {
+    const mapping = titleTypeMapping[type as keyof typeof titleTypeMapping];
+    const isTypeSupported = mapping !== undefined;
+    if (isTypeSupported) {
+      const HeaderTag = as ?? mapping;
+      return (
+        <HeaderTag
+          ref={ref as React.Ref<any>}
+          {...props}
+          className={clsx(`np-text-${type}`, className)}
+        />
+      );
+    }
+    const HeaderTag = as ?? titleTypeMapping[DEFAULT_TYPE];
+    return (
+      <HeaderTag
+        ref={ref as React.Ref<any>}
+        {...props}
+        className={clsx(`np-text-${DEFAULT_TYPE}`, className)}
+      />
+    );
+  },
+);
 
 export default Title;