@recursica/mui-adapter 0.5.0 → 0.7.0

package/src/components/Panel/Panel.module.css

@@ -1,38 +1,206 @@
-/* EXEMPTIONS:
-   This component is a placeholder stub. Once fully implemented, its specific
-   tokens will be fully wired up to direct styles. */
-
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_border-radius */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_border-size */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_colors_background */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_colors_border-color */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_colors_content */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_colors_divider-color */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_colors_header-footer-background */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_colors_title */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-horizontal-padding */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-style_fontFamily */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-style_fontSize */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-style_fontStyle */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-style_fontWeight */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-style_letterSpacing */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-style_lineHeight */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-style_textCase */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-style_textDecoration */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_content-vertical-padding */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_divider-size */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_elevation */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_footer-button-gap */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-close-gap */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-footer-horizontal-padding */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-footer-vertical-padding */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-style_fontFamily */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-style_fontSize */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-style_fontStyle */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-style_fontWeight */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-style_letterSpacing */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-style_lineHeight */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-style_textCase */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_header-style_textDecoration */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_max-width */
-/* recursica-ignore: --recursica_ui-kit_components_panel_properties_min-width */
+/* HARDCODED VALUES:
+   - border-style: solid: Structural rendering rule for the panel border.
+   - .inner { left: 0 }: Prevents the fixed Drawer portal from being pushed off-screen in centered flex environments (like Storybook Canvas).
+   - flexbox layout on .content & .body: Required to create a vertical flex context that pushes the footer to the bottom.
+   - position: sticky & negative margins on .footer: A CSS technique used to break the footer out of the .body padding constraints so it stretches edge-to-edge, while remaining fixed at the bottom of the scroll container.
+   - z-index: 10 on .footer: Ensures the footer covers the body content as it scrolls underneath.
+ */
+
+/* ======================================
+   PANEL CONTENT (outer drawer container)
+   ====================================== */
+
+.content {
+  background-color: var(
+    --recursica_ui-kit_components_panel_properties_colors_background
+  );
+  border-style: solid;
+  border-width: var(--recursica_ui-kit_components_panel_properties_border-size);
+  border-color: var(
+    --recursica_ui-kit_components_panel_properties_colors_border-color
+  );
+  border-radius: var(
+    --recursica_ui-kit_components_panel_properties_border-radius
+  );
+  box-shadow: var(--recursica_ui-kit_components_panel_properties_elevation);
+  min-width: var(--recursica_ui-kit_components_panel_properties_min-width);
+  max-width: var(--recursica_ui-kit_components_panel_properties_max-width);
+
+  display: flex;
+  flex-direction: column;
+  height: 100%;
+}
+
+.inner {
+  /* Forces the Drawer Inner container to the left edge, preventing it from inheriting
+     a centered static position in flex environments like Storybook's Canvas wrapper */
+  left: 0;
+}
+
+/* ======================================
+   PANEL HEADER
+   ====================================== */
+
+.header {
+  background-color: var(
+    --recursica_ui-kit_components_panel_properties_colors_header-footer-background
+  );
+  padding: var(
+      --recursica_ui-kit_components_panel_properties_header-footer-vertical-padding
+    )
+    var(
+      --recursica_ui-kit_components_panel_properties_header-footer-horizontal-padding
+    );
+  border-bottom: var(
+      --recursica_ui-kit_components_panel_properties_divider-size
+    )
+    solid
+    var(--recursica_ui-kit_components_panel_properties_colors_divider-color);
+  gap: var(--recursica_ui-kit_components_panel_properties_header-close-gap);
+}
+
+/* ======================================
+   PANEL TITLE
+   ====================================== */
+
+.title {
+  color: var(--recursica_ui-kit_components_panel_properties_colors_title);
+
+  /* Direct Figma Typography Mapping */
+  font-family: var(
+    --recursica_ui-kit_components_panel_properties_header-style_fontFamily
+  );
+  font-size: var(
+    --recursica_ui-kit_components_panel_properties_header-style_fontSize
+  );
+  font-style: var(
+    --recursica_ui-kit_components_panel_properties_header-style_fontStyle
+  );
+  font-weight: var(
+    --recursica_ui-kit_components_panel_properties_header-style_fontWeight
+  );
+  letter-spacing: var(
+    --recursica_ui-kit_components_panel_properties_header-style_letterSpacing
+  );
+  line-height: var(
+    --recursica_ui-kit_components_panel_properties_header-style_lineHeight
+  );
+  text-transform: var(
+    --recursica_ui-kit_components_panel_properties_header-style_textCase
+  );
+  text-decoration: var(
+    --recursica_ui-kit_components_panel_properties_header-style_textDecoration
+  );
+}
+
+.titleTruncate {
+  composes: title;
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  display: block;
+  flex: 1;
+  min-width: 0;
+}
+
+/* ======================================
+   PANEL BODY
+   ====================================== */
+
+.body {
+  padding: var(
+      --recursica_ui-kit_components_panel_properties_content-vertical-padding
+    )
+    var(
+      --recursica_ui-kit_components_panel_properties_content-horizontal-padding
+    );
+  color: var(--recursica_ui-kit_components_panel_properties_colors_content);
+
+  flex: 1;
+  display: flex;
+  flex-direction: column;
+  overflow-y: auto;
+
+  /* Direct Figma Typography Mapping */
+  font-family: var(
+    --recursica_ui-kit_components_panel_properties_content-style_fontFamily
+  );
+  font-size: var(
+    --recursica_ui-kit_components_panel_properties_content-style_fontSize
+  );
+  font-style: var(
+    --recursica_ui-kit_components_panel_properties_content-style_fontStyle
+  );
+  font-weight: var(
+    --recursica_ui-kit_components_panel_properties_content-style_fontWeight
+  );
+  letter-spacing: var(
+    --recursica_ui-kit_components_panel_properties_content-style_letterSpacing
+  );
+  line-height: var(
+    --recursica_ui-kit_components_panel_properties_content-style_lineHeight
+  );
+  text-transform: var(
+    --recursica_ui-kit_components_panel_properties_content-style_textCase
+  );
+  text-decoration: var(
+    --recursica_ui-kit_components_panel_properties_content-style_textDecoration
+  );
+}
+
+/* ======================================
+   PANEL FOOTER
+   ====================================== */
+
+.footer {
+  background-color: var(
+    --recursica_ui-kit_components_panel_properties_colors_header-footer-background
+  );
+  padding: var(
+      --recursica_ui-kit_components_panel_properties_header-footer-vertical-padding
+    )
+    var(
+      --recursica_ui-kit_components_panel_properties_header-footer-horizontal-padding
+    );
+  border-top: var(--recursica_ui-kit_components_panel_properties_divider-size)
+    solid
+    var(--recursica_ui-kit_components_panel_properties_colors_divider-color);
+
+  display: flex;
+  align-items: center;
+  justify-content: flex-end;
+  gap: var(--recursica_ui-kit_components_panel_properties_footer-button-gap);
+
+  /* Ensure footer sticks to the bottom of the scroll container */
+  margin-top: auto;
+  position: sticky;
+
+  /* Break out of .body padding constraints to stretch edge-to-edge */
+  bottom: calc(
+    var(
+        --recursica_ui-kit_components_panel_properties_content-vertical-padding
+      ) *
+      -1
+  );
+  margin-left: calc(
+    var(
+        --recursica_ui-kit_components_panel_properties_content-horizontal-padding
+      ) *
+      -1
+  );
+  margin-right: calc(
+    var(
+        --recursica_ui-kit_components_panel_properties_content-horizontal-padding
+      ) *
+      -1
+  );
+  margin-bottom: calc(
+    var(
+        --recursica_ui-kit_components_panel_properties_content-vertical-padding
+      ) *
+      -1
+  );
+
+  /* Render over scrolling content */
+  z-index: 10;
+}

