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

docs/translations/api-docs/step/step.json

50 строк2 KB

Michał Dudak

[docs-infra] Simplify CSS classes extraction in API docs generator (#39808)

30 ноя 2023, 11:30

30 ноя 2023, 11:30c6d17be

{
  "componentDescription": "",
  "propDescriptions": {
    "active": { "description": "Sets the step as active. Is passed to child components." },
    "children": {
      "description": "Should be <code>Step</code> sub-components such as <code>StepLabel</code>, <code>StepContent</code>."
    },
    "classes": { "description": "Override or extend the styles applied to the component." },
    "completed": { "description": "Mark the step as completed. Is passed to child components." },
    "component": {
      "description": "The component used for the root node. Either a string to use a HTML element or a component."
    },
    "disabled": {
      "description": "If <code>true</code>, the step is disabled, will also disable the button if <code>StepButton</code> is a child of <code>Step</code>. Is passed to child components."
    },
    "expanded": { "description": "Expand the step." },
    "index": {
      "description": "The position of the step. The prop defaults to the value inherited from the parent Stepper component."
    },
    "last": {
      "description": "If <code>true</code>, the Step is displayed as rendered last. The prop defaults to the value inherited from the parent Stepper component."
    },
    "sx": {
      "description": "The system prop that allows defining system overrides as well as additional CSS styles."
    }
  },
  "classDescriptions": {
    "alternativeLabel": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>alternativeLabel={true}</code>"
    },
    "completed": {
      "description": "State class applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>completed={true}</code>"
    },
    "horizontal": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>orientation=\"horizontal\"</code>"
    },
    "root": { "description": "Styles applied to the root element." },
    "vertical": {
      "description": "Styles applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>orientation=\"vertical\"</code>"
    }
  }
}