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

package/README.md

@@ -104,6 +104,45 @@ function App() {
 - **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.
@@ -114,6 +153,7 @@ 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.3.0",
+  "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/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

@@ -2,4 +2,6 @@ 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";