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

package/README.md

@@ -154,6 +154,9 @@ 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)
+- **Link** - Hyperlink component with typography variants and underline options
+- **Divider** - Horizontal and vertical divider lines (with optional text labels)
+- **Copyright** - Copyright notice component (automatically adds © and current year)
 
 More components coming soon!
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@carrier-dpx/air-react-library",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Air web React component library for Figma Make",
   "main": "src/index.ts",
   "types": "src/index.ts",
@@ -32,19 +32,22 @@
   "author": "Carrier DPX",
   "license": "MIT",
   "peerDependencies": {
-    "react": "^18.0.0",
-    "react-dom": "^18.0.0",
-    "@mui/material": "^5.0.0",
     "@emotion/react": "^11.0.0",
-    "@emotion/styled": "^11.0.0"
+    "@emotion/styled": "^11.0.0",
+    "@mui/material": "^5.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
   },
   "devDependencies": {
-    "@figma/code-connect": "^1.0.0",
-    "@mui/material": "^5.15.0",
     "@emotion/react": "^11.11.0",
     "@emotion/styled": "^11.11.0",
+    "@figma/code-connect": "^1.0.0",
+    "@mui/material": "^5.15.0",
     "@types/react": "^18.0.0",
     "@types/react-dom": "^18.0.0",
     "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "clsx": "^2.1.1"
   }
 }

package/src/components/Copyright/Copyright.figma.tsx

@@ -0,0 +1,27 @@
+/**
+ * Figma Code Connect Configuration for Copyright Component
+ */
+
+import figma from "@figma/code-connect";
+import Copyright from "./Copyright";
+
+figma.connect(
+  Copyright,
+  "https://www.figma.com/design/vkoHdM6rchIhH9IWetZeP0/Air--Components?node-id=37592-67050",
+  {
+    props: {
+      /**
+       * TEXT CONTENT
+       * Copyright component shows © {year} {text}
+       * The year is automatically generated, so we just need the text
+       */
+      text: figma.string("*"),
+    },
+
+    /**
+     * CODE EXAMPLE TEMPLATE
+     * Copyright automatically adds © symbol and current year
+     */
+    example: ({ text }) => <Copyright text={text || "Carrier"} />,
+  }
+);

package/src/components/Copyright/Copyright.tsx

@@ -0,0 +1,36 @@
+import { FC, useMemo } from "react";
+import { CSSObject, styled } from "@mui/material/styles";
+import Typography from "../Typography";
+import { CopyrightProps } from "./types";
+import clsx from "clsx";
+import styles from "./styles";
+import { getSxStyles } from "../utils/styles";
+
+const CopyrightStyled = styled(Typography)(styles);
+const baseClassName = "copyright";
+
+/** The Copyright pattern provides legal confirmation for time of ownership.
+ *  //Default Import
+ * `import Copyright from '@carrier-io/air-react/Copyright'`
+ *  //Named Import
+ *  `import { Copyright } from '@carrier-io/air-react'`
+ */
+const Copyright: FC<CopyrightProps> = ({ text, sx, className }) => {
+  const currentYear = useMemo(() => {
+    return new Date().getFullYear();
+  }, []);
+
+  return (
+    <CopyrightStyled
+      variant="body3"
+      sx={(theme) =>
+        ({ fontSize: "12px", ...getSxStyles(theme, sx) } as CSSObject)
+      }
+      className={clsx(baseClassName, className)}
+    >
+      © {currentYear} {text}
+    </CopyrightStyled>
+  );
+};
+
+export default Copyright;

package/src/components/Copyright/index.ts

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

package/src/components/Copyright/styles.ts

@@ -0,0 +1,8 @@
+import { lighten } from "@mui/material";
+import { StyledComponentDefaultProps } from "../types/common";
+
+const styles = ({ theme }: StyledComponentDefaultProps) => ({
+  color: lighten(theme.palette.common.black, 0.6),
+});
+
+export default styles;

package/src/components/Copyright/types.ts

@@ -0,0 +1,8 @@
+import { StylesExtendable } from "../types/props";
+
+export interface CopyrightProps extends StylesExtendable {
+  /**
+   * The content rendered within the component.
+   */
+  text: string;
+}

package/src/components/Divider/Divider.horizontal.figma.tsx

@@ -0,0 +1,50 @@
+/**
+ * Figma Code Connect Configuration for Divider Component (Horizontal)
+ */
+
+import figma from "@figma/code-connect";
+import Divider from "./Divider";
+
+figma.connect(
+  Divider,
+  "https://www.figma.com/design/vkoHdM6rchIhH9IWetZeP0/Air--Components?node-id=15518-67418",
+  {
+    props: {
+      /**
+       * VARIANT MAPPING
+       */
+      variant: figma.enum("variant", {
+        full: "full",
+        padded: "padded",
+      }),
+
+      /**
+       * TEXT ALIGN MAPPING
+       */
+      textAlign: figma.enum("textAlign", {
+        center: "center",
+        left: "left",
+        right: "right",
+      }),
+
+      /**
+       * TEXT CONTENT
+       * When text boolean is true, shows Typography children
+       */
+      children: figma.boolean("text") ? figma.children("*") : undefined,
+    },
+
+    /**
+     * CODE EXAMPLE TEMPLATE
+     * Horizontal divider (default orientation)
+     */
+    example: ({ variant, textAlign, children }) =>
+      children ? (
+        <Divider variant={variant} textAlign={textAlign}>
+          {children}
+        </Divider>
+      ) : (
+        <Divider variant={variant} />
+      ),
+  }
+);

