@recursica/adapter-mui-v7 1.0.0

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

@@ -0,0 +1,231 @@
+/* HARDCODED VALUES:
+   - border-style: solid: Structural rendering rule for the panel border.
+   - 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 PAPER (MUI Drawer's actual positioned/sized DOM node)
+   ====================================== */
+
+.paper {
+  /* MUI's Drawer `classes` prop only exposes its own slots (root, paper, docked, ...) — unlike
+     Mantine's `classNames`, it has no content/header/title/body slots to bind the rest of this
+     file's classes into. The box-model/appearance chrome below lives on `.content` instead,
+     rendered as an explicit child of Paper (see Panel.tsx). Strip Paper's own default MUI
+     appearance (elevation box-shadow, paper background) so only `.content`'s chrome shows —
+     otherwise the two would double up as a square-cornered shadow behind the rounded one. */
+  background-color: transparent;
+  box-shadow: none;
+}
+
+/* ======================================
+   PANEL CONTENT (the whole visible panel box, rendered inside Paper)
+   ====================================== */
+
+.content {
+  background-color: var(
+    --recursica_ui-kit_components_panel_properties_colors_background-color
+  );
+  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%;
+}
+
+/* ======================================
+   PANEL HEADER
+   ====================================== */
+
+.header {
+  /* HARDCODE: Mantine's `Drawer.Header` is flex (title + close button side-by-side) natively;
+     MUI's header here is a plain manually-built div (see Panel.tsx), so the layout has to be
+     declared explicitly. */
+  display: flex;
+  align-items: center;
+  justify-content: space-between;
+
+  background-color: var(
+    --recursica_ui-kit_components_panel_properties_colors_header-background-color
+  );
+  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);
+}
+
+.close {
+  /* No Recursica token namespace exists for a panel close icon (Mantine's own Panel doesn't
+     style one either — it renders Mantine's plain default CloseButton) — flex-shrink keeps it
+     from being squeezed by a long, truncating title. */
+  flex-shrink: 0;
+}
+
+/* ======================================
+   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: clip; /* HARDCODE: `hidden` clips descenders (e.g. "g") when text_line-height is
+    tighter than the font's natural ascent+descent; overflow-clip-margin gives ink a small bleed
+    allowance while still clipping genuinely overflowing text (see Chip's IMPLEMENTATION_NOTES.md). */
+  overflow-clip-margin: 0.35em;
+  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_footer-background-color
+  );
+  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

@@ -0,0 +1,227 @@
+import { useState } from "react";
+import type { Meta, StoryObj } from "@storybook/react";
+import { Panel, type PanelProps } from "./Panel";
+import { Button } from "../Button";
+import { Text } from "../Text/Text";
+
+// 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: {
+    placement: {
+      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: {
+    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 Mui'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" placement="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<PanelStoryArgs>;
+
+export const Default: Story = {
+  args: {
+    placement: "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"
+          placement="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 LeftPlacement: Story = {
+  args: {
+    placement: "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: {
+    placement: "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: {
+    placement: "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.test.tsx

@@ -0,0 +1 @@
+// Placeholder for future Panel component tests. Add tests here if/when needed.

package/src/components/Panel/Panel.tsx

@@ -0,0 +1,186 @@
+import { forwardRef, type ReactNode } from "react";
+import {
+  Drawer as MuiDrawer,
+  type DrawerProps as MuiDrawerProps,
+  IconButton as MuiIconButton,
+} from "@mui/material";
+import {
+  filterStylingProps,
+  mergeClassNames,
+  type RecursicaOverStyled,
+} from "../../utils/filterStylingProps";
+import styles from "./Panel.module.css";
+
+// ============================================================
+// PANEL (Drawer)
+// ============================================================
+
+import { type RecursicaPanelProps as BaseRecursicaPanelProps } from "@recursica/adapter-common";
+
+/**
+ * Recursica Panel root props. Extends Mui Drawer.
+ */
+export interface RecursicaPanelProps
+  extends Omit<
+      MuiDrawerProps,
+      "classes" | "position" | "style" | "anchor" | "open" | "title"
+    >,
+    BaseRecursicaPanelProps {
+  /** Panel header title label. */
+  title?: ReactNode;
+  /** Whether to display a background overlay. Default true. */
+  withOverlay?: boolean;
+  /** Whether to display the close button in the header. Default true. */
+  withCloseButton?: boolean;
+}
+
+export type PanelProps = RecursicaOverStyled<RecursicaPanelProps>;
+
+const CloseIcon = () => (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    width="16"
+    height="16"
+    viewBox="0 0 24 24"
+    fill="none"
+    stroke="currentColor"
+    strokeWidth="2"
+    strokeLinecap="round"
+    strokeLinejoin="round"
+  >
+    <path d="M18 6L6 18M6 6l12 12" />
+  </svg>
+);
+
+/**
+ * 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" placement="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,
+  placement = "right",
+  keepMounted = true,
+  wrapHeaderText = true,
+  opened,
+  title,
+  withOverlay = true,
+  withCloseButton = true,
+  onClose,
+  children,
+  ...rest
+}: PanelProps) {
+  const sanitizedProps = filterStylingProps(rest, overStyled);
+
+  // MUI Drawer's `classes` prop only recognizes its own slot names (`root`, `paper`,
+  // `docked`, ...) — unlike Mantine's `classNames`, it has no `content`/`header`/`title`/`body`
+  // slots to bind into. Passing those keys here used to silently no-op every one of them, which
+  // is why the panel rendered with none of its Recursica chrome (border, radius, sizing) and no
+  // header at all: MUI's raw Drawer has no `title`/`withCloseButton` convenience API the way
+  // Mantine's does, so those props were being spread onto the DOM as inert attributes instead of
+  // building a header. The box-model/appearance chrome (border, radius, shadow, size bounds) now
+  // lives on an explicit `.content` wrapper rendered as Paper's child instead; `.paper` strips
+  // MUI's own default Paper appearance so only the wrapper's chrome is visible.
+  const mergedClassNames = mergeClassNames(
+    { paper: styles.paper },
+    (sanitizedProps as Record<string, unknown>).classes as
+      | Partial<Record<string, string>>
+      | undefined,
+  );
+
+  return (
+    <MuiDrawer
+      anchor={placement} /* Recursica default: right; Mui default: left */
+      keepMounted={keepMounted}
+      open={Boolean(opened)}
+      onClose={onClose}
+      hideBackdrop={!withOverlay}
+      {...(sanitizedProps as unknown as MuiDrawerProps)}
+      classes={mergedClassNames as unknown as MuiDrawerProps["classes"]}
+    >
+      <div className={styles.content}>
+        {(title || withCloseButton) && (
+          <div className={styles.header}>
+            {title && (
+              <div
+                className={wrapHeaderText ? styles.titleTruncate : styles.title}
+              >
+                {title}
+              </div>
+            )}
+            {withCloseButton && (
+              <MuiIconButton
+                size="small"
+                aria-label="Close"
+                onClick={(e) => onClose?.(e, "backdropClick")}
+                className={styles.close}
+              >
+                <CloseIcon />
+              </MuiIconButton>
+            )}
+          </div>
+        )}
+        <div className={styles.body}>{children}</div>
+      </div>
+    </MuiDrawer>
+  );
+};
+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} {...sanitizedProps} className={finalClassName} />;
+  },
+);
+PanelFooter.displayName = "PanelFooter";
+
+// ============================================================
+type PanelComponent = typeof PanelBase & {
+  Footer: typeof PanelFooter;
+};
+
+export const Panel = PanelBase as PanelComponent;
+Panel.Footer = PanelFooter;

package/src/components/Panel/USAGE.md

@@ -0,0 +1,46 @@
+# Panel - Usage Guide
+
+This document describes how to integrate and use the `Panel` component in your projects using `@recursica/adapter-mui-v7`.
+
+---
+
+## 1. Import Reference
+
+```tsx
+import { Panel } from "@recursica/adapter-mui-v7";
+```
+
+---
+
+## 2. Basic Example
+
+```tsx
+import React from "react";
+import { Panel } from "@recursica/adapter-mui-v7";
+
+export default function Demo() {
+  return (
+    <Panel>
+      <Text>This is a clean, structured visual container.</Text>
+    </Panel>
+  );
+}
+```
+
+---
+
+## 3. Design System Integration
+
+All Recursica components in the `@recursica/adapter-mui-v7` package adhere strictly to design system spacing, scaling, and behavior patterns.
+
+> [!IMPORTANT]
+>
+> - **Anti-override protection**: Rogues style injections (like inline `style` or arbitrary `className`) are automatically blocked by our prop layer unless `overStyled={true}` is explicitly provided.
+> - **No Direct Layers**: Do not pass a `layer` prop to this component. To place it on a specific visual layer, wrap it in a `<Layer layer={0|1|2|3}>` component natively.
+> - **Variables and Theming**: Styling is entirely determined by local CSS variables defined in `recursica_variables_scoped.css` and mapped in the component's CSS module.
+
+---
+
+## 4. Key Integration Features & Constraints
+
+`Panel` accepts a `placement` prop (`"left"`, `"right"`, `"top"`, or `"bottom"`) that controls which edge of the screen the panel slides in from, and defaults to `"right"`. This prop was renamed from `position` to `placement`.

package/src/components/Panel/index.ts

@@ -0,0 +1 @@
+export * from "./Panel";