@carrier-dpx/air-react-library 0.2.2 → 0.4.0

package/README.md

@@ -80,6 +80,69 @@ function App() {
 - `onClick`: `() => void` - Click handler
 - All standard Material-UI Button props
 
+### Typography Component
+
+```tsx
+import { Typography } from '@carrier-dpx/air-react-library';
+
+function App() {
+  return (
+    <>
+      <Typography variant="h1">Heading 1</Typography>
+      <Typography variant="body1">Regular body text</Typography>
+      <Typography variant="body1Semibold">Semibold body text</Typography>
+      <Typography variant="caps2">UPPERCASE TEXT</Typography>
+    </>
+  );
+}
+```
+
+#### Available Typography Variants
+
+- **Headings**: `h1`, `h2`, `h3`, `h4`, `h5`, `h6`
+- **Body**: `body1`, `body1Semibold`, `body1Bold`, `body2`, `body2Semibold`, `body2Bold`, `body3`, `body3Semibold`, `body3Bold`
+- **Caps**: `caps1`, `caps1Bold`, `caps2`, `caps2Bold`, `caps3`, `caps3Bold`, `caps4`, `caps4Bold`
+- All standard Material-UI Typography props
+
+### TextField Component
+
+```tsx
+import { TextField } from '@carrier-dpx/air-react-library';
+
+function App() {
+  return (
+    <>
+      <TextField
+        label="Email"
+        placeholder="Enter your email"
+        size="large"
+        showBorder
+      />
+      <TextField
+        label="Password"
+        type="password"
+        placeholder="Enter your password"
+        size="large"
+        error
+        helperText="Password is required"
+      />
+    </>
+  );
+}
+```
+
+#### Available TextField Props
+
+- **size**: `xlarge`, `large` (default), `medium`, `small`
+- **color**: `primary`, `error`, `success`, `warning`, `info`
+- **error**: `boolean` - Shows error state
+- **disabled**: `boolean` - Disables the field
+- **showBorder**: `boolean` - Shows border around field
+- **hideBackgroundColor**: `boolean` - Removes background color
+- **characterCounter**: `boolean` - Shows character count
+- **characterMax**: `number` - Max character limit
+- All standard Material-UI TextField props
+
 ## Figma Integration
 
 This library is integrated with Figma Code Connect. When using Figma Make, components from this library will be automatically suggested and used in generated code.
@@ -89,6 +152,8 @@ This library is integrated with Figma Code Connect. When using Figma Make, compo
 Currently available components:
 
 - **Button** - Material-UI based button component with Carrier DPX design system styling
+- **Typography** - Text component with all Carrier DPX typography variants (h1-h6, body1-3, caps, etc.)
+- **TextField** - Input field component with Carrier DPX styling (supports multiple sizes, colors, validation states)
 
 More components coming soon!
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carrier-dpx/air-react-library",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "Air web React component library for Figma Make",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/components/TextField/TextField.figma.tsx

@@ -0,0 +1,76 @@
+/**
+ * Figma Code Connect Configuration for TextField Component
+ * 
+ * Maps Figma TextField component to React TextField component
+ */
+
+import figma from "@figma/code-connect";
+import TextField from "./TextField";
+
+figma.connect(
+  TextField,
+  "https://www.figma.com/design/vkoHdM6rchIhH9IWetZeP0/Air--Components?node-id=18128-89412",
+  {
+    props: {
+      /**
+       * SIZE MAPPING
+       * Maps Figma size format (with px values) to React size prop
+       */
+      size: figma.enum("size", {
+        "xlarge-56px": "xlarge",
+        "large-48px": "large",
+        "medium-40px": "medium",
+        "small-32px": "small",
+      }),
+
+      /**
+       * COLOR MAPPING
+       * Maps Figma color variants to React color prop
+       */
+      color: figma.enum("color", {
+        primary: "primary",
+        error: "error",
+        success: "success",
+        warning: "warning",
+        info: "info",
+      }),
+
+      /**
+       * ERROR STATE
+       * Maps Figma error boolean to React error prop
+       */
+      error: figma.boolean("error"),
+
+      /**
+       * DISABLED STATE
+       * Maps Figma disabled boolean to React disabled prop
+       */
+      disabled: figma.boolean("disabled"),
+
+      /**
+       * SHOW BORDER
+       * Maps Figma showBorder boolean to React showBorder prop
+       */
+      showBorder: figma.boolean("showBorder"),
+    },
+
+    /**
+     * CODE EXAMPLE TEMPLATE
+     * 
+     * Shows how TextField should be used in React code
+     * Note: label, placeholder, value, onChange etc. are runtime props
+     * that aren't configured in Figma's static component
+     */
+    example: ({ size, color, error, disabled, showBorder }) => (
+      <TextField
+        size={size}
+        color={color}
+        error={error}
+        disabled={disabled}
+        showBorder={showBorder}
+        label="Email"
+        placeholder="Enter your email"
+      />
+    ),
+  }
+);

package/src/components/TextField/TextField.tsx

@@ -0,0 +1,253 @@
+import { forwardRef, useState, ChangeEvent } from "react";
+
+import MuiTextField, {
+  StandardTextFieldProps as MuiTextFieldProps,
+} from "@mui/material/TextField";
+import { InputProps } from "@mui/material/Input";
+import { InputMaxHeightMap } from "../utils/HeightUtils";
+import { getSxStyles } from "../utils/styles";
+import { CSSObject } from "@mui/material";
+import { fleetPalette } from "../theme";
+import { styleTokens } from "../theme/constants/styleTokens";
+
+declare module "@mui/material/TextField" {
+  interface TextFieldPropsSizeOverrides {
+    xlarge: true;
+    large: true;
+  }
+}
+export interface TextFieldInputProps
+  extends Omit<InputProps, "disableUnderline"> {}
+
+export interface TextFieldProps
+  extends Omit<
+    MuiTextFieldProps,
+    "variant" | "margin" | "classes" | "hiddenLabel"
+  > {
+  /** Set to true to remove background color. */
+  hideBackgroundColor?: boolean;
+
+  /** Input Node for Child Input. */
+  inputSetting?: TextFieldInputProps;
+
+  // Renamed 'hiddenLabel' to hideLabel for consistency.
+  /**
+   * If `true`, the label is hidden.
+   * This is used to increase density for a `FilledInput`.
+   * Be sure to add `aria-label` to the `input` element.
+   * @default false
+   */
+  hideLabel?: boolean;
+
+  /** Set to true to show a border around the TextField.*/
+  showBorder?: boolean;
+
+  /** Toggles the counter visibility. Setting to `true` will display the counter and respect the characterMax if set. `false` will hide the counter and ignore `characterMax`.
+   * @default false
+   */
+  characterCounter?: boolean;
+
+  /** Sets a counter character limit while `characterCounter` is enabled. */
+  characterMax?: number;
+}
+
+/** The TextField component allows users to enter or edit free-form text data.
+ *
+ * `import TextField from '@carrier-io/air-react/TextField'`
+ */
+
+const TextField = forwardRef<HTMLDivElement, TextFieldProps>(
+  (
+    {
+      hideBackgroundColor = false,
+      inputSetting = {},
+      InputProps = {},
+      label,
+      showBorder = false,
+      size = "large",
+      type = "text",
+      sx = {},
+      hideLabel,
+      InputLabelProps = {},
+      FormHelperTextProps = {},
+      helperText,
+      characterCounter,
+      characterMax,
+      defaultValue,
+      onChange,
+      ...rest
+    },
+    ref
+  ) => {
+    const [value, setValue] = useState<string | number>(
+      defaultValue as string | number
+    );
+
+    const handleChange = (event: ChangeEvent) => {
+      const targetValue = (event.target as HTMLInputElement).value;
+      if (
+        characterCounter &&
+        characterMax &&
+        targetValue?.length > characterMax
+      ) {
+        return;
+      }
+      if (onChange) {
+        onChange(event as ChangeEvent<HTMLInputElement>);
+      }
+      setValue(targetValue);
+    };
+
+    const joinInputLabelProps = {
+      sx: {
+        ...(showBorder ? { paddingLeft: "2px" } : { paddingLeft: "0px" }),
+        "& .MuiInputLabel-asterisk": {
+          color: fleetPalette.base?.filledInput.required,
+        },
+        "&.Mui-focused .MuiInputLabel-asterisk": {
+          color: "inherit",
+        },
+
+        ...InputLabelProps.sx,
+      },
+      ...InputLabelProps,
+    };
+
+    const joinFormHelperTextProps: typeof FormHelperTextProps = {
+      sx: {
+        whiteSpace: "nowrap",
+        overflow: "hidden",
+        textOverflow: "ellipsis",
+        m: "2px",
+        pl: "2px",
+        ...FormHelperTextProps.sx,
+      },
+      ...FormHelperTextProps,
+    };
+
+    const input = {
+      ...InputProps,
+      ...inputSetting,
+      disableUnderline: true,
+      size: size,
+    };
+
+    const inputSx = input.sx;
+
+    input.sx = (theme) =>
+      ({
+        ...getSxStyles(theme, inputSx),
+        // Conditionally apply properties
+        ...(!rest.multiline && { height: InputMaxHeightMap[size] }),
+        ...(!showBorder && !rest.error && { border: "0px!important" }),
+        ...(hideBackgroundColor && { backgroundColor: "inherit!important" }),
+        borderRadius: `${styleTokens.borderRadius.large}`,
+        "&.MuiInputBase-root": {
+          "&:hover": {
+            backgroundColor: `${fleetPalette.base?.filledInput.backgroundHover} !important`,
+          },
+        },
+      } as CSSObject);
+
+    const getHelperText = () => {
+      return (
+        <>
+          {helperText}
+          {characterCounter && (
+            <span
+              style={{
+                float: "right",
+                padding: `0px 2px`,
+              }}
+            >
+              {value ? value?.toString().length : "0"}
+              {!!characterMax && `/${characterMax}`}
+            </span>
+          )}
+        </>
+      );
+    };
+
+    let largeSizeLabelValue: string | number;
+    if (size === "large") {
+      largeSizeLabelValue = "16px";
+    } else if (size === "xlarge") {
+      largeSizeLabelValue = "24px";
+    } else {
+      largeSizeLabelValue = 0;
+    }
+
+    const largeSizeLabelSX = {
+      "& .MuiFormLabel-root": {
+        lineHeight: largeSizeLabelValue,
+      },
+    };
+
+    return (
+      <MuiTextField
+        variant="filled"
+        type={type}
+        margin={size === "medium" ? "dense" : "none"}
+        color={rest.error ? "error" : rest.color}
+        hiddenLabel={size === "small" || size === "medium" || hideLabel}
+        InputProps={input}
+        InputLabelProps={joinInputLabelProps}
+        FormHelperTextProps={joinFormHelperTextProps}
+        helperText={getHelperText()}
+        onChange={handleChange}
+        value={value}
+        sx={(theme) =>
+          ({
+            ...getSxStyles(theme, sx),
+            "& .MuiInputBase-root.MuiFilledInput-root": {
+              borderRadius: `${styleTokens.borderRadius.large}`,
+              "& .MuiInputBase-input::placeholder": {
+                color: fleetPalette.base?.filledInput.placeholderLabel,
+              },
+              "& .MuiInputBase-input.MuiFilledInput-input::-webkit-input-placeholder":
+                {
+                  opacity: "unset",
+                },
+            },
+
+            ...((size === "large" || size === "xlarge") && largeSizeLabelSX),
+            "& .MuiInputBase-root.Mui-focused": {
+              backgroundColor:
+                fleetPalette.base?.background.paper + " !important",
+              ...((rest.error === false || rest.error === undefined) && {
+                "&.MuiInputBase-colorPrimary": {
+                  border: `1px solid ${theme.palette.primary.main} !important`,
+                },
+                "&.MuiInputBase-colorSecondary": {
+                  border: `1px solid ${theme.palette.secondary.main} !important`,
+                },
+                "&.MuiInputBase-colorBase": {
+                  border: `1px solid ${theme.palette.base?.main} !important`,
+                },
+                "&.MuiInputBase-colorWarning": {
+                  border: `1px solid ${theme.palette.warning.main} !important`,
+                },
+                "&.MuiInputBase-colorSuccess": {
+                  border: `1px solid ${theme.palette.success.main} !important`,
+                },
+                "&.MuiInputBase-colorInfo": {
+                  border: `1px solid ${theme.palette.info.main} !important`,
+                },
+                "&.MuiInputBase-colorError": {
+                  border: `1px solid ${theme.palette.error.main} !important`,
+                },
+              }),
+            },
+          } as CSSObject)
+        }
+        label={!(size === "small" || size === "medium" || hideLabel) && label}
+        {...rest}
+        ref={ref}
+      />
+    );
+  }
+);
+
+TextField.displayName = "TextField";
+
+export default TextField;

package/src/components/TextField/index.ts

@@ -0,0 +1,3 @@
+export { default } from "./TextField";
+export * from "./TextField";
+export type { TextFieldProps, TextFieldInputProps } from "./TextField";

package/src/components/Typography/Typography.figma.tsx

@@ -0,0 +1,66 @@
+/**
+ * Figma Code Connect Configuration for Typography Component
+ * 
+ * Maps Figma Typography component to React Typography component
+ */
+
+import figma from "@figma/code-connect";
+import Typography from "./Typography";
+
+figma.connect(
+  Typography,
+  "https://www.figma.com/design/vkoHdM6rchIhH9IWetZeP0/Air--Components?node-id=10984-58055",
+  {
+    props: {
+      /**
+       * VARIANT MAPPING
+       * Maps Figma's "variant" property to React's "variant" prop
+       * 
+       * Figma variant names with spaces need to be converted to camelCase for React
+       */
+      variant: figma.enum("variant", {
+        body1: "body1",
+        "body1 semibold": "body1Semibold",
+        "body1 bold": "body1Bold",
+        body2: "body2",
+        "body2 semibold": "body2Semibold",
+        "body2 bold": "body2Bold",
+        body3: "body3",
+        "body3 semibold": "body3Semibold",
+        "body3 bold": "body3Bold",
+        h1: "h1",
+        h2: "h2",
+        h3: "h3",
+        h4: "h4",
+        h5: "h5",
+        h6: "h6",
+        caps1: "caps1",
+        "caps1 bold": "caps1Bold",
+        caps2: "caps2",
+        "caps2 bold": "caps2Bold",
+        caps3: "caps3",
+        "caps3 bold": "caps3Bold",
+        caps4: "caps4",
+        "caps4 bold": "caps4Bold",
+      }),
+
+      /**
+       * TEXT CONTENT
+       * Maps the text content from Figma's "Label" layer
+       * This is the editable text in the Typography component
+       */
+      children: figma.children("Label"),
+    },
+
+    /**
+     * CODE EXAMPLE TEMPLATE
+     * 
+     * Shows how the Typography component should be used in React code
+     */
+    example: ({ variant, children }) => (
+      <Typography variant={variant}>
+        {children}
+      </Typography>
+    ),
+  }
+);

package/src/components/Typography/Typography.tsx

@@ -0,0 +1,17 @@
+import { forwardRef } from "react";
+import MuiTypography from "@mui/material/Typography";
+import { TypographyProps } from "./types";
+
+/** The Typography component provides access to available font variations within the FDS theme and is useful for creating content hierarchy and instance swapping.
+ *
+ * `import Typography from '@carrier-io/air-react/Typography'`
+ */
+const Typography = forwardRef<HTMLSpanElement, TypographyProps>(
+  (props, ref) => {
+    return <MuiTypography {...props} ref={ref} />;
+  }
+);
+
+Typography.displayName = "Typography";
+
+export default Typography;

package/src/components/Typography/index.ts

@@ -0,0 +1,2 @@
+export { default } from "./Typography";
+export * from "./types";

package/src/components/Typography/types.ts

@@ -0,0 +1,185 @@
+import { ElementType, CSSProperties } from "react";
+import { ResponsiveStyleValue, AllSystemCSSProperties } from "@mui/system";
+import { TypographyProps as MuiTypographyProps } from "@mui/material/Typography";
+
+export interface AdditionalTypographyVariants {
+  body3: CSSProperties;
+  buttonLarge: CSSProperties;
+  buttonMedium: CSSProperties;
+  buttonSmall: CSSProperties;
+  avatarLetter: CSSProperties;
+  inputText1: CSSProperties;
+  inputText2: CSSProperties;
+  alertTitle: CSSProperties;
+  tableHeader1: CSSProperties;
+  tableHeader2: CSSProperties;
+  inputLabel: CSSProperties;
+  chip: CSSProperties;
+  helperText: CSSProperties;
+  badge: CSSProperties;
+  tooltip: CSSProperties;
+  body1Semibold: CSSProperties;
+  body1Bold: CSSProperties;
+  body2Semibold: CSSProperties;
+  body2Bold: CSSProperties;
+  body3Semibold: CSSProperties;
+  body3Bold: CSSProperties;
+  caps1: CSSProperties;
+  caps1Bold: CSSProperties;
+  caps2: CSSProperties;
+  caps2Bold: CSSProperties;
+  caps3: CSSProperties;
+  caps3Bold: CSSProperties;
+  caps4: CSSProperties;
+  caps4Bold: CSSProperties;
+  body4Semibold: CSSProperties;
+}
+
+export interface ExtraTypographyFontWeightOptions {
+  fontWeightExtraLight?: CSSProperties["fontWeight"];
+  fontWeightSemiBold?: CSSProperties["fontWeight"];
+  fontWeightExtraBold?: CSSProperties["fontWeight"];
+  fontWeightBlack?: CSSProperties["fontWeight"];
+}
+
+export type UnnecessaryTypographyVariants = "button";
+
+export type CustomTypographyVariant =
+  | "body3"
+  | "buttonLarge"
+  | "buttonMedium"
+  | "buttonSmall"
+  | "avatarLetter"
+  | "inputLabel"
+  | "chip"
+  | "helperText"
+  | "badge"
+  | "tooltip"
+  | "inputText1"
+  | "inputText2"
+  | "alertTitle"
+  | "tableHeader1"
+  | "tableHeader2"
+  | "body1Semibold"
+  | "body1Bold"
+  | "body2Semibold"
+  | "body2Bold"
+  | "body3Semibold"
+  | "body3Bold"
+  | "caps1"
+  | "caps1Bold"
+  | "caps2"
+  | "caps2Bold"
+  | "caps3"
+  | "caps3Bold"
+  | "caps4"
+  | "caps4Bold"
+  | "body4Semibold";
+
+declare module "@mui/material/styles" {
+  /**
+   * Extended TypographyVariants
+   */
+  interface TypographyVariants
+    extends AdditionalTypographyVariants,
+      ExtraTypographyFontWeightOptions {}
+  /**
+   * Extended TypographyVariantsOptions (allow configuration using `createTheme`)
+   */
+  interface TypographyVariantsOptions
+    extends AdditionalTypographyVariants,
+      ExtraTypographyFontWeightOptions {}
+}
+
+declare module "@mui/material/Typography" {
+  /**
+   * Update the Typography's variant prop options
+   */
+  interface TypographyPropsVariantOverrides {
+    body3: true;
+    button: false;
+    buttonLarge: true;
+    buttonMedium: true;
+    buttonSmall: true;
+    avatarLetter: true;
+    inputText1: true;
+    inputText2: true;
+    alertTitle: true;
+    tableHeader1: true;
+    tableHeader2: true;
+    inputLabel: true;
+    chip: true;
+    helperText: true;
+    badge: true;
+    tooltip: true;
+    body1Semibold: true;
+    body1Bold: true;
+    body2Semibold: true;
+    body2Bold: true;
+    body3Semibold: true;
+    body3Bold: true;
+    caps1: true;
+    caps1Bold: true;
+    caps2: true;
+    caps2Bold: true;
+    caps3: true;
+    caps3Bold: true;
+    caps4: true;
+    caps4Bold: true;
+    body4Semibold: true;
+  }
+}
+
+export interface TypographyProps
+  extends Omit<MuiTypographyProps, "variant" | "variantMapping"> {
+  /**
+   * Applies the theme typography styles.
+   * @default 'body1'
+   */
+  variant?:
+    | Exclude<MuiTypographyProps["variant"], UnnecessaryTypographyVariants>
+    | CustomTypographyVariant;
+  /**
+   * The component maps the variant prop to a range of different HTML element types.
+   * For instance, subtitle1 to `<h6>`.
+   * If you wish to change that mapping, you can provide your own.
+   * Alternatively, you can use the `component` prop.
+   * @default {
+   *   h1: 'h1',
+   *   h2: 'h2',
+   *   h3: 'h3',
+   *   h4: 'h4',
+   *   h5: 'h5',
+   *   h6: 'h6',
+   *   subtitle1: 'h6',
+   *   subtitle2: 'h6',
+   *   body1: 'p',
+   *   body2: 'p',
+   *   body3: 'p',
+   *   inherit: 'p',
+   *   buttonLarge: "span",
+   *   buttonMedium: "span",
+   *   buttonSmall: "span",
+   *   avatarLetter: "span",
+   *   inputText1: "span",
+   *   inputText2: "span",
+   *   alertTitle: "span",
+   *   tableHeader1: "span",
+   *   tableHeader2: "span",
+   *   inputLabel: "span",
+   *   chip: "span",
+   *   helperText: "span",
+   *   badge: "span",
+   *   tooltip: "span",
+   * }
+   */
+  variantMapping?: MuiTypographyProps["variantMapping"];
+  /**
+   * The component used for the root node. Either a string to use a HTML element or a component.
+   */
+  component?: ElementType;
+  /**
+   * Specifies how to capitalize an element's text
+   */
+  textTransform?: ResponsiveStyleValue<AllSystemCSSProperties["textTransform"]>;
+}

package/src/components/utils/HeightUtils.ts

@@ -0,0 +1,38 @@
+export const heightMap = {
+  small: 32,
+  medium: 40,
+  large: 48,
+};
+
+export const InputMaxHeightMap = {
+  small: 32,
+  medium: 40,
+  large: 48,
+  xlarge: 56,
+};
+
+export const InputMaxDividerHeightMap = {
+  small: 16,
+  medium: 24,
+  large: 32,
+  xlarge: 40,
+};
+
+export const AutocompleteInternalHeightMap = {
+  small: "26px",
+  medium: 40,
+  large: 48,
+  xlarge: 56,
+};
+
+export const ChipHeightMap = {
+  micro: 20,
+  xsmall: 24,
+  small: 32,
+};
+
+export const RangeChartHeightMap = {
+  xsmall: 8,
+  small: 16,
+  medium: 24,
+};

package/src/index.ts

@@ -1,3 +1,7 @@
 export { default as Button } from "./components/Button";
 export type { ButtonProps } from "./components/Button";
+export { default as Typography } from "./components/Typography";
+export type { TypographyProps } from "./components/Typography";
+export { default as TextField } from "./components/TextField";
+export type { TextFieldProps, TextFieldInputProps } from "./components/TextField";
 export * from "./components/theme";