package/src/components/Divider/Divider.tsx

@@ -0,0 +1,57 @@
+import { forwardRef } from "react";
+
+import MuiDivider, {
+  DividerProps as MuiDividerProps,
+} from "@mui/material/Divider";
+import { styled } from "@mui/material/styles";
+
+import { styleTokens } from "../theme/constants/styleTokens";
+
+export interface DividerProps extends Omit<MuiDividerProps, "light"> {}
+
+declare module "@mui/material/Divider" {
+  interface DividerPropsVariantOverrides {
+    padded: true;
+    middle: false;
+    full: true;
+    fullWidth: false;
+    inset: false;
+  }
+}
+
+/** The Divider component is a thin line that groups content in lists and layouts.
+ *
+ * // Default import
+ * import Divider from '@carrier-io/air-react/Divider'
+ *
+ * // Named import
+ * import { Divider } from '@carrier-io/air-react'
+ */
+
+const MuiDividerStyled = styled(MuiDivider)(({ theme }) => ({
+  "&.MuiDivider-padded": {
+    marginLeft: styleTokens.margin.large,
+    marginRight: styleTokens.margin.large,
+    paddingTop: "8px",
+    paddingBottom: "8px",
+  },
+  "& .MuiDivider-wrapper": {
+    paddingLeft: styleTokens.padding.xsmall,
+    paddingRight: styleTokens.padding.xsmall,
+    color: theme.palette.base?.text.primary,
+  },
+  "&.MuiDivider-root": {
+    borderColor: theme.palette.base?.divider,
+    "&:before, &:after": {
+      borderTop: `thin solid ${theme.palette.base?.divider}`,
+    },
+  },
+}));
+
+const Divider = forwardRef<HTMLHRElement, DividerProps>((props, ref) => {
+  return <MuiDividerStyled {...props} ref={ref} />;
+});
+
+Divider.displayName = "Divider";
+
+export default Divider;

package/src/components/Divider/Divider.vertical.figma.tsx

@@ -0,0 +1,54 @@
+/**
+ * Figma Code Connect Configuration for Divider Component (Vertical)
+ */
+
+import figma from "@figma/code-connect";
+import Divider from "./Divider";
+
+figma.connect(
+  Divider,
+  "https://www.figma.com/design/vkoHdM6rchIhH9IWetZeP0/Air--Components?node-id=15556-68596",
+  {
+    props: {
+      /**
+       * VARIANT MAPPING
+       */
+      variant: figma.enum("variant", {
+        full: "full",
+        padded: "padded",
+      }),
+
+      /**
+       * TEXT ALIGN MAPPING
+       */
+      textAlign: figma.enum("textAlign", {
+        center: "center",
+        left: "left",
+        right: "right",
+      }),
+
+      /**
+       * TEXT CONTENT
+       * When text boolean is true, shows Typography children
+       */
+      children: figma.boolean("text") ? figma.children("*") : undefined,
+    },
+
+    /**
+     * CODE EXAMPLE TEMPLATE
+     * Vertical divider - sets orientation="vertical"
+     */
+    example: ({ variant, textAlign, children }) =>
+      children ? (
+        <Divider
+          orientation="vertical"
+          variant={variant}
+          textAlign={textAlign}
+        >
+          {children}
+        </Divider>
+      ) : (
+        <Divider orientation="vertical" variant={variant} />
+      ),
+  }
+);

package/src/components/Divider/index.ts

@@ -0,0 +1,3 @@
+export { default } from "./Divider";
+export * from "./Divider";
+export type { DividerProps } from "./Divider";

package/src/components/Link/Link.figma.tsx

@@ -0,0 +1,70 @@
+/**
+ * Figma Code Connect Configuration for Link Component
+ */
+
+import figma from "@figma/code-connect";
+import Link from "./Link";
+
+figma.connect(
+  Link,
+  "https://www.figma.com/design/vkoHdM6rchIhH9IWetZeP0/Air--Components?node-id=6574-50682",
+  {
+    props: {
+      /**
+       * VARIANT MAPPING
+       * Same variants as Typography component
+       */
+      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",
+      }),
+
+      /**
+       * UNDERLINE MAPPING
+       * Maps Figma underline style to React underline prop
+       */
+      underline: figma.enum("underline", {
+        always: "always",
+        hover: "hover",
+        none: "none",
+      }),
+
+      /**
+       * TEXT CONTENT
+       * Maps the link text from "Label" layer
+       */
+      children: figma.children("Label"),
+    },
+
+    /**
+     * CODE EXAMPLE TEMPLATE
+     * Note: href is a runtime prop, not configured in static Figma component
+     */
+    example: ({ variant, underline, children }) => (
+      <Link variant={variant} underline={underline} href="#">
+        {children}
+      </Link>
+    ),
+  }
+);

