@transferwise/components 0.0.0-experimental-b7e52e5 → 0.0.0-experimental-2442a28

package/build/header/Header.js

@@ -3,7 +3,6 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var clsx = require('clsx');
-var Button_resolver = require('../button/Button.resolver.js');
 require('../common/theme.js');
 require('../common/direction.js');
 require('../common/propsValues/control.js');
@@ -24,78 +23,119 @@ require('../common/propsValues/scroll.js');
 require('../common/propsValues/markdownNodeType.js');
 require('../common/fileType.js');
 require('@transferwise/icons');
-require('react');
+var React = require('react');
 require('react-intl');
 require('../common/closeButton/CloseButton.messages.js');
 var jsxRuntime = require('react/jsx-runtime');
 var Link = require('../link/Link.js');
+var Button_resolver = require('../button/Button.resolver.js');
 var Title = require('../title/Title.js');
 
-const HeaderAction = ({
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var React__default = /*#__PURE__*/_interopDefault(React);
+
+const HeaderAction = /*#__PURE__*/React__default.default.forwardRef(({
   action
-}) => {
-  const props = {
-    'aria-label': action['aria-label']
-  };
+}, ref) => {
+  const {
+    'aria-label': ariaLabel,
+    text,
+    onClick
+  } = action;
   if ('href' in action) {
+    const {
+      href,
+      target,
+      onClick: linkOnClick
+    } = action;
     return /*#__PURE__*/jsxRuntime.jsx(Link.default, {
-      href: action.href,
-      target: action.target,
-      onClick: action.onClick,
-      ...props,
-      children: action.text
+      ref: ref,
+      href: href,
+      target: target,
+      "aria-label": ariaLabel,
+      onClick: linkOnClick,
+      children: text
     });
   }
   return /*#__PURE__*/jsxRuntime.jsx(Button_resolver.default, {
+    ref: ref,
     className: "np-header__button",
     priority: "tertiary",
     size: "sm",
-    onClick: action.onClick,
-    ...props,
-    children: action.text
+    "aria-label": ariaLabel,
+    onClick: onClick,
+    children: text
   });
-};
+});
+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]
  *
- * Neptune Web: https://transferwise.github.io/neptune-web/components/content/Header
- *
+ * @see {@link Header } for further information.
+ * @see {@link https://storybook.wise.design/?path=/docs/typography-header--docs|Storybook Wise Design}
  */
-const Header = ({
-  id,
-  action,
+const Header = /*#__PURE__*/React__default.default.forwardRef(({
   as = 'h5',
-  title,
+  action,
   className,
-  role = undefined
-}) => {
-  if (!action) {
+  testId,
+  title,
+  level = 'group',
+  ...props
+}, ref) => {
+  const internalRef = React.useRef(null);
+  const levelTypography = level === 'section' ? typography.Typography.TITLE_SUBSECTION : typography.Typography.TITLE_GROUP;
+  const headerClasses = clsx.clsx('np-header', className, {
+    'np-header--section': level === 'section',
+    'np-header__title': !action || as === 'legend'
+  });
+  const commonProps = {
+    className: headerClasses,
+    'data-testid': testId
+  };
+  React.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 || as === 'legend') {
     return /*#__PURE__*/jsxRuntime.jsx(Title.default, {
+      ref: internalRef,
       as: as,
-      id: id,
-      role: role,
-      type: typography.Typography.TITLE_GROUP,
-      className: clsx.clsx('np-header', 'np-header__title', className),
+      type: levelTypography,
+      ...commonProps,
+      ...props,
       children: title
     });
   }
-  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');
-  }
+  const actionRef = /*#__PURE__*/React__default.default.createRef();
   return /*#__PURE__*/jsxRuntime.jsxs("div", {
-    className: clsx.clsx('np-header', className),
+    ...commonProps,
+    ...props,
+    ref: ref,
     children: [/*#__PURE__*/jsxRuntime.jsx(Title.default, {
       as: as,
-      type: typography.Typography.TITLE_GROUP,
-      id: id,
+      type: levelTypography,
       className: "np-header__title",
       children: title
     }), /*#__PURE__*/jsxRuntime.jsx(HeaderAction, {
+      ref: actionRef,
       action: action
     })]
   });
-};
+});
+Header.displayName = 'Header';
 
-exports.Header = Header;
 exports.default = Header;
 //# sourceMappingURL=Header.js.map

package/build/header/Header.js.map

@@ -1 +1 @@
-{"version":3,"file":"Header.js","sources":["../../src/header/Header.tsx"],"sourcesContent":["import { clsx } from 'clsx';\n\nimport { ActionButtonProps } from '../actionButton/ActionButton';\nimport Button from '../button';\nimport { AriaLabelProperty, CommonProps, Heading, LinkProps, Typography } from '../common';\nimport Link from '../link';\nimport Title from '../title';\nimport { HTMLAttributes } from 'react';\n\ntype ActionProps = AriaLabelProperty & {\n  text: string;\n};\n\ntype ButtonActionProps = ActionProps & ActionButtonProps;\n\ntype LinkActionProps = ActionProps & LinkProps;\n\nexport type HeaderProps = CommonProps & {\n  /**\n   * When the `href` property is provided to the `action`, we will render a `Link` instead of a `ActionButton`.\n   */\n  action?: ButtonActionProps | LinkActionProps;\n  /**\n   * Override the heading element rendered for the title, useful to specify the semantics of your header.\n   *\n   * @default \"h5\"\n   */\n  as?: Heading | 'legend' | 'header';\n  title: string;\n} & Pick<HTMLAttributes<HTMLDivElement>, 'role' | 'id'>;\n\nconst HeaderAction = ({ action }: { action: ButtonActionProps | LinkActionProps }) => {\n  const props = {\n    'aria-label': action['aria-label'],\n  };\n\n  if ('href' in action) {\n    return (\n      <Link href={action.href} target={action.target} onClick={action.onClick} {...props}>\n        {action.text}\n      </Link>\n    );\n  }\n\n  return (\n    <Button\n      className=\"np-header__button\"\n      priority=\"tertiary\"\n      size=\"sm\"\n      onClick={action.onClick}\n      {...props}\n    >\n      {action.text}\n    </Button>\n  );\n};\n\n/**\n *\n * Neptune Web: https://transferwise.github.io/neptune-web/components/content/Header\n *\n */\nexport const Header = ({\n  id,\n  action,\n  as = 'h5',\n  title,\n  className,\n  role = undefined,\n}: HeaderProps) => {\n  if (!action) {\n    return (\n      <Title\n        as={as}\n        id={id}\n        role={role}\n        type={Typography.TITLE_GROUP}\n        className={clsx('np-header', 'np-header__title', className)}\n      >\n        {title}\n      </Title>\n    );\n  }\n\n  if (as === 'legend') {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'Legends should be the first child in a fieldset, and this is not possible when including an action',\n    );\n  }\n\n  return (\n    <div className={clsx('np-header', className)}>\n      <Title as={as} type={Typography.TITLE_GROUP} id={id} className=\"np-header__title\">\n        {title}\n      </Title>\n      <HeaderAction action={action} />\n    </div>\n  );\n};\n\nexport default Header;\n"],"names":["HeaderAction","action","props","_jsx","Link","href","target","onClick","children","text","Button","className","priority","size","Header","id","as","title","role","undefined","Title","type","Typography","TITLE_GROUP","clsx","console","warn","_jsxs"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAMA,YAAY,GAAGA,CAAC;AAAEC,EAAAA,MAAAA;AAAM,CAAmD,KAAI;AACnF,EAAA,MAAMC,KAAK,GAAG;IACZ,YAAY,EAAED,MAAM,CAAC,YAAY,CAAA;GAClC,CAAA;EAED,IAAI,MAAM,IAAIA,MAAM,EAAE;IACpB,oBACEE,cAAA,CAACC,YAAI,EAAA;MAACC,IAAI,EAAEJ,MAAM,CAACI,IAAK;MAACC,MAAM,EAAEL,MAAM,CAACK,MAAO;MAACC,OAAO,EAAEN,MAAM,CAACM,OAAQ;AAAA,MAAA,GAAKL,KAAK;MAAAM,QAAA,EAC/EP,MAAM,CAACQ,IAAAA;AAAI,KACR,CAAC,CAAA;AAEX,GAAA;EAEA,oBACEN,cAAA,CAACO,uBAAM,EAAA;AACLC,IAAAA,SAAS,EAAC,mBAAmB;AAC7BC,IAAAA,QAAQ,EAAC,UAAU;AACnBC,IAAAA,IAAI,EAAC,IAAI;IACTN,OAAO,EAAEN,MAAM,CAACM,OAAQ;AAAA,IAAA,GACpBL,KAAK;IAAAM,QAAA,EAERP,MAAM,CAACQ,IAAAA;AAAI,GACN,CAAC,CAAA;AAEb,CAAC,CAAA;AAED;;;;AAIG;AACI,MAAMK,MAAM,GAAGA,CAAC;EACrBC,EAAE;EACFd,MAAM;AACNe,EAAAA,EAAE,GAAG,IAAI;EACTC,KAAK;EACLN,SAAS;AACTO,EAAAA,IAAI,GAAGC,SAAAA;AACK,CAAA,KAAI;EAChB,IAAI,CAAClB,MAAM,EAAE;IACX,oBACEE,cAAA,CAACiB,aAAK,EAAA;AACJJ,MAAAA,EAAE,EAAEA,EAAG;AACPD,MAAAA,EAAE,EAAEA,EAAG;AACPG,MAAAA,IAAI,EAAEA,IAAK;MACXG,IAAI,EAAEC,qBAAU,CAACC,WAAY;MAC7BZ,SAAS,EAAEa,SAAI,CAAC,WAAW,EAAE,kBAAkB,EAAEb,SAAS,CAAE;AAAAH,MAAAA,QAAA,EAE3DS,KAAAA;AAAK,KACD,CAAC,CAAA;AAEZ,GAAA;EAEA,IAAID,EAAE,KAAK,QAAQ,EAAE;AACnB;AACAS,IAAAA,OAAO,CAACC,IAAI,CACV,oGAAoG,CACrG,CAAA;AACH,GAAA;AAEA,EAAA,oBACEC,eAAA,CAAA,KAAA,EAAA;AAAKhB,IAAAA,SAAS,EAAEa,SAAI,CAAC,WAAW,EAAEb,SAAS,CAAE;IAAAH,QAAA,EAAA,cAC3CL,cAAA,CAACiB,aAAK,EAAA;AAACJ,MAAAA,EAAE,EAAEA,EAAG;MAACK,IAAI,EAAEC,qBAAU,CAACC,WAAY;AAACR,MAAAA,EAAE,EAAEA,EAAG;AAACJ,MAAAA,SAAS,EAAC,kBAAkB;AAAAH,MAAAA,QAAA,EAC9ES,KAAAA;AAAK,KACD,CACP,eAAAd,cAAA,CAACH,YAAY,EAAA;AAACC,MAAAA,MAAM,EAAEA,MAAAA;AAAO,KAC/B,CAAA,CAAA;AAAA,GAAK,CAAC,CAAA;AAEV;;;;;"}
+{"version":3,"file":"Header.js","sources":["../../src/header/Header.tsx"],"sourcesContent":["import { clsx } from 'clsx';\n\nimport { AriaLabelProperty, CommonProps, Heading, LinkProps, Typography } from '../common';\nimport Link from '../link';\nimport Button from '../button';\nimport Title from '../title';\nimport React, { useEffect, useRef, FunctionComponent } from 'react';\n\ntype ActionProps = AriaLabelProperty & {\n  text: string;\n  onClick?: () => void;\n};\n\ntype ButtonActionProps = ActionProps;\ntype LinkActionProps = ActionProps & LinkProps;\n\nexport interface HeaderProps extends CommonProps {\n  /**\n   * Optional prop to define the action for the header. If the `href` property\n   * is provided, a `Link` will be rendered instead of an `ActionButton`.\n   */\n  action?: ButtonActionProps | LinkActionProps;\n\n  /** Option prop to specify DOM render element of the title */\n  as?: Heading | 'legend' | 'header';\n\n  /** Required prop to set the title of the Header. */\n  title: string;\n\n  /** Optional prop to specify the level of the Header */\n  level?: 'section' | 'group';\n\n  className?: string;\n  testId?: string;\n}\n\n/**\n * Renders a header action which can be either a button or a link.\n *\n * @param {Object} props - The properties object.\n * @param {ButtonActionProps | LinkActionProps} props.action - The action object which can be either a button or a link.\n * @returns {JSX.Element} The rendered header action component.\n */\nconst HeaderAction = React.forwardRef(\n  (\n    { action }: { action: ButtonActionProps | LinkActionProps },\n    ref: React.Ref<HTMLButtonElement | HTMLAnchorElement>,\n  ) => {\n    const { 'aria-label': ariaLabel, text, onClick } = action;\n\n    if ('href' in action) {\n      const { href, target, onClick: linkOnClick } = action;\n      return (\n        <Link\n          ref={ref as React.Ref<HTMLAnchorElement>}\n          href={href}\n          target={target}\n          aria-label={ariaLabel}\n          onClick={linkOnClick}\n        >\n          {text}\n        </Link>\n      );\n    }\n\n    return (\n      <Button\n        ref={ref as React.Ref<HTMLButtonElement>}\n        className=\"np-header__button\"\n        priority=\"tertiary\"\n        size=\"sm\"\n        aria-label={ariaLabel}\n        onClick={onClick}\n      >\n        {text}\n      </Button>\n    );\n  },\n);\n\nHeaderAction.displayName = 'HeaderAction';\n\n/**\n * @param {ButtonActionProps | LinkActionProps} [action] - Optional prop to specify the action button or link.\n * @param {Heading | 'legend'} [as='h5'] - Optional prop to override the heading element rendered for the title.\n * @param {string} title - Required prop to set the title of the section header.\n * @param {'group' | 'section'} [level='group'] - Optional prop to specify the level of the section header.\n * @param {string} [className]\n * @param {string} [testId]\n *\n * @see {@link Header } for further information.\n * @see {@link https://storybook.wise.design/?path=/docs/typography-header--docs|Storybook Wise Design}\n */\nconst Header: FunctionComponent<HeaderProps> = React.forwardRef(\n  (\n    { as = 'h5', action, className, testId, title, level = 'group', ...props },\n    ref: React.Ref<HTMLDivElement | HTMLHeadingElement | HTMLLegendElement>,\n  ) => {\n    const internalRef = useRef<HTMLLegendElement>(null);\n    const levelTypography =\n      level === 'section' ? Typography.TITLE_SUBSECTION : Typography.TITLE_GROUP;\n    const headerClasses = clsx('np-header', className, {\n      'np-header--section': level === 'section',\n      'np-header__title': !action || as === 'legend',\n    });\n\n    const commonProps = {\n      className: headerClasses,\n      'data-testid': testId,\n    };\n\n    useEffect(() => {\n      if (as === 'legend' && internalRef.current) {\n        const { parentElement } = internalRef.current;\n        if (!parentElement || parentElement.tagName.toLowerCase() !== 'fieldset') {\n          console.warn(\n            'Legends should be the first child in a fieldset, and this is not possible when including an action',\n          );\n        }\n      }\n    }, [as]);\n\n    if (!action || as === 'legend') {\n      return (\n        <Title ref={internalRef} as={as} type={levelTypography} {...commonProps} {...props}>\n          {title}\n        </Title>\n      );\n    }\n\n    const actionRef = React.createRef<HTMLButtonElement | HTMLAnchorElement>();\n\n    return (\n      <div {...commonProps} {...props} ref={ref as React.Ref<HTMLDivElement>}>\n        <Title as={as} type={levelTypography} className=\"np-header__title\">\n          {title}\n        </Title>\n        <HeaderAction ref={actionRef} action={action} />\n      </div>\n    );\n  },\n);\n\nHeader.displayName = 'Header';\n\nexport default Header;\n"],"names":["HeaderAction","React","forwardRef","action","ref","ariaLabel","text","onClick","href","target","linkOnClick","_jsx","Link","children","Button","className","priority","size","displayName","Header","as","testId","title","level","props","internalRef","useRef","levelTypography","Typography","TITLE_SUBSECTION","TITLE_GROUP","headerClasses","clsx","commonProps","useEffect","current","parentElement","tagName","toLowerCase","console","warn","Title","type","actionRef","createRef","_jsxs"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,MAAMA,YAAY,gBAAGC,sBAAK,CAACC,UAAU,CACnC,CACE;AAAEC,EAAAA,MAAAA;AAAM,CAAmD,EAC3DC,GAAqD,KACnD;EACF,MAAM;AAAE,IAAA,YAAY,EAAEC,SAAS;IAAEC,IAAI;AAAEC,IAAAA,OAAAA;AAAO,GAAE,GAAGJ,MAAM,CAAA;EAEzD,IAAI,MAAM,IAAIA,MAAM,EAAE;IACpB,MAAM;MAAEK,IAAI;MAAEC,MAAM;AAAEF,MAAAA,OAAO,EAAEG,WAAAA;AAAW,KAAE,GAAGP,MAAM,CAAA;IACrD,oBACEQ,cAAA,CAACC,YAAI,EAAA;AACHR,MAAAA,GAAG,EAAEA,GAAoC;AACzCI,MAAAA,IAAI,EAAEA,IAAK;AACXC,MAAAA,MAAM,EAAEA,MAAO;AACf,MAAA,YAAA,EAAYJ,SAAU;AACtBE,MAAAA,OAAO,EAAEG,WAAY;AAAAG,MAAAA,QAAA,EAEpBP,IAAAA;AAAI,KACD,CAAC,CAAA;AAEX,GAAA;EAEA,oBACEK,cAAA,CAACG,uBAAM,EAAA;AACLV,IAAAA,GAAG,EAAEA,GAAoC;AACzCW,IAAAA,SAAS,EAAC,mBAAmB;AAC7BC,IAAAA,QAAQ,EAAC,UAAU;AACnBC,IAAAA,IAAI,EAAC,IAAI;AACT,IAAA,YAAA,EAAYZ,SAAU;AACtBE,IAAAA,OAAO,EAAEA,OAAQ;AAAAM,IAAAA,QAAA,EAEhBP,IAAAA;AAAI,GACC,CAAC,CAAA;AAEb,CAAC,CACF,CAAA;AAEDN,YAAY,CAACkB,WAAW,GAAG,cAAc,CAAA;AAEzC;;;;;;;;;;AAUG;AACH,MAAMC,MAAM,gBAAmClB,sBAAK,CAACC,UAAU,CAC7D,CACE;AAAEkB,EAAAA,EAAE,GAAG,IAAI;EAAEjB,MAAM;EAAEY,SAAS;EAAEM,MAAM;EAAEC,KAAK;AAAEC,EAAAA,KAAK,GAAG,OAAO;EAAE,GAAGC,KAAAA;AAAK,CAAE,EAC1EpB,GAAuE,KACrE;AACF,EAAA,MAAMqB,WAAW,GAAGC,YAAM,CAAoB,IAAI,CAAC,CAAA;AACnD,EAAA,MAAMC,eAAe,GACnBJ,KAAK,KAAK,SAAS,GAAGK,qBAAU,CAACC,gBAAgB,GAAGD,qBAAU,CAACE,WAAW,CAAA;AAC5E,EAAA,MAAMC,aAAa,GAAGC,SAAI,CAAC,WAAW,EAAEjB,SAAS,EAAE;IACjD,oBAAoB,EAAEQ,KAAK,KAAK,SAAS;AACzC,IAAA,kBAAkB,EAAE,CAACpB,MAAM,IAAIiB,EAAE,KAAK,QAAA;AACvC,GAAA,CAAC,CAAA;AAEF,EAAA,MAAMa,WAAW,GAAG;AAClBlB,IAAAA,SAAS,EAAEgB,aAAa;AACxB,IAAA,aAAa,EAAEV,MAAAA;GAChB,CAAA;AAEDa,EAAAA,eAAS,CAAC,MAAK;AACb,IAAA,IAAId,EAAE,KAAK,QAAQ,IAAIK,WAAW,CAACU,OAAO,EAAE;MAC1C,MAAM;AAAEC,QAAAA,aAAAA;OAAe,GAAGX,WAAW,CAACU,OAAO,CAAA;AAC7C,MAAA,IAAI,CAACC,aAAa,IAAIA,aAAa,CAACC,OAAO,CAACC,WAAW,EAAE,KAAK,UAAU,EAAE;AACxEC,QAAAA,OAAO,CAACC,IAAI,CACV,oGAAoG,CACrG,CAAA;AACH,OAAA;AACF,KAAA;AACF,GAAC,EAAE,CAACpB,EAAE,CAAC,CAAC,CAAA;AAER,EAAA,IAAI,CAACjB,MAAM,IAAIiB,EAAE,KAAK,QAAQ,EAAE;IAC9B,oBACET,cAAA,CAAC8B,aAAK,EAAA;AAACrC,MAAAA,GAAG,EAAEqB,WAAY;AAACL,MAAAA,EAAE,EAAEA,EAAG;AAACsB,MAAAA,IAAI,EAAEf,eAAgB;AAAA,MAAA,GAAKM,WAAW;AAAA,MAAA,GAAMT,KAAK;AAAAX,MAAAA,QAAA,EAC/ES,KAAAA;AAAK,KACD,CAAC,CAAA;AAEZ,GAAA;AAEA,EAAA,MAAMqB,SAAS,gBAAG1C,sBAAK,CAAC2C,SAAS,EAAyC,CAAA;AAE1E,EAAA,oBACEC,eAAA,CAAA,KAAA,EAAA;AAAA,IAAA,GAASZ,WAAW;AAAA,IAAA,GAAMT,KAAK;AAAEpB,IAAAA,GAAG,EAAEA,GAAiC;IAAAS,QAAA,EAAA,cACrEF,cAAA,CAAC8B,aAAK,EAAA;AAACrB,MAAAA,EAAE,EAAEA,EAAG;AAACsB,MAAAA,IAAI,EAAEf,eAAgB;AAACZ,MAAAA,SAAS,EAAC,kBAAkB;AAAAF,MAAAA,QAAA,EAC/DS,KAAAA;AAAK,KACD,CACP,eAAAX,cAAA,CAACX,YAAY,EAAA;AAACI,MAAAA,GAAG,EAAEuC,SAAU;AAACxC,MAAAA,MAAM,EAAEA,MAAAA;AAAO,KAC/C,CAAA,CAAA;AAAA,GAAK,CAAC,CAAA;AAEV,CAAC,EACF;AAEDgB,MAAM,CAACD,WAAW,GAAG,QAAQ;;;;"}

package/build/header/Header.mjs

@@ -1,5 +1,4 @@
 import { clsx } from 'clsx';
-import Button from '../button/Button.resolver.mjs';
 import '../common/theme.mjs';
 import '../common/direction.mjs';
 import '../common/propsValues/control.mjs';
@@ -20,77 +19,115 @@ import '../common/propsValues/scroll.mjs';
 import '../common/propsValues/markdownNodeType.mjs';
 import '../common/fileType.mjs';
 import '@transferwise/icons';
-import 'react';
+import React__default, { useRef, useEffect } from 'react';
 import 'react-intl';
 import '../common/closeButton/CloseButton.messages.mjs';
 import { jsx, jsxs } from 'react/jsx-runtime';
 import Link from '../link/Link.mjs';
+import Button from '../button/Button.resolver.mjs';
 import Title from '../title/Title.mjs';
 
-const HeaderAction = ({
+const HeaderAction = /*#__PURE__*/React__default.forwardRef(({
   action
-}) => {
-  const props = {
-    'aria-label': action['aria-label']
-  };
+}, ref) => {
+  const {
+    'aria-label': ariaLabel,
+    text,
+    onClick
+  } = action;
   if ('href' in action) {
+    const {
+      href,
+      target,
+      onClick: linkOnClick
+    } = action;
     return /*#__PURE__*/jsx(Link, {
-      href: action.href,
-      target: action.target,
-      onClick: action.onClick,
-      ...props,
-      children: action.text
+      ref: ref,
+      href: href,
+      target: target,
+      "aria-label": ariaLabel,
+      onClick: linkOnClick,
+      children: text
     });
   }
   return /*#__PURE__*/jsx(Button, {
+    ref: ref,
     className: "np-header__button",
     priority: "tertiary",
     size: "sm",
-    onClick: action.onClick,
-    ...props,
-    children: action.text
+    "aria-label": ariaLabel,
+    onClick: onClick,
+    children: text
   });
-};
+});
+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]
  *
- * Neptune Web: https://transferwise.github.io/neptune-web/components/content/Header
- *
+ * @see {@link Header } for further information.
+ * @see {@link https://storybook.wise.design/?path=/docs/typography-header--docs|Storybook Wise Design}
  */
-const Header = ({
-  id,
-  action,
+const Header = /*#__PURE__*/React__default.forwardRef(({
   as = 'h5',
-  title,
+  action,
   className,
-  role = undefined
-}) => {
-  if (!action) {
+  testId,
+  title,
+  level = 'group',
+  ...props
+}, ref) => {
+  const internalRef = useRef(null);
+  const levelTypography = level === 'section' ? Typography.TITLE_SUBSECTION : Typography.TITLE_GROUP;
+  const headerClasses = clsx('np-header', className, {
+    'np-header--section': level === 'section',
+    'np-header__title': !action || as === 'legend'
+  });
+  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 || as === 'legend') {
     return /*#__PURE__*/jsx(Title, {
+      ref: internalRef,
       as: as,
-      id: id,
-      role: role,
-      type: Typography.TITLE_GROUP,
-      className: clsx('np-header', 'np-header__title', className),
+      type: levelTypography,
+      ...commonProps,
+      ...props,
       children: title
     });
   }
-  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');
-  }
+  const actionRef = /*#__PURE__*/React__default.createRef();
   return /*#__PURE__*/jsxs("div", {
-    className: clsx('np-header', className),
+    ...commonProps,
+    ...props,
+    ref: ref,
     children: [/*#__PURE__*/jsx(Title, {
       as: as,
-      type: Typography.TITLE_GROUP,
-      id: id,
+      type: levelTypography,
       className: "np-header__title",
       children: title
     }), /*#__PURE__*/jsx(HeaderAction, {
+      ref: actionRef,
       action: action
     })]
   });
-};
+});
+Header.displayName = 'Header';
 
-export { Header, Header as default };
+export { Header as default };
 //# sourceMappingURL=Header.mjs.map

package/build/header/Header.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"Header.mjs","sources":["../../src/header/Header.tsx"],"sourcesContent":["import { clsx } from 'clsx';\n\nimport { ActionButtonProps } from '../actionButton/ActionButton';\nimport Button from '../button';\nimport { AriaLabelProperty, CommonProps, Heading, LinkProps, Typography } from '../common';\nimport Link from '../link';\nimport Title from '../title';\nimport { HTMLAttributes } from 'react';\n\ntype ActionProps = AriaLabelProperty & {\n  text: string;\n};\n\ntype ButtonActionProps = ActionProps & ActionButtonProps;\n\ntype LinkActionProps = ActionProps & LinkProps;\n\nexport type HeaderProps = CommonProps & {\n  /**\n   * When the `href` property is provided to the `action`, we will render a `Link` instead of a `ActionButton`.\n   */\n  action?: ButtonActionProps | LinkActionProps;\n  /**\n   * Override the heading element rendered for the title, useful to specify the semantics of your header.\n   *\n   * @default \"h5\"\n   */\n  as?: Heading | 'legend' | 'header';\n  title: string;\n} & Pick<HTMLAttributes<HTMLDivElement>, 'role' | 'id'>;\n\nconst HeaderAction = ({ action }: { action: ButtonActionProps | LinkActionProps }) => {\n  const props = {\n    'aria-label': action['aria-label'],\n  };\n\n  if ('href' in action) {\n    return (\n      <Link href={action.href} target={action.target} onClick={action.onClick} {...props}>\n        {action.text}\n      </Link>\n    );\n  }\n\n  return (\n    <Button\n      className=\"np-header__button\"\n      priority=\"tertiary\"\n      size=\"sm\"\n      onClick={action.onClick}\n      {...props}\n    >\n      {action.text}\n    </Button>\n  );\n};\n\n/**\n *\n * Neptune Web: https://transferwise.github.io/neptune-web/components/content/Header\n *\n */\nexport const Header = ({\n  id,\n  action,\n  as = 'h5',\n  title,\n  className,\n  role = undefined,\n}: HeaderProps) => {\n  if (!action) {\n    return (\n      <Title\n        as={as}\n        id={id}\n        role={role}\n        type={Typography.TITLE_GROUP}\n        className={clsx('np-header', 'np-header__title', className)}\n      >\n        {title}\n      </Title>\n    );\n  }\n\n  if (as === 'legend') {\n    // eslint-disable-next-line no-console\n    console.warn(\n      'Legends should be the first child in a fieldset, and this is not possible when including an action',\n    );\n  }\n\n  return (\n    <div className={clsx('np-header', className)}>\n      <Title as={as} type={Typography.TITLE_GROUP} id={id} className=\"np-header__title\">\n        {title}\n      </Title>\n      <HeaderAction action={action} />\n    </div>\n  );\n};\n\nexport default Header;\n"],"names":["HeaderAction","action","props","_jsx","Link","href","target","onClick","children","text","Button","className","priority","size","Header","id","as","title","role","undefined","Title","type","Typography","TITLE_GROUP","clsx","console","warn","_jsxs"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,MAAMA,YAAY,GAAGA,CAAC;AAAEC,EAAAA,MAAAA;AAAM,CAAmD,KAAI;AACnF,EAAA,MAAMC,KAAK,GAAG;IACZ,YAAY,EAAED,MAAM,CAAC,YAAY,CAAA;GAClC,CAAA;EAED,IAAI,MAAM,IAAIA,MAAM,EAAE;IACpB,oBACEE,GAAA,CAACC,IAAI,EAAA;MAACC,IAAI,EAAEJ,MAAM,CAACI,IAAK;MAACC,MAAM,EAAEL,MAAM,CAACK,MAAO;MAACC,OAAO,EAAEN,MAAM,CAACM,OAAQ;AAAA,MAAA,GAAKL,KAAK;MAAAM,QAAA,EAC/EP,MAAM,CAACQ,IAAAA;AAAI,KACR,CAAC,CAAA;AAEX,GAAA;EAEA,oBACEN,GAAA,CAACO,MAAM,EAAA;AACLC,IAAAA,SAAS,EAAC,mBAAmB;AAC7BC,IAAAA,QAAQ,EAAC,UAAU;AACnBC,IAAAA,IAAI,EAAC,IAAI;IACTN,OAAO,EAAEN,MAAM,CAACM,OAAQ;AAAA,IAAA,GACpBL,KAAK;IAAAM,QAAA,EAERP,MAAM,CAACQ,IAAAA;AAAI,GACN,CAAC,CAAA;AAEb,CAAC,CAAA;AAED;;;;AAIG;AACI,MAAMK,MAAM,GAAGA,CAAC;EACrBC,EAAE;EACFd,MAAM;AACNe,EAAAA,EAAE,GAAG,IAAI;EACTC,KAAK;EACLN,SAAS;AACTO,EAAAA,IAAI,GAAGC,SAAAA;AACK,CAAA,KAAI;EAChB,IAAI,CAAClB,MAAM,EAAE;IACX,oBACEE,GAAA,CAACiB,KAAK,EAAA;AACJJ,MAAAA,EAAE,EAAEA,EAAG;AACPD,MAAAA,EAAE,EAAEA,EAAG;AACPG,MAAAA,IAAI,EAAEA,IAAK;MACXG,IAAI,EAAEC,UAAU,CAACC,WAAY;MAC7BZ,SAAS,EAAEa,IAAI,CAAC,WAAW,EAAE,kBAAkB,EAAEb,SAAS,CAAE;AAAAH,MAAAA,QAAA,EAE3DS,KAAAA;AAAK,KACD,CAAC,CAAA;AAEZ,GAAA;EAEA,IAAID,EAAE,KAAK,QAAQ,EAAE;AACnB;AACAS,IAAAA,OAAO,CAACC,IAAI,CACV,oGAAoG,CACrG,CAAA;AACH,GAAA;AAEA,EAAA,oBACEC,IAAA,CAAA,KAAA,EAAA;AAAKhB,IAAAA,SAAS,EAAEa,IAAI,CAAC,WAAW,EAAEb,SAAS,CAAE;IAAAH,QAAA,EAAA,cAC3CL,GAAA,CAACiB,KAAK,EAAA;AAACJ,MAAAA,EAAE,EAAEA,EAAG;MAACK,IAAI,EAAEC,UAAU,CAACC,WAAY;AAACR,MAAAA,EAAE,EAAEA,EAAG;AAACJ,MAAAA,SAAS,EAAC,kBAAkB;AAAAH,MAAAA,QAAA,EAC9ES,KAAAA;AAAK,KACD,CACP,eAAAd,GAAA,CAACH,YAAY,EAAA;AAACC,MAAAA,MAAM,EAAEA,MAAAA;AAAO,KAC/B,CAAA,CAAA;AAAA,GAAK,CAAC,CAAA;AAEV;;;;"}
+{"version":3,"file":"Header.mjs","sources":["../../src/header/Header.tsx"],"sourcesContent":["import { clsx } from 'clsx';\n\nimport { AriaLabelProperty, CommonProps, Heading, LinkProps, Typography } from '../common';\nimport Link from '../link';\nimport Button from '../button';\nimport Title from '../title';\nimport React, { useEffect, useRef, FunctionComponent } from 'react';\n\ntype ActionProps = AriaLabelProperty & {\n  text: string;\n  onClick?: () => void;\n};\n\ntype ButtonActionProps = ActionProps;\ntype LinkActionProps = ActionProps & LinkProps;\n\nexport interface HeaderProps extends CommonProps {\n  /**\n   * Optional prop to define the action for the header. If the `href` property\n   * is provided, a `Link` will be rendered instead of an `ActionButton`.\n   */\n  action?: ButtonActionProps | LinkActionProps;\n\n  /** Option prop to specify DOM render element of the title */\n  as?: Heading | 'legend' | 'header';\n\n  /** Required prop to set the title of the Header. */\n  title: string;\n\n  /** Optional prop to specify the level of the Header */\n  level?: 'section' | 'group';\n\n  className?: string;\n  testId?: string;\n}\n\n/**\n * Renders a header action which can be either a button or a link.\n *\n * @param {Object} props - The properties object.\n * @param {ButtonActionProps | LinkActionProps} props.action - The action object which can be either a button or a link.\n * @returns {JSX.Element} The rendered header action component.\n */\nconst HeaderAction = React.forwardRef(\n  (\n    { action }: { action: ButtonActionProps | LinkActionProps },\n    ref: React.Ref<HTMLButtonElement | HTMLAnchorElement>,\n  ) => {\n    const { 'aria-label': ariaLabel, text, onClick } = action;\n\n    if ('href' in action) {\n      const { href, target, onClick: linkOnClick } = action;\n      return (\n        <Link\n          ref={ref as React.Ref<HTMLAnchorElement>}\n          href={href}\n          target={target}\n          aria-label={ariaLabel}\n          onClick={linkOnClick}\n        >\n          {text}\n        </Link>\n      );\n    }\n\n    return (\n      <Button\n        ref={ref as React.Ref<HTMLButtonElement>}\n        className=\"np-header__button\"\n        priority=\"tertiary\"\n        size=\"sm\"\n        aria-label={ariaLabel}\n        onClick={onClick}\n      >\n        {text}\n      </Button>\n    );\n  },\n);\n\nHeaderAction.displayName = 'HeaderAction';\n\n/**\n * @param {ButtonActionProps | LinkActionProps} [action] - Optional prop to specify the action button or link.\n * @param {Heading | 'legend'} [as='h5'] - Optional prop to override the heading element rendered for the title.\n * @param {string} title - Required prop to set the title of the section header.\n * @param {'group' | 'section'} [level='group'] - Optional prop to specify the level of the section header.\n * @param {string} [className]\n * @param {string} [testId]\n *\n * @see {@link Header } for further information.\n * @see {@link https://storybook.wise.design/?path=/docs/typography-header--docs|Storybook Wise Design}\n */\nconst Header: FunctionComponent<HeaderProps> = React.forwardRef(\n  (\n    { as = 'h5', action, className, testId, title, level = 'group', ...props },\n    ref: React.Ref<HTMLDivElement | HTMLHeadingElement | HTMLLegendElement>,\n  ) => {\n    const internalRef = useRef<HTMLLegendElement>(null);\n    const levelTypography =\n      level === 'section' ? Typography.TITLE_SUBSECTION : Typography.TITLE_GROUP;\n    const headerClasses = clsx('np-header', className, {\n      'np-header--section': level === 'section',\n      'np-header__title': !action || as === 'legend',\n    });\n\n    const commonProps = {\n      className: headerClasses,\n      'data-testid': testId,\n    };\n\n    useEffect(() => {\n      if (as === 'legend' && internalRef.current) {\n        const { parentElement } = internalRef.current;\n        if (!parentElement || parentElement.tagName.toLowerCase() !== 'fieldset') {\n          console.warn(\n            'Legends should be the first child in a fieldset, and this is not possible when including an action',\n          );\n        }\n      }\n    }, [as]);\n\n    if (!action || as === 'legend') {\n      return (\n        <Title ref={internalRef} as={as} type={levelTypography} {...commonProps} {...props}>\n          {title}\n        </Title>\n      );\n    }\n\n    const actionRef = React.createRef<HTMLButtonElement | HTMLAnchorElement>();\n\n    return (\n      <div {...commonProps} {...props} ref={ref as React.Ref<HTMLDivElement>}>\n        <Title as={as} type={levelTypography} className=\"np-header__title\">\n          {title}\n        </Title>\n        <HeaderAction ref={actionRef} action={action} />\n      </div>\n    );\n  },\n);\n\nHeader.displayName = 'Header';\n\nexport default Header;\n"],"names":["HeaderAction","React","forwardRef","action","ref","ariaLabel","text","onClick","href","target","linkOnClick","_jsx","Link","children","Button","className","priority","size","displayName","Header","as","testId","title","level","props","internalRef","useRef","levelTypography","Typography","TITLE_SUBSECTION","TITLE_GROUP","headerClasses","clsx","commonProps","useEffect","current","parentElement","tagName","toLowerCase","console","warn","Title","type","actionRef","createRef","_jsxs"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,MAAMA,YAAY,gBAAGC,cAAK,CAACC,UAAU,CACnC,CACE;AAAEC,EAAAA,MAAAA;AAAM,CAAmD,EAC3DC,GAAqD,KACnD;EACF,MAAM;AAAE,IAAA,YAAY,EAAEC,SAAS;IAAEC,IAAI;AAAEC,IAAAA,OAAAA;AAAO,GAAE,GAAGJ,MAAM,CAAA;EAEzD,IAAI,MAAM,IAAIA,MAAM,EAAE;IACpB,MAAM;MAAEK,IAAI;MAAEC,MAAM;AAAEF,MAAAA,OAAO,EAAEG,WAAAA;AAAW,KAAE,GAAGP,MAAM,CAAA;IACrD,oBACEQ,GAAA,CAACC,IAAI,EAAA;AACHR,MAAAA,GAAG,EAAEA,GAAoC;AACzCI,MAAAA,IAAI,EAAEA,IAAK;AACXC,MAAAA,MAAM,EAAEA,MAAO;AACf,MAAA,YAAA,EAAYJ,SAAU;AACtBE,MAAAA,OAAO,EAAEG,WAAY;AAAAG,MAAAA,QAAA,EAEpBP,IAAAA;AAAI,KACD,CAAC,CAAA;AAEX,GAAA;EAEA,oBACEK,GAAA,CAACG,MAAM,EAAA;AACLV,IAAAA,GAAG,EAAEA,GAAoC;AACzCW,IAAAA,SAAS,EAAC,mBAAmB;AAC7BC,IAAAA,QAAQ,EAAC,UAAU;AACnBC,IAAAA,IAAI,EAAC,IAAI;AACT,IAAA,YAAA,EAAYZ,SAAU;AACtBE,IAAAA,OAAO,EAAEA,OAAQ;AAAAM,IAAAA,QAAA,EAEhBP,IAAAA;AAAI,GACC,CAAC,CAAA;AAEb,CAAC,CACF,CAAA;AAEDN,YAAY,CAACkB,WAAW,GAAG,cAAc,CAAA;AAEzC;;;;;;;;;;AAUG;AACH,MAAMC,MAAM,gBAAmClB,cAAK,CAACC,UAAU,CAC7D,CACE;AAAEkB,EAAAA,EAAE,GAAG,IAAI;EAAEjB,MAAM;EAAEY,SAAS;EAAEM,MAAM;EAAEC,KAAK;AAAEC,EAAAA,KAAK,GAAG,OAAO;EAAE,GAAGC,KAAAA;AAAK,CAAE,EAC1EpB,GAAuE,KACrE;AACF,EAAA,MAAMqB,WAAW,GAAGC,MAAM,CAAoB,IAAI,CAAC,CAAA;AACnD,EAAA,MAAMC,eAAe,GACnBJ,KAAK,KAAK,SAAS,GAAGK,UAAU,CAACC,gBAAgB,GAAGD,UAAU,CAACE,WAAW,CAAA;AAC5E,EAAA,MAAMC,aAAa,GAAGC,IAAI,CAAC,WAAW,EAAEjB,SAAS,EAAE;IACjD,oBAAoB,EAAEQ,KAAK,KAAK,SAAS;AACzC,IAAA,kBAAkB,EAAE,CAACpB,MAAM,IAAIiB,EAAE,KAAK,QAAA;AACvC,GAAA,CAAC,CAAA;AAEF,EAAA,MAAMa,WAAW,GAAG;AAClBlB,IAAAA,SAAS,EAAEgB,aAAa;AACxB,IAAA,aAAa,EAAEV,MAAAA;GAChB,CAAA;AAEDa,EAAAA,SAAS,CAAC,MAAK;AACb,IAAA,IAAId,EAAE,KAAK,QAAQ,IAAIK,WAAW,CAACU,OAAO,EAAE;MAC1C,MAAM;AAAEC,QAAAA,aAAAA;OAAe,GAAGX,WAAW,CAACU,OAAO,CAAA;AAC7C,MAAA,IAAI,CAACC,aAAa,IAAIA,aAAa,CAACC,OAAO,CAACC,WAAW,EAAE,KAAK,UAAU,EAAE;AACxEC,QAAAA,OAAO,CAACC,IAAI,CACV,oGAAoG,CACrG,CAAA;AACH,OAAA;AACF,KAAA;AACF,GAAC,EAAE,CAACpB,EAAE,CAAC,CAAC,CAAA;AAER,EAAA,IAAI,CAACjB,MAAM,IAAIiB,EAAE,KAAK,QAAQ,EAAE;IAC9B,oBACET,GAAA,CAAC8B,KAAK,EAAA;AAACrC,MAAAA,GAAG,EAAEqB,WAAY;AAACL,MAAAA,EAAE,EAAEA,EAAG;AAACsB,MAAAA,IAAI,EAAEf,eAAgB;AAAA,MAAA,GAAKM,WAAW;AAAA,MAAA,GAAMT,KAAK;AAAAX,MAAAA,QAAA,EAC/ES,KAAAA;AAAK,KACD,CAAC,CAAA;AAEZ,GAAA;AAEA,EAAA,MAAMqB,SAAS,gBAAG1C,cAAK,CAAC2C,SAAS,EAAyC,CAAA;AAE1E,EAAA,oBACEC,IAAA,CAAA,KAAA,EAAA;AAAA,IAAA,GAASZ,WAAW;AAAA,IAAA,GAAMT,KAAK;AAAEpB,IAAAA,GAAG,EAAEA,GAAiC;IAAAS,QAAA,EAAA,cACrEF,GAAA,CAAC8B,KAAK,EAAA;AAACrB,MAAAA,EAAE,EAAEA,EAAG;AAACsB,MAAAA,IAAI,EAAEf,eAAgB;AAACZ,MAAAA,SAAS,EAAC,kBAAkB;AAAAF,MAAAA,QAAA,EAC/DS,KAAAA;AAAK,KACD,CACP,eAAAX,GAAA,CAACX,YAAY,EAAA;AAACI,MAAAA,GAAG,EAAEuC,SAAU;AAACxC,MAAAA,MAAM,EAAEA,MAAAA;AAAO,KAC/C,CAAA,CAAA;AAAA,GAAK,CAAC,CAAA;AAEV,CAAC,EACF;AAEDgB,MAAM,CAACD,WAAW,GAAG,QAAQ;;;;"}

package/build/index.js

@@ -201,7 +201,7 @@ exports.DropFade = DropFade.default;
 exports.Emphasis = Emphasis.default;
 exports.Field = Field.Field;
 exports.FlowNavigation = FlowNavigation.default;
-exports.Header = Header.Header;
+exports.Header = Header.default;
 Object.defineProperty(exports, "InfoPresentation", {
 	enumerable: true,
 	get: function () { return infoPresentations.InfoPresentation; }

package/build/index.mjs

@@ -46,7 +46,7 @@ export { default as DropFade } from './dropFade/DropFade.mjs';
 export { default as Emphasis } from './emphasis/Emphasis.mjs';
 export { Field } from './field/Field.mjs';
 export { default as FlowNavigation } from './flowNavigation/FlowNavigation.mjs';
-export { Header } from './header/Header.mjs';
+export { default as Header } from './header/Header.mjs';
 export { InfoPresentation } from './info/infoPresentations.mjs';
 export { default as Info } from './info/Info.mjs';
 export { default as InlineAlert } from './inlineAlert/InlineAlert.mjs';

package/build/inputs/SelectInput.js

@@ -603,7 +603,7 @@ function SelectInputGroupItemView({
   needle
 }) {
   const headerId = React.useId();
-  const header = /*#__PURE__*/jsxRuntime.jsx(Header.Header, {
+  const header = /*#__PURE__*/jsxRuntime.jsx(Header.default, {
     as: "header",
     role: "none",
     id: headerId,