@recursica/mantine-adapter 0.17.0 → 0.19.0

package/src/components/Modal/Modal.stories.tsx

@@ -1,17 +1,79 @@
+import { useState } from "react";
 import type { Meta, StoryObj } from "@storybook/react";
-import { Modal } from "./Modal";
-import { ComingSoon } from "@recursica/storybook-template";
+import { Modal, type ModalProps } from "./Modal";
+import { Button } from "../Button";
 
 const meta: Meta<typeof Modal> = {
-  title: "UI-Kit/🚧 Modal",
+  title: "UI-Kit/Modal",
   component: Modal,
   tags: ["autodocs"],
+  argTypes: {
+    opened: { table: { disable: true } },
+    onClose: { table: { disable: true } },
+    defaultChecked: { table: { disable: true } },
+  },
 };
 
 export default meta;
 
 type Story = StoryObj<typeof Modal>;
 
+const DefaultWrapper = (args: ModalProps) => {
+  const [opened, setOpened] = useState(false);
+  return (
+    <>
+      <Modal {...args} opened={opened} onClose={() => setOpened(false)}>
+        Please log in to continue accessing this feature.
+        <Modal.Footer>
+          <Button variant="outline" onClick={() => setOpened(false)}>
+            Cancel
+          </Button>
+          <Button onClick={() => setOpened(false)}>Confirm</Button>
+        </Modal.Footer>
+      </Modal>
+      <Button onClick={() => setOpened(true)}>Open Modal</Button>
+    </>
+  );
+};
+
 export const Default: Story = {
-  render: () => <ComingSoon componentName="Modal" />,
+  args: {
+    title: "Authentication Required",
+  },
+  render: (args) => <DefaultWrapper {...args} />,
+};
+
+const ScrollingWrapper = (args: ModalProps) => {
+  const [opened, setOpened] = useState(false);
+  return (
+    <>
+      <Modal {...args} opened={opened} onClose={() => setOpened(false)}>
+        <p>
+          This modal demonstrates the dynamically injected scroll dividers. When
+          this body content overflows, the borders between the Header and Footer
+          automatically appear to define the scrolling boundary.
+        </p>
+        {Array(20)
+          .fill(0)
+          .map((_, i) => (
+            <p key={i}>Scrolling content block {i + 1}...</p>
+          ))}
+        {/* The new Footer abstraction */}
+        <Modal.Footer>
+          <Button variant="outline" onClick={() => setOpened(false)}>
+            Decline
+          </Button>
+          <Button onClick={() => setOpened(false)}>Accept Terms</Button>
+        </Modal.Footer>
+      </Modal>
+      <Button onClick={() => setOpened(true)}>Open Scrolling Modal</Button>
+    </>
+  );
+};
+
+export const ScrollingContent: Story = {
+  args: {
+    title: "Terms and Conditions",
+  },
+  render: (args) => <ScrollingWrapper {...args} />,
 };

package/src/components/Modal/Modal.tsx

@@ -1,7 +1,222 @@
 import React from "react";
+import {
+  Modal as MantineModal,
+  type ModalProps as MantineModalProps,
+} from "@mantine/core";
+import {
+  filterStylingProps,
+  type RecursicaOverStyled,
+} from "../../utils/filterStylingProps";
+import styles from "./Modal.module.css";
 
-export type ModalProps = React.HTMLAttributes<HTMLDivElement>;
+/**
+ * Properties for the strictly-tokenized Modal component.
+ * Native Mantine abstract properties like `size`, `radius`, and `shadow` have been stripped out
+ * because they directly conflict with the non-negotiable pixel boundaries defined in the Recursica UI Kit.
+ */
+export type ModalProps = RecursicaOverStyled<
+  Omit<MantineModalProps, "size" | "radius" | "shadow">
+>;
 
-export const Modal: React.FC<ModalProps> = (props) => {
-  return <div {...props}>Modal</div>;
+/**
+ * The `Modal` component displays a window overlaid on the primary viewport.
+ *
+ * **Recursica Abstract:**
+ * This component acts as a strict structural wrapper around Mantine's `<Modal>`.
+ * It automatically enforces Figma UI Kit geometries (`max-width: 960px`, `min-width: 304px`)
+ * and handles internal body scrolling explicitly via CSS module overrides.
+ *
+ * @example
+ * ```tsx
+ * <Modal opened={opened} onClose={close} title="Hello World">
+ *   Modal Content
+ * </Modal>
+ * ```
+ */
+const ModalInner = React.forwardRef<HTMLDivElement, ModalProps>(function Modal(
+  {
+    overStyled = false,
+    children,
+    title,
+    withCloseButton = true,
+    overlayProps,
+    withOverlay = true,
+    closeButtonProps,
+    ...rest
+  },
+  ref,
+) {
+  const sanitizedProps = filterStylingProps(rest, overStyled);
+
+  const mergedClassNames: Partial<Record<string, string>> = {
+    root: styles.root,
+    inner: styles.inner,
+    content: styles.content,
+    header: styles.header,
+    title: styles.title,
+    close: styles.close,
+  };
+
+  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 (
+    <MantineModal.Root
+      ref={ref}
+      classNames={mergedClassNames}
+      {...(sanitizedProps as unknown as Omit<
+        MantineModalProps,
+        "size" | "radius" | "shadow"
+      >)}
+    >
+      {withOverlay && <MantineModal.Overlay {...overlayProps} />}
+      <MantineModal.Content>
+        {(title || withCloseButton) && (
+          <MantineModal.Header>
+            {title && <MantineModal.Title>{title}</MantineModal.Title>}
+            {withCloseButton && (
+              <MantineModal.CloseButton {...closeButtonProps} />
+            )}
+          </MantineModal.Header>
+        )}
+        <ModalBody>{children}</ModalBody>
+      </MantineModal.Content>
+    </MantineModal.Root>
+  );
+});
+
+ModalInner.displayName = "Modal";
+
+/**
+ * The `Modal.Footer` provides a perfectly padded container for modal actions.
+ *
+ * **Recursica Abstract:**
+ * By default, this container aligns its children to the right (`justify-content: flex-end`)
+ * and applies the standard Figma button-gap spacing.
+ *
+ * > [!IMPORTANT]
+ * > **Button Hierarchy:** Recursica design language explicitly requires that the
+ * > primary action button MUST be the right-most element, with the secondary
+ * > (outline variant) action placed immediately to the left of it.
+ */
+const ModalFooter = React.forwardRef<
+  HTMLDivElement,
+  React.ComponentPropsWithoutRef<"div">
+>(function ModalFooter({ className, ...rest }, ref) {
+  return (
+    <div
+      ref={ref}
+      className={`${styles.footer} ${className || ""}`}
+      {...rest}
+    />
+  );
+});
+ModalFooter.displayName = "Modal.Footer";
+
+const ModalBody = React.forwardRef<
+  HTMLDivElement,
+  React.ComponentPropsWithoutRef<typeof MantineModal.Body>
+>(function ModalBody({ className, onScroll, children, ...rest }, ref) {
+  const internalRef = React.useRef<HTMLDivElement>(null);
+  const [scrolledTop, setScrolledTop] = React.useState(false);
+  const [scrolledBottom, setScrolledBottom] = React.useState(false);
+
+  const checkScroll = React.useCallback(() => {
+    if (internalRef.current) {
+      const { scrollTop, scrollHeight, clientHeight } = internalRef.current;
+      setScrolledTop(scrollTop > 0);
+      setScrolledBottom(Math.ceil(scrollTop + clientHeight) < scrollHeight);
+    }
+  }, []);
+
+  // Re-check scroll on mount and window resize
+  React.useEffect(() => {
+    checkScroll();
+    window.addEventListener("resize", checkScroll);
+    return () => window.removeEventListener("resize", checkScroll);
+  }, [checkScroll, children]);
+
+  const handleScroll = (e: React.UIEvent<HTMLDivElement>) => {
+    checkScroll();
+    onScroll?.(e);
+  };
+
+  // Intercept children to pull Modal.Footer out of the scrolling container
+  let footer: React.ReactNode = null;
+  const bodyChildren: React.ReactNode[] = [];
+
+  React.Children.forEach(children, (child) => {
+    if (
+      React.isValidElement(child) &&
+      (child.type === ModalFooter ||
+        (child.type as React.ComponentType)?.displayName === "Modal.Footer")
+    ) {
+      footer = child;
+    } else {
+      bodyChildren.push(child);
+    }
+  });
+
+  return (
+    <MantineModal.Body
+      {...rest}
+      ref={(node) => {
+        if (typeof ref === "function") ref(node);
+        else if (ref)
+          (ref as React.MutableRefObject<HTMLDivElement | null>).current = node;
+      }}
+      className={`${styles.bodyWrapper} ${className || ""}`}
+    >
+      <div
+        ref={internalRef}
+        onScroll={handleScroll}
+        data-scrolled-top={scrolledTop || undefined}
+        data-scrolled-bottom={scrolledBottom || undefined}
+        className={styles.scrollArea}
+      >
+        {bodyChildren}
+      </div>
+      {footer}
+    </MantineModal.Body>
+  );
+});
+ModalBody.displayName = "Modal.Body";
+
+interface ModalComponent
+  extends React.ForwardRefExoticComponent<
+    ModalProps & React.RefAttributes<HTMLDivElement>
+  > {
+  Root: typeof MantineModal.Root;
+  Overlay: typeof MantineModal.Overlay;
+  Content: typeof MantineModal.Content;
+  Header: typeof MantineModal.Header;
+  Title: typeof MantineModal.Title;
+  CloseButton: typeof MantineModal.CloseButton;
+  Body: typeof ModalBody;
+  Footer: typeof ModalFooter;
+}
+
+export const Modal = ModalInner as ModalComponent & {
+  Footer: typeof ModalFooter;
 };
+Modal.Root = MantineModal.Root;
+Modal.Overlay = MantineModal.Overlay;
+Modal.Content = MantineModal.Content;
+Modal.Header = MantineModal.Header;
+Modal.Title = MantineModal.Title;
+Modal.CloseButton = MantineModal.CloseButton;
+Modal.Body = ModalBody;
+Modal.Footer = ModalFooter;

package/src/components/Modal/index.ts

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

package/src/components/Popover/IMPLEMENTATION_NOTES.md

@@ -0,0 +1,77 @@
+# Popover – Implementation Notes
+
+Decisions and design tweaks strictly tailored for the UI Kit's Popover wrapped against `@mantine/core`. This is a living document that tracks _why_ specific logic decisions exist.
+
+---
+
+## 1. Composable API Preservation (1:1 Mapping)
+
+**Decision:** We maintain the exact library composition API structure (`<Popover>`, `<Popover.Target>`, `<Popover.Dropdown>`) as a 1:1 React component mapping.
+
+**Implementation:** Mantine's Popover internally manages click detection, open/close state, Floating UI positioning, and portal rendering. By preserving the exact sub-component tree, Recursica safely inherits all of these behaviors without reimplementation.
+
+---
+
+## 2. Popover.Target Pass-Through
+
+**Decision:** `Popover.Target` is a transparent pass-through with no styling applied.
+
+**Implementation:** The target wrapper exists solely to manage Mantine's ref forwarding and event binding for the trigger element. No `filterStylingProps` or CSS module classes are applied — the trigger's appearance is entirely controlled by whatever component the integrator places inside it (e.g., `<Button>`). This is identical to the `Menu.Target` and `HoverCard.Target` pattern.
+
+---
+
+## 3. Token Namespace: `hover-card-popover`
+
+**Decision:** The CSS module exclusively uses variables from the `--recursica_ui-kit_components_hover-card-popover_*` namespace.
+
+**Implementation:** The Recursica token system defines a single shared namespace (`hover-card-popover`) for this component and HoverCard. It covers geometry (border-radius, border-size, padding, min/max-width), typography (content-text\_\*), elevation, and layer-aware colors (background, border-color, content).
+
+---
+
+## 4. Hardcoded Values
+
+**Decision:** Two hardcoded values exist in the component.
+
+### `border-style: solid` (CSS module)
+
+Mantine renders the dropdown using its `Paper` component, which does not set `border-style` natively. Without this hardcoded value, the border-width and border-color tokens would have no visible effect. This is the same pattern used in the Menu component's dropdown.
+
+### `arrowSize` defaulted to `16` (Popover.tsx)
+
+Mantine's `arrowSize` prop is a JavaScript number used for inline style calculations: it sets `width`, `height`, and a positioning offset (`-arrowSize/2`) directly on the arrow `<div>` element. These inline styles **cannot** be overridden via CSS without `!important`, and the positioning offset has no CSS equivalent. This means the beak size cannot be fully CSS-driven — it is one of the rare cases where a design token value must be mirrored as a JS prop.
+
+The default value `16` matches the Recursica `beak-size` token (`--recursica_ui-kit_components_hover-card-popover_properties_beak-size: 16px`). Developers can override `arrowSize` if needed, but should be aware this is a design system concern. If the token value changes, the default in `Popover.tsx` must also be updated.
+
+This is documented as an open issue in `docs/COMPONENT_ISSUES.md`.
+
+**Note:** Mantine calls this the "arrow"; Recursica calls it the "beak". The Recursica prop `withBeak` (defaulting to `true`) maps to Mantine's `withArrow`. Both `withBeak` and `withArrow` are accepted; `withBeak` takes precedence.
+
+---
+
+## 5. Minimal CSS Override Philosophy
+
+**Decision:** The CSS module only overrides visual design tokens (colors, typography, spacing, borders, shadows). All structural layout properties are deferred to Mantine's native behavior.
+
+**Implementation:** Popover is an overlay component where Mantine's native Floating UI positioning and Paper layout are already correct. We avoid setting:
+
+- `overflow` on the dropdown (Mantine handles scroll behavior natively)
+- `display`, `position`, `z-index` (Floating UI controls these)
+- `pointer-events` (Mantine manages hover detection across target and dropdown)
+
+**Rationale:** Default to Mantine's native behavior and only override what the Recursica token system explicitly needs to control.
+
+---
+
+## 6. ClassNames Merging on Root
+
+**Decision:** The root `Popover` component binds CSS module classes via `classNames` on the Mantine root.
+
+**Implementation:** The root component receives `classNames={{ dropdown: styles.dropdown, arrow: styles.arrow }}` and merges any consumer-provided `classNames` when `overStyled` is true. This ensures our token-driven styles are applied to the dropdown panel without wrapper divs, and the consumer's classes are additive.
+
+---
+
+## 7. Default Position Override
+
+**Decision:** Recursica defaults `position` to `"top"`. Mantine defaults to `"bottom"`.
+
+**Implementation:** The `position="top"` default is set on the Mantine root element before the prop spread, so developer-provided `position` values still take precedence. This aligns with Recursica's design intent for overlay components to appear above their trigger by default.

package/src/components/Popover/Popover.module.css

@@ -0,0 +1,84 @@
+/* HARDCODED VALUES:
+   - border-style: solid. Structural rendering rule for the dropdown border (Mantine uses Paper
+     which may not set border-style natively). Same pattern as Menu and HoverCard.
+   - arrowSize defaults to 16 in Popover.tsx. Mantine uses arrowSize for inline width/height
+     and positioning (-arrowSize/2) calculations that cannot be CSS-driven. The default matches
+     the Recursica beak-size token (16px). See COMPONENT_ISSUES.md for details.
+   - All structural layout (display, position, overflow) is deferred to Mantine's native
+     behavior. We only override visual design tokens (colors, typography, spacing, borders).
+*/
+
+/* ======================================
+   DROPDOWN CONTAINER
+   ====================================== */
+
+.dropdown {
+  background-color: var(
+    --recursica_ui-kit_components_hover-card-popover_colors_background
+  );
+  border-style: solid; /* HARDCODE: Mantine Paper does not set border-style natively */
+  border-width: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_border-size
+  );
+  border-color: var(
+    --recursica_ui-kit_components_hover-card-popover_colors_border-color
+  );
+  border-radius: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_border-radius
+  );
+  box-shadow: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_elevation
+  );
+
+  min-width: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_min-width
+  );
+  max-width: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_max-width
+  );
+
+  padding: var(
+      --recursica_ui-kit_components_hover-card-popover_properties_vertical-padding
+    )
+    var(
+      --recursica_ui-kit_components_hover-card-popover_properties_horizontal-padding
+    );
+
+  /* Typography */
+  font-family: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_content-text_font-family
+  );
+  font-size: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_content-text_font-size
+  );
+  font-style: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_content-text_font-style
+  );
+  font-weight: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_content-text_font-weight
+  );
+  letter-spacing: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_content-text_letter-spacing
+  );
+  line-height: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_content-text_line-height
+  );
+  text-decoration: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_content-text_text-decoration
+  );
+  text-transform: var(
+    --recursica_ui-kit_components_hover-card-popover_properties_content-text_text-transform
+  );
+
+  color: var(--recursica_ui-kit_components_hover-card-popover_colors_content);
+}
+
+/* ======================================
+   ARROW / BEAK
+   ====================================== */
+
+.arrow {
+  border-color: var(
+    --recursica_ui-kit_components_hover-card-popover_colors_border-color
+  );
+}

package/src/components/Popover/Popover.stories.tsx

@@ -0,0 +1,133 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import { Popover } from "./Popover";
+import { Button } from "../Button";
+import { Text } from "../Text/Text";
+import { Stack } from "../Stack/Stack";
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type PopoverStoryArgs = Record<string, any>;
+
+const meta = {
+  title: "UI-Kit/Popover",
+  component: Popover,
+  tags: ["autodocs"],
+  parameters: {
+    docs: {
+      description: {
+        component:
+          "The `Popover` component is a composable wrapper around Mantine's Popover. It displays a dropdown panel when the user clicks or interacts with a target element.",
+      },
+    },
+  },
+  argTypes: {
+    withBeak: {
+      control: "boolean",
+      description:
+        "Whether to display a beak (arrow) pointing from the dropdown to the target.",
+    },
+    position: {
+      control: "select",
+      options: [
+        "top",
+        "top-start",
+        "top-end",
+        "bottom",
+        "bottom-start",
+        "bottom-end",
+        "left",
+        "left-start",
+        "left-end",
+        "right",
+        "right-start",
+        "right-end",
+      ],
+      description: "Dropdown position relative to target",
+    },
+    defaultOpened: {
+      control: "boolean",
+      description: "Initial opened state",
+    },
+  },
+} satisfies Meta<typeof Popover>;
+
+export default meta;
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    withBeak: true,
+    position: "top",
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  render: ({ withLayer, layer, ...args }: PopoverStoryArgs) => {
+    return (
+      <Popover width={250} {...args}>
+        <Popover.Target>
+          <Button variant="solid">Toggle Popover</Button>
+        </Popover.Target>
+        <Popover.Dropdown>
+          <Text size="rec-sm">
+            This is the popover content. It can contain any elements you want to
+            display when the user clicks the target.
+          </Text>
+        </Popover.Dropdown>
+      </Popover>
+    );
+  },
+};
+
+export const SolidDefault: Story = {
+  args: {
+    withBeak: true,
+    position: "top",
+    defaultOpened: true,
+  },
+  parameters: {
+    controls: { disable: true },
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  render: ({ withLayer, layer, ...args }: PopoverStoryArgs) => {
+    return (
+      <Stack align="center" justify="center" style={{ padding: "100px" }}>
+        <Popover width={200} {...args}>
+          <Popover.Target>
+            <Button variant="solid">Toggle Popover</Button>
+          </Popover.Target>
+          <Popover.Dropdown>
+            <Text size="rec-sm">
+              This is a static representation of an opened popover with a beak.
+            </Text>
+          </Popover.Dropdown>
+        </Popover>
+      </Stack>
+    );
+  },
+};
+
+export const WithoutBeak: Story = {
+  args: {
+    withBeak: false,
+    position: "bottom",
+    defaultOpened: true,
+  },
+  parameters: {
+    controls: { disable: true },
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  render: ({ withLayer, layer, ...args }: PopoverStoryArgs) => {
+    return (
+      <Stack align="center" justify="center" style={{ padding: "100px" }}>
+        <Popover width={200} {...args}>
+          <Popover.Target>
+            <Button variant="outline">Bottom Popover</Button>
+          </Popover.Target>
+          <Popover.Dropdown>
+            <Text size="rec-sm">
+              This popover is positioned at the bottom and has no beak.
+            </Text>
+          </Popover.Dropdown>
+        </Popover>
+      </Stack>
+    );
+  },
+};