@windstream/react-shared-components 0.0.1

package/src/components/list/List.stories.tsx

@@ -0,0 +1,272 @@
+import { List, ListItem } from "./index";
+import { DocsPage } from "@shared/stories/DocsTemplate";
+
+import type { Meta, StoryObj } from "@storybook/react";
+
+const meta: Meta<typeof List> = {
+  title: "Components/List",
+  component: List,
+  tags: ["autodocs"],
+  parameters: {
+    layout: "centered",
+    docs: {
+      page: DocsPage,
+      description: {
+        component:
+          "Flexible list components for ordered, unordered, and custom lists.",
+      },
+    },
+  },
+  argTypes: {
+    type: {
+      control: { type: "select" },
+      options: ["ul", "ol"],
+      description: "List type (ul or ol)",
+    },
+    variant: {
+      control: { type: "select" },
+      options: ["default", "unstyled"],
+      description: "List styling variant",
+    },
+    children: {
+      control: { type: "text" },
+      description: "List content",
+    },
+  },
+  args: {
+    type: "ul",
+    variant: "default",
+    children: "List content",
+  },
+};
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+// Default list
+export const Default: Story = {
+  render: () => (
+    <List>
+      <ListItem>First item</ListItem>
+      <ListItem>Second item</ListItem>
+      <ListItem>Third item</ListItem>
+    </List>
+  ),
+};
+
+// Unordered list
+export const Unordered: Story = {
+  render: () => (
+    <List type="ul">
+      <ListItem>Apple</ListItem>
+      <ListItem>Banana</ListItem>
+      <ListItem>Cherry</ListItem>
+      <ListItem>Date</ListItem>
+    </List>
+  ),
+};
+
+// Ordered list
+export const Ordered: Story = {
+  render: () => (
+    <List type="ol">
+      <ListItem>First step</ListItem>
+      <ListItem>Second step</ListItem>
+      <ListItem>Third step</ListItem>
+      <ListItem>Fourth step</ListItem>
+    </List>
+  ),
+};
+
+// Unstyled list
+export const Unstyled: Story = {
+  render: () => (
+    <List variant="unstyled" className="space-y-3">
+      <ListItem className="flex items-center gap-3 rounded-lg bg-gray-50 p-3">
+        <div className="h-3 w-3 rounded-full bg-blue-500"></div>
+        <span>Unstyled item 1</span>
+      </ListItem>
+      <ListItem className="flex items-center gap-3 rounded-lg bg-gray-50 p-3">
+        <div className="h-3 w-3 rounded-full bg-green-500"></div>
+        <span>Unstyled item 2</span>
+      </ListItem>
+      <ListItem className="flex items-center gap-3 rounded-lg bg-gray-50 p-3">
+        <div className="h-3 w-3 rounded-full bg-purple-500"></div>
+        <span>Unstyled item 3</span>
+      </ListItem>
+    </List>
+  ),
+};
+
+// Compact list
+export const Compact: Story = {
+  render: () => (
+    <List className="space-y-1">
+      <ListItem>Compact item 1</ListItem>
+      <ListItem>Compact item 2</ListItem>
+      <ListItem>Compact item 3</ListItem>
+    </List>
+  ),
+};
+
+// Spaced list
+export const Spaced: Story = {
+  render: () => (
+    <List className="space-y-4">
+      <ListItem>Spaced item 1</ListItem>
+      <ListItem>Spaced item 2</ListItem>
+      <ListItem>Spaced item 3</ListItem>
+    </List>
+  ),
+};
+
+// Navigation list
+export const Navigation: Story = {
+  render: () => (
+    <List variant="unstyled" className="space-y-1">
+      <ListItem>
+        <a
+          href="#dashboard"
+          className="block rounded px-4 py-2 text-gray-700 hover:bg-gray-100"
+        >
+          Dashboard
+        </a>
+      </ListItem>
+      <ListItem>
+        <a
+          href="#profile"
+          className="block rounded px-4 py-2 text-gray-700 hover:bg-gray-100"
+        >
+          Profile
+        </a>
+      </ListItem>
+      <ListItem>
+        <a
+          href="#settings"
+          className="block rounded px-4 py-2 text-gray-700 hover:bg-gray-100"
+        >
+          Settings
+        </a>
+      </ListItem>
+      <ListItem>
+        <a
+          href="#logout"
+          className="block rounded px-4 py-2 text-red-600 hover:bg-red-50"
+        >
+          Logout
+        </a>
+      </ListItem>
+    </List>
+  ),
+  parameters: {
+    docs: {
+      description: {
+        story: "Navigation menu using unstyled list.",
+      },
+    },
+  },
+};
+
+// Feature list
+export const FeatureList: Story = {
+  render: () => (
+    <List variant="unstyled" className="space-y-4">
+      <ListItem className="flex items-start gap-3">
+        <div className="mt-0.5 flex h-6 w-6 items-center justify-center rounded-full bg-green-100">
+          <span className="text-sm text-green-600">✓</span>
+        </div>
+        <div>
+          <h4 className="font-medium text-gray-900">Feature 1</h4>
+          <p className="text-sm text-gray-600">
+            Description of the first feature
+          </p>
+        </div>
+      </ListItem>
+      <ListItem className="flex items-start gap-3">
+        <div className="mt-0.5 flex h-6 w-6 items-center justify-center rounded-full bg-green-100">
+          <span className="text-sm text-green-600">✓</span>
+        </div>
+        <div>
+          <h4 className="font-medium text-gray-900">Feature 2</h4>
+          <p className="text-sm text-gray-600">
+            Description of the second feature
+          </p>
+        </div>
+      </ListItem>
+      <ListItem className="flex items-start gap-3">
+        <div className="mt-0.5 flex h-6 w-6 items-center justify-center rounded-full bg-green-100">
+          <span className="text-sm text-green-600">✓</span>
+        </div>
+        <div>
+          <h4 className="font-medium text-gray-900">Feature 3</h4>
+          <p className="text-sm text-gray-600">
+            Description of the third feature
+          </p>
+        </div>
+      </ListItem>
+    </List>
+  ),
+  parameters: {
+    docs: {
+      description: {
+        story: "Feature list with icons and descriptions.",
+      },
+    },
+  },
+};
+
+// All variants showcase
+export const AllVariants: Story = {
+  render: () => (
+    <div className="space-y-8">
+      <div>
+        <h3 className="mb-3 text-lg font-semibold">List Types</h3>
+        <div className="grid grid-cols-2 gap-8">
+          <div>
+            <h4 className="mb-2 font-medium">Unordered</h4>
+            <List type="ul">
+              <ListItem>Item 1</ListItem>
+              <ListItem>Item 2</ListItem>
+              <ListItem>Item 3</ListItem>
+            </List>
+          </div>
+          <div>
+            <h4 className="mb-2 font-medium">Ordered</h4>
+            <List type="ol">
+              <ListItem>Step 1</ListItem>
+              <ListItem>Step 2</ListItem>
+              <ListItem>Step 3</ListItem>
+            </List>
+          </div>
+        </div>
+      </div>
+
+      <div>
+        <h3 className="mb-3 text-lg font-semibold">Variants</h3>
+        <div className="grid grid-cols-2 gap-6">
+          <div>
+            <h4 className="mb-2 font-medium">Default</h4>
+            <List variant="default">
+              <ListItem>Default item</ListItem>
+              <ListItem>Default item</ListItem>
+            </List>
+          </div>
+          <div>
+            <h4 className="mb-2 font-medium">Unstyled</h4>
+            <List variant="unstyled">
+              <ListItem>Unstyled item</ListItem>
+              <ListItem>Unstyled item</ListItem>
+            </List>
+          </div>
+        </div>
+      </div>
+    </div>
+  ),
+  parameters: {
+    docs: {
+      description: {
+        story: "Showcase of all list variants and sizes.",
+      },
+    },
+  },
+};

