react-test/docs/translations/api-docs/dialog/dialog.json

{
  "componentDescription": "Dialogs are overlaid modal paper based components with a backdrop.",
  "propDescriptions": {
    "aria-describedby": { "description": "The id(s) of the element(s) that describe the dialog." },
    "aria-labelledby": { "description": "The id(s) of the element(s) that label the dialog." },
    "aria-modal": {
      "description": "Informs assistive technologies that the element is modal. It's added on the element with role="dialog"."
    },
    "BackdropComponent": {
      "description": "A backdrop component. This prop enables custom backdrop rendering."
    },
    "children": { "description": "Dialog children, usually the included sub-components." },
    "classes": { "description": "Override or extend the styles applied to the component." },
    "disableEscapeKeyDown": {
      "description": "If <code>true</code>, hitting escape will not fire the <code>onClose</code> callback."
    },
    "fullScreen": { "description": "If <code>true</code>, the dialog is full-screen." },
    "fullWidth": {
      "description": "If <code>true</code>, the dialog stretches to <code>maxWidth</code>.<br>Notice that the dialog width grow is limited by the default margin."
    },
    "maxWidth": {
      "description": "Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to <code>false</code> to disable <code>maxWidth</code>."
    },
    "onClose": {
      "description": "Callback fired when the component requests to be closed.",
      "typeDescriptions": {
        "event": { "name": "event", "description": "The event source of the callback." },
        "reason": {
          "name": "reason",
          "description": "Can be: <code>&quot;escapeKeyDown&quot;</code>, <code>&quot;backdropClick&quot;</code>."
        }
      }
    },
    "open": { "description": "If <code>true</code>, the component is shown." },
    "PaperComponent": { "description": "The component used to render the body of the dialog." },
    "PaperProps": {
      "description": "Props applied to the <a href=\"https://mui.com/material-ui/api/paper/\"><code>Paper</code></a> element."
    },
    "scroll": { "description": "Determine the container for scrolling the dialog." },
    "slotProps": { "description": "The props used for each slot inside." },
    "slots": { "description": "The components used for each slot inside." },
    "sx": {
      "description": "The system prop that allows defining system overrides as well as additional CSS styles."
    },
    "TransitionComponent": {
      "description": "The component used for the transition. <a href=\"https://mui.com/material-ui/transitions/#transitioncomponent-prop\">Follow this guide</a> to learn more about the requirements for this component."
    },
    "transitionDuration": {
      "description": "The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object."
    },
    "TransitionProps": {
      "description": "Props applied to the transition element. By default, the element is based on this <a href=\"https://reactcommunity.org/react-transition-group/transition/\"><code>Transition</code></a> component."
    }
  },
  "classDescriptions": {
    "paperFullScreen": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>fullScreen={true}</code>"
    },
    "paperFullWidth": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>fullWidth={true}</code>"
    },
    "paperScrollBody": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>scroll=\"body\"</code>",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/dialog/#Dialog-css-MuiDialog-paper\">.MuiDialog-paper</a> and <a href=\"/material-ui/api/dialog/#dialog-classes-MuiDialog-scrollBody\">.MuiDialog-scrollBody</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "paperScrollPaper": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>scroll=\"paper\"</code>",
      "deprecationInfo": "Combine the <a href=\"/material-ui/api/dialog/#Dialog-css-MuiDialog-paper\">.MuiDialog-paper</a> and <a href=\"/material-ui/api/dialog/#dialog-classes-MuiDialog-scrollPaper\">.MuiDialog-scrollPaper</a> classes instead. See <a href=\"/material-ui/migration/migrating-from-deprecated-apis/\">Migrating from deprecated APIs</a> for more details."
    },
    "paperWidthFalse": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>maxWidth=false</code>"
    },
    "paperWidthLg": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>maxWidth=\"lg\"</code>"
    },
    "paperWidthMd": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>maxWidth=\"md\"</code>"
    },
    "paperWidthSm": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>maxWidth=\"sm\"</code>"
    },
    "paperWidthXl": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>maxWidth=\"xl\"</code>"
    },
    "paperWidthXs": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the Paper component",
      "conditions": "<code>maxWidth=\"xs\"</code>"
    },
    "scrollBody": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the container element",
      "conditions": "<code>scroll=\"body\"</code>"
    },
    "scrollPaper": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the container element",
      "conditions": "<code>scroll=\"paper\"</code>"
    }
  },
  "slotDescriptions": {
    "backdrop": "The component that renders the backdrop.",
    "container": "The component that renders the container.",
    "paper": "The component that renders the paper.",
    "root": "The component that renders the root.",
    "transition": "The component that renders the transition. <a href=\"/material-ui/transitions/#transitioncomponent-prop\">Follow this guide</a> to learn more about the requirements for this component."
  }
}