Files
react-test/docs/pages/joy-ui/api/skeleton.json

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

175 lines
6.0 KiB
JSON
Raw Normal View History

2025-12-12 14:26:25 +09:00
{
"props": {
"animation": {
"type": {
"name": "enum",
"description": "'pulse'<br>&#124;&nbsp;'wave'<br>&#124;&nbsp;false"
},
"default": "'pulse'"
},
"children": { "type": { "name": "node" } },
"component": { "type": { "name": "elementType" } },
"height": {
"type": {
"name": "union",
"description": "Array&lt;number<br>&#124;&nbsp;string&gt;<br>&#124;&nbsp;number<br>&#124;&nbsp;{ lg?: number<br>&#124;&nbsp;string, md?: number<br>&#124;&nbsp;string, sm?: number<br>&#124;&nbsp;string, xl?: number<br>&#124;&nbsp;string, xs?: number<br>&#124;&nbsp;string }<br>&#124;&nbsp;string"
}
},
"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": "variant === 'text' ? 'body-md' : 'inherit'"
},
"loading": { "type": { "name": "bool" }, "default": "true" },
"overlay": { "type": { "name": "bool" }, "default": "false" },
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func<br>&#124;&nbsp;object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"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 }
},
"variant": {
"type": {
"name": "union",
"description": "'circular'<br>&#124;&nbsp;'inline'<br>&#124;&nbsp;'overlay'<br>&#124;&nbsp;'rectangular'<br>&#124;&nbsp;'text'<br>&#124;&nbsp;string"
},
"default": "'overlay'",
"additionalInfo": { "joy-variant": true }
},
"width": {
"type": {
"name": "union",
"description": "Array&lt;number<br>&#124;&nbsp;string&gt;<br>&#124;&nbsp;number<br>&#124;&nbsp;{ lg?: number<br>&#124;&nbsp;string, md?: number<br>&#124;&nbsp;string, sm?: number<br>&#124;&nbsp;string, xl?: number<br>&#124;&nbsp;string, xs?: number<br>&#124;&nbsp;string }<br>&#124;&nbsp;string"
}
}
},
"name": "Skeleton",
"imports": ["import Skeleton from '@mui/joy/Skeleton';", "import { Skeleton } from '@mui/joy';"],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'span'",
"class": "MuiSkeleton-root"
}
],
"classes": [
{
"key": "body-lg",
"className": "MuiSkeleton-body-lg",
"description": "Class name applied to the root element if `level=\"body-lg\"`.",
"isGlobal": false
},
{
"key": "body-md",
"className": "MuiSkeleton-body-md",
"description": "Class name applied to the root element if `level=\"body-md\"`.",
"isGlobal": false
},
{
"key": "body-sm",
"className": "MuiSkeleton-body-sm",
"description": "Class name applied to the root element if `level=\"body-sm\"`.",
"isGlobal": false
},
{
"key": "body-xs",
"className": "MuiSkeleton-body-xs",
"description": "Class name applied to the root element if `level=\"body-xs\"`.",
"isGlobal": false
},
{
"key": "h1",
"className": "MuiSkeleton-h1",
"description": "Class name applied to the root element if `level=\"h1\"`.",
"isGlobal": false
},
{
"key": "h2",
"className": "MuiSkeleton-h2",
"description": "Class name applied to the root element if `level=\"h2\"`.",
"isGlobal": false
},
{
"key": "h3",
"className": "MuiSkeleton-h3",
"description": "Class name applied to the root element if `level=\"h3\"`.",
"isGlobal": false
},
{
"key": "h4",
"className": "MuiSkeleton-h4",
"description": "Class name applied to the root element if `level=\"h4\"`.",
"isGlobal": false
},
{
"key": "title-lg",
"className": "MuiSkeleton-title-lg",
"description": "Class name applied to the root element if `level=\"title-lg\"`.",
"isGlobal": false
},
{
"key": "title-md",
"className": "MuiSkeleton-title-md",
"description": "Class name applied to the root element if `level=\"title-md\"`.",
"isGlobal": false
},
{
"key": "title-sm",
"className": "MuiSkeleton-title-sm",
"description": "Class name applied to the root element if `level=\"title-sm\"`.",
"isGlobal": false
},
{
"key": "variantCircular",
"className": "MuiSkeleton-variantCircular",
"description": "Class name applied to the root element if `variant=\"circular\"`.",
"isGlobal": false
},
{
"key": "variantInline",
"className": "MuiSkeleton-variantInline",
"description": "Class name applied to the root element if `variant=\"inline\"`.",
"isGlobal": false
},
{
"key": "variantOverlay",
"className": "MuiSkeleton-variantOverlay",
"description": "Class name applied to the root element if `variant=\"overlay\"`.",
"isGlobal": false
},
{
"key": "variantRectangular",
"className": "MuiSkeleton-variantRectangular",
"description": "Class name applied to the root element if `variant=\"rectangular\"`.",
"isGlobal": false
},
{
"key": "variantText",
"className": "MuiSkeleton-variantText",
"description": "Class name applied to the root element if `variant=\"text\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoySkeleton",
"forwardsRefTo": "HTMLSpanElement",
"filename": "/packages/mui-joy/src/Skeleton/Skeleton.tsx",
"inheritance": null,
"demos": "<ul><li><a href=\"/joy-ui/react-skeleton/\">Skeleton</a></li></ul>",
"cssComponent": false
}