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

{
  "componentDescription": "",
  "propDescriptions": {
    "action": {
      "description": "The action to display. It renders after the message, at the end of the snackbar."
    },
    "anchorOrigin": {
      "description": "The anchor of the <code>Snackbar</code>. On smaller screens, the component grows to occupy all the available width, the horizontal alignment is ignored."
    },
    "autoHideDuration": {
      "description": "The number of milliseconds to wait before automatically calling the <code>onClose</code> function. <code>onClose</code> should then set the state of the <code>open</code> prop to hide the Snackbar. This behavior is disabled by default with the <code>null</code> value."
    },
    "children": { "description": "Replace the <code>SnackbarContent</code> component." },
    "classes": { "description": "Override or extend the styles applied to the component." },
    "ClickAwayListenerProps": {
      "description": "Props applied to the <code>ClickAwayListener</code> element."
    },
    "ContentProps": {
      "description": "Props applied to the <a href=\"https://mui.com/material-ui/api/snackbar-content/\"><code>SnackbarContent</code></a> element."
    },
    "disableWindowBlurListener": {
      "description": "If <code>true</code>, the <code>autoHideDuration</code> timer will expire even if the window is not focused."
    },
    "key": {
      "description": "When displaying multiple consecutive snackbars using a single parent-rendered <code>&lt;Snackbar/&gt;</code>, add the <code>key</code> prop to ensure independent treatment of each message. For instance, use <code>&lt;Snackbar key={message} /&gt;</code>. Otherwise, messages might update in place, and features like <code>autoHideDuration</code> could be affected."
    },
    "message": { "description": "The message to display." },
    "onClose": {
      "description": "Callback fired when the component requests to be closed. Typically <code>onClose</code> is used to set state in the parent component, which is used to control the <code>Snackbar</code> <code>open</code> prop. The <code>reason</code> parameter can optionally be used to control the response to <code>onClose</code>, for example ignoring <code>clickaway</code>.",
      "typeDescriptions": {
        "event": { "name": "event", "description": "The event source of the callback." },
        "reason": {
          "name": "reason",
          "description": "Can be: <code>&quot;timeout&quot;</code> (<code>autoHideDuration</code> expired), <code>&quot;clickaway&quot;</code>, or <code>&quot;escapeKeyDown&quot;</code>."
        }
      }
    },
    "open": { "description": "If <code>true</code>, the component is shown." },
    "resumeHideDuration": {
      "description": "The number of milliseconds to wait before dismissing after user interaction. If <code>autoHideDuration</code> prop isn&#39;t specified, it does nothing. If <code>autoHideDuration</code> prop is specified but <code>resumeHideDuration</code> isn&#39;t, we default to <code>autoHideDuration / 2</code> ms."
    },
    "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": {
    "anchorOriginBottomCenter": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchorOrigin={{ 'bottom', 'center' }}</code>"
    },
    "anchorOriginBottomLeft": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchorOrigin={{ 'bottom', 'left' }}</code>"
    },
    "anchorOriginBottomRight": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchorOrigin={{ 'bottom', 'right' }}</code>"
    },
    "anchorOriginTopCenter": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchorOrigin={{ 'top', 'center' }}</code>"
    },
    "anchorOriginTopLeft": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchorOrigin={{ 'top', 'left' }}</code>"
    },
    "anchorOriginTopRight": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>anchorOrigin={{ 'top', 'right' }}</code>"
    }
  },
  "slotDescriptions": {
    "clickAwayListener": "The component that renders the clickAwayListener slot.",
    "content": "The component that renders the content slot.",
    "root": "The component that renders the root slot.",
    "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."
  }
}