Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
107 lines
5.0 KiB
JSON
107 lines
5.0 KiB
JSON
{
|
|
"componentDescription": "",
|
|
"propDescriptions": {
|
|
"autoComplete": {
|
|
"description": "This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it <a href=\"https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill\">following the specification</a>."
|
|
},
|
|
"autoFocus": {
|
|
"description": "If <code>true</code>, the <code>input</code> element is focused during the first mount."
|
|
},
|
|
"className": { "description": "Class name applied to the root element." },
|
|
"defaultValue": {
|
|
"description": "The default value. Use when the component is not controlled."
|
|
},
|
|
"disabled": {
|
|
"description": "If <code>true</code>, the component is disabled. The prop defaults to the value (<code>false</code>) inherited from the parent FormControl component."
|
|
},
|
|
"endAdornment": { "description": "Trailing adornment for this input." },
|
|
"error": {
|
|
"description": "If <code>true</code>, the <code>input</code> will indicate an error by setting the <code>aria-invalid</code> attribute on the input and the <code>baseui--error</code> class on the root element. The prop defaults to the value (<code>false</code>) inherited from the parent FormControl component."
|
|
},
|
|
"id": { "description": "The id of the <code>input</code> element." },
|
|
"maxRows": {
|
|
"description": "Maximum number of rows to display when multiline option is set to true."
|
|
},
|
|
"minRows": {
|
|
"description": "Minimum number of rows to display when multiline option is set to true."
|
|
},
|
|
"multiline": {
|
|
"description": "If <code>true</code>, a <code>textarea</code> element is rendered."
|
|
},
|
|
"name": { "description": "Name attribute of the <code>input</code> element." },
|
|
"placeholder": {
|
|
"description": "The short hint displayed in the <code>input</code> before the user enters a value."
|
|
},
|
|
"readOnly": {
|
|
"description": "It prevents the user from changing the value of the field (not from interacting with the field)."
|
|
},
|
|
"required": {
|
|
"description": "If <code>true</code>, the <code>input</code> element is required. The prop defaults to the value (<code>false</code>) inherited from the parent FormControl component."
|
|
},
|
|
"rows": { "description": "Number of rows to display when multiline option is set to true." },
|
|
"slotProps": { "description": "The props used for each slot inside the Input." },
|
|
"slots": {
|
|
"description": "The components used for each slot inside the InputBase. Either a string to use a HTML element or a component."
|
|
},
|
|
"startAdornment": { "description": "Leading adornment for this input." },
|
|
"type": {
|
|
"description": "Type of the <code>input</code> element. It should be <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types\">a valid HTML5 input type</a>."
|
|
},
|
|
"value": {
|
|
"description": "The value of the <code>input</code> element, required for a controlled component."
|
|
}
|
|
},
|
|
"classDescriptions": {
|
|
"adornedEnd": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>endAdornment</code> is provided"
|
|
},
|
|
"adornedStart": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>startAdornment</code> is provided"
|
|
},
|
|
"disabled": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>disabled={true}</code>"
|
|
},
|
|
"error": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>error={true}</code>"
|
|
},
|
|
"focused": {
|
|
"description": "State class applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "the component is focused"
|
|
},
|
|
"formControl": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "the component is a descendant of <code>FormControl</code>"
|
|
},
|
|
"inputMultiline": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the input element",
|
|
"conditions": "<code>multiline={true}</code>"
|
|
},
|
|
"inputTypeSearch": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the input element",
|
|
"conditions": "<code>type=\"search\"</code>"
|
|
},
|
|
"multiline": {
|
|
"description": "Class name applied to {{nodeName}} if {{conditions}}.",
|
|
"nodeName": "the root element",
|
|
"conditions": "<code>multiline={true}</code>"
|
|
}
|
|
},
|
|
"slotDescriptions": {
|
|
"input": "The component that renders the input.",
|
|
"root": "The component that renders the root.",
|
|
"textarea": "The component that renders the textarea."
|
|
}
|
|
}
|