react-test/docs/translations/api-docs-joy/badge/badge.json

{
  "componentDescription": "",
  "propDescriptions": {
    "anchorOrigin": { "description": "The anchor of the badge." },
    "badgeContent": { "description": "The content rendered within the badge." },
    "badgeInset": {
      "description": "The inset of the badge. Support shorthand syntax as described in <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/inset\">https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/inset</a>."
    },
    "children": { "description": "The badge will be added relative to this node." },
    "color": {
      "description": "The color of the component. It supports those theme colors that make sense for this component."
    },
    "component": {
      "description": "The component used for the root node. Either a string to use a HTML element or a component."
    },
    "invisible": { "description": "If <code>true</code>, the badge is invisible." },
    "max": { "description": "Max count to show." },
    "showZero": {
      "description": "Controls whether the badge is hidden when <code>badgeContent</code> is zero."
    },
    "size": { "description": "The size of the component." },
    "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."
    },
    "variant": {
      "description": "The <a href=\"https://mui.com/joy-ui/main-features/global-variants/\">global variant</a> to use."
    }
  },
  "classDescriptions": {
    "anchorOriginBottomLeft": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>anchorOrigin={{ 'bottom', 'left' }}</code>"
    },
    "anchorOriginBottomRight": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>anchorOrigin={{ 'bottom', 'right' }}</code>"
    },
    "anchorOriginTopLeft": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>anchorOrigin={{ 'top', 'left' }}</code>"
    },
    "anchorOriginTopRight": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>anchorOrigin={{ 'top', 'right' }}</code>"
    },
    "colorContext": {
      "description": "Class name applied to {{nodeName}} when {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "color inversion is triggered"
    },
    "colorDanger": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>color=\"danger\"</code>"
    },
    "colorNeutral": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>color=\"neutral\"</code>"
    },
    "colorPrimary": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>color=\"primary\"</code>"
    },
    "colorSuccess": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>color=\"success\"</code>"
    },
    "colorWarning": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>color=\"warning\"</code>"
    },
    "invisible": {
      "description": "State class applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>invisible={true}</code>"
    },
    "locationInside": {
      "description": "State class applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>location=\"inside\"</code>"
    },
    "locationOutside": {
      "description": "State class applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>location=\"outside\"</code>"
    },
    "sizeLg": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>size=\"lg\"</code>"
    },
    "sizeMd": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>size=\"md\"</code>"
    },
    "sizeSm": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>size=\"sm\"</code>"
    },
    "variantOutlined": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>variant=\"outlined\"</code>"
    },
    "variantPlain": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>variant=\"plain\"</code>"
    },
    "variantSoft": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>variant=\"soft\"</code>"
    },
    "variantSolid": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the badge <code>span</code> element",
      "conditions": "<code>variant=\"solid\"</code>"
    }
  },
  "slotDescriptions": {
    "badge": "The component that renders the badge.",
    "root": "The component that renders the root."
  }
}