@recursica/mantine-adapter 0.13.0 → 0.14.0

package/src/components/NumberInput/NumberInput.tsx

@@ -1,7 +1,146 @@
-import React from "react";
+import React, { forwardRef } from "react";
+import {
+  NumberInput as MantineNumberInput,
+  type NumberInputProps as MantineNumberInputProps,
+} from "@mantine/core";
+import { type ReadOnlyControlProps } from "@recursica/adapter-common";
+import {
+  filterStylingProps,
+  type RecursicaOverStyled,
+} from "../../utils/filterStylingProps";
+import { type RecursicaFormControlWrapperProps } from "../FormControlWrapper/FormControlWrapper";
+import { WithReadOnlyWrapper } from "../ReadOnlyField/WithReadOnlyWrapper";
+import styles from "./NumberInput.module.css";
 
-export type NumberInputProps = React.HTMLAttributes<HTMLDivElement>;
+export interface RecursicaNumberInputProps
+  extends Omit<
+      MantineNumberInputProps,
+      "size" | "variant" | "radius" | "wrapperProps" | "classNames" | "styles"
+    >,
+    Pick<
+      RecursicaFormControlWrapperProps,
+      | "assistiveText"
+      | "assistiveWithIcon"
+      | "formLayout"
+      | "labelSize"
+      | "labelAlignment"
+      | "labelOptionalText"
+      | "labelWithEditIcon"
+      | "onLabelEditClick"
+    >,
+    ReadOnlyControlProps {
+  /** Enables/disables the controls to increment and decrement the value */
+  hideControls?: boolean;
+}
 
-export const NumberInput: React.FC<NumberInputProps> = (props) => {
-  return <div {...props}>NumberInput</div>;
-};
+export type NumberInputProps = RecursicaOverStyled<RecursicaNumberInputProps>;
+
+export const NumberInput = forwardRef<HTMLInputElement, NumberInputProps>(
+  function NumberInput(props, ref) {
+    const {
+      overStyled = false,
+      formLayout = "stacked",
+
+      // Label & Wrapper Maps
+      labelSize,
+      labelAlignment,
+      labelOptionalText,
+      labelWithEditIcon,
+      onLabelEditClick,
+
+      label,
+      assistiveText,
+      assistiveWithIcon,
+      error,
+      required,
+      withAsterisk,
+      id,
+      className,
+      style,
+      disabled,
+      readOnly,
+      readOnlyComponent,
+      emptyValueComponent,
+      value,
+      defaultValue,
+      hideControls = false,
+      ...rest
+    } = props;
+
+    const sanitizedProps = filterStylingProps(rest, overStyled);
+    const restRecord = sanitizedProps as Record<string, unknown>;
+
+    // Delete prohibited sizing hooks from bypassing variables natively
+    delete restRecord["size"];
+    delete restRecord["variant"];
+    delete restRecord["radius"];
+
+    // Securely map core native blocks down ensuring nested CSS modules map precisely
+    const mergedClassNames: Partial<Record<string, string>> = {
+      wrapper: styles.root, // The nested Input internal relative wrapper bounding box
+      input: styles.input,
+      section: styles.section,
+      controls: styles.controls,
+      control: styles.control,
+    };
+
+    return (
+      <WithReadOnlyWrapper
+        className={className}
+        style={style as React.CSSProperties}
+        controlMaxWidth="var(--recursica_ui-kit_components_number-input_properties_max-width)"
+        controlMinWidth="var(--recursica_ui-kit_components_number-input_properties_min-width)"
+        overStyled={overStyled as true}
+        formLayout={formLayout}
+        labelSize={labelSize}
+        labelAlignment={labelAlignment}
+        labelOptionalText={labelOptionalText}
+        labelWithEditIcon={labelWithEditIcon}
+        onLabelEditClick={onLabelEditClick}
+        label={label}
+        assistiveText={assistiveText}
+        assistiveWithIcon={assistiveWithIcon}
+        error={error}
+        required={required}
+        withAsterisk={withAsterisk}
+        id={id}
+        readOnly={readOnly}
+        readOnlyComponent={readOnlyComponent}
+        emptyValueComponent={emptyValueComponent}
+        readOnlyType="text"
+        readOnlyValue={
+          value !== undefined ? value?.toString() : defaultValue?.toString()
+        }
+        readOnlyNativeProps={props}
+        activeComponent={
+          /* Naked Input execution safely decoupled from Mantine's macro Input.Wrapper DOM hooks */
+          <MantineNumberInput
+            ref={ref}
+            classNames={mergedClassNames}
+            disabled={disabled}
+            value={value}
+            defaultValue={defaultValue}
+            hideControls={hideControls}
+            label={undefined}
+            description={undefined}
+            error={undefined}
+            required={undefined}
+            withAsterisk={undefined}
+            wrapperProps={{
+              "data-disabled": disabled ? "true" : undefined,
+              "data-error": error ? "true" : undefined,
+              "data-with-left-section": restRecord.leftSection
+                ? "true"
+                : undefined,
+              "data-with-right-section":
+                restRecord.rightSection || !hideControls ? "true" : undefined,
+            }}
+            {...(sanitizedProps as unknown as MantineNumberInputProps)}
+          />
+        }
+      />
+    );
+  },
+);
+
+NumberInput.displayName = "NumberInput";

package/src/components/Panel/PANEL_IMPLEMENTATION_NOTES.md

@@ -0,0 +1,106 @@
+# Panel – Implementation Notes
+
+Decisions and design tweaks strictly tailored for the UI Kit's Panel wrapped against `@mantine/core`. This is a living document that tracks _why_ specific logic decisions exist.
+
+---
+
+## 1. Mapping to Mantine Drawer
+
+**Decision:** Panel maps to Mantine's `Drawer` component, not `Paper` or `Card`.
+
+**Implementation:** Per the Recursica design system specification, "Panels slide in or expand from the edge of the screen to reveal additional content or functionality." This is the exact behavior of Mantine's `Drawer` component, which provides:
+
+- Slide-in animation from any screen edge
+- Overlay/backdrop
+- Portal rendering
+- Focus trapping
+- Scroll locking
+- Close button and title in header
+
+Paper and Card are static containers; Drawer is an overlay that matches Panel's defined behavior.
+
+---
+
+## 2. Token Namespace: `panel`
+
+**Decision:** The CSS module exclusively uses variables from the `--recursica_ui-kit_components_panel_*` namespace.
+
+**Implementation:** The Recursica token system defines the `panel` namespace covering:
+
+- Geometry: border-radius, border-size, min-width (200px), max-width (960px)
+- Content padding: content-horizontal-padding (xl), content-vertical-padding (lg)
+- Header/Footer padding: header-footer-horizontal-padding (xl), header-footer-vertical-padding (md)
+- Spacing: header-close-gap (md), footer-button-gap (md)
+- Divider: divider-size (1px), divider-color
+- Elevation: elevation-3
+- Colors (layer-aware): background, border-color, content, divider-color, header-footer-background, title
+- Non-CSS: header-style ("h3") — see §7
+
+No tokens from other component namespaces are referenced.
+
+---
+
+## 3. ClassNames Mapping to Drawer
+
+**Decision:** Panel maps CSS module classes to Mantine Drawer's stylesNames.
+
+**Implementation:** The Drawer stylesNames used are:
+
+- `content` — Outer container (background, border, elevation)
+- `header` — Title bar with close button (padding, divider, gap)
+- `title` — Title text color
+- `body` — Scrollable content area (padding)
+
+Other stylesNames (`overlay`, `root`, `inner`, `close`) are left to Mantine defaults.
+
+---
+
+## 4. Default Position Override
+
+**Decision:** Recursica defaults `position` to `"right"`. Mantine defaults to `"left"`.
+
+**Implementation:** The `position="right"` default is set before the prop spread, so developer-provided `position` values still take precedence. Right-side panels are the most common pattern for supplementary content, settings, and detail views.
+
+---
+
+## 5. Custom Panel.Footer
+
+**Decision:** A custom `Panel.Footer` sub-component is provided. Mantine's Drawer does not have a native footer.
+
+**Implementation:** `Panel.Footer` is a `<div>` with inline styles referencing Recursica CSS variables for:
+
+- `header-footer-background` and `header-footer-padding` tokens
+- Top divider using `divider-size` and `divider-color`
+- `footer-button-gap` for action button spacing
+- `margin-top: auto` to push the footer to the bottom
+
+Inline styles are used instead of a CSS module class because the footer is rendered inside the Drawer's `<body>` element, and the CSS variables are applied to the body's parent container. The inline styles ensure the footer correctly references the panel tokens regardless of DOM position.
+
+---
+
+## 6. Hardcoded Values
+
+### `border-style: solid` (CSS module, `.content`)
+
+Mantine's Drawer content does not set `border-style` natively. Without this, the border-width and border-color tokens have no visible effect. Same pattern as Card, Menu, HoverCard, Tooltip.
+
+---
+
+## 7. header-style Token Reference Bug
+
+**Decision:** The `header-style: "h3"` token currently outputs as a raw string in the UI kit JSON, breaking our PostCSS compiler when mapped as CSS variable fallbacks. We have explicitly removed these fallbacks.
+
+**Implementation:** The design system intended for the `header-style` token to act as a proper typography reference, which would compile into fully expanded properties like `--recursica_ui-kit_components_panel_properties_header-style_fontFamily`. Because the JSON export currently passes it as the raw string `"h3"`, attempting to bind to the non-existent variables breaks the build plugin. Until the JSON export is fixed to compile proper reference nodes, we are stripping typography bindings from the `.title` class and relying purely on `color` and Mantine's defaults.
+
+---
+
+## 8. Panel Types: Standard vs Scrollable
+
+**Decision:** Both standard and scrollable types are supported natively.
+
+**Implementation:** Per the Recursica specification:
+
+- **Standard** — All content visible without scrolling. The default behavior when content fits.
+- **Scrollable** — Internal scrollbar enabled when content exceeds the panel height. Header and footer CTAs remain pinned.
+
+Mantine's Drawer handles this automatically — the `body` section scrolls when content overflows, while the `header` remains fixed. The `Panel.Footer` uses `margin-top: auto` to stay at the bottom.

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

@@ -0,0 +1,143 @@
+/* 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);
+  color: var(--recursica_ui-kit_components_panel_properties_colors_content);
+
+  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);
+}
+
+/* ======================================
+   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;
+}
+
+/* ======================================
+   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,17 +1,216 @@
+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.",
+    },
+    // 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 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,
+  },
+  render: () => {
+    // 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
+          opened={opened}
+          onClose={() => setOpened(false)}
+          title="Panel Title"
+          position="right"
+        >
+          <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,
+  },
+  // 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,
+  },
+  // 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,
+  },
+  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>
+      </>
+    );
+  },
 };