package/src/components/Link/Link.tsx

@@ -0,0 +1,69 @@
+import { forwardRef } from "react";
+
+import MuiLink, { LinkProps as MuiLinkProps } from "@mui/material/Link";
+import { AllSystemCSSProperties, ResponsiveStyleValue } from "@mui/system";
+import { useTheme } from "@mui/material";
+import { TypographyProps } from "@mui/material/Typography";
+
+// List of variants we want to exclude
+type ExcludedVariants =
+  | "overline"
+  | "avatarLetter"
+  | "buttonLarge"
+  | "buttonMedium"
+  | "buttonSmall"
+  | "caption"
+  | "inputLabel"
+  | "inputText1"
+  | "inputText2"
+  | "helperText"
+  | "alertTitle"
+  | "tableHeader1"
+  | "tableHeader2"
+  | "badge"
+  | "chip"
+  | "tooltip";
+
+// Get all valid variant options from MUI's Typography component
+type MUIValidVariants = Exclude<TypographyProps["variant"], ExcludedVariants>;
+
+export interface LinkProps extends Omit<MuiLinkProps, "variant"> {
+  /**
+   * Specifies how to capitalize an element's text
+   */
+  textTransform?: ResponsiveStyleValue<AllSystemCSSProperties["textTransform"]>;
+  /**
+   * The target attribute specifies where to open the linked document:
+   */
+  target?: string;
+  /**
+   * Applies the theme typography styles.
+   */
+  variant?: MUIValidVariants;
+}
+
+/** The Link component allows you to easily customize anchor elements with your theme colors and typography styles.
+ *
+ * `import Link from '@carrier-io/air-react/Link'`
+ */
+
+const Link = forwardRef<HTMLAnchorElement, LinkProps>(
+  ({ color, variant = "body2", ...rest }, ref) => {
+    const theme = useTheme();
+    const resolvedColor = color ?? theme.palette.primary.main;
+
+    return (
+      <MuiLink
+        {...rest}
+        color={resolvedColor}
+        ref={ref}
+        variant={variant}
+        sx={{ cursor: "pointer", textUnderlineOffset: "4px" }}
+      />
+    );
+  }
+);
+
+Link.displayName = "Link";
+
+export default Link;

package/src/components/Link/index.ts

@@ -0,0 +1,3 @@
+export { default } from "./Link";
+export * from "./Link";
+export type { LinkProps } from "./Link";

package/src/components/theme/constants/styleTokens.ts

@@ -1,6 +1,42 @@
+import { Theme } from "@mui/material";
+
 export const styleTokens = {
   borderRadius: {
+    small: "2px",
+    medium: "4px",
     large: "8px",
-    circular: "50%",
+    xlarge: "10px",
+    none: "0px",
+    circular: "999px",
   },
+  border: {
+    standard: (theme: Theme) =>
+      `1px solid ${theme.palette.base?.filledInput.outlinedBorder}`,
+    divider: (theme: Theme) => `1px solid ${theme.palette.base?.divider}`,
+  },
+  padding: {
+    none: "0px",
+    xsmall: "8px",
+    small: "10px",
+    medium: "12px",
+    large: "14px",
+    xlarge: "16px",
+  },
+
+  margin: {
+    none: "0px",
+    xsmall: "8px",
+    small: "10px",
+    medium: "12px",
+    large: "16px",
+    xlarge: "20px",
+  },
+  height: {
+    large: "20px",
+    xlarge: "24px",
+  },
+  paddingTop: {
+    large: "18px",
+  },
+  paddingItem: "4px",
 };

package/src/components/types/common.ts

@@ -0,0 +1,5 @@
+import { Theme } from "@mui/material/styles";
+
+export interface StyledComponentDefaultProps {
+  theme: Theme;
+}

package/src/components/types/props.ts

@@ -0,0 +1,6 @@
+import { SxProps, Theme } from "@mui/material/styles";
+
+export interface StylesExtendable {
+  sx?: SxProps<Theme>;
+  className?: string;
+}

package/src/index.ts

@@ -4,4 +4,10 @@ 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 { default as Link } from "./components/Link";
+export type { LinkProps } from "./components/Link";
+export { default as Divider } from "./components/Divider";
+export type { DividerProps } from "./components/Divider";
+export { default as Copyright } from "./components/Copyright";
+export type { CopyrightProps } from "./components/Copyright";
 export * from "./components/theme";