import * as React from 'react'; import { SxProps } from '@mui/system'; import { OverridableStringUnion } from '@mui/types'; import { OverridableComponent, OverrideProps } from '@mui/material/OverridableComponent'; import { Theme } from '../styles'; import { FormControlClasses } from '@mui/material/FormControl/formControlClasses'; export interface FormControlPropsSizeOverrides {} export interface FormControlPropsColorOverrides {} export interface FormControlOwnProps { /** * The content of the component. */ children?: React.HTMLAttributes['children']; /** * Override or extend the styles applied to the component. */ classes?: Partial; /** * The color of the component. * It supports both default and custom theme colors, which can be added as shown in the * [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors). * @default 'primary' */ color?: OverridableStringUnion< 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning', FormControlPropsColorOverrides >; /** * If `true`, the label, input and helper text should be displayed in a disabled state. * @default false */ disabled?: boolean; /** * If `true`, the label is displayed in an error state. * @default false */ error?: boolean; /** * If `true`, the component will take up the full width of its container. * @default false */ fullWidth?: boolean; /** * If `true`, the component is displayed in focused state. */ focused?: boolean; /** * If `true`, the label is hidden. * This is used to increase density for a `FilledInput`. * Be sure to add `aria-label` to the `input` element. * @default false */ hiddenLabel?: boolean; /** * If `dense` or `normal`, will adjust vertical spacing of this and contained components. * @default 'none' */ margin?: 'dense' | 'normal' | 'none'; /** * If `true`, the label will indicate that the `input` is required. * @default false */ required?: boolean; /** * The size of the component. * @default 'medium' */ size?: OverridableStringUnion<'small' | 'medium', FormControlPropsSizeOverrides>; /** * The system prop that allows defining system overrides as well as additional CSS styles. */ sx?: SxProps; /** * The variant to use. * @default 'outlined' */ variant?: 'standard' | 'outlined' | 'filled'; } export interface FormControlTypeMap< AdditionalProps = {}, RootComponent extends React.ElementType = 'div', > { props: AdditionalProps & FormControlOwnProps; defaultComponent: RootComponent; } /** * Provides context such as filled/focused/error/required for form inputs. * Relying on the context provides high flexibility and ensures that the state always stays * consistent across the children of the `FormControl`. * This context is used by the following components: * * * FormLabel * * FormHelperText * * Input * * InputLabel * * You can find one composition example below and more going to [the demos](https://mui.com/material-ui/react-text-field/#components). * * ```jsx * * Email address * * We'll never share your email. * * ``` * * ⚠️ Only one `InputBase` can be used within a FormControl because it creates visual inconsistencies. * For instance, only one input can be focused at the same time, the state shouldn't be shared. * * Demos: * * - [Checkbox](https://mui.com/material-ui/react-checkbox/) * - [Radio Group](https://mui.com/material-ui/react-radio-button/) * - [Switch](https://mui.com/material-ui/react-switch/) * - [Text Field](https://mui.com/material-ui/react-text-field/) * * API: * * - [FormControl API](https://mui.com/material-ui/api/form-control/) */ declare const FormControl: OverridableComponent; export type FormControlProps< RootComponent extends React.ElementType = FormControlTypeMap['defaultComponent'], AdditionalProps = {}, > = OverrideProps, RootComponent> & { component?: React.ElementType; }; export default FormControl;