react-test/docs/pages/joy-ui/api/typography.json

{
  "props": {
    "children": { "type": { "name": "node" } },
    "color": {
      "type": {
        "name": "union",
        "description": "'danger'<br>&#124;&nbsp;'neutral'<br>&#124;&nbsp;'primary'<br>&#124;&nbsp;'success'<br>&#124;&nbsp;'warning'<br>&#124;&nbsp;string"
      },
      "additionalInfo": { "joy-color": true }
    },
    "component": { "type": { "name": "elementType" } },
    "endDecorator": { "type": { "name": "node" } },
    "gutterBottom": { "type": { "name": "bool" }, "default": "false" },
    "level": {
      "type": {
        "name": "union",
        "description": "'h1'<br>&#124;&nbsp;'h2'<br>&#124;&nbsp;'h3'<br>&#124;&nbsp;'h4'<br>&#124;&nbsp;'title-lg'<br>&#124;&nbsp;'title-md'<br>&#124;&nbsp;'title-sm'<br>&#124;&nbsp;'body-lg'<br>&#124;&nbsp;'body-md'<br>&#124;&nbsp;'body-sm'<br>&#124;&nbsp;'body-xs'<br>&#124;&nbsp;'inherit'<br>&#124;&nbsp;string"
      },
      "default": "'body-md'"
    },
    "levelMapping": {
      "type": { "name": "object" },
      "default": "{\n  h1: 'h1',\n  h2: 'h2',\n  h3: 'h3',\n  h4: 'h4',\n  'title-lg': 'p',\n  'title-md': 'p',\n  'title-sm': 'p',\n  'body-lg': 'p',\n  'body-md': 'p',\n  'body-sm': 'p',\n  'body-xs': 'span',\n  inherit: 'p',\n}"
    },
    "noWrap": { "type": { "name": "bool" }, "default": "false" },
    "slotProps": {
      "type": {
        "name": "shape",
        "description": "{ endDecorator?: func<br>&#124;&nbsp;object, root?: func<br>&#124;&nbsp;object, startDecorator?: func<br>&#124;&nbsp;object }"
      },
      "default": "{}"
    },
    "slots": {
      "type": {
        "name": "shape",
        "description": "{ endDecorator?: elementType, root?: elementType, startDecorator?: elementType }"
      },
      "default": "{}",
      "additionalInfo": { "slotsApi": true }
    },
    "startDecorator": { "type": { "name": "node" } },
    "sx": {
      "type": {
        "name": "union",
        "description": "Array&lt;func<br>&#124;&nbsp;object<br>&#124;&nbsp;bool&gt;<br>&#124;&nbsp;func<br>&#124;&nbsp;object"
      },
      "additionalInfo": { "sx": true }
    },
    "textColor": { "type": { "name": "any" } },
    "variant": {
      "type": {
        "name": "union",
        "description": "'outlined'<br>&#124;&nbsp;'plain'<br>&#124;&nbsp;'soft'<br>&#124;&nbsp;'solid'<br>&#124;&nbsp;string"
      },
      "additionalInfo": { "joy-variant": true }
    }
  },
  "name": "Typography",
  "imports": [
    "import Typography from '@mui/joy/Typography';",
    "import { Typography } from '@mui/joy';"
  ],
  "slots": [
    {
      "name": "root",
      "description": "The component that renders the root.",
      "default": "'a'",
      "class": "MuiTypography-root"
    },
    {
      "name": "startDecorator",
      "description": "The component that renders the start decorator.",
      "default": "'span'",
      "class": "MuiTypography-startDecorator"
    },
    {
      "name": "endDecorator",
      "description": "The component that renders the end decorator.",
      "default": "'span'",
      "class": "MuiTypography-endDecorator"
    }
  ],
  "classes": [
    {
      "key": "body-lg",
      "className": "MuiTypography-body-lg",
      "description": "Class name applied to the root element if `level=\"body-lg\"`.",
      "isGlobal": false
    },
    {
      "key": "body-md",
      "className": "MuiTypography-body-md",
      "description": "Class name applied to the root element if `level=\"body-md\"`.",
      "isGlobal": false
    },
    {
      "key": "body-sm",
      "className": "MuiTypography-body-sm",
      "description": "Class name applied to the root element if `level=\"body-sm\"`.",
      "isGlobal": false
    },
    {
      "key": "body-xs",
      "className": "MuiTypography-body-xs",
      "description": "Class name applied to the root element if `level=\"body-xs\"`.",
      "isGlobal": false
    },
    {
      "key": "colorContext",
      "className": "MuiTypography-colorContext",
      "description": "Class name applied to the root element when color inversion is triggered.",
      "isGlobal": false
    },
    {
      "key": "colorDanger",
      "className": "MuiTypography-colorDanger",
      "description": "Class name applied to the root element if `color=\"danger\"`.",
      "isGlobal": false
    },
    {
      "key": "colorNeutral",
      "className": "MuiTypography-colorNeutral",
      "description": "Class name applied to the root element if `color=\"neutral\"`.",
      "isGlobal": false
    },
    {
      "key": "colorPrimary",
      "className": "MuiTypography-colorPrimary",
      "description": "Class name applied to the root element if `color=\"primary\"`.",
      "isGlobal": false
    },
    {
      "key": "colorSuccess",
      "className": "MuiTypography-colorSuccess",
      "description": "Class name applied to the root element if `color=\"success\"`.",
      "isGlobal": false
    },
    {
      "key": "colorWarning",
      "className": "MuiTypography-colorWarning",
      "description": "Class name applied to the root element if `color=\"warning\"`.",
      "isGlobal": false
    },
    {
      "key": "gutterBottom",
      "className": "MuiTypography-gutterBottom",
      "description": "Class name applied to the root element if `gutterBottom={true}`.",
      "isGlobal": false
    },
    {
      "key": "h1",
      "className": "MuiTypography-h1",
      "description": "Class name applied to the root element if `level=\"h1\"`.",
      "isGlobal": false
    },
    {
      "key": "h2",
      "className": "MuiTypography-h2",
      "description": "Class name applied to the root element if `level=\"h2\"`.",
      "isGlobal": false
    },
    {
      "key": "h3",
      "className": "MuiTypography-h3",
      "description": "Class name applied to the root element if `level=\"h3\"`.",
      "isGlobal": false
    },
    {
      "key": "h4",
      "className": "MuiTypography-h4",
      "description": "Class name applied to the root element if `level=\"h4\"`.",
      "isGlobal": false
    },
    {
      "key": "noWrap",
      "className": "MuiTypography-noWrap",
      "description": "Class name applied to the root element if `nowrap={true}`.",
      "isGlobal": false
    },
    {
      "key": "title-lg",
      "className": "MuiTypography-title-lg",
      "description": "Class name applied to the root element if `level=\"title-lg\"`.",
      "isGlobal": false
    },
    {
      "key": "title-md",
      "className": "MuiTypography-title-md",
      "description": "Class name applied to the root element if `level=\"title-md\"`.",
      "isGlobal": false
    },
    {
      "key": "title-sm",
      "className": "MuiTypography-title-sm",
      "description": "Class name applied to the root element if `level=\"title-sm\"`.",
      "isGlobal": false
    },
    {
      "key": "variantOutlined",
      "className": "MuiTypography-variantOutlined",
      "description": "Class name applied to the root element if `variant=\"outlined\"`.",
      "isGlobal": false
    },
    {
      "key": "variantPlain",
      "className": "MuiTypography-variantPlain",
      "description": "Class name applied to the root element if `variant=\"plain\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSoft",
      "className": "MuiTypography-variantSoft",
      "description": "Class name applied to the root element if `variant=\"soft\"`.",
      "isGlobal": false
    },
    {
      "key": "variantSolid",
      "className": "MuiTypography-variantSolid",
      "description": "Class name applied to the root element if `variant=\"solid\"`.",
      "isGlobal": false
    }
  ],
  "spread": true,
  "themeDefaultProps": true,
  "muiName": "JoyTypography",
  "forwardsRefTo": "HTMLParagraphElement",
  "filename": "/packages/mui-joy/src/Typography/Typography.tsx",
  "inheritance": null,
  "demos": "<ul><li><a href=\"/joy-ui/react-skeleton/\">Skeleton</a></li>\n<li><a href=\"/joy-ui/react-typography/\">Typography</a></li></ul>",
  "cssComponent": true
}