FormHelperText.d.ts
2.32 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { OverridableComponent, OverrideProps } from "../OverridableComponent/index.js";
import { Theme } from "../styles/index.js";
import { FormHelperTextClasses } from "./formHelperTextClasses.js";
export interface FormHelperTextPropsVariantOverrides {}
export interface FormHelperTextOwnProps {
/**
* The content of the component.
*
* If `' '` is provided, the component reserves one line height for displaying a future message.
*/
children?: React.ReactNode;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<FormHelperTextClasses>;
/**
* If `true`, the helper text should be displayed in a disabled state.
*/
disabled?: boolean;
/**
* If `true`, helper text should be displayed in an error state.
*/
error?: boolean;
/**
* If `true`, the helper text should use filled classes key.
*/
filled?: boolean;
/**
* If `true`, the helper text should use focused classes key.
*/
focused?: boolean;
/**
* If `dense`, will adjust vertical spacing. This is normally obtained via context from
* FormControl.
*/
margin?: 'dense';
/**
* If `true`, the helper text should use required classes key.
*/
required?: boolean;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme>;
/**
* The variant to use.
*/
variant?: OverridableStringUnion<'standard' | 'outlined' | 'filled', FormHelperTextPropsVariantOverrides>;
}
export interface FormHelperTextTypeMap<AdditionalProps = {}, RootComponent extends React.ElementType = 'p'> {
props: AdditionalProps & FormHelperTextOwnProps;
defaultComponent: RootComponent;
}
/**
*
* Demos:
*
* - [Text Field](https://mui.com/material-ui/react-text-field/)
*
* API:
*
* - [FormHelperText API](https://mui.com/material-ui/api/form-helper-text/)
*/
declare const FormHelperText: OverridableComponent<FormHelperTextTypeMap>;
export type FormHelperTextProps<RootComponent extends React.ElementType = FormHelperTextTypeMap['defaultComponent'], AdditionalProps = {}> = OverrideProps<FormHelperTextTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType;
};
export default FormHelperText;