@windstream/react-shared-components 0.1.20 → 0.1.22

package/src/components/modal/Modal.stories.tsx

@@ -1,171 +1,171 @@
-import { Modal } from "./index";
-
-import { DocsPage } from "@shared/stories/DocsTemplate";
-import type { Meta, StoryObj } from "@storybook/react";
-
-const meta: Meta<typeof Modal> = {
-  title: "Components/Modal",
-  component: Modal,
-  tags: ["autodocs"],
-  parameters: {
-    layout: "centered",
-    docs: {
-      page: DocsPage,
-      description: {
-        component:
-          "A flexible modal component with customizable sizing, animations, and behavior options. Supports portal rendering, escape key handling, and overlay click dismissal.",
-      },
-    },
-  },
-  argTypes: {
-    isOpen: {
-      control: { type: "boolean" },
-      description: "Whether the modal is open",
-    },
-    title: {
-      control: { type: "text" },
-      description: "Optional title for the modal header",
-    },
-    size: {
-      control: { type: "select" },
-      options: ["xs", "sm", "md", "lg", "xl"],
-      description: "Modal size variant",
-    },
-    animation: {
-      control: { type: "select" },
-      options: ["popper", "bottomSheet"],
-      description: "Animation variant",
-    },
-    shape: {
-      control: { type: "select" },
-      options: ["rounded", "square"],
-      description: "Shape variant",
-    },
-    shouldCloseOnEsc: {
-      control: { type: "boolean" },
-      description: "Whether to close on escape key",
-    },
-    shouldCloseOnOverlayClick: {
-      control: { type: "boolean" },
-      description: "Whether to close on overlay click",
-    },
-  },
-  args: {
-    isOpen: true,
-    title: "Modal Title",
-    size: "md",
-    animation: "popper",
-    shape: "rounded",
-    shouldCloseOnEsc: true,
-    shouldCloseOnOverlayClick: true,
-  },
-};
-
-export default meta;
-type Story = StoryObj<typeof Modal>;
-
-export const Default: Story = {
-  args: {
-    children: (
-      <div className="space-y-4">
-        <p className="text-gray-600">
-          This is a default modal with some content. You can close it by
-          clicking the X button, pressing Escape, or clicking outside the modal.
-        </p>
-        <div className="flex justify-end space-x-2">
-          <button className="px-4 py-2 text-gray-600 hover:text-gray-800">
-            Cancel
-          </button>
-          <button className="rounded bg-blue-600 px-4 py-2 text-white hover:bg-blue-700">
-            Confirm
-          </button>
-        </div>
-      </div>
-    ),
-  },
-};
-
-export const Small: Story = {
-  args: {
-    size: "xs",
-    children: (
-      <div className="text-center">
-        <p className="text-gray-600">Small modal content</p>
-      </div>
-    ),
-  },
-};
-
-export const Large: Story = {
-  args: {
-    size: "xl",
-    children: (
-      <div className="space-y-4">
-        <h3 className="text-lg font-semibold">Large Modal</h3>
-        <p className="text-gray-600">
-          This is a large modal that can accommodate more content. It's useful
-          for forms, detailed information, or complex layouts.
-        </p>
-        <div className="grid grid-cols-2 gap-4">
-          <div className="rounded bg-gray-100 p-4">Content 1</div>
-          <div className="rounded bg-gray-100 p-4">Content 2</div>
-        </div>
-      </div>
-    ),
-  },
-};
-
-export const BottomSheet: Story = {
-  args: {
-    animation: "bottomSheet",
-    size: "sm",
-    className: "top-auto bottom-0 max-w-none rounded-t-lg",
-    children: (
-      <div className="space-y-4">
-        <h3 className="text-lg font-semibold">Bottom Sheet</h3>
-        <p className="text-gray-600">
-          This modal slides up from the bottom, perfect for mobile interfaces.
-        </p>
-        <div className="space-y-2">
-          <button className="w-full rounded p-3 text-left hover:bg-gray-100">
-            Option 1
-          </button>
-          <button className="w-full rounded p-3 text-left hover:bg-gray-100">
-            Option 2
-          </button>
-          <button className="w-full rounded p-3 text-left hover:bg-gray-100">
-            Option 3
-          </button>
-        </div>
-      </div>
-    ),
-  },
-};
-
-export const WithoutTitle: Story = {
-  args: {
-    title: undefined,
-    children: (
-      <div className="space-y-4">
-        <p className="text-gray-600">
-          This modal doesn't have a title in the header, but still has a close
-          button.
-        </p>
-      </div>
-    ),
-  },
-};
-
-export const NoCloseButton: Story = {
-  args: {
-    closeButtonClassName: "hidden",
-    children: (
-      <div className="space-y-4">
-        <p className="text-gray-600">
-          This modal doesn't have a close button. You can only close it by
-          pressing Escape or clicking outside.
-        </p>
-      </div>
-    ),
-  },
-};
+import { Modal } from "./index";
+
+import { DocsPage } from "@shared/stories/DocsTemplate";
+import type { Meta, StoryObj } from "@storybook/react";
+
+const meta: Meta<typeof Modal> = {
+  title: "Components/Modal",
+  component: Modal,
+  tags: ["autodocs"],
+  parameters: {
+    layout: "centered",
+    docs: {
+      page: DocsPage,
+      description: {
+        component:
+          "A flexible modal component with customizable sizing, animations, and behavior options. Supports portal rendering, escape key handling, and overlay click dismissal.",
+      },
+    },
+  },
+  argTypes: {
+    isOpen: {
+      control: { type: "boolean" },
+      description: "Whether the modal is open",
+    },
+    title: {
+      control: { type: "text" },
+      description: "Optional title for the modal header",
+    },
+    size: {
+      control: { type: "select" },
+      options: ["xs", "sm", "md", "lg", "xl"],
+      description: "Modal size variant",
+    },
+    animation: {
+      control: { type: "select" },
+      options: ["popper", "bottomSheet"],
+      description: "Animation variant",
+    },
+    shape: {
+      control: { type: "select" },
+      options: ["rounded", "square"],
+      description: "Shape variant",
+    },
+    shouldCloseOnEsc: {
+      control: { type: "boolean" },
+      description: "Whether to close on escape key",
+    },
+    shouldCloseOnOverlayClick: {
+      control: { type: "boolean" },
+      description: "Whether to close on overlay click",
+    },
+  },
+  args: {
+    isOpen: true,
+    title: "Modal Title",
+    size: "md",
+    animation: "popper",
+    shape: "rounded",
+    shouldCloseOnEsc: true,
+    shouldCloseOnOverlayClick: true,
+  },
+};
+
+export default meta;
+type Story = StoryObj<typeof Modal>;
+
+export const Default: Story = {
+  args: {
+    children: (
+      <div className="space-y-4">
+        <p className="text-gray-600">
+          This is a default modal with some content. You can close it by
+          clicking the X button, pressing Escape, or clicking outside the modal.
+        </p>
+        <div className="flex justify-end space-x-2">
+          <button className="px-4 py-2 text-gray-600 hover:text-gray-800">
+            Cancel
+          </button>
+          <button className="rounded bg-blue-600 px-4 py-2 text-white hover:bg-blue-700">
+            Confirm
+          </button>
+        </div>
+      </div>
+    ),
+  },
+};
+
+export const Small: Story = {
+  args: {
+    size: "xs",
+    children: (
+      <div className="text-center">
+        <p className="text-gray-600">Small modal content</p>
+      </div>
+    ),
+  },
+};
+
+export const Large: Story = {
+  args: {
+    size: "xl",
+    children: (
+      <div className="space-y-4">
+        <h3 className="text-lg font-semibold">Large Modal</h3>
+        <p className="text-gray-600">
+          This is a large modal that can accommodate more content. It's useful
+          for forms, detailed information, or complex layouts.
+        </p>
+        <div className="grid grid-cols-2 gap-4">
+          <div className="rounded bg-gray-100 p-4">Content 1</div>
+          <div className="rounded bg-gray-100 p-4">Content 2</div>
+        </div>
+      </div>
+    ),
+  },
+};
+
+export const BottomSheet: Story = {
+  args: {
+    animation: "bottomSheet",
+    size: "sm",
+    className: "top-auto bottom-0 max-w-none rounded-t-lg",
+    children: (
+      <div className="space-y-4">
+        <h3 className="text-lg font-semibold">Bottom Sheet</h3>
+        <p className="text-gray-600">
+          This modal slides up from the bottom, perfect for mobile interfaces.
+        </p>
+        <div className="space-y-2">
+          <button className="w-full rounded p-3 text-left hover:bg-gray-100">
+            Option 1
+          </button>
+          <button className="w-full rounded p-3 text-left hover:bg-gray-100">
+            Option 2
+          </button>
+          <button className="w-full rounded p-3 text-left hover:bg-gray-100">
+            Option 3
+          </button>
+        </div>
+      </div>
+    ),
+  },
+};
+
+export const WithoutTitle: Story = {
+  args: {
+    title: undefined,
+    children: (
+      <div className="space-y-4">
+        <p className="text-gray-600">
+          This modal doesn't have a title in the header, but still has a close
+          button.
+        </p>
+      </div>
+    ),
+  },
+};
+
+export const NoCloseButton: Story = {
+  args: {
+    closeButtonClassName: "hidden",
+    children: (
+      <div className="space-y-4">
+        <p className="text-gray-600">
+          This modal doesn't have a close button. You can only close it by
+          pressing Escape or clicking outside.
+        </p>
+      </div>
+    ),
+  },
+};