package/src/components/Panel/Panel.stories.tsx

@@ -1,35 +1,227 @@
+import { useState } from "react";
 import type { Meta, StoryObj } from "@storybook/react";
-import { Panel } from "./Panel";
-import { ComingSoon } from "@recursica/storybook-template";
+import { Panel, type PanelProps } from "./Panel";
+import { Button } from "../Button";
+import { Text } from "../Text/Text";
 
-const meta: Meta<typeof Panel> = {
-  title: "UI-Kit/🚧 Panel",
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type PanelStoryArgs = Record<string, any>;
+
+const meta: Meta = {
+  title: "UI-Kit/Panel",
   component: Panel,
   tags: ["autodocs"],
+  argTypes: {
+    position: {
+      control: "select",
+      options: ["left", "right", "top", "bottom"],
+      description: "Side of the screen the panel slides in from.",
+    },
+    title: {
+      control: "text",
+      description: "Panel title displayed in the header.",
+    },
+    withOverlay: {
+      control: "boolean",
+      description: "Whether to display a background overlay.",
+    },
+    withCloseButton: {
+      control: "boolean",
+      description: "Whether to display the close button in the header.",
+    },
+    wrapHeaderText: {
+      control: "boolean",
+      description:
+        "If true, forces the header text to a single line and truncates with an ellipsis.",
+    },
+    // Hide auto-detected HTML attributes
+    defaultChecked: { table: { disable: true } },
+    defaultValue: { table: { disable: true } },
+    suppressContentEditableWarning: { table: { disable: true } },
+    suppressHydrationWarning: { table: { disable: true } },
+  },
   parameters: {
-    controls: {
-      include: [
-        "layer",
-        "withLayer",
-        "children",
-        "component",
-        "variant",
-        "size",
-        "icon",
-        "disabled",
-        "href",
-        "onClick",
-        "onChange",
-        "value",
-        "checked",
-      ],
+    layout: "fullscreen",
+    docs: {
+      description: {
+        component: `
+The \`Panel\` component slides in or expands from the edge of the screen to reveal additional content or functionality. Built on Mantine's \`Drawer\`, it enforces Recursica design tokens for styling.
+
+### Anatomy
+1. **Header** — Title and close icon, remains fixed on scroll
+2. **Divider** — Separates header/footer from content
+3. **Body (Slot)** — Scrollable content area for custom content
+4. **Footer** — Fixed action buttons (Recursica-specific)
+
+### Usage
+\`\`\`tsx
+const [opened, { open, close }] = useDisclosure(false);
+
+<Button onClick={open}>Open Panel</Button>
+<Panel opened={opened} onClose={close} title="Settings" position="right">
+  Content goes here
+  <Panel.Footer>
+    <Button variant="outline">Cancel</Button>
+    <Button variant="solid">Save</Button>
+  </Panel.Footer>
+</Panel>
+\`\`\`
+        `,
+      },
     },
   },
 };
 
 export default meta;
-type Story = StoryObj<typeof Panel>;
+
+type Story = StoryObj<PanelStoryArgs>;
 
 export const Default: Story = {
-  render: () => <ComingSoon componentName="Panel" />,
+  args: {
+    position: "right",
+    title: "Panel Title",
+    withOverlay: true,
+    withCloseButton: true,
+    wrapHeaderText: false,
+  },
+  render: ({ wrapHeaderText, ...args }: PanelStoryArgs) => {
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const [opened, setOpened] = useState(false);
+
+    return (
+      <>
+        <Button variant="solid" onClick={() => setOpened(true)}>
+          Open Panel
+        </Button>
+        <Panel
+          {...(args as PanelProps)}
+          opened={opened}
+          onClose={() => setOpened(false)}
+          title="Panel Title"
+          position="right"
+          wrapHeaderText={wrapHeaderText}
+        >
+          <Text>
+            This is the panel body content area. Panels slide in from the edge
+            of the screen to reveal supplementary information, navigation
+            options, or toolsets.
+          </Text>
+          <Panel.Footer>
+            <Button variant="outline" onClick={() => setOpened(false)}>
+              Cancel
+            </Button>
+            <Button variant="solid">Save</Button>
+          </Panel.Footer>
+        </Panel>
+      </>
+    );
+  },
+};
+
+export const LeftPosition: Story = {
+  args: {
+    position: "left",
+    title: "Navigation",
+    withOverlay: true,
+    withCloseButton: true,
+    wrapHeaderText: false,
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  render: ({ withLayer, layer, ...args }: PanelStoryArgs) => {
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const [opened, setOpened] = useState(false);
+
+    return (
+      <>
+        <Button variant="outline" onClick={() => setOpened(true)}>
+          Open Left Panel
+        </Button>
+        <Panel
+          {...(args as PanelProps)}
+          opened={opened}
+          onClose={() => setOpened(false)}
+        >
+          <Text>
+            A panel sliding in from the left, commonly used for navigation menus
+            or sidebars.
+          </Text>
+        </Panel>
+      </>
+    );
+  },
+};
+
+export const ScrollableContent: Story = {
+  args: {
+    position: "right",
+    title: "Scrollable Panel",
+    withOverlay: true,
+    withCloseButton: true,
+    wrapHeaderText: false,
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  render: ({ withLayer, layer, ...args }: PanelStoryArgs) => {
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const [opened, setOpened] = useState(false);
+
+    return (
+      <>
+        <Button variant="solid" onClick={() => setOpened(true)}>
+          Open Scrollable Panel
+        </Button>
+        <Panel
+          {...(args as PanelProps)}
+          opened={opened}
+          onClose={() => setOpened(false)}
+        >
+          {Array.from({ length: 20 }).map((_, i) => (
+            <p key={i} style={{ marginBottom: "1rem" }}>
+              Paragraph {i + 1}: This is sample content to demonstrate the
+              scrollable behavior of the panel when content exceeds the viewport
+              height.
+            </p>
+          ))}
+          <Panel.Footer>
+            <Button variant="outline" onClick={() => setOpened(false)}>
+              Close
+            </Button>
+            <Button variant="solid">Apply</Button>
+          </Panel.Footer>
+        </Panel>
+      </>
+    );
+  },
+};
+
+export const LongTitle: Story = {
+  args: {
+    position: "right",
+    title:
+      "This is a ridiculously long panel title designed to test how the header CSS handles text overflow and whether it truncates correctly or breaks the layout",
+    withOverlay: true,
+    withCloseButton: true,
+    wrapHeaderText: true,
+  },
+  render: ({ ...args }: PanelStoryArgs) => {
+    // eslint-disable-next-line react-hooks/rules-of-hooks
+    const [opened, setOpened] = useState(false);
+
+    return (
+      <>
+        <Button variant="solid" onClick={() => setOpened(true)}>
+          Open Long Title Panel
+        </Button>
+        <Panel
+          {...(args as PanelProps)}
+          opened={opened}
+          onClose={() => setOpened(false)}
+        >
+          <Text>
+            Check the header to see if the long title is handled gracefully
+            without pushing the close button off screen.
+          </Text>
+        </Panel>
+      </>
+    );
+  },
 };

package/src/components/Panel/Panel.tsx

@@ -1,8 +1,133 @@
-import React from "react";
-import "./Panel.module.css";
+import { forwardRef } from "react";
+import {
+  Drawer as MuiDrawer,
+  type DrawerProps as MuiDrawerProps,
+} from "@mui/material";
+import {
+  filterStylingProps,
+  type RecursicaOverStyled,
+} from "../../utils/filterStylingProps";
+import styles from "./Panel.module.css";
 
-export type PanelProps = React.HTMLAttributes<HTMLDivElement>;
+// ============================================================
+// PANEL (Drawer)
+// ============================================================
 
-export const Panel: React.FC<PanelProps> = (props) => {
-  return <div {...props}>Panel</div>;
+import { type RecursicaPanelProps } from "@recursica/adapter-common";
+
+/**
+ * Recursica Panel root props. Extends Mui Drawer.
+ */
+export type PanelProps = RecursicaOverStyled<RecursicaPanelProps>;
+
+/**
+ * Recursica Panel component wrapping Mui's Drawer.
+ *
+ * Panels slide in or expand from the edge of the screen to reveal
+ * additional content or functionality. They are commonly used to provide
+ * supplementary information, navigation options, or toolsets without
+ * cluttering the main interface.
+ *
+ * ```tsx
+ * <Panel opened={opened} onClose={close} title="Panel Title" position="right">
+ *   <Panel.Body>
+ *     Content goes here
+ *   </Panel.Body>
+ * </Panel>
+ * ```
+ *
+ * Mui Drawer sub-components available via dot-notation:
+ * - `Panel.Header` — Top section with title and close button
+ * - `Panel.Title` — Title text within the header
+ * - `Panel.CloseButton` — Close button within the header
+ * - `Panel.Body` — Scrollable body content area
+ * - `Panel.Content` — Outer content container
+ * - `Panel.Overlay` — Background overlay
+ * - `Panel.Root` — Root element for advanced composition
+ * - `Panel.Stack` — Stacked drawer context
+ */
+const PanelBase = function Panel({
+  overStyled = false,
+  position = "right",
+  keepMounted = true,
+  wrapHeaderText = false,
+  ...rest
+}: PanelProps & {
+  position?: "left" | "right" | "top" | "bottom";
+  opened?: boolean;
+}) {
+  const sanitizedProps = filterStylingProps(rest, overStyled);
+
+  // Bind CSS module classes to Mui's internal classNames API
+  const mergedClassNames: Partial<Record<string, string>> = {
+    content: styles.content,
+    header: styles.header,
+    title: wrapHeaderText ? styles.titleTruncate : styles.title,
+    body: styles.body,
+    inner: styles.inner,
+  };
+
+  const classNamesProp = (sanitizedProps as Record<string, unknown>).classNames;
+  if (
+    classNamesProp &&
+    typeof classNamesProp === "object" &&
+    !Array.isArray(classNamesProp)
+  ) {
+    const o = classNamesProp as Record<string, string>;
+    Object.keys(o).forEach((key) => {
+      if (mergedClassNames[key]) {
+        mergedClassNames[key] = `${mergedClassNames[key]} ${o[key]}`;
+      } else {
+        mergedClassNames[key] = o[key];
+      }
+    });
+  }
+
+  return (
+    <MuiDrawer
+      anchor={position} /* Recursica default: right; Mui default: left */
+      keepMounted={keepMounted}
+      open={Boolean(rest.opened)}
+      {...(sanitizedProps as unknown as MuiDrawerProps)}
+      classes={mergedClassNames}
+    />
+  );
 };
+PanelBase.displayName = "Panel";
+
+// ============================================================
+// PANEL FOOTER (custom — Mui Drawer has no Footer sub-component)
+// ============================================================
+
+export type PanelFooterProps = RecursicaOverStyled<
+  React.HTMLAttributes<HTMLDivElement>
+>;
+
+/**
+ * Panel footer section with action buttons.
+ * Separated from the body by a divider. Remains fixed at the bottom.
+ * This is a Recursica-specific sub-component; Mui Drawer does not
+ * natively provide a footer.
+ */
+export const PanelFooter = forwardRef<HTMLDivElement, PanelFooterProps>(
+  function PanelFooter({ overStyled = false, ...rest }, ref) {
+    const sanitizedProps = filterStylingProps(rest, overStyled);
+    const classNameProp = (sanitizedProps as Record<string, unknown>)
+      .className as string | undefined;
+
+    const finalClassName = classNameProp
+      ? `${styles.footer} ${classNameProp}`
+      : styles.footer;
+
+    return <div ref={ref} className={finalClassName} {...sanitizedProps} />;
+  },
+);
+PanelFooter.displayName = "PanelFooter";
+
+// ============================================================
+type PanelComponent = typeof PanelBase & {
+  Footer: typeof PanelFooter;
+};
+
+export const Panel = PanelBase as PanelComponent;
+Panel.Footer = PanelFooter;