package/src/components/list/index.tsx

@@ -0,0 +1,86 @@
+import React, { forwardRef } from "react";
+import { cx } from "../../utils";
+import { ListItem, ListItemProps } from "./list-item";
+import { ListProps } from "./types";
+
+export const List = forwardRef<HTMLUListElement | HTMLOListElement, ListProps>(
+  (
+    {
+      type = "ul",
+      items,
+      className = "",
+      renderItem,
+      children,
+      variant = "unstyled",
+      style,
+      ...props
+    },
+    ref
+  ) => {
+    // Get Tailwind classes for different variants
+    const getVariantClasses = () => {
+      if (variant === "unstyled") {
+        return "";
+      }
+
+      // TODO: Add styles based on the figma design for all variants
+      const baseClasses = "m-0 p-0";
+      const typeClasses =
+        type === "ol" ? "pl-6 list-decimal" : "pl-5 list-disc";
+
+      return `${baseClasses} ${typeClasses}`;
+    };
+
+    const tailwindClasses = getVariantClasses();
+    const combinedClassName = cx(
+      tailwindClasses,
+      `list--${type}`,
+      `list--${variant}`,
+      className
+    );
+
+    // Render items if provided
+    const renderItems = () => {
+      if (!items || items.length === 0) return null;
+
+      return items.map((item, index) => {
+        if (renderItem) {
+          return renderItem(item, index);
+        }
+
+        return (
+          <ListItem
+            key={item.id || index}
+            className={item.className}
+            variant={variant}
+          >
+            {item.content}
+          </ListItem>
+        );
+      });
+    };
+
+    const content = children || renderItems();
+
+    // Create props object to avoid duplication
+    const listProps = {
+      className: combinedClassName,
+      style,
+      ...props,
+      children: content,
+    };
+
+    // Return appropriate list type with conditional rendering for proper TypeScript inference
+    if (type === "ol") {
+      return <ol {...listProps} ref={ref as React.Ref<HTMLOListElement>} />;
+    }
+
+    return <ul {...listProps} ref={ref as React.Ref<HTMLUListElement>} />;
+  }
+);
+
+List.displayName = "List";
+
+export { ListItem };
+
+export type { ListProps, ListItemProps };

