{
"props": {
"children": { "type": { "name": "node" } },
"color": {
"type": {
"name": "union",
"description": "'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string"
},
"additionalInfo": { "joy-color": true }
},
"component": { "type": { "name": "elementType" } },
"disabled": { "type": { "name": "bool" }, "default": "false" },
"error": { "type": { "name": "bool" }, "default": "false" },
"orientation": {
"type": { "name": "enum", "description": "'horizontal'
| 'vertical'" },
"default": "'vertical'"
},
"required": { "type": { "name": "bool" }, "default": "false" },
"size": {
"type": {
"name": "union",
"description": "'sm'
| 'md'
| 'lg'
| string"
},
"default": "'md'",
"additionalInfo": { "joy-size": true }
},
"slotProps": {
"type": { "name": "shape", "description": "{ root?: func
| object }" },
"default": "{}"
},
"slots": {
"type": { "name": "shape", "description": "{ root?: elementType }" },
"default": "{}",
"additionalInfo": { "slotsApi": true }
},
"sx": {
"type": {
"name": "union",
"description": "Array<func
| object
| bool>
| func
| object"
},
"additionalInfo": { "sx": true }
}
},
"name": "FormControl",
"imports": [
"import FormControl from '@mui/joy/FormControl';",
"import { FormControl } from '@mui/joy';"
],
"slots": [
{
"name": "root",
"description": "The component that renders the root.",
"default": "'div'",
"class": "MuiFormControl-root"
}
],
"classes": [
{
"key": "colorDanger",
"className": "MuiFormControl-colorDanger",
"description": "Class name applied to the root element if `color=\"danger\"`.",
"isGlobal": false
},
{
"key": "colorNeutral",
"className": "MuiFormControl-colorNeutral",
"description": "Class name applied to the root element if `color=\"neutral\"`.",
"isGlobal": false
},
{
"key": "colorPrimary",
"className": "MuiFormControl-colorPrimary",
"description": "Class name applied to the root element if `color=\"primary\"`.",
"isGlobal": false
},
{
"key": "colorSuccess",
"className": "MuiFormControl-colorSuccess",
"description": "Class name applied to the root element if `color=\"success\"`.",
"isGlobal": false
},
{
"key": "colorWarning",
"className": "MuiFormControl-colorWarning",
"description": "Class name applied to the root element if `color=\"warning\"`.",
"isGlobal": false
},
{
"key": "disabled",
"className": "Mui-disabled",
"description": "Class name applied to the root element if `disabled={true}`.",
"isGlobal": true
},
{
"key": "error",
"className": "Mui-error",
"description": "State class applied to the root element if `error={true}`.",
"isGlobal": true
},
{
"key": "horizontal",
"className": "MuiFormControl-horizontal",
"description": "Class name applied to the root element if `orientation=\"horizontal\"`.",
"isGlobal": false
},
{
"key": "sizeLg",
"className": "MuiFormControl-sizeLg",
"description": "Class name applied to the root element if `size=\"lg\"`.",
"isGlobal": false
},
{
"key": "sizeMd",
"className": "MuiFormControl-sizeMd",
"description": "Class name applied to the root element if `size=\"md\"`.",
"isGlobal": false
},
{
"key": "sizeSm",
"className": "MuiFormControl-sizeSm",
"description": "Class name applied to the root element if `size=\"sm\"`.",
"isGlobal": false
},
{
"key": "vertical",
"className": "MuiFormControl-vertical",
"description": "Class name applied to the root element if `orientation=\"vertical\"`.",
"isGlobal": false
}
],
"spread": true,
"themeDefaultProps": true,
"muiName": "JoyFormControl",
"forwardsRefTo": "HTMLDivElement",
"filename": "/packages/mui-joy/src/FormControl/FormControl.tsx",
"inheritance": null,
"demos": "