@windstream/react-shared-components 0.1.6 → 0.1.7

package/src/components/checklist/Checklist.stories.tsx

@@ -1,150 +1,150 @@
-import { Checklist } from "./index";
-
-import { DocsPage } from "@shared/stories/DocsTemplate";
-import type { Meta, StoryObj } from "@storybook/react";
-
-const meta: Meta<typeof Checklist> = {
-  title: "Components/Checklist",
-  component: Checklist,
-  tags: ["autodocs"],
-  parameters: {
-    layout: "centered",
-    docs: {
-      page: DocsPage,
-      description: {
-        component:
-          "A checklist component that displays a list of items with icons, typically used for feature lists or task lists.",
-      },
-    },
-  },
-  argTypes: {
-    items: {
-      control: { type: "object" },
-      description: "Array of strings to display as checklist items",
-    },
-    listIconName: {
-      control: { type: "select" },
-      options: ["check"],
-      description: "Icon name to display for each item",
-    },
-    listItemClassName: {
-      control: { type: "text" },
-      description: "Additional CSS classes for list items",
-    },
-  },
-  args: {
-    items: ["Feature 1", "Feature 2", "Feature 3"],
-    listIconName: "check",
-  },
-};
-
-export default meta;
-type Story = StoryObj<typeof meta>;
-
-// Default checklist
-export const Default: Story = {
-  args: {},
-};
-
-// With items
-export const WithItems: Story = {
-  args: {
-    items: [
-      "High-speed internet connection",
-      "24/7 customer support",
-      "No data caps",
-      "Free installation",
-    ],
-  },
-};
-
-// Custom icon
-export const CustomIcon: Story = {
-  args: {
-    items: ["Item 1", "Item 2", "Item 3"],
-    listIconName: "check",
-  },
-};
-
-// Custom styling
-export const CustomStyling: Story = {
-  args: {
-    items: ["Styled item 1", "Styled item 2", "Styled item 3"],
-    listItemClassName: "body1 text-text-brand",
-  },
-};
-
-// Long list
-export const LongList: Story = {
-  args: {
-    items: [
-      "Feature one with a longer description",
-      "Feature two",
-      "Feature three",
-      "Feature four",
-      "Feature five",
-      "Feature six",
-      "Feature seven",
-      "Feature eight",
-    ],
-  },
-};
-
-// Single item
-export const SingleItem: Story = {
-  args: {
-    items: ["Single checklist item"],
-  },
-};
-
-// Empty state (should not render)
-export const Empty: Story = {
-  args: {
-    items: [],
-  },
-  parameters: {
-    docs: {
-      description: {
-        story: "Checklist with no items (component returns null).",
-      },
-    },
-  },
-};
-
-// All variants showcase
-export const AllVariants: Story = {
-  render: () => (
-    <div className="space-y-8">
-      <div>
-        <h3 className="mb-3 text-lg font-semibold">Default Checklist</h3>
-        <Checklist items={["Item 1", "Item 2", "Item 3"]} />
-      </div>
-      <div>
-        <h3 className="mb-3 text-lg font-semibold">Custom Styled</h3>
-        <Checklist
-          items={["Styled item 1", "Styled item 2"]}
-          listItemClassName="body1 font-semibold"
-        />
-      </div>
-      <div>
-        <h3 className="mb-3 text-lg font-semibold">Long List</h3>
-        <Checklist
-          items={[
-            "Feature one",
-            "Feature two",
-            "Feature three",
-            "Feature four",
-            "Feature five",
-          ]}
-        />
-      </div>
-    </div>
-  ),
-  parameters: {
-    docs: {
-      description: {
-        story: "Showcase of all checklist variants and styling options.",
-      },
-    },
-  },
-};
+import { Checklist } from "./index";
+
+import { DocsPage } from "@shared/stories/DocsTemplate";
+import type { Meta, StoryObj } from "@storybook/react";
+
+const meta: Meta<typeof Checklist> = {
+  title: "Components/Checklist",
+  component: Checklist,
+  tags: ["autodocs"],
+  parameters: {
+    layout: "centered",
+    docs: {
+      page: DocsPage,
+      description: {
+        component:
+          "A checklist component that displays a list of items with icons, typically used for feature lists or task lists.",
+      },
+    },
+  },
+  argTypes: {
+    items: {
+      control: { type: "object" },
+      description: "Array of strings to display as checklist items",
+    },
+    listIconName: {
+      control: { type: "select" },
+      options: ["check"],
+      description: "Icon name to display for each item",
+    },
+    listItemClassName: {
+      control: { type: "text" },
+      description: "Additional CSS classes for list items",
+    },
+  },
+  args: {
+    items: ["Feature 1", "Feature 2", "Feature 3"],
+    listIconName: "check",
+  },
+};
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// Default checklist
+export const Default: Story = {
+  args: {},
+};
+
+// With items
+export const WithItems: Story = {
+  args: {
+    items: [
+      "High-speed internet connection",
+      "24/7 customer support",
+      "No data caps",
+      "Free installation",
+    ],
+  },
+};
+
+// Custom icon
+export const CustomIcon: Story = {
+  args: {
+    items: ["Item 1", "Item 2", "Item 3"],
+    listIconName: "check",
+  },
+};
+
+// Custom styling
+export const CustomStyling: Story = {
+  args: {
+    items: ["Styled item 1", "Styled item 2", "Styled item 3"],
+    listItemClassName: "body1 text-text-brand",
+  },
+};
+
+// Long list
+export const LongList: Story = {
+  args: {
+    items: [
+      "Feature one with a longer description",
+      "Feature two",
+      "Feature three",
+      "Feature four",
+      "Feature five",
+      "Feature six",
+      "Feature seven",
+      "Feature eight",
+    ],
+  },
+};
+
+// Single item
+export const SingleItem: Story = {
+  args: {
+    items: ["Single checklist item"],
+  },
+};
+
+// Empty state (should not render)
+export const Empty: Story = {
+  args: {
+    items: [],
+  },
+  parameters: {
+    docs: {
+      description: {
+        story: "Checklist with no items (component returns null).",
+      },
+    },
+  },
+};
+
+// All variants showcase
+export const AllVariants: Story = {
+  render: () => (
+    <div className="space-y-8">
+      <div>
+        <h3 className="mb-3 text-lg font-semibold">Default Checklist</h3>
+        <Checklist items={["Item 1", "Item 2", "Item 3"]} />
+      </div>
+      <div>
+        <h3 className="mb-3 text-lg font-semibold">Custom Styled</h3>
+        <Checklist
+          items={["Styled item 1", "Styled item 2"]}
+          listItemClassName="body1 font-semibold"
+        />
+      </div>
+      <div>
+        <h3 className="mb-3 text-lg font-semibold">Long List</h3>
+        <Checklist
+          items={[
+            "Feature one",
+            "Feature two",
+            "Feature three",
+            "Feature four",
+            "Feature five",
+          ]}
+        />
+      </div>
+    </div>
+  ),
+  parameters: {
+    docs: {
+      description: {
+        story: "Showcase of all checklist variants and styling options.",
+      },
+    },
+  },
+};

package/src/components/checklist/index.tsx

@@ -1,59 +1,59 @@
-import React from "react";
-
-import { ChecklistProps, iconColors } from "@shared/components/checklist/types";
-import { List, ListItem } from "@shared/components/list";
-import { MaterialIcon } from "@shared/components/material-icon";
-import { Text } from "@shared/components/text";
-import { cx } from "@shared/utils";
-
-export const Checklist: React.FC<ChecklistProps> = props => {
-  const {
-    items,
-    listIconName = "check",
-    listItemClassName,
-    iconSize = 20,
-    iconPosition = "center",
-    iconColor = "green",
-    iconClassName,
-  } = props;
-  const showIcons = listIconName !== "disc";
-  if (!items?.length) return null;
-
-  return (
-    <List
-      className="mt-2 space-y-1"
-      variant={showIcons ? "unstyled" : "default"}
-    >
-      {items.map((text, idx) => (
-        <ListItem
-          variant={showIcons ? "unstyled" : "default"}
-          key={idx}
-          className={cx(
-            `${showIcons ? "flex" : ""} ${iconPosition === "top" ? "items-start" : "items-center"} gap-2 text-text-secondary`,
-            listItemClassName
-          )}
-        >
-          {showIcons && (
-            <div>
-              <MaterialIcon
-                name={listIconName}
-                size={iconSize}
-                color={iconColors[iconColor]}
-                weight="600"
-                className={cx(
-                  iconPosition === "top" ? "mt-1" : "",
-                  iconClassName
-                )}
-              />
-            </div>
-          )}
-          <Text as="div">{text}</Text>
-        </ListItem>
-      ))}
-    </List>
-  );
-};
-
-Checklist.displayName = "Checklist";
-
-export type { ChecklistProps };
+import React from "react";
+
+import { ChecklistProps, iconColors } from "@shared/components/checklist/types";
+import { List, ListItem } from "@shared/components/list";
+import { MaterialIcon } from "@shared/components/material-icon";
+import { Text } from "@shared/components/text";
+import { cx } from "@shared/utils";
+
+export const Checklist: React.FC<ChecklistProps> = props => {
+  const {
+    items,
+    listIconName = "check",
+    listItemClassName,
+    iconSize = 20,
+    iconPosition = "center",
+    iconColor = "green",
+    iconClassName,
+  } = props;
+  const showIcons = listIconName !== "disc";
+  if (!items?.length) return null;
+
+  return (
+    <List
+      className="mt-2 space-y-1"
+      variant={showIcons ? "unstyled" : "default"}
+    >
+      {items.map((text, idx) => (
+        <ListItem
+          variant={showIcons ? "unstyled" : "default"}
+          key={idx}
+          className={cx(
+            `${showIcons ? "flex" : ""} ${iconPosition === "top" ? "items-start" : "items-center"} gap-2 text-text-secondary`,
+            listItemClassName
+          )}
+        >
+          {showIcons && (
+            <div>
+              <MaterialIcon
+                name={listIconName}
+                size={iconSize}
+                color={iconColors[iconColor]}
+                weight="600"
+                className={cx(
+                  iconPosition === "top" ? "mt-1" : "",
+                  iconClassName
+                )}
+              />
+            </div>
+          )}
+          <Text as="div">{text}</Text>
+        </ListItem>
+      ))}
+    </List>
+  );
+};
+
+Checklist.displayName = "Checklist";
+
+export type { ChecklistProps };

package/src/components/checklist/types.ts

@@ -1,16 +1,16 @@
-export type ChecklistProps = {
-  items: React.ReactNode[];
-  // TODO: add icon names as needed
-  listIconName?: "check" | "disc";
-  listItemClassName?: string;
-  iconClassName?: string;
-  iconSize?: 20 | 24 | 32 | 40 | 48 | 52 | undefined;
-  iconPosition?: "top" | "center";
-  iconColor?: "green" | "yellow" | "blue";
-};
-
-export const iconColors = {
-  green: "#209A61",
-  yellow: "#F5FF36",
-  blue: "#0393BA",
-};
+export type ChecklistProps = {
+  items: React.ReactNode[];
+  // TODO: add icon names as needed
+  listIconName?: "check" | "disc";
+  listItemClassName?: string;
+  iconClassName?: string;
+  iconSize?: 20 | 24 | 32 | 40 | 48 | 52 | undefined;
+  iconPosition?: "top" | "center";
+  iconColor?: "green" | "yellow" | "blue";
+};
+
+export const iconColors = {
+  green: "#209A61",
+  yellow: "#F5FF36",
+  blue: "#0393BA",
+};