266 lines
8.4 KiB
TypeScript
266 lines
8.4 KiB
TypeScript
import * as React from 'react';
|
|
import { StandardProps, PropTypes } from '..';
|
|
import { FormControlProps } from '../FormControl';
|
|
import { FormHelperTextProps } from '../FormHelperText';
|
|
import { InputProps as StandardInputProps } from '../Input';
|
|
import { FilledInputProps } from '../FilledInput';
|
|
import { OutlinedInputProps } from '../OutlinedInput';
|
|
import { InputLabelProps } from '../InputLabel';
|
|
import { SelectProps } from '../Select';
|
|
|
|
export interface BaseTextFieldProps
|
|
extends StandardProps<
|
|
FormControlProps,
|
|
TextFieldClassKey,
|
|
// event handlers are declared on derived interfaces
|
|
'onChange' | 'onBlur' | 'onFocus' | 'defaultValue'
|
|
> {
|
|
/**
|
|
* 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 [following the specification](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill).
|
|
*/
|
|
autoComplete?: string;
|
|
/**
|
|
* If `true`, the `input` element will be focused during the first mount.
|
|
*/
|
|
autoFocus?: boolean;
|
|
/**
|
|
* @ignore
|
|
*/
|
|
children?: React.ReactNode;
|
|
/**
|
|
* The color of the component. It supports those theme colors that make sense for this component.
|
|
*/
|
|
color?: 'primary' | 'secondary';
|
|
/**
|
|
* The default value of the `input` element.
|
|
*/
|
|
defaultValue?: unknown;
|
|
/**
|
|
* If `true`, the `input` element will be disabled.
|
|
*/
|
|
disabled?: boolean;
|
|
/**
|
|
* If `true`, the label will be displayed in an error state.
|
|
*/
|
|
error?: boolean;
|
|
/**
|
|
* Props applied to the [`FormHelperText`](/api/form-helper-text/) element.
|
|
*/
|
|
FormHelperTextProps?: Partial<FormHelperTextProps>;
|
|
/**
|
|
* If `true`, the input will take up the full width of its container.
|
|
*/
|
|
fullWidth?: boolean;
|
|
/**
|
|
* The helper text content.
|
|
*/
|
|
helperText?: React.ReactNode;
|
|
/**
|
|
* The id of the `input` element.
|
|
* Use this prop to make `label` and `helperText` accessible for screen readers.
|
|
*/
|
|
id?: string;
|
|
/**
|
|
* Props applied to the [`InputLabel`](/api/input-label/) element.
|
|
*/
|
|
InputLabelProps?: Partial<InputLabelProps>;
|
|
/**
|
|
* Pass a ref to the `input` element.
|
|
*/
|
|
inputRef?: React.Ref<any>;
|
|
/**
|
|
* The label content.
|
|
*/
|
|
label?: React.ReactNode;
|
|
/**
|
|
* If `dense` or `normal`, will adjust vertical spacing of this and contained components.
|
|
*/
|
|
margin?: PropTypes.Margin;
|
|
/**
|
|
* If `true`, a textarea element will be rendered instead of an input.
|
|
*/
|
|
multiline?: boolean;
|
|
/**
|
|
* Name attribute of the `input` element.
|
|
*/
|
|
name?: string;
|
|
/**
|
|
* The short hint displayed in the input before the user enters a value.
|
|
*/
|
|
placeholder?: string;
|
|
/**
|
|
* If `true`, the label is displayed as required and the `input` element` will be required.
|
|
*/
|
|
required?: boolean;
|
|
/**
|
|
* Number of rows to display when multiline option is set to true.
|
|
* @deprecated Use `minRows` instead.
|
|
*/
|
|
rows?: string | number;
|
|
/**
|
|
* Maximum number of rows to display.
|
|
* @deprecated Use `maxRows` instead.
|
|
*/
|
|
rowsMax?: string | number;
|
|
/**
|
|
* Maximum number of rows to display when multiline option is set to true.
|
|
*/
|
|
maxRows?: string | number;
|
|
/**
|
|
* Minimum number of rows to display.
|
|
*/
|
|
minRows?: string | number;
|
|
/**
|
|
* Render a [`Select`](/api/select/) element while passing the Input element to `Select` as `input` parameter.
|
|
* If this option is set you must pass the options of the select as children.
|
|
*/
|
|
select?: boolean;
|
|
/**
|
|
* Props applied to the [`Select`](/api/select/) element.
|
|
*/
|
|
SelectProps?: Partial<SelectProps>;
|
|
/**
|
|
* The size of the text field.
|
|
*/
|
|
size?: 'small' | 'medium';
|
|
/**
|
|
* Type of the `input` element. It should be [a valid HTML5 input type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types).
|
|
*/
|
|
type?: React.InputHTMLAttributes<unknown>['type'];
|
|
/**
|
|
* The value of the `input` element, required for a controlled component.
|
|
*/
|
|
value?: unknown;
|
|
}
|
|
|
|
export interface StandardTextFieldProps extends BaseTextFieldProps {
|
|
onBlur?: StandardInputProps['onBlur'];
|
|
/**
|
|
* Callback fired when the value is changed.
|
|
*
|
|
* @param {object} event The event source of the callback.
|
|
* You can pull out the new value by accessing `event.target.value` (string).
|
|
*/
|
|
onChange?: StandardInputProps['onChange'];
|
|
onFocus?: StandardInputProps['onFocus'];
|
|
/**
|
|
* The variant to use.
|
|
*/
|
|
variant?: 'standard';
|
|
/**
|
|
* Props applied to the Input element.
|
|
* It will be a [`FilledInput`](/api/filled-input/),
|
|
* [`OutlinedInput`](/api/outlined-input/) or [`Input`](/api/input/)
|
|
* component depending on the `variant` prop value.
|
|
*/
|
|
InputProps?: Partial<StandardInputProps>;
|
|
/**
|
|
* [Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes) applied to the `input` element.
|
|
*/
|
|
inputProps?: StandardInputProps['inputProps'];
|
|
}
|
|
|
|
export interface FilledTextFieldProps extends BaseTextFieldProps {
|
|
onBlur?: FilledInputProps['onBlur'];
|
|
/**
|
|
* Callback fired when the value is changed.
|
|
*
|
|
* @param {object} event The event source of the callback.
|
|
* You can pull out the new value by accessing `event.target.value` (string).
|
|
*/
|
|
onChange?: FilledInputProps['onChange'];
|
|
onFocus?: FilledInputProps['onFocus'];
|
|
/**
|
|
* The variant to use.
|
|
*/
|
|
variant: 'filled';
|
|
/**
|
|
* Props applied to the Input element.
|
|
* It will be a [`FilledInput`](/api/filled-input/),
|
|
* [`OutlinedInput`](/api/outlined-input/) or [`Input`](/api/input/)
|
|
* component depending on the `variant` prop value.
|
|
*/
|
|
InputProps?: Partial<FilledInputProps>;
|
|
/**
|
|
* [Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes) applied to the `input` element.
|
|
*/
|
|
inputProps?: FilledInputProps['inputProps'];
|
|
}
|
|
|
|
export interface OutlinedTextFieldProps extends BaseTextFieldProps {
|
|
onBlur?: OutlinedInputProps['onBlur'];
|
|
/**
|
|
* Callback fired when the value is changed.
|
|
*
|
|
* @param {object} event The event source of the callback.
|
|
* You can pull out the new value by accessing `event.target.value` (string).
|
|
*/
|
|
onChange?: OutlinedInputProps['onChange'];
|
|
onFocus?: OutlinedInputProps['onFocus'];
|
|
/**
|
|
* The variant to use.
|
|
*/
|
|
variant: 'outlined';
|
|
/**
|
|
* Props applied to the Input element.
|
|
* It will be a [`FilledInput`](/api/filled-input/),
|
|
* [`OutlinedInput`](/api/outlined-input/) or [`Input`](/api/input/)
|
|
* component depending on the `variant` prop value.
|
|
*/
|
|
InputProps?: Partial<OutlinedInputProps>;
|
|
/**
|
|
* [Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Attributes) applied to the `input` element.
|
|
*/
|
|
inputProps?: OutlinedInputProps['inputProps'];
|
|
}
|
|
|
|
export type TextFieldProps = StandardTextFieldProps | FilledTextFieldProps | OutlinedTextFieldProps;
|
|
|
|
export type TextFieldClassKey = 'root';
|
|
|
|
/**
|
|
* The `TextField` is a convenience wrapper for the most common cases (80%).
|
|
* It cannot be all things to all people, otherwise the API would grow out of control.
|
|
*
|
|
* ## Advanced Configuration
|
|
*
|
|
* It's important to understand that the text field is a simple abstraction
|
|
* on top of the following components:
|
|
*
|
|
* - [FormControl](https://mui.com/api/form-control/)
|
|
* - [InputLabel](https://mui.com/api/input-label/)
|
|
* - [FilledInput](https://mui.com/api/filled-input/)
|
|
* - [OutlinedInput](https://mui.com/api/outlined-input/)
|
|
* - [Input](https://mui.com/api/input/)
|
|
* - [FormHelperText](https://mui.com/api/form-helper-text/)
|
|
*
|
|
* If you wish to alter the props applied to the `input` element, you can do so as follows:
|
|
*
|
|
* ```jsx
|
|
* const inputProps = {
|
|
* step: 300,
|
|
* };
|
|
*
|
|
* return <TextField id="time" type="time" inputProps={inputProps} />;
|
|
* ```
|
|
*
|
|
* For advanced cases, please look at the source of TextField by clicking on the
|
|
* "Edit this page" button above. Consider either:
|
|
*
|
|
* - using the upper case props for passing values directly to the components
|
|
* - using the underlying components directly as shown in the demos
|
|
* Demos:
|
|
*
|
|
* - [Autocomplete](https://mui.com/components/autocomplete/)
|
|
* - [Pickers](https://mui.com/components/pickers/)
|
|
* - [Text Fields](https://mui.com/components/text-fields/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [TextField API](https://mui.com/api/text-field/)
|
|
* - inherits [FormControl API](https://mui.com/api/form-control/)
|
|
*/
|
|
export default function TextField(props: TextFieldProps): JSX.Element;
|