package/src/components/modal/index.tsx

@@ -9,7 +9,11 @@ import { Animation, ModalProps, Shape, Size } from "./types";
 import ReactModal from "react-modal";
 import { Transition } from "react-transition-group";
 
-const Modal: React.FC<ModalProps> = ({
+type ExtendedModalProps = ModalProps & {
+  bodyAttributes?: React.HTMLAttributes<HTMLDivElement>;
+};
+
+const Modal: React.FC<ExtendedModalProps> = ({
   size = "md",
   shape = "default",
   animation = "popper",
@@ -28,8 +32,9 @@ const Modal: React.FC<ModalProps> = ({
   parentSelector,
   hideScrollOnIsOpenFalse = true,
   hideCloseButton = false,
+  bodyAttributes,
   ...modalProps
-}: ModalProps) => {
+}: ExtendedModalProps) => {
   // Use the custom hook to lock/unlock the body scroll when the modal is open/closed.
   useBodyScrollLock(isOpen, hideScrollOnIsOpenFalse);
 
@@ -93,7 +98,7 @@ const Modal: React.FC<ModalProps> = ({
   };
 
   return (
-    <Transition enter exit in={isTransitioning} timeout={0}>
+    <Transition enter={true} exit={true} in={isTransitioning} timeout={0}>
       {(state: string) => (
         <ReactModal
           ariaHideApp={false}
@@ -116,40 +121,42 @@ const Modal: React.FC<ModalProps> = ({
           )}
           {...modalProps}
         >
-          {!hideCloseButton && (
-            <div className={cx(closeWrapperClassName)}>
-              <Button
+          <div {...bodyAttributes}>
+            {!hideCloseButton && (
+              <div className={cx(closeWrapperClassName)}>
+                <Button
+                  className={cx(
+                    "absolute right-0 top-0 float-right h-6 cursor-pointer p-5 text-text",
+                    closeButtonClassName
+                  )}
+                  onClick={onRequestClose as () => void}
+                  data-testid="close-button"
+                  data-track-element-name="modal_close_button"
+                  data-track-click-text="Close Modal"
+                  data-track-element-clicked="modal"
+                >
+                  <MaterialIcon name="close" size={24} />
+                </Button>
+              </div>
+            )}
+
+            {title ? (
+              <div
                 className={cx(
-                  "absolute right-0 top-0 float-right h-6 cursor-pointer p-5 text-text",
-                  closeButtonClassName
+                  "border-b border-border-secondary-on-bg-fill px-[7px] py-[7px] text-text"
                 )}
-                onClick={onRequestClose as () => void}
-                data-testid="close-button"
-                data-track-element-name="modal_close_button"
-                data-track-click-text="Close Modal"
-                data-track-element-clicked="modal"
               >
-                <MaterialIcon name="close" size={24} />
-              </Button>
-            </div>
-          )}
-
-          {title ? (
+                {title}
+              </div>
+            ) : null}
             <div
-              className={cx(
-                "border-b border-border-secondary-on-bg-fill px-[7px] py-[7px] text-text"
-              )}
+              className={cx("p-5", bodyClassName)}
+              style={bodyStyle}
+              data-testid={modalProps["data-testid"]}
+              data-cy={modalProps["data-cy"]}
             >
-              {title}
+              {children}
             </div>
-          ) : null}
-          <div
-            className={cx("p-5", bodyClassName)}
-            style={bodyStyle}
-            data-testid={modalProps["data-testid"]}
-            data-cy={modalProps["data-cy"]}
-          >
-            {children}
           </div>
         </ReactModal>
       )}

package/src/components/modal/types.ts

@@ -1,24 +1,24 @@
-import { Props as RModalProps } from "react-modal";
-
-export type Size = "xl" | "lg" | "md" | "sm" | "xs";
-export type Shape = "rounded" | "default";
-export type Animation = "popper" | "bottomSheet";
-
-type OwnProps = {
-  size?: Size;
-  shape?: Shape;
-  title?: string;
-  bodyClassName?: string | null | undefined;
-  closeWrapperClassName?: string | null | undefined;
-  closeButtonClassName?: string | null | undefined;
-  bodyStyle?: React.CSSProperties;
-  centered?: boolean;
-  hideScrollOnIsOpenFalse?: boolean;
-  parentSelector?: string;
-  animation?: Animation;
-  hideCloseButton?: boolean;
-  ["data-testid"]?: string;
-  ["data-cy"]?: string;
-};
-
-export type ModalProps = OwnProps & RModalProps;
+import { Props as RModalProps } from "react-modal";
+
+export type Size = "xl" | "lg" | "md" | "sm" | "xs";
+export type Shape = "rounded" | "default";
+export type Animation = "popper" | "bottomSheet";
+
+type OwnProps = {
+  size?: Size;
+  shape?: Shape;
+  title?: string;
+  bodyClassName?: string | null | undefined;
+  closeWrapperClassName?: string | null | undefined;
+  closeButtonClassName?: string | null | undefined;
+  bodyStyle?: React.CSSProperties;
+  centered?: boolean;
+  hideScrollOnIsOpenFalse?: boolean;
+  parentSelector?: string;
+  animation?: Animation;
+  hideCloseButton?: boolean;
+  ["data-testid"]?: string;
+  ["data-cy"]?: string;
+};
+
+export type ModalProps = OwnProps & RModalProps;

package/src/components/next-image/index.tsx

@@ -1,54 +1,54 @@
-"use client";
-
-import { forwardRef } from "react";
-import NextJsImage, {
-  type ImageLoaderProps,
-  type ImageProps as NextImageProps,
-} from "next/image";
-
-import { cx } from "@shared/utils";
-
-export interface NextImageComponentProps extends NextImageProps {
-  className?: string;
-}
-
-/**
- * Image loader that uses Contentful's Image API to serve optimized WebP images
- * at the requested width and quality, avoiding an extra round-trip through
- * the Next.js image optimization server.
- */
-const contentfulImageLoader = ({ src, width, quality }: ImageLoaderProps) => {
-  const url = new URL(src);
-  url.searchParams.set("w", String(width));
-  url.searchParams.set("q", String(quality || 90));
-  url.searchParams.set("fm", "webp");
-  return url.toString();
-};
-
-export const NextImage = forwardRef<HTMLImageElement, NextImageComponentProps>(
-  ({ className, ...props }, ref) => {
-    const srcString = typeof props.src === "string" ? props.src : "";
-    const urlWithoutParams = srcString.toLowerCase().split("?")[0] || "";
-    const isContentfulImage = srcString.includes("images.ctfassets.net");
-    const isSvgFromContentful =
-      isContentfulImage && urlWithoutParams.endsWith(".svg");
-
-    // Use Contentful's Image API for non-SVG Contentful images;
-    // skip optimization entirely for SVGs.
-    const loaderProps =
-      isContentfulImage && !isSvgFromContentful
-        ? { loader: contentfulImageLoader, unoptimized: false }
-        : { unoptimized: isSvgFromContentful };
-
-    return (
-      <NextJsImage
-        ref={ref}
-        className={cx(className)}
-        {...props}
-        {...loaderProps}
-      />
-    );
-  }
-);
-
-NextImage.displayName = "NextImage";
+"use client";
+
+import { forwardRef } from "react";
+import NextJsImage, {
+  type ImageLoaderProps,
+  type ImageProps as NextImageProps,
+} from "next/image";
+
+import { cx } from "@shared/utils";
+
+export interface NextImageComponentProps extends NextImageProps {
+  className?: string;
+}
+
+/**
+ * Image loader that uses Contentful's Image API to serve optimized WebP images
+ * at the requested width and quality, avoiding an extra round-trip through
+ * the Next.js image optimization server.
+ */
+const contentfulImageLoader = ({ src, width, quality }: ImageLoaderProps) => {
+  const url = new URL(src);
+  url.searchParams.set("w", String(width));
+  url.searchParams.set("q", String(quality || 90));
+  url.searchParams.set("fm", "webp");
+  return url.toString();
+};
+
+export const NextImage = forwardRef<HTMLImageElement, NextImageComponentProps>(
+  ({ className, ...props }, ref) => {
+    const srcString = typeof props.src === "string" ? props.src : "";
+    const urlWithoutParams = srcString.toLowerCase().split("?")[0] || "";
+    const isContentfulImage = srcString.includes("images.ctfassets.net");
+    const isSvgFromContentful =
+      isContentfulImage && urlWithoutParams.endsWith(".svg");
+
+    // Use Contentful's Image API for non-SVG Contentful images;
+    // skip optimization entirely for SVGs.
+    const loaderProps =
+      isContentfulImage && !isSvgFromContentful
+        ? { loader: contentfulImageLoader, unoptimized: false }
+        : { unoptimized: isSvgFromContentful };
+
+    return (
+      <NextJsImage
+        ref={ref}
+        className={cx(className)}
+        {...props}
+        {...loaderProps}
+      />
+    );
+  }
+);
+
+NextImage.displayName = "NextImage";

package/src/components/next-image/types.ts

@@ -1 +1 @@
-export type { NextImageComponentProps } from "./index";
+export type { NextImageComponentProps } from "./index";