package/src/components/list/list-item/index.tsx

@@ -0,0 +1,36 @@
+import { forwardRef } from "react";
+import { cx } from "../../../utils";
+import { ListItemProps } from "./types";
+
+export const ListItem = forwardRef<HTMLLIElement, ListItemProps>(
+  (
+    { children, className = "", variant = "unstyled", style, ...props },
+    ref
+  ) => {
+    // Get Tailwind classes for different variants
+    const getVariantClasses = () => {
+      if (variant === "unstyled") return "";
+
+      // TODO: Add styles based on the figma design for all variants
+      return "mb-1 leading-6";
+    };
+
+    const tailwindClasses = getVariantClasses();
+    const combinedClassName = cx(
+      tailwindClasses,
+      "list-item",
+      `list-item--${variant}`,
+      className
+    );
+
+    return (
+      <li ref={ref} className={combinedClassName} style={style} {...props}>
+        {children}
+      </li>
+    );
+  }
+);
+
+ListItem.displayName = "ListItem";
+
+export type { ListItemProps };

package/src/components/list/list-item/types.ts

@@ -0,0 +1,13 @@
+import { CSSProperties, LiHTMLAttributes, ReactNode } from "react";
+import { ListVariant } from "../types";
+
+export interface ListItemProps extends LiHTMLAttributes<HTMLLIElement> {
+  /** Content to render inside the list item */
+  children: ReactNode;
+  /** Custom className for the list item */
+  className?: string;
+  /** Additional styling options */
+  variant?: ListVariant;
+  /** Custom styles */
+  style?: CSSProperties;
+}

package/src/components/list/types.ts

@@ -0,0 +1,29 @@
+import { CSSProperties, HTMLAttributes, ReactNode } from "react";
+
+export type ListType = "ul" | "ol";
+export type ListVariant = "default" | "unstyled";
+
+export type ListItem = {
+  id: string | number;
+  content: ReactNode;
+  className?: string;
+  [key: string]: any;
+};
+
+export interface ListProps
+  extends Omit<HTMLAttributes<HTMLUListElement | HTMLOListElement>, "type"> {
+  /** List type - unordered (ul) or ordered (ol) */
+  type?: ListType;
+  /** Array of items to render */
+  items?: ListItem[];
+  /** Custom className for the list */
+  className?: string;
+  /** Custom item renderer function */
+  renderItem?: (item: ListItem, index: number) => ReactNode;
+  /** Children to render instead of items */
+  children?: ReactNode;
+  /** Additional styling options */
+  variant?: ListVariant;
+  /** Custom styles */
+  style?: CSSProperties;
+}