@recursica/mui-adapter 0.5.0 → 0.7.0

package/src/components/Checkbox/Checkbox.stories.tsx

@@ -1,35 +1,97 @@
 import type { Meta, StoryObj } from "@storybook/react";
 import { Checkbox } from "./Checkbox";
-import { ComingSoon } from "@recursica/storybook-template";
 
 const meta: Meta<typeof Checkbox> = {
-  title: "UI-Kit/🚧 Checkbox",
+  title: "UI-Kit/Checkbox",
   component: Checkbox,
   tags: ["autodocs"],
   parameters: {
-    controls: {
-      include: [
-        "layer",
-        "withLayer",
-        "children",
-        "component",
-        "variant",
-        "size",
-        "icon",
-        "disabled",
-        "href",
-        "onClick",
-        "onChange",
-        "value",
-        "checked",
-      ],
+    docs: {
+      description: {
+        component: `
+The \`Checkbox\` component is a precisely engineered, atomic form primitive representing boolean states natively aligned to the Recursica design system. It overrides Mantine's standard properties explicitly enforcing our variables natively across all structural boundaries.
+
+> [!IMPORTANT]  
+> The atomic \`Checkbox\` is intended primarily as an internal primitive. **When wrapping multiple Checkbox elements together or rendering form controls, always utilize the \`<Checkbox.Group>\` component.** \`Checkbox.Group\` inherits the global \`FormControlWrapper\`, granting instantaneous access to macroscopic layout structuring, assistive descriptions, validation errors, and strict flex arrays.
+
+### Usage
+To render a solitary component natively:
+\`\`\`tsx
+<Checkbox label="Acknowledge Terms" defaultChecked />
+\`\`\`
+`,
+      },
+    },
+  },
+  argTypes: {
+    disabled: {
+      control: "boolean",
+    },
+    readOnly: {
+      control: "boolean",
+      description:
+        "Toggles structural read-only data presentation bypassing interaction boundaries completely.",
     },
+    controlMaxWidth: { table: { disable: true } },
+    controlMinWidth: { table: { disable: true } },
   },
 };
 
 export default meta;
+
 type Story = StoryObj<typeof Checkbox>;
 
 export const Default: Story = {
-  render: () => <ComingSoon componentName="Checkbox" />,
+  args: {
+    disabled: false,
+    label: "Standard Unchecked Property",
+  },
+};
+
+export const SideBySideLayout: Story = {
+  args: {
+    label: "Opt-in form alignment",
+    formLayout: "side-by-side",
+  },
+};
+
+export const LongLabelWrap: Story = {
+  args: {
+    label:
+      "A meticulously long Checkbox label property demonstrating the absolute maximum 400px wrapper constraints actively snapping the text engine down onto a secondary wrapping line automatically without blowing out the visual boundaries.",
+  },
+};
+
+export const StaticVariations: Story = {
+  args: {},
+  render: () => (
+    <div
+      style={{
+        display: "flex",
+        flexDirection: "column",
+        gap: "24px",
+      }}
+    >
+      <Checkbox label="Default Unchecked State" />
+      <Checkbox label="Acknowledge Configuration" defaultChecked />
+      <Checkbox label="Indeterminate Master" indeterminate />
+      <Checkbox label="Disabled Variant" disabled />
+      <Checkbox label="Disabled Checked Variant" checked disabled />
+    </div>
+  ),
+};
+
+export const ReadOnly: Story = {
+  args: {},
+  render: () => (
+    <div
+      style={{
+        display: "flex",
+        flexDirection: "column",
+        gap: "24px",
+      }}
+    >
+      <Checkbox label="Accept Terms & Conditions" defaultChecked readOnly />
+    </div>
+  ),
 };

package/src/components/Checkbox/Checkbox.tsx

@@ -1,8 +1,249 @@
-import React from "react";
-import "./Checkbox.module.css";
+import React, { forwardRef } from "react";
+import {
+  Checkbox as MuiCheckbox,
+  type CheckboxProps as MuiCheckboxProps,
+} from "@mui/material";
+import { type ReadOnlyControlProps } from "@recursica/adapter-common";
+import { CheckboxGroup, CheckboxGroupContext } from "./CheckboxGroup";
+import {
+  filterStylingProps,
+  type RecursicaOverStyled,
+} from "../../utils/filterStylingProps";
+import {
+  type RequireAccessibleLabel,
+  type RecursicaCheckboxProps,
+} from "@recursica/adapter-common";
+import {
+  FormControlLayout,
+  type FormControlLayoutProps,
+} from "../FormControlLayout/FormControlLayout";
 
-export type CheckboxProps = React.HTMLAttributes<HTMLDivElement>;
+import styles from "./Checkbox.module.css";
 
-export const Checkbox: React.FC<CheckboxProps> = (props) => {
-  return <div {...props}>Checkbox</div>;
+export type CheckboxWrapperProps = Omit<MuiCheckboxProps, "size" | "color"> &
+  RecursicaCheckboxProps &
+  ReadOnlyControlProps &
+  Pick<
+    FormControlLayoutProps,
+    "formLayout" | "labelSize" | "controlMaxWidth" | "controlMinWidth"
+  >;
+
+export type RecursicaCheckboxPropsAlias =
+  RequireAccessibleLabel<CheckboxWrapperProps>;
+
+export type CheckboxProps = RecursicaOverStyled<RecursicaCheckboxPropsAlias>;
+
+type CheckboxComponent = React.ForwardRefExoticComponent<
+  CheckboxProps & React.RefAttributes<HTMLButtonElement>
+> & {
+  Group: typeof CheckboxGroup;
 };
+
+export const Checkbox = forwardRef<HTMLButtonElement, CheckboxProps>(
+  function Checkbox(props, ref) {
+    const {
+      overStyled = false,
+      readOnly,
+      readOnlyComponent,
+      disabled,
+      formLayout,
+      labelSize,
+      controlMaxWidth,
+      controlMinWidth,
+      label,
+      description,
+      error,
+      style,
+      ...rest
+    } = props;
+
+    const sanitizedProps = filterStylingProps(rest, overStyled);
+    const restRecord = sanitizedProps as Record<string, unknown>;
+
+    delete restRecord["size"];
+    delete restRecord["color"];
+
+    const mergedClassNames: Partial<Record<string, string>> = {
+      root: styles.root,
+      checked: styles.checked,
+      disabled: styles.disabled,
+    };
+
+    const classesProp = restRecord.classes;
+    if (
+      classesProp &&
+      typeof classesProp === "object" &&
+      !Array.isArray(classesProp)
+    ) {
+      const o = classesProp as Partial<Record<string, string>>;
+      mergedClassNames.root = o.root ? `${styles.root} ${o.root}` : styles.root;
+      mergedClassNames.checked = o.checked
+        ? `${styles.checked} ${o.checked}`
+        : styles.checked;
+      mergedClassNames.disabled = o.disabled
+        ? `${styles.disabled} ${o.disabled}`
+        : styles.disabled;
+    }
+
+    const classNameProp = restRecord.className as string | undefined;
+    const finalClass = classNameProp
+      ? `${styles.root} ${classNameProp}`
+      : styles.root;
+
+    const groupContext = React.useContext(CheckboxGroupContext);
+    const isGrouped = groupContext !== null;
+    const isGroupReadOnly = isGrouped ? groupContext.readOnly : false;
+    const isChecked = isGrouped
+      ? (groupContext.value || []).includes(restRecord.value)
+      : !!(restRecord.checked ?? restRecord.defaultChecked);
+
+    if (readOnly && !!readOnlyComponent) {
+      const ReadOnlyComp = readOnlyComponent;
+      const roNode = (
+        <ReadOnlyComp
+          {...props}
+          checked={isChecked}
+          label={label as React.ReactNode}
+        />
+      );
+
+      if (formLayout) {
+        return (
+          <FormControlLayout
+            formLayout={formLayout}
+            labelSize={labelSize}
+            controlMaxWidth={controlMaxWidth}
+            controlMinWidth={controlMinWidth}
+          >
+            {roNode}
+          </FormControlLayout>
+        );
+      }
+
+      return <>{roNode}</>;
+    }
+
+    const handleChange = (e: React.ChangeEvent<HTMLInputElement>) => {
+      if (isGrouped) {
+        const newValue = e.target.checked
+          ? [...(groupContext.value || []), restRecord.value]
+          : (groupContext.value || []).filter((v) => v !== restRecord.value);
+        if (groupContext.onChange) {
+          groupContext.onChange(e, newValue);
+        }
+      } else {
+        if (restRecord.onChange) {
+          (restRecord.onChange as any)(e, e.target.checked);
+        }
+      }
+    };
+
+    const CheckIcon = (props: React.ComponentProps<"svg">) => (
+      <svg
+        viewBox="0 0 10 7"
+        fill="none"
+        xmlns="http://www.w3.org/2000/svg"
+        {...props}
+      >
+        <path
+          d="M4 4.586L1.707 2.293A1 1 0 1 0 .293 3.707l3 3a.997.997 0 0 0 1.414 0l5-5A1 1 0 1 0 8.293.293L4 4.586z"
+          fill="currentColor"
+          fillRule="evenodd"
+          clipRule="evenodd"
+        />
+      </svg>
+    );
+
+    const checkboxNode = (
+      <MuiCheckbox
+        ref={ref}
+        className={!label ? `${finalClass} ${styles.inner}` : styles.inner}
+        classes={mergedClassNames}
+        disabled={readOnly || disabled || isGroupReadOnly}
+        {...(sanitizedProps as unknown as MuiCheckboxProps)}
+        checked={isChecked as boolean}
+        onChange={handleChange}
+        sx={label ? { padding: 0 } : undefined}
+        icon={<div className={styles.input} />}
+        checkedIcon={
+          <div className={`${styles.input} ${styles.inputChecked}`}>
+            <CheckIcon className={styles.icon} />
+          </div>
+        }
+        indeterminateIcon={
+          <div className={`${styles.input} ${styles.inputIndeterminate}`}>
+            <svg
+              className={styles.icon}
+              xmlns="http://www.w3.org/2000/svg"
+              fill="none"
+              viewBox="0 0 32 32"
+            >
+              <rect x="6" y="14" width="20" height="4" fill="currentColor" />
+            </svg>
+          </div>
+        }
+      />
+    );
+
+    const finalNode = label ? (
+      <div className={finalClass} style={style as React.CSSProperties}>
+        <div className={styles.body}>
+          {checkboxNode}
+          <div className={styles.labelWrapper}>
+            <label
+              className={styles.label}
+              htmlFor={restRecord.id as string}
+              data-disabled={
+                readOnly || disabled || isGroupReadOnly ? true : undefined
+              }
+            >
+              {label as React.ReactNode}
+            </label>
+            {description && (
+              <div
+                className={styles.description}
+                data-disabled={
+                  readOnly || disabled || isGroupReadOnly ? true : undefined
+                }
+              >
+                {description}
+              </div>
+            )}
+            {error && (
+              <div
+                className={styles.error}
+                data-disabled={
+                  readOnly || disabled || isGroupReadOnly ? true : undefined
+                }
+              >
+                {error}
+              </div>
+            )}
+          </div>
+        </div>
+      </div>
+    ) : (
+      <div className={finalClass} style={style as React.CSSProperties}>
+        {checkboxNode}
+      </div>
+    );
+
+    if (formLayout) {
+      return (
+        <FormControlLayout
+          formLayout={formLayout}
+          labelSize={labelSize}
+          controlMaxWidth={controlMaxWidth}
+          controlMinWidth={controlMinWidth}
+        >
+          {finalNode}
+        </FormControlLayout>
+      );
+    }
+
+    return finalNode;
+  },
+) as CheckboxComponent;
+
+Checkbox.displayName = "Checkbox";
+Checkbox.Group = CheckboxGroup;

package/src/components/Checkbox/CheckboxGroup.stories.tsx

@@ -0,0 +1,139 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import { Checkbox } from "./Checkbox";
+import { CheckboxGroup } from "./CheckboxGroup";
+import { useState } from "react";
+import { formControlArgTypes } from "../../../.storybook/commonArgTypes";
+
+const meta: Meta<typeof CheckboxGroup> = {
+  title: "UI-Kit/CheckboxGroup",
+  component: CheckboxGroup,
+  tags: ["autodocs"],
+  parameters: {
+    docs: {
+      description: {
+        component: `
+The \`CheckboxGroup\` component is the mandatory organizational wrapper aggregating multiple \`Checkbox\` primitives into structurally bound unified arrays. It inherently leverages the \`FormControlWrapper\` granting native access to macroscopic layout structuring, assistive descriptions, and strict flex arrays.
+
+We exclusively utilize the \`formLayout\` parameter to control macro-level form flow:
+- **\`formLayout="stacked"\`**: Top-to-bottom layout cascading the Label bounding box down vertically into a standard stacked checkbox column array.
+- **\`formLayout="side-by-side"\`**: Flow architecture pulling the grouping Label dynamically to the left while structurally organizing the internal checkboxes cleanly alongside it horizontally.
+
+\`\`\`tsx
+<Checkbox.Group 
+  label="Execution Targets" 
+  assistiveText="Strictly mapped structural grouping dynamically applied natively."
+  formLayout="stacked" 
+>
+  <Checkbox value="react" label="Browser Execution Context" />
+  <Checkbox value="svelte" label="Edge Nodes" />
+</Checkbox.Group>
+\`\`\`
+`,
+      },
+    },
+  },
+  argTypes: {
+    ...formControlArgTypes,
+    readOnly: {
+      control: "boolean",
+      description:
+        "Toggles structural read-only data presentation bypassing interaction boundaries completely.",
+    },
+  },
+};
+
+export default meta;
+
+type Story = StoryObj<typeof CheckboxGroup>;
+
+export const Default: Story = {
+  args: {
+    formLayout: "stacked",
+    label: "Standard Group",
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any
+  render: function StoryRender({ withLayer, layer, ...args }: any) {
+    const [value, setValue] = useState<string[]>([]);
+    return (
+      <Checkbox.Group {...args} value={value} onChange={setValue}>
+        <Checkbox value="1" label="Option 1" />
+        <Checkbox value="2" label="Option 2" />
+      </Checkbox.Group>
+    );
+  },
+};
+
+export const SideBySideLayout: Story = {
+  args: {
+    formLayout: "side-by-side",
+    labelOptionalText: "Recommended",
+    labelWithEditIcon: true,
+    label: "Frontend Frameworks",
+    assistiveText:
+      "Select all libraries currently in use for this specific workspace configuration.",
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any
+  render: function StoryRender({ withLayer, layer, ...args }: any) {
+    const [value, setValue] = useState<string[]>(["react"]);
+    return (
+      <Checkbox.Group {...args} value={value} onChange={setValue}>
+        <Checkbox value="react" label="React (Standard Build)" />
+        <Checkbox
+          value="svelte"
+          label="The Svelte architecture which provides a highly optimized, completely compiler-driven framework avoiding virtual DOM boundaries. This massively extended text explicitly guarantees accurate wrapper constraint checking and multi-line flex alignment."
+        />
+        <Checkbox value="vue" label="Vue Configuration Map" />
+      </Checkbox.Group>
+    );
+  },
+};
+
+export const StackedLayout: Story = {
+  args: {
+    formLayout: "stacked",
+    required: true,
+    label: "Execution Targets",
+    error: "You must select at least one deployment target to compile.",
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any
+  render: function StoryRender({ withLayer, layer, ...args }: any) {
+    const [value, setValue] = useState<string[]>(["react"]);
+    return (
+      <Checkbox.Group {...args} value={value} onChange={setValue}>
+        <Checkbox value="react" label="Browser Execution Context" />
+        <Checkbox
+          value="svelte"
+          label="Highly distributed Edge computing environments seamlessly bridging local runtime boundaries."
+        />
+        <Checkbox value="vue" label="Serverless Cloud Providers" />
+      </Checkbox.Group>
+    );
+  },
+};
+
+export const ReadOnly: Story = {
+  args: {
+    readOnly: true,
+    formLayout: "stacked",
+    required: true,
+    label: "Static ReadOnly Execution Locks",
+    assistiveText:
+      "This structure explicitly validates native component-level DOM preservation natively mapping lock bounds safely over interaction.",
+  },
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-explicit-any
+  render: function StoryRender({ withLayer, layer, ...args }: any) {
+    const [value, setValue] = useState<string[]>(["disabledNode"]);
+    return (
+      <Checkbox.Group {...args} value={value} onChange={setValue}>
+        <Checkbox
+          value="disabledNode"
+          label="Structurally Checked Node natively"
+        />
+        <Checkbox
+          value="disabledNodeEmpty"
+          label="Unchecked Configuration Limit"
+        />
+      </Checkbox.Group>
+    );
+  },
+};

package/src/components/Checkbox/CheckboxGroup.tsx

@@ -0,0 +1,137 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import React, { forwardRef } from "react";
+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 "./Checkbox.module.css";
+
+import { FormGroup as MuiFormGroup } from "@mui/material";
+
+export const CheckboxGroupContext = React.createContext<{
+  value?: any[];
+  onChange?: (event: React.SyntheticEvent, value: any) => void;
+  name?: string;
+  readOnly?: boolean;
+} | null>(null);
+
+import { type RecursicaCheckboxGroupProps as BaseRecursicaCheckboxGroupProps } from "@recursica/adapter-common";
+
+export interface RecursicaCheckboxGroupProps
+  extends Omit<React.HTMLAttributes<HTMLDivElement>, "onChange">,
+    Omit<
+      RecursicaFormControlWrapperProps,
+      | "controlMaxWidth"
+      | "controlMinWidth"
+      | "onChange"
+      | "classes"
+      | "withAsterisk"
+    >,
+    ReadOnlyControlProps,
+    BaseRecursicaCheckboxGroupProps {}
+
+export type CheckboxGroupProps =
+  RecursicaOverStyled<RecursicaCheckboxGroupProps>;
+
+export const CheckboxGroup = forwardRef<HTMLDivElement, CheckboxGroupProps>(
+  function CheckboxGroup(props, ref) {
+    const {
+      overStyled = false,
+      formLayout = "stacked",
+
+      // Label Wrappers
+      labelSize,
+      labelAlignment,
+      labelOptionalText,
+      labelWithEditIcon,
+      onLabelEditClick,
+
+      // Base Mantine Extracted Attributes
+      label,
+      description,
+      assistiveText,
+      assistiveWithIcon,
+      error,
+      required,
+      // removed withAsterisk
+      id,
+      className,
+      style,
+      children,
+      readOnly,
+      readOnlyComponent,
+      emptyValueComponent,
+      value,
+      defaultValue,
+      onChange,
+      row,
+      ...rest
+    } = props;
+    const sanitizedProps = filterStylingProps(rest, overStyled);
+    const restRecord = sanitizedProps as Record<string, unknown>;
+
+    // Delete prohibited sizing hooks
+    delete restRecord["size"];
+
+    const handleChange = (_event: React.SyntheticEvent, childValue: any) => {
+      if (onChange) {
+        onChange(childValue);
+      }
+    };
+
+    return (
+      <WithReadOnlyWrapper
+        className={className}
+        style={style as React.CSSProperties}
+        controlMaxWidth="var(--recursica_ui-kit_components_checkbox-item_properties_max-width)"
+        controlMinWidth={undefined}
+        overStyled={overStyled as true}
+        // strictly override
+        formLayout={formLayout}
+        labelSize={labelSize}
+        labelAlignment={labelAlignment}
+        labelOptionalText={labelOptionalText}
+        labelWithEditIcon={labelWithEditIcon}
+        onLabelEditClick={onLabelEditClick}
+        label={label}
+        description={description}
+        assistiveText={assistiveText}
+        assistiveWithIcon={assistiveWithIcon}
+        error={error}
+        required={required}
+        id={id}
+        readOnly={readOnly && !!readOnlyComponent}
+        readOnlyComponent={readOnlyComponent}
+        emptyValueComponent={emptyValueComponent}
+        readOnlyType="text"
+        readOnlyValue={value !== undefined ? value : defaultValue}
+        readOnlyNativeProps={props}
+        activeComponent={
+          <CheckboxGroupContext.Provider
+            value={{
+              value: value !== undefined ? value : defaultValue,
+              onChange: handleChange,
+              name: restRecord.name as string | undefined,
+              readOnly: readOnly || !!(restRecord as any).disabled,
+            }}
+          >
+            <MuiFormGroup
+              ref={ref}
+              row={row}
+              {...(sanitizedProps as any)}
+              className={`${styles.groupRoot} ${(sanitizedProps as any).className || ""}`.trim()}
+              data-layout={formLayout}
+            >
+              {children}
+            </MuiFormGroup>
+          </CheckboxGroupContext.Provider>
+        }
+      />
+    );
+  },
+);
+
+CheckboxGroup.displayName = "CheckboxGroup";

package/src/components/Checkbox/index.ts

@@ -1 +1,6 @@
-export * from "./Checkbox";
+import { CheckboxGroup } from "./CheckboxGroup";
+
+export { Checkbox } from "./Checkbox";
+export type { CheckboxProps } from "./Checkbox";
+export { CheckboxGroup };
+export type { CheckboxGroupProps } from "./CheckboxGroup";