Heading.tsx

import { type ReactElement, type ReactNode } from "react";
import Typography from "../Typography/Typography";
import { useTheme } from "../ThemeProvider/ThemeProvider";

/**
 * [Heading](https://cambly-syntax.vercel.app/?path=/docs/components-heading--docs) enforces a consistent style & accessibility best practices for headings.
 */
const Heading = ({
  align = "start",
  as = "h1",
  children,
  color = "gray900",
  "data-testid": dataTestId,
  fontStyle,
  lineClamp,
  size = 500,
}: {
  /**
   * Aligns the text to the left, right, or center of the container.
   * * `start` and `end` will align the text to the left or right of the container depending on the locale.
   * * `forceLeft` and `forceRight` will align the text to the left or right of the container regardless of the locale (should be used sparingly).
   *
   * @defaultValue "start"
   */
  align?: "start" | "end" | "forceLeft" | "center" | "forceRight";
  /**
   * DOM element to render as.
   *
   * @defaultValue "h1"
   */
  as?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
  /**
   * The text to be rendered
   */
  children?: ReactNode;
  /**
   * The color of the text.
   *
   * @defaultValue "gray900"
   */
  color?:
    | "gray900"
    | "gray700"
    | "primary"
    | "destructive-primary"
    | "success"
    | "white"
    | "inherit"
    | "black";
  /**
   * Test id for the text.
   */
  "data-testid"?: string;
  /**
   * Style of the font
   *
   * Classic only supports `sans-serif`
   *
   * @defaultValue "sans-serif"
   */
  fontStyle?: "serif" | "sans-serif";
  /**
   * The number of lines we should truncate the text at
   */
  lineClamp?: number | undefined;
  /**
   * Size of the text.
   *
   * Classic:
   * * `500`: 20px
   * * `600`: 28px
   * * `700`: 40px
   * * `800`: 64px
   *
   * Cambio Mobile:
   * * `400`: 20px
   * * `500`: 23px
   * * `600`: 26px
   * * `700`: 29px
   * * `800`: 33px
   * * `900`: 37px
   * * `1000`: 41px
   * * `1100`: 46px
   *
   * Cambio Desktop (viewport width > 480px):
   * * `400`: 25px
   * * `500`: 31px
   * * `600`: 39px
   * * `700`: 49px
   * * `800`: 61px
   * * `900`: 76px
   * * `1000`: 95px
   * * `1100`: 119px
   *
   * @defaultValue 500
   */
  size?: 400 | 500 | 600 | 700 | 800 | 900 | 1000 | 1100;
}): ReactElement => {
  const { themeName } = useTheme();
  const classicWeight = [700, 800].includes(size) ? "heavy" : "bold";
  const cambioWeight = fontStyle === "serif" ? "medium" : "regular";

  return (
    <Typography
      align={align}
      as={as}
      color={color}
      fontStyle={fontStyle}
      data-testid={dataTestId}
      lineClamp={lineClamp}
      size={size}
      weight={themeName === "classic" ? classicWeight : cambioWeight}
    >
      {children}
    </Typography>
  );
};

export default Heading;