[infra] Add support for automatic generation of data-attributes API (#…

…1022)
mui · Dec 11, 2024 · f41cd16 · f41cd16
1 parent 5864f86
commit f41cd16
Show file tree

Hide file tree

Showing 13 changed files with 57 additions and 43 deletions.
diff --git a/docs/reference/generated/collapsible-trigger.json b/docs/reference/generated/collapsible-trigger.json
@@ -10,5 +10,10 @@
       "type": "React.ReactElement | (props, state) => React.ReactElement",
       "description": "A function to customize rendering of the component."
     }
+  },
+  "dataAttributes": {
+    "data-panel-open": {
+      "description": "Present when the collapsible panel is open."
+    }
   }
 }
diff --git a/docs/reference/generated/dialog-backdrop.json b/docs/reference/generated/dialog-backdrop.json
@@ -16,17 +16,17 @@
       "description": "A function to customize rendering of the component."
     }
   },
-  "attributes": {
-    "[data-open]": {
+  "dataAttributes": {
+    "data-open": {
       "description": "Present when the dialog is open."
     },
-    "[data-closed]": {
+    "data-closed": {
       "description": "Present when the dialog is closed."
     },
-    "[data-starting-style]": {
+    "data-starting-style": {
       "description": "Present when the dialog is animating in."
     },
-    "[data-ending-style]": {
+    "data-ending-style": {
       "description": "Present when the dialog is animating out."
     }
   }

diff --git a/docs/reference/generated/dialog-popup.json b/docs/reference/generated/dialog-popup.json
@@ -24,23 +24,23 @@
       "description": "A function to customize rendering of the component."
     }
   },
-  "attributes": {
-    "[data-open]": {
+  "dataAttributes": {
+    "data-open": {
       "description": "Present when the dialog is open."
     },
-    "[data-closed]": {
+    "data-closed": {
       "description": "Present when the dialog is closed."
     },
-    "[data-starting-style]": {
+    "data-starting-style": {
       "description": "Present when the dialog is animating in."
     },
-    "[data-ending-style]": {
+    "data-ending-style": {
       "description": "Present when the dialog is animating out."
     },
-    "[data-modal]": {
+    "data-modal": {
       "description": "Present when the dialog is modal."
     },
-    "[data-nested-dialogs]": {
+    "data-nested-dialogs": {
       "type": "number",
       "description": "Indicates how many dialogs are nested within."
     }

diff --git a/docs/reference/generated/dialog-trigger.json b/docs/reference/generated/dialog-trigger.json
@@ -11,11 +11,11 @@
       "description": "A function to customize rendering of the component."
     }
   },
-  "attributes": {
-    "[data-modal]": {
+  "dataAttributes": {
+    "data-modal": {
       "description": "Present when the corresponding dialog is modal."
     },
-    "[data-popup-open]": {
+    "data-popup-open": {
       "description": "Present when the corresponding dialog is open."
     }
   }

diff --git a/docs/reference/overrides/dialog-backdrop.json b/docs/reference/overrides/dialog-backdrop.json
@@ -1,16 +1,16 @@
 {
   "name": "DialogBackdrop",
-  "attributes": {
-    "[data-open]": {
+  "dataAttributes": {
+    "data-open": {
       "description": "Present when the dialog is open."
     },
-    "[data-closed]": {
+    "data-closed": {
       "description": "Present when the dialog is closed."
     },
-    "[data-starting-style]": {
+    "data-starting-style": {
       "description": "Present when the dialog is animating in."
     },
-    "[data-ending-style]": {
+    "data-ending-style": {
       "description": "Present when the dialog is animating out."
     }
   }

diff --git a/docs/reference/overrides/dialog-popup.json b/docs/reference/overrides/dialog-popup.json
@@ -1,22 +1,22 @@
 {
   "name": "DialogPopup",
-  "attributes": {
-    "[data-open]": {
+  "dataAttributes": {
+    "data-open": {
       "description": "Present when the dialog is open."
     },
-    "[data-closed]": {
+    "data-closed": {
       "description": "Present when the dialog is closed."
     },
-    "[data-starting-style]": {
+    "data-starting-style": {
       "description": "Present when the dialog is animating in."
     },
-    "[data-ending-style]": {
+    "data-ending-style": {
       "description": "Present when the dialog is animating out."
     },
-    "[data-modal]": {
+    "data-modal": {
       "description": "Present when the dialog is modal."
     },
-    "[data-nested-dialogs]": {
+    "data-nested-dialogs": {
       "type": "number",
       "description": "Indicates how many dialogs are nested within."
     }

diff --git a/docs/reference/overrides/dialog-trigger.json b/docs/reference/overrides/dialog-trigger.json
@@ -1,10 +1,10 @@
 {
   "name": "DialogTrigger",
-  "attributes": {
-    "[data-modal]": {
+  "dataAttributes": {
+    "data-modal": {
       "description": "Present when the corresponding dialog is modal."
     },
-    "[data-popup-open]": {
+    "data-popup-open": {
       "description": "Present when the corresponding dialog is open."
     }
   }

diff --git a/docs/src/components/reference/rehypeReference.mjs b/docs/src/components/reference/rehypeReference.mjs
@@ -104,11 +104,11 @@ export function rehypeReference() {
             }),
           );
 
-          if (def.attributes) {
+          if (def.dataAttributes) {
             subtree.push(
               createMdxElement({
                 name: ATTRIBUTES_TABLE,
-                props: { data: def.attributes },
+                props: { data: def.dataAttributes },
               }),
             );
           }

diff --git a/docs/src/components/reference/types.ts b/docs/src/components/reference/types.ts
@@ -2,7 +2,7 @@ export interface ComponentDef {
   name: string;
   description?: string;
   props: Record<string, PropDef>;
-  attributes?: Record<string, AttributeDef>;
+  dataAttributes?: Record<string, AttributeDef>;
   cssVariables?: Record<string, CssVariableDef>;
 }
 

diff --git a/package.json b/package.json
@@ -78,7 +78,7 @@
     "@mui/internal-markdown": "^1.0.22",
     "@mui/internal-scripts": "^1.0.29",
     "@mui/internal-test-utils": "https://pkg.csb.dev/mui/material-ui/commit/92c23999/@mui/internal-test-utils",
-    "@mui/monorepo": "github:mui/material-ui#817470c5a7c2ae721401e308b961005730cdf2ab",
+    "@mui/monorepo": "github:mui/material-ui#v6.2.0",
     "@next/eslint-plugin-next": "^14.2.18",
     "@octokit/rest": "^20.1.1",
     "@playwright/test": "1.49.0",

diff --git a/packages/react/src/collapsible/trigger/CollapsibleTriggerDataAttributes.ts b/packages/react/src/collapsible/trigger/CollapsibleTriggerDataAttributes.ts
@@ -0,0 +1,6 @@
+export enum CollapsibleTriggerDataAttributes {
+  /**
+   * Present when the collapsible panel is open.
+   */
+  panelOpen = 'data-panel-open',
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/buildApiDocs/buildReference.ts b/scripts/buildApiDocs/buildReference.ts
@@ -81,17 +81,20 @@ export async function buildReference() {
       console.warn(`Missing component description: ${componentData.name}`);
     }
 
-    const attributes = componentOverrides?.attributes;
+    const dataAttributes =
+      !!componentData?.dataAttributes || !!componentOverrides?.dataAttributes
+        ? { ...componentData?.dataAttributes, ...componentOverrides?.dataAttributes }
+        : undefined;
     const cssVariables =
-      !!componentData?.cssVariables || componentOverrides?.cssVariables
+      !!componentData?.cssVariables || !!componentOverrides?.cssVariables
         ? { ...componentData?.cssVariables, ...componentOverrides?.cssVariables }
         : undefined;
 
     const json: ComponentDef = {
       name: componentData.name,
       description: descriptionData.componentDescription,
       props,
-      attributes,
+      dataAttributes,
       cssVariables,
     };