uikit-react-public 0.17.4 → 0.21.9

package/lib/components/Heading/Heading.tsx

@@ -1,94 +1,225 @@
-import { memo, HTMLAttributes, forwardRef } from 'react';
+import { memo, HTMLAttributes, JSX } from 'react';
 import { css, cx } from '@emotion/css';
 import useTheme from '../../theme/useTheme';
 import marginsStyle, { MarginProps } from '../common/marginsStyle';
 
 export const NAME = 'ucl-uikit-heading';
 
+export type HeadingLevel = 'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs';
+
 export interface HeadingBaseProps extends HTMLAttributes<HTMLHeadingElement> {
-  level?: 1 | 2 | 3 | 4;
-  margins?: boolean; // todo: deprecate
+  level?: HeadingLevel | 1 | 2 | 3 | 4;
+  as?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'div' | 'span';
+  margins?: boolean; // deprecated
   testId?: string;
+  ref?: React.Ref<HTMLHeadingElement>;
 }
 
 export type HeadingProps = HeadingBaseProps & MarginProps;
 
-export type Ref = HTMLHeadingElement;
-
-const Heading = forwardRef<Ref, HeadingProps>(
-  ({ level = 1, margins = true, testId = NAME, className, ...props }, ref) => {
+const Heading = memo(
+  ({
+    level = 1,
+    as,
+    margins = true,
+    testId = NAME,
+    className,
+    ref,
+    noMargins,
+    ...props
+  }: HeadingProps) => {
     const [theme] = useTheme();
 
     const {
-      font: { size, lineHeight },
+      typography: {
+        heading: { xxl, xl, lg, md, sm, xs },
+      },
     } = theme;
 
-    const level1Style = css`
-      font-size: ${size.f36};
-      line-height: ${lineHeight.h130};
-      @media screen and (min-width: ${theme.breakpoints.desktop}px) {
-        font-size: ${size.f40};
+    const mappedLevel: HeadingLevel =
+      level === 1
+        ? 'xxl'
+        : level === 2
+          ? 'xl'
+          : level === 3
+            ? 'lg'
+            : level === 4
+              ? 'md'
+              : level;
+
+    const defaultHeadingTag =
+      mappedLevel === 'xxl'
+        ? 'h1'
+        : mappedLevel === 'xl'
+          ? 'h2'
+          : mappedLevel === 'lg'
+            ? 'h3'
+            : mappedLevel === 'md'
+              ? 'h4'
+              : mappedLevel === 'sm'
+                ? 'h5'
+                : 'h6';
+
+    const baseStyle = css`
+      font-family: ${md.md.fontFamily};
+      font-feature-settings: ${md.md.fontSettings};
+      color: ${theme.colour.text.default};
+      margin: 0;
+    `;
+
+    const levelXxlStyle = css`
+      font-size: ${xxl.sm.fontSize}px;
+      font-weight: ${xxl.sm.fontWeight};
+      line-height: ${xxl.sm.lineHeight}%;
+      @media screen and (min-width: ${theme.breakpoints.tablet}px) {
+        font-size: ${xxl.md.fontSize}px;
+        font-weight: ${xxl.md.fontWeight};
+        line-height: ${xxl.md.lineHeight}%;
       }
     `;
 
-    const level2Style = css`
-      font-size: ${size.f28};
-      line-height: ${lineHeight.h140};
-      @media screen and (min-width: ${theme.breakpoints.desktop}px) {
-        font-size: ${size.f32};
-        line-height: ${lineHeight.h130};
+    const levelXlStyle = css`
+      font-size: ${xl.sm.fontSize}px;
+      font-weight: ${xl.sm.fontWeight};
+      line-height: ${xl.sm.lineHeight}%;
+      @media screen and (min-width: ${theme.breakpoints.tablet}px) {
+        font-size: ${xl.md.fontSize}px;
+        font-weight: ${xl.md.fontWeight};
+        line-height: ${xl.md.lineHeight}%;
       }
     `;
 
-    const level3Style = css`
-      font-size: ${size.f20};
-      line-height: ${lineHeight.h140};
-      @media screen and (min-width: ${theme.breakpoints.desktop}px) {
-        font-size: ${size.f24};
+    const levelLgStyle = css`
+      font-size: ${lg.sm.fontSize}px;
+      font-weight: ${lg.sm.fontWeight};
+      line-height: ${lg.sm.lineHeight}%;
+      @media screen and (min-width: ${theme.breakpoints.tablet}px) {
+        font-size: ${lg.md.fontSize}px;
+        font-weight: ${lg.md.fontWeight};
+        line-height: ${lg.md.lineHeight}%;
       }
     `;
 
-    const level4Style = css`
-      font-size: ${size.f16};
-      line-height: ${lineHeight.h150};
-      @media screen and (min-width: ${theme.breakpoints.desktop}px) {
-        font-size: ${size.f18};
+    const levelMdStyle = css`
+      font-size: ${md.sm.fontSize}px;
+      font-weight: ${md.sm.fontWeight};
+      line-height: ${md.sm.lineHeight}%;
+      @media screen and (min-width: ${theme.breakpoints.tablet}px) {
+        font-size: ${md.md.fontSize}px;
+        font-weight: ${md.md.fontWeight};
+        line-height: ${md.md.lineHeight}%;
       }
     `;
 
-    const baseStyle = css`
-      font-family: ${theme.font.family.primary};
-      font-weight: bold;
-      color: ${theme.color.text.primary};
+    const levelSmStyle = css`
+      font-size: ${sm.sm.fontSize}px;
+      font-weight: ${sm.sm.fontWeight};
+      line-height: ${sm.sm.lineHeight}%;
+      @media screen and (min-width: ${theme.breakpoints.tablet}px) {
+        font-size: ${sm.md.fontSize}px;
+        font-weight: ${sm.md.fontWeight};
+        line-height: ${sm.md.lineHeight}%;
+      }
     `;
 
-    const noMarginsStyle = css`
-      margin: 0;
+    const levelXsStyle = css`
+      font-size: ${xs.sm.fontSize}px;
+      font-weight: ${xs.sm.fontWeight};
+      line-height: ${xs.sm.lineHeight}%;
+      @media screen and (min-width: ${theme.breakpoints.tablet}px) {
+        font-size: ${xs.md.fontSize}px;
+        font-weight: ${xs.md.fontWeight};
+        line-height: ${xs.md.lineHeight}%;
+      }
     `;
 
     const style = cx(
       NAME,
       baseStyle,
-      marginsStyle(props, theme),
-      level === 1 && level1Style,
-      level === 2 && level2Style,
-      level === 3 && level3Style,
-      level === 4 && level4Style,
-      margins === false && noMarginsStyle,
+      mappedLevel === 'xxl' && levelXxlStyle,
+      mappedLevel === 'xl' && levelXlStyle,
+      mappedLevel === 'lg' && levelLgStyle,
+      mappedLevel === 'md' && levelMdStyle,
+      mappedLevel === 'sm' && levelSmStyle,
+      mappedLevel === 'xs' && levelXsStyle,
+      marginsStyle(
+        { ...props, noMargins: noMargins || margins === false },
+        theme
+      ),
       className
     );
 
-    const HeadingTag = `h${level}` as 'h1' | 'h2' | 'h3' | 'h4';
+    const headingTag = (as || defaultHeadingTag) as keyof JSX.IntrinsicElements;
 
     return (
-      <HeadingTag
-        ref={ref}
-        className={style}
-        data-testid={testId}
-        {...props}
-      />
+      <>
+        {headingTag === 'h1' && (
+          <h1
+            ref={ref}
+            className={style}
+            data-testid={testId}
+            {...props}
+          />
+        )}
+        {headingTag === 'h2' && (
+          <h2
+            ref={ref}
+            className={style}
+            data-testid={testId}
+            {...props}
+          />
+        )}
+        {headingTag === 'h3' && (
+          <h3
+            ref={ref}
+            className={style}
+            data-testid={testId}
+            {...props}
+          />
+        )}
+        {headingTag === 'h4' && (
+          <h4
+            ref={ref}
+            className={style}
+            data-testid={testId}
+            {...props}
+          />
+        )}
+        {headingTag === 'h5' && (
+          <h5
+            ref={ref}
+            className={style}
+            data-testid={testId}
+            {...props}
+          />
+        )}
+        {headingTag === 'h6' && (
+          <h6
+            ref={ref}
+            className={style}
+            data-testid={testId}
+            {...props}
+          />
+        )}
+        {headingTag === 'span' && (
+          <span
+            ref={ref as React.Ref<HTMLSpanElement>}
+            className={style}
+            data-testid={testId}
+            {...props}
+          />
+        )}
+        {headingTag === 'div' && (
+          <div
+            ref={ref as React.Ref<HTMLDivElement>}
+            className={style}
+            data-testid={testId}
+            {...props}
+          />
+        )}
+      </>
     );
   }
 );
 
-export default memo(Heading);
+export default Heading;

package/lib/components/Heading/__tests__/__snapshots__/Heading.test.tsx.snap

@@ -2,7 +2,7 @@
 
 exports[`Heading > snapshot: custom test id 1`] = `
 <h1
-  class="ucl-uikit-heading css-1bjykaw"
+  class="ucl-uikit-heading css-7nmnfv"
   data-testid="custom-test-id"
 >
   This is a test
@@ -11,7 +11,7 @@ exports[`Heading > snapshot: custom test id 1`] = `
 
 exports[`Heading > snapshot: level 1`] = `
 <h1
-  class="ucl-uikit-heading css-1bjykaw"
+  class="ucl-uikit-heading css-7nmnfv"
   data-testid="ucl-uikit-heading"
 >
   Level 1
@@ -20,7 +20,7 @@ exports[`Heading > snapshot: level 1`] = `
 
 exports[`Heading > snapshot: minimal props 1`] = `
 <h1
-  class="ucl-uikit-heading css-1bjykaw"
+  class="ucl-uikit-heading css-7nmnfv"
   data-testid="ucl-uikit-heading"
 >
   This is a test
@@ -29,7 +29,7 @@ exports[`Heading > snapshot: minimal props 1`] = `
 
 exports[`Heading > snapshot: no margins 1`] = `
 <h1
-  class="ucl-uikit-heading css-x9klp3"
+  class="ucl-uikit-heading css-kt47of"
   data-testid="ucl-uikit-heading"
 >
   No margins

package/lib/components/Icon/__tests__/__snapshots__/Icon.test.tsx.snap

@@ -5,11 +5,12 @@ exports[`Icon > Snapshot: title prop 1`] = `
   class="ucl-uikit-icon css-148hpxb"
   data-testid="ucl-uikit-icon"
   fill="none"
+  focusable="false"
   height="24"
   stroke="currentColor"
   stroke-linecap="round"
   stroke-linejoin="round"
-  stroke-width="3"
+  stroke-width="2"
   viewBox="0 0 24 24"
   width="24"
   xmlns="http://www.w3.org/2000/svg"
@@ -17,8 +18,8 @@ exports[`Icon > Snapshot: title prop 1`] = `
   <title>
     Custom Title
   </title>
-  <polyline
-    points="20 6 9 17 4 12"
+  <path
+    d="M20 6 9 17l-5-5"
   />
 </svg>
 `;
@@ -28,17 +29,18 @@ exports[`Icon > snapshot: className prop 1`] = `
   class="ucl-uikit-icon css-148hpxb a-class-name"
   data-testid="ucl-uikit-icon"
   fill="none"
+  focusable="false"
   height="24"
   stroke="currentColor"
   stroke-linecap="round"
   stroke-linejoin="round"
-  stroke-width="3"
+  stroke-width="2"
   viewBox="0 0 24 24"
   width="24"
   xmlns="http://www.w3.org/2000/svg"
 >
-  <polyline
-    points="20 6 9 17 4 12"
+  <path
+    d="M20 6 9 17l-5-5"
   />
 </svg>
 `;
@@ -48,17 +50,18 @@ exports[`Icon > snapshot: no props 1`] = `
   class="ucl-uikit-icon css-148hpxb"
   data-testid="ucl-uikit-icon"
   fill="none"
+  focusable="false"
   height="24"
   stroke="currentColor"
   stroke-linecap="round"
   stroke-linejoin="round"
-  stroke-width="3"
+  stroke-width="2"
   viewBox="0 0 24 24"
   width="24"
   xmlns="http://www.w3.org/2000/svg"
 >
-  <polyline
-    points="20 6 9 17 4 12"
+  <path
+    d="M20 6 9 17l-5-5"
   />
 </svg>
 `;
@@ -68,17 +71,18 @@ exports[`Icon > snapshot: size prop 1`] = `
   class="ucl-uikit-icon css-148hpxb"
   data-testid="ucl-uikit-icon"
   fill="none"
+  focusable="false"
   height="32"
   stroke="currentColor"
   stroke-linecap="round"
   stroke-linejoin="round"
-  stroke-width="3"
+  stroke-width="2"
   viewBox="0 0 24 24"
   width="32"
   xmlns="http://www.w3.org/2000/svg"
 >
-  <polyline
-    points="20 6 9 17 4 12"
+  <path
+    d="M20 6 9 17l-5-5"
   />
 </svg>
 `;