docs/translations/api-docs/switch/switch.json - master - githubmirror/material-ui

docs/translations/api-docs/switch/switch.json
91 строка4 KB
Siriwat K
[Checkbox][Radio][Switch] Remove deprecated inputProps and inputRef (#48059)
23 мар 2026, 09:29
23 мар 2026, 09:2958cf9c2
{
  "componentDescription": "",
  "propDescriptions": {
    "checked": { "description": "If <code>true</code>, the component is checked." },
    "checkedIcon": { "description": "The icon to display when the component is checked." },
    "classes": { "description": "Override or extend the styles applied to the component." },
    "color": {
      "description": "The color of the component. It supports both default and custom theme colors, which can be added as shown in the <a href=\"https://mui.com/material-ui/customization/palette/#custom-colors\">palette customization guide</a>."
    },
    "defaultChecked": {
      "description": "The default checked state. Use when the component is not controlled."
    },
    "disabled": { "description": "If <code>true</code>, the component is disabled." },
    "disableRipple": { "description": "If <code>true</code>, the ripple effect is disabled." },
    "edge": {
      "description": "If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape)."
    },
    "icon": { "description": "The icon to display when the component is unchecked." },
    "id": { "description": "The id of the <code>input</code> element." },
    "onChange": {
      "description": "Callback fired when the state is changed.",
      "typeDescriptions": {
        "event": {
          "name": "event",
          "description": "The event source of the callback. You can pull out the new value by accessing <code>event.target.value</code> (string). You can pull out the new checked state by accessing <code>event.target.checked</code> (boolean)."
        }
      }
    },
    "required": {
      "description": "If <code>true</code>, the <code>input</code> element is required."
    },
    "size": {
      "description": "The size of the component. <code>small</code> is equivalent to the dense switch styling."
    },
    "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."
    },
    "value": {
      "description": "The value of the component. The DOM API casts this to a string. The browser uses &quot;on&quot; as the default value."
    }
  },
  "classDescriptions": {
    "checked": {
      "description": "State class applied to {{nodeName}}.",
      "nodeName": "the internal <code>SwitchBase</code> component&#39;s <code>checked</code> class"
    },
    "colorPrimary": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the internal SwitchBase component&#39;s root element",
      "conditions": "<code>color=\"primary\"</code>"
    },
    "colorSecondary": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the internal SwitchBase component&#39;s root element",
      "conditions": "<code>color=\"secondary\"</code>"
    },
    "disabled": {
      "description": "State class applied to {{nodeName}}.",
      "nodeName": "the internal SwitchBase component&#39;s disabled class"
    },
    "edgeEnd": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>edge=\"end\"</code>"
    },
    "edgeStart": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>edge=\"start\"</code>"
    },
    "sizeMedium": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>size=\"medium\"</code>"
    },
    "sizeSmall": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>size=\"small\"</code>"
    }
  },
  "slotDescriptions": {
    "input": "The component that renders the switchBase&#39;s input slot.",
    "root": "The component that renders the root slot.",
    "switchBase": "The component that renders the switchBase slot.",
    "thumb": "The component that renders the thumb slot.",
    "track": "The component that renders the track slot."
  }
}