1 | import * as React from 'react';
|
2 | import { OverridableComponent, OverrideProps } from '../OverridableComponent';
|
3 |
|
4 | export interface FormLabelTypeMap<P = {}, D extends React.ElementType = 'label'> {
|
5 | props: P &
|
6 | FormLabelBaseProps & {
|
7 | /**
|
8 | * The content of the component.
|
9 | */
|
10 | children?: React.ReactNode;
|
11 | /**
|
12 | * The color of the component. It supports those theme colors that make sense for this component.
|
13 | */
|
14 | color?: 'primary' | 'secondary';
|
15 | /**
|
16 | * If `true`, the label should be displayed in a disabled state.
|
17 | */
|
18 | disabled?: boolean;
|
19 | /**
|
20 | * If `true`, the label should be displayed in an error state.
|
21 | */
|
22 | error?: boolean;
|
23 | /**
|
24 | * If `true`, the label should use filled classes key.
|
25 | */
|
26 | filled?: boolean;
|
27 | /**
|
28 | * If `true`, the input of this label is focused (used by `FormGroup` components).
|
29 | */
|
30 | focused?: boolean;
|
31 | /**
|
32 | * If `true`, the label will indicate that the input is required.
|
33 | */
|
34 | required?: boolean;
|
35 | };
|
36 | defaultComponent: D;
|
37 | classKey: FormLabelClassKey;
|
38 | }
|
39 |
|
40 | /**
|
41 | *
|
42 | * Demos:
|
43 | *
|
44 | * - [Checkboxes](https://mui.com/components/checkboxes/)
|
45 | * - [Radio Buttons](https://mui.com/components/radio-buttons/)
|
46 | * - [Switches](https://mui.com/components/switches/)
|
47 | *
|
48 | * API:
|
49 | *
|
50 | * - [FormLabel API](https://mui.com/api/form-label/)
|
51 | */
|
52 | declare const FormLabel: OverridableComponent<FormLabelTypeMap>;
|
53 |
|
54 | export type FormLabelClassKey =
|
55 | | 'root'
|
56 | | 'colorSecondary'
|
57 | | 'focused'
|
58 | | 'disabled'
|
59 | | 'error'
|
60 | | 'filled'
|
61 | | 'required'
|
62 | | 'asterisk';
|
63 |
|
64 | export type FormLabelBaseProps = React.LabelHTMLAttributes<HTMLLabelElement>;
|
65 |
|
66 | export type FormLabelProps<
|
67 | D extends React.ElementType = FormLabelTypeMap['defaultComponent'],
|
68 | P = {}
|
69 | > = OverrideProps<FormLabelTypeMap<P, D>, D>;
|
70 |
|
71 | export default FormLabel;
|