@recursica/mantine-adapter 0.5.0 → 0.7.0

package/src/components/Avatar/Avatar.stories.tsx

@@ -0,0 +1,102 @@
+import React from "react";
+import type { Meta, StoryObj } from "@storybook/react";
+import { Avatar } from "./Avatar";
+import { Layer } from "@recursica/adapter-common";
+
+type AvatarStoryProps = React.ComponentProps<typeof Avatar>;
+
+const meta: Meta<AvatarStoryProps> = {
+  title: "UI-Kit/Avatar",
+  component: Avatar,
+  tags: ["autodocs"],
+  argTypes: {
+    variant: {
+      control: "select",
+      options: ["solid", "outline", "ghost"],
+      description:
+        "The visual variant of the avatar (applies to icon/text styles)",
+    },
+    size: {
+      control: "radio",
+      options: ["default", "small", "large"],
+      description: "The size of the avatar",
+    },
+    src: {
+      control: "text",
+      description: "Image URL for the image style avatar",
+    },
+    icon: {
+      table: {
+        disable: true,
+      },
+    },
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<AvatarStoryProps>;
+
+export const Default: Story = {
+  args: {
+    size: "default",
+    variant: "solid",
+  },
+  render: (args) => {
+    return <Avatar {...args} />;
+  },
+};
+
+export const TextSolidDefault: Story = {
+  args: {
+    children: "JD",
+    variant: "solid",
+    size: "default",
+  },
+  render: (args) => <Avatar {...args} />,
+};
+
+export const ImageLarge: Story = {
+  args: {
+    src: "https://images.unsplash.com/photo-1535713875002-d1d0cf377fde?ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=250&q=80",
+    size: "large",
+  },
+  render: (args) => <Avatar {...args} />,
+};
+
+export const IconSmallGhost: Story = {
+  args: {
+    size: "small",
+    variant: "ghost",
+    icon: (
+      <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="M20 21v-2a4 4 0 0 0-4-4H8a4 4 0 0 0-4 4v2"></path>
+        <circle cx="12" cy="7" r="4"></circle>
+      </svg>
+    ),
+  },
+  render: (args) => <Avatar {...args} />,
+};
+
+export const LayerOneOutline: Story = {
+  args: {
+    children: "L1",
+    variant: "outline",
+    size: "default",
+  },
+  render: (args) => (
+    <Layer layer={1} style={{ padding: "24px", display: "inline-block" }}>
+      <Avatar {...args} />
+    </Layer>
+  ),
+};

package/src/components/Avatar/Avatar.tsx

@@ -0,0 +1,100 @@
+import React, { forwardRef } from "react";
+import {
+  Avatar as MantineAvatar,
+  type AvatarProps as MantineAvatarProps,
+} from "@mantine/core";
+import styles from "./Avatar.module.css";
+
+export interface RecursicaAvatarProps {
+  size?: "small" | "default" | "large";
+  variant?: "solid" | "outline" | "ghost";
+  icon?: React.ReactNode;
+}
+
+export type AvatarProps = Omit<
+  MantineAvatarProps,
+  "variant" | "size" | "color" | "radius"
+> &
+  RecursicaAvatarProps;
+
+export const Avatar = forwardRef<HTMLDivElement, AvatarProps>(function Avatar(
+  {
+    size = "default",
+    variant = "solid",
+    icon,
+    className,
+    classNames,
+    children,
+    style,
+    src,
+    ...rest
+  },
+  ref,
+) {
+  const mapVariant = {
+    solid: "filled",
+    outline: "outline",
+    ghost: "transparent",
+  } as const;
+
+  const mapSize = {
+    default: "md",
+    small: "sm",
+    large: "lg",
+  } as const;
+
+  // Determine semantic style based on provided props
+  let computedStyle = "text";
+  if (src) {
+    computedStyle = "image";
+  } else if (icon) {
+    computedStyle = "icon";
+  }
+
+  const mergedClassNames: Partial<Record<string, string>> = {
+    root: styles.root,
+    image: styles.image,
+    placeholder: styles.placeholder,
+  };
+
+  if (
+    classNames &&
+    typeof classNames === "object" &&
+    !Array.isArray(classNames)
+  ) {
+    const o = classNames as Partial<Record<string, string>>;
+    mergedClassNames.root = o.root ? `${styles.root} ${o.root}` : styles.root;
+    mergedClassNames.image = o.image
+      ? `${styles.image} ${o.image}`
+      : styles.image;
+    mergedClassNames.placeholder = o.placeholder
+      ? `${styles.placeholder} ${o.placeholder}`
+      : styles.placeholder;
+  }
+
+  return (
+    <MantineAvatar
+      ref={ref}
+      className={className}
+      classNames={mergedClassNames}
+      variant={mapVariant[variant]}
+      size={mapSize[size]}
+      style={style}
+      src={src}
+      data-variant={variant}
+      data-size={size}
+      data-style={computedStyle}
+      {...rest}
+    >
+      {icon != null ? (
+        <span className={styles.iconWrapper} aria-hidden>
+          {icon}
+        </span>
+      ) : children != null ? (
+        <span className={styles.textWrapper}>{children}</span>
+      ) : undefined}
+    </MantineAvatar>
+  );
+});
+
+Avatar.displayName = "Avatar";

package/src/components/Avatar/index.ts

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

package/src/components/Badge/BADGE_IMPLEMENTATION_NOTES.md

@@ -0,0 +1,18 @@
+# Badge Implementation Notes
+
+This document captures specific decisions, regressions, and structural compromises made when integrating Mantine's `Badge` component into the Recursica styling system.
+
+## 1. Stripped Size Properties
+
+As logged in `COMPONENT_ISSUES.md`, there are currently no Figma variables mapped for different `size` variants (`small`, `default`, etc.). The component explicitly `Omit`s the Mantine `size` property from its signature to prevent integrators from attempting to drive sizes that do not exist in the tokens.
+
+## 2. Intent-Based Variants
+
+Mantine supports multiple visual variants (`outline`, `filled`, `light`). However, the existing variable schema for `Badge` only defines "Styles" which act as intents (`alert`, `primary-color`, `success`, `warning`).
+
+- Default is arbitrarily mapped to `primary-color` as we lack a pure `neutral` schema right now.
+- `variant` mapped to underlying Mantine prop has been hardcoded to `filled`, since the Recursica coloring fully replaces the Mantine DOM.
+
+## 3. The `overStyled` Prop
+
+This component implements the newly added `overStyled` architectural standard. By default, passing inline `{style}` React properties to `Badge` will be ignored. This prevents accidental cascading regressions of our strict CSS-variables layouts unless a developer explicitly forces `overStyled={true}`.

package/src/components/Badge/Badge.module.css

@@ -0,0 +1,124 @@
+/* HARDCODED VALUES:
+   - border-style: solid (needs a token if we support other border styles)
+   - box-sizing: border-box
+   - display: inline-flex
+   - align-items: center
+   - justify-content: center
+   - text-transform: uppercase (Mantine does this, but our tokens also specify it so we map it)
+*/
+
+.root {
+  /* HARDCODE: Basic structural assumptions */
+  box-sizing: border-box;
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  border-style: solid;
+
+  /* Base style resets to fully clear Mantine's defaults before applying ours */
+  background-color: transparent;
+  color: inherit;
+  border-color: transparent;
+
+  /* Apply global badge properties */
+  border-radius: var(
+    --recursica_ui-kit_components_badge_properties_border-radius
+  );
+  border-width: var(--recursica_ui-kit_components_badge_properties_border-size);
+  box-shadow: var(--recursica_ui-kit_components_badge_properties_elevation);
+
+  padding-left: var(
+    --recursica_ui-kit_components_badge_properties_padding-horizontal
+  );
+  padding-right: var(
+    --recursica_ui-kit_components_badge_properties_padding-horizontal
+  );
+  padding-top: var(
+    --recursica_ui-kit_components_badge_properties_padding-vertical
+  );
+  padding-bottom: var(
+    --recursica_ui-kit_components_badge_properties_padding-vertical
+  );
+
+  font-family: var(
+    --recursica_ui-kit_components_badge_properties_text_font-family
+  );
+  font-size: var(--recursica_ui-kit_components_badge_properties_text_font-size);
+  font-weight: var(
+    --recursica_ui-kit_components_badge_properties_text_font-weight
+  );
+  letter-spacing: var(
+    --recursica_ui-kit_components_badge_properties_text_letter-spacing
+  );
+  line-height: var(
+    --recursica_ui-kit_components_badge_properties_text_line-height
+  );
+  text-decoration: var(
+    --recursica_ui-kit_components_badge_properties_text_text-decoration
+  );
+  text-transform: var(
+    --recursica_ui-kit_components_badge_properties_text_text-transform
+  );
+}
+
+/* Variant Definitions */
+
+.root[data-variant="alert"] {
+  background-color: var(
+    --recursica_ui-kit_components_badge_variants_styles_alert_properties_colors_background
+  );
+  border-color: var(
+    --recursica_ui-kit_components_badge_variants_styles_alert_properties_colors_border-color
+  );
+  color: var(
+    --recursica_ui-kit_components_badge_variants_styles_alert_properties_colors_text
+  );
+}
+
+.root[data-variant="primary-color"] {
+  background-color: var(
+    --recursica_ui-kit_components_badge_variants_styles_primary-color_properties_colors_background
+  );
+  border-color: var(
+    --recursica_ui-kit_components_badge_variants_styles_primary-color_properties_colors_border-color
+  );
+  color: var(
+    --recursica_ui-kit_components_badge_variants_styles_primary-color_properties_colors_text
+  );
+}
+
+.root[data-variant="success"] {
+  background-color: var(
+    --recursica_ui-kit_components_badge_variants_styles_success_properties_colors_background
+  );
+  border-color: var(
+    --recursica_ui-kit_components_badge_variants_styles_success_properties_colors_border-color
+  );
+  color: var(
+    --recursica_ui-kit_components_badge_variants_styles_success_properties_colors_text
+  );
+}
+
+.root[data-variant="warning"] {
+  background-color: var(
+    --recursica_ui-kit_components_badge_variants_styles_warning_properties_colors_background
+  );
+  border-color: var(
+    --recursica_ui-kit_components_badge_variants_styles_warning_properties_colors_border-color
+  );
+  color: var(
+    --recursica_ui-kit_components_badge_variants_styles_warning_properties_colors_text
+  );
+}
+
+/* Target Mantine internal children if needed for typography constraints */
+.root :global(.mantine-Badge-label),
+.root :global(.mantine-Badge-section) {
+  /* HARDCODE: Prevent Mantine from overriding our typography setup inside inner wrappers */
+  font-size: inherit;
+  font-weight: inherit;
+  line-height: inherit;
+  font-family: inherit;
+  letter-spacing: inherit;
+  text-transform: inherit;
+}

package/src/components/Badge/Badge.stories.tsx

@@ -0,0 +1,77 @@
+import React from "react";
+import type { Meta, StoryObj } from "@storybook/react";
+import { Badge } from "./Badge";
+import { Layer } from "@recursica/adapter-common";
+
+type BadgeStoryProps = React.ComponentProps<typeof Badge>;
+
+const meta: Meta<BadgeStoryProps> = {
+  title: "UI-Kit/Badge",
+  component: Badge,
+  tags: ["autodocs"],
+  argTypes: {
+    variant: {
+      control: "select",
+      options: ["alert", "primary-color", "success", "warning"],
+      description: "The style / intent mapping for the badge",
+    },
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<BadgeStoryProps>;
+
+export const Default: Story = {
+  args: {
+    children: "Badge Label",
+    variant: "primary-color",
+  },
+  render: (args) => {
+    return <Badge {...args} />;
+  },
+};
+
+export const StaticAlert: Story = {
+  args: {
+    children: "Alert Badge",
+    variant: "alert",
+  },
+  render: (args: BadgeStoryProps) => <Badge {...args} />,
+};
+
+export const StaticPrimary: Story = {
+  args: {
+    children: "Primary Badge",
+    variant: "primary-color",
+  },
+  render: (args: BadgeStoryProps) => <Badge {...args} />,
+};
+
+export const StaticSuccess: Story = {
+  args: {
+    children: "Success Badge",
+    variant: "success",
+  },
+  render: (args: BadgeStoryProps) => <Badge {...args} />,
+};
+
+export const StaticWarning: Story = {
+  args: {
+    children: "Warning Badge",
+    variant: "warning",
+  },
+  render: (args: BadgeStoryProps) => <Badge {...args} />,
+};
+
+export const LayerOneAlert: Story = {
+  args: {
+    children: "Layer 1 Alert",
+    variant: "alert",
+  },
+  render: (args: BadgeStoryProps) => (
+    <Layer layer={1} style={{ padding: "24px" }}>
+      <Badge {...args} />
+    </Layer>
+  ),
+};

package/src/components/Badge/Badge.tsx

@@ -0,0 +1,66 @@
+import { forwardRef } from "react";
+import {
+  Badge as MantineBadge,
+  type BadgeProps as MantineBadgeProps,
+} from "@mantine/core";
+import {
+  filterStylingProps,
+  type RecursicaOverStyled,
+} from "../../utils/filterStylingProps";
+import styles from "./Badge.module.css";
+
+export interface RecursicaBadgeProps {
+  /** Map to the component styles defined in variables */
+  variant?: "alert" | "primary-color" | "success" | "warning";
+}
+
+export type BadgeProps = RecursicaOverStyled<
+  Omit<MantineBadgeProps, "variant" | "size" | "color" | "radius"> &
+    RecursicaBadgeProps
+>;
+
+export const Badge = forwardRef<HTMLDivElement, BadgeProps>(function Badge(
+  { variant = "primary-color", overStyled = false, ...rest },
+  ref,
+) {
+  // Strip all visual override injections unless developer has specifically opted into overStyling.
+  // External layout props like margins are safely preserved.
+  const sanitizedProps = filterStylingProps(rest, overStyled);
+
+  const mergedClassNames: Partial<Record<string, string>> = {
+    root: styles.root,
+    section: styles.section,
+    label: styles.label,
+  };
+
+  const classNamesProp = (sanitizedProps as Record<string, unknown>).classNames;
+  if (
+    classNamesProp &&
+    typeof classNamesProp === "object" &&
+    !Array.isArray(classNamesProp)
+  ) {
+    const o = classNamesProp as Partial<Record<string, string>>;
+    mergedClassNames.root = o.root ? `${styles.root} ${o.root}` : styles.root;
+    mergedClassNames.section = o.section ?? styles.section;
+    mergedClassNames.label = o.label ?? styles.label;
+  }
+
+  const classNameProp = (sanitizedProps as Record<string, unknown>)
+    .className as string | undefined;
+  const finalClass = classNameProp
+    ? `${styles.root} ${classNameProp}`
+    : styles.root;
+
+  return (
+    <MantineBadge
+      ref={ref}
+      variant="filled" // We manage visual style purely through our CSS variables mapping
+      data-variant={variant}
+      {...sanitizedProps}
+      className={finalClass}
+      classNames={mergedClassNames}
+    />
+  );
+});
+
+Badge.displayName = "Badge";

package/src/components/Breadcrumb/BREADCRUMB_IMPLEMENTATION_NOTES.md

@@ -0,0 +1,14 @@
+# Breadcrumb Implementation Notes
+
+## Missing Variants and Sizes
+
+The `Breadcrumb` currently does not establish any size (`xs`, `sm`, etc.) or variant variables in the underlying design tokens (`recursica_ui-kit.json`). Only basic structural definitions for `padding` and `item-gap` exist. Because of this, the `size` and `variant` properties have been explicitly omitted from the passed mantine props.
+
+## Gap Styling
+
+We attach `gap` to `.root` directly within `.module.css`. Mantine's inner `separator` divs can natively accept our CSS variables for structural layout.
+
+## Composition and Separators
+
+We preserve standard hierarchical composition based on Mantine's defaults. The component natively accepts typical anchor tags as children without wrapping them in structural spans, allowing developers to utilize `Link` wrappers as needed contextually.
+The separator character is inherited natively from Mantine's default configuration (`/`) unless overridden by passing `separator={<Icon />}` to the component props.

package/src/components/Breadcrumb/Breadcrumb.module.css

@@ -0,0 +1,26 @@
+/* HARDCODED VALUES:
+   - align-items: center
+*/
+
+.root {
+  /* HARDCODE: Basic structural flex layout for breadcrumbs */
+  display: flex;
+  align-items: center;
+
+  /* Base style resets */
+  background-color: transparent;
+  color: inherit;
+
+  /* Apply global breadcrumb properties */
+  padding: var(--recursica_ui-kit_components_breadcrumb_properties_padding);
+
+  /* Mantine's breadcrumbs uses gap on the root or pseudo classes, but standard gap is safest since flex is used */
+  gap: var(--recursica_ui-kit_components_breadcrumb_properties_item-gap);
+}
+
+.separator {
+  /* Separator base resets if needed */
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}

package/src/components/Breadcrumb/Breadcrumb.stories.tsx

@@ -0,0 +1,77 @@
+import React from "react";
+import type { Meta, StoryObj } from "@storybook/react";
+import { Breadcrumb } from "./Breadcrumb";
+
+type BreadcrumbStoryProps = React.ComponentProps<typeof Breadcrumb> & {
+  items?: string[];
+};
+
+const meta: Meta<BreadcrumbStoryProps> = {
+  title: "UI-Kit/Breadcrumb",
+  component: Breadcrumb,
+  tags: ["autodocs"],
+  argTypes: {
+    children: {
+      table: {
+        disable: true,
+      },
+    },
+    items: {
+      control: "object",
+      description:
+        "Array of string labels used to dynamically generate the interactive Breadcrumb nodes.",
+      table: {
+        category: "Story Controls",
+      },
+    },
+    separator: {
+      control: "text",
+      description: "Custom separator between items",
+    },
+  },
+  args: {
+    items: ["Home", "Components", "Breadcrumbs"],
+  },
+  render: ({ items, children, ...args }) => {
+    const mappedChildren = items
+      ? items.map((label, index) => (
+          <a
+            href="#"
+            key={index}
+            style={{
+              color:
+                "var(--recursica_brand_palettes_primary_default_color_tone)",
+              textDecoration: "none",
+            }}
+          >
+            {label}
+          </a>
+        ))
+      : children;
+
+    return <Breadcrumb children={mappedChildren} {...args} />;
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<BreadcrumbStoryProps>;
+
+export const Default: Story = {
+  args: {
+    items: ["Dashboard", "Settings", "Security"],
+  },
+};
+
+export const StaticExample: Story = {
+  args: {
+    items: ["Store", "Electronics", "Computers", "Laptops"],
+  },
+};
+
+export const CustomSeparator: Story = {
+  args: {
+    items: ["Root", "Branch", "Leaf"],
+    separator: "→",
+  },
+};

package/src/components/Breadcrumb/Breadcrumb.tsx

@@ -0,0 +1,64 @@
+import { forwardRef } from "react";
+import {
+  Breadcrumbs as MantineBreadcrumbs,
+  type BreadcrumbsProps as MantineBreadcrumbsProps,
+} from "@mantine/core";
+import {
+  filterStylingProps,
+  type RecursicaOverStyled,
+} from "../../utils/filterStylingProps";
+import styles from "./Breadcrumb.module.css";
+
+// Currently there are no Recursica prop additions specific to Breadcrumbs (like size or variant)
+// according to recursica_ui-kit.json
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
+export interface RecursicaBreadcrumbProps {}
+
+export type BreadcrumbProps = RecursicaOverStyled<
+  Omit<MantineBreadcrumbsProps, "variant" | "size"> & RecursicaBreadcrumbProps
+>;
+
+export const Breadcrumb = forwardRef<HTMLDivElement, BreadcrumbProps>(
+  function Breadcrumb({ overStyled = false, separator = ">", ...rest }, ref) {
+    const sanitizedProps = filterStylingProps(
+      { separator, ...rest },
+      overStyled,
+    );
+
+    const mergedClassNames: Partial<Record<string, string>> = {
+      root: styles.root,
+      separator: styles.separator,
+    };
+
+    const classNamesProp = (sanitizedProps as Record<string, unknown>)
+      .classNames;
+    if (
+      classNamesProp &&
+      typeof classNamesProp === "object" &&
+      !Array.isArray(classNamesProp)
+    ) {
+      const o = classNamesProp as Partial<Record<string, string>>;
+      mergedClassNames.root = o.root ? `${styles.root} ${o.root}` : styles.root;
+      mergedClassNames.separator = o.separator
+        ? `${styles.separator} ${o.separator}`
+        : styles.separator;
+    }
+
+    const classNameProp = (sanitizedProps as Record<string, unknown>)
+      .className as string | undefined;
+    const finalClass = classNameProp
+      ? `${styles.root} ${classNameProp}`
+      : styles.root;
+
+    return (
+      <MantineBreadcrumbs
+        ref={ref}
+        {...(sanitizedProps as unknown as MantineBreadcrumbsProps)}
+        className={finalClass}
+        classNames={mergedClassNames}
+      />
+    );
+  },
+);
+
+Breadcrumb.displayName = "Breadcrumb";