Interface WithFormControlProps

interface WithFormControlProps {
    FormHelperTextProps?: Partial<FormHelperTextProps>;
    InputLabelProps?: Partial<InputLabelProps>;
    InputProps?: Partial<InputProps>;
    SelectProps?: Partial<SelectProps>;
    about?: string;
    accessKey?: string;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?:
        | "none"
        | "inline"
        | "list"
        | "both";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?:
        | boolean
        | "true"
        | "false"
        | "mixed";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?:
        | boolean
        | "page"
        | "time"
        | "true"
        | "false"
        | "step"
        | "location"
        | "date";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?:
        | "link"
        | "none"
        | "copy"
        | "execute"
        | "move"
        | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?:
        | boolean
        | "grid"
        | "dialog"
        | "menu"
        | "true"
        | "false"
        | "listbox"
        | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?:
        | boolean
        | "true"
        | "false"
        | "grammar"
        | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "off" | "assertive" | "polite";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?:
        | boolean
        | "true"
        | "false"
        | "mixed";
    aria-readonly?: Booleanish;
    aria-relevant?:
        | "all"
        | "text"
        | "additions"
        | "additions removals"
        | "additions text"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?:
        | "none"
        | "ascending"
        | "descending"
        | "other";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    autoCapitalize?:
        | string & {}
        | "none"
        | "off"
        | "on"
        | "sentences"
        | "words"
        | "characters";
    autoComplete?: string;
    autoCorrect?: string;
    autoFocus?: boolean;
    autoSave?: string;
    className?: string;
    classes?: Partial<TextFieldClasses>;
    color?: OverridableStringUnion<
        | "primary"
        | "secondary"
        | "error"
        | "info"
        | "success"
        | "warning", TextFieldPropsColorOverrides>;
    component?: ElementType<any, (keyof IntrinsicElements)>;
    content?: string;
    contentEditable?: "inherit" | Booleanish | "plaintext-only";
    contextMenu?: string;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    datatype?: string;
    defaultChecked?: boolean;
    defaultValue?: unknown;
    dir?: string;
    disabled?: boolean;
    draggable?: Booleanish;
    enterKeyHint?:
        | "search"
        | "enter"
        | "done"
        | "go"
        | "next"
        | "previous"
        | "send";
    error?: boolean;
    fieldLabel?: string;
    focused?: boolean;
    formControlName?: string;
    fullWidth?: boolean;
    helperText?: ReactNode;
    hidden?: boolean;
    hiddenLabel?: boolean;
    id?: string;
    inlist?: any;
    inputMode?:
        | "search"
        | "text"
        | "none"
        | "tel"
        | "url"
        | "email"
        | "numeric"
        | "decimal";
    inputProps?: InputBaseComponentProps;
    inputRef?: Ref<any>;
    is?: string;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    label?: ReactNode;
    lang?: string;
    margin?: "none" | "normal" | "dense";
    maxRows?: string | number;
    minRows?: string | number;
    multiline?: boolean;
    name?: string;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLDivElement>;
    onAbortCapture?: ReactEventHandler<HTMLDivElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLDivElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLDivElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>;
    onAnimationStart?: AnimationEventHandler<HTMLDivElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>;
    onAuxClick?: MouseEventHandler<HTMLDivElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLDivElement>;
    onBeforeInput?: FormEventHandler<HTMLDivElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLDivElement>;
    onBlur?: FocusEventHandler<HTMLTextAreaElement | HTMLInputElement>;
    onBlurCapture?: FocusEventHandler<HTMLDivElement>;
    onCanPlay?: ReactEventHandler<HTMLDivElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLDivElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLDivElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>;
    onChange?: ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement>;
    onChangeCapture?: FormEventHandler<HTMLDivElement>;
    onClick?: MouseEventHandler<HTMLDivElement>;
    onClickCapture?: MouseEventHandler<HTMLDivElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLDivElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>;
    onCompositionStart?: CompositionEventHandler<HTMLDivElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>;
    onContextMenu?: MouseEventHandler<HTMLDivElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLDivElement>;
    onCopy?: ClipboardEventHandler<HTMLDivElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLDivElement>;
    onCut?: ClipboardEventHandler<HTMLDivElement>;
    onCutCapture?: ClipboardEventHandler<HTMLDivElement>;
    onDoubleClick?: MouseEventHandler<HTMLDivElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>;
    onDrag?: DragEventHandler<HTMLDivElement>;
    onDragCapture?: DragEventHandler<HTMLDivElement>;
    onDragEnd?: DragEventHandler<HTMLDivElement>;
    onDragEndCapture?: DragEventHandler<HTMLDivElement>;
    onDragEnter?: DragEventHandler<HTMLDivElement>;
    onDragEnterCapture?: DragEventHandler<HTMLDivElement>;
    onDragExit?: DragEventHandler<HTMLDivElement>;
    onDragExitCapture?: DragEventHandler<HTMLDivElement>;
    onDragLeave?: DragEventHandler<HTMLDivElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLDivElement>;
    onDragOver?: DragEventHandler<HTMLDivElement>;
    onDragOverCapture?: DragEventHandler<HTMLDivElement>;
    onDragStart?: DragEventHandler<HTMLDivElement>;
    onDragStartCapture?: DragEventHandler<HTMLDivElement>;
    onDrop?: DragEventHandler<HTMLDivElement>;
    onDropCapture?: DragEventHandler<HTMLDivElement>;
    onDurationChange?: ReactEventHandler<HTMLDivElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>;
    onEmptied?: ReactEventHandler<HTMLDivElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLDivElement>;
    onEncrypted?: ReactEventHandler<HTMLDivElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLDivElement>;
    onEnded?: ReactEventHandler<HTMLDivElement>;
    onEndedCapture?: ReactEventHandler<HTMLDivElement>;
    onError?: ReactEventHandler<HTMLDivElement>;
    onErrorCapture?: ReactEventHandler<HTMLDivElement>;
    onFocus?: FocusEventHandler<HTMLTextAreaElement | HTMLInputElement>;
    onFocusCapture?: FocusEventHandler<HTMLDivElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLDivElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
    onInput?: FormEventHandler<HTMLDivElement>;
    onInputCapture?: FormEventHandler<HTMLDivElement>;
    onInvalid?: FormEventHandler<HTMLDivElement>;
    onInvalidCapture?: FormEventHandler<HTMLDivElement>;
    onKeyDown?: KeyboardEventHandler<HTMLDivElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>;
    onKeyPress?: KeyboardEventHandler<HTMLDivElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>;
    onKeyUp?: KeyboardEventHandler<HTMLDivElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>;
    onLoad?: ReactEventHandler<HTMLDivElement>;
    onLoadCapture?: ReactEventHandler<HTMLDivElement>;
    onLoadStart?: ReactEventHandler<HTMLDivElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLDivElement>;
    onLoadedData?: ReactEventHandler<HTMLDivElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLDivElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLDivElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>;
    onMouseDown?: MouseEventHandler<HTMLDivElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLDivElement>;
    onMouseEnter?: MouseEventHandler<HTMLDivElement>;
    onMouseLeave?: MouseEventHandler<HTMLDivElement>;
    onMouseMove?: MouseEventHandler<HTMLDivElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>;
    onMouseOut?: MouseEventHandler<HTMLDivElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLDivElement>;
    onMouseOver?: MouseEventHandler<HTMLDivElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLDivElement>;
    onMouseUp?: MouseEventHandler<HTMLDivElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLDivElement>;
    onPaste?: ClipboardEventHandler<HTMLDivElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLDivElement>;
    onPause?: ReactEventHandler<HTMLDivElement>;
    onPauseCapture?: ReactEventHandler<HTMLDivElement>;
    onPlay?: ReactEventHandler<HTMLDivElement>;
    onPlayCapture?: ReactEventHandler<HTMLDivElement>;
    onPlaying?: ReactEventHandler<HTMLDivElement>;
    onPlayingCapture?: ReactEventHandler<HTMLDivElement>;
    onPointerCancel?: PointerEventHandler<HTMLDivElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerDown?: PointerEventHandler<HTMLDivElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerEnter?: PointerEventHandler<HTMLDivElement>;
    onPointerLeave?: PointerEventHandler<HTMLDivElement>;
    onPointerMove?: PointerEventHandler<HTMLDivElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerOut?: PointerEventHandler<HTMLDivElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerOver?: PointerEventHandler<HTMLDivElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLDivElement>;
    onPointerUp?: PointerEventHandler<HTMLDivElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLDivElement>;
    onProgress?: ReactEventHandler<HTMLDivElement>;
    onProgressCapture?: ReactEventHandler<HTMLDivElement>;
    onRateChange?: ReactEventHandler<HTMLDivElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLDivElement>;
    onReset?: FormEventHandler<HTMLDivElement>;
    onResetCapture?: FormEventHandler<HTMLDivElement>;
    onResize?: ReactEventHandler<HTMLDivElement>;
    onResizeCapture?: ReactEventHandler<HTMLDivElement>;
    onScroll?: UIEventHandler<HTMLDivElement>;
    onScrollCapture?: UIEventHandler<HTMLDivElement>;
    onSeeked?: ReactEventHandler<HTMLDivElement>;
    onSeekedCapture?: ReactEventHandler<HTMLDivElement>;
    onSeeking?: ReactEventHandler<HTMLDivElement>;
    onSeekingCapture?: ReactEventHandler<HTMLDivElement>;
    onSelect?: ReactEventHandler<HTMLDivElement>;
    onSelectCapture?: ReactEventHandler<HTMLDivElement>;
    onStalled?: ReactEventHandler<HTMLDivElement>;
    onStalledCapture?: ReactEventHandler<HTMLDivElement>;
    onSubmit?: FormEventHandler<HTMLDivElement>;
    onSubmitCapture?: FormEventHandler<HTMLDivElement>;
    onSuspend?: ReactEventHandler<HTMLDivElement>;
    onSuspendCapture?: ReactEventHandler<HTMLDivElement>;
    onTimeUpdate?: ReactEventHandler<HTMLDivElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>;
    onTouchCancel?: TouchEventHandler<HTMLDivElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>;
    onTouchEnd?: TouchEventHandler<HTMLDivElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLDivElement>;
    onTouchMove?: TouchEventHandler<HTMLDivElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>;
    onTouchStart?: TouchEventHandler<HTMLDivElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLDivElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLDivElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>;
    onVolumeChange?: ReactEventHandler<HTMLDivElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>;
    onWaiting?: ReactEventHandler<HTMLDivElement>;
    onWaitingCapture?: ReactEventHandler<HTMLDivElement>;
    onWheel?: WheelEventHandler<HTMLDivElement>;
    onWheelCapture?: WheelEventHandler<HTMLDivElement>;
    placeholder?: string;
    prefix?: string;
    property?: string;
    radioGroup?: string;
    ref?: null | ((instance: null | HTMLDivElement) => void) | RefObject<HTMLDivElement>;
    rel?: string;
    required?: boolean;
    resource?: string;
    results?: number;
    rev?: string;
    role?: AriaRole;
    rows?: string | number;
    security?: string;
    select?: boolean;
    size?: OverridableStringUnion<"small" | "medium", TextFieldPropsSizeOverrides>;
    slot?: string;
    slotProps?: {
        formHelperText?: SlotProps<ElementType<FormHelperTextProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
        htmlInput?: SlotProps<ElementType<undefined | InputBaseComponentProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
        input?: SlotProps<ElementType<InputProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
        inputLabel?: SlotProps<ElementType<InputLabelProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
        select?: SlotProps<ElementType<SelectProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
    };
    slots?: Partial<TextFieldSlots>;
    spellCheck?: Booleanish;
    style?: CSSProperties;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    sx?: SxProps<Theme>;
    tabIndex?: number;
    title?: string;
    translate?: "yes" | "no";
    type?: HTMLInputTypeAttribute;
    typeof?: string;
    unselectable?: "off" | "on";
    value?: unknown;
    variant?: "standard";
    vocab?: string;
}

Hierarchy (view full)

StandardTextFieldProps
- WithFormControlProps
  - NameWithFormControlProps

Index

Properties

FormHelperTextProps? InputLabelProps? InputProps? SelectProps? about? accessKey? aria-activedescendant? aria-atomic? aria-autocomplete? aria-braillelabel? aria-brailleroledescription? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colindextext? aria-colspan? aria-controls? aria-current? aria-describedby? aria-description? aria-details? aria-disabled? aria-dropeffect? aria-errormessage? aria-expanded? aria-flowto? aria-grabbed? aria-haspopup? aria-hidden? aria-invalid? aria-keyshortcuts? aria-label? aria-labelledby? aria-level? aria-live? aria-modal? aria-multiline? aria-multiselectable? aria-orientation? aria-owns? aria-placeholder? aria-posinset? aria-pressed? aria-readonly? aria-relevant? aria-required? aria-roledescription? aria-rowcount? aria-rowindex? aria-rowindextext? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? autoCapitalize? autoComplete? autoCorrect? autoFocus? autoSave? className? classes? color? component? content? contentEditable? contextMenu? dangerouslySetInnerHTML? datatype? defaultChecked? defaultValue? dir? disabled? draggable? enterKeyHint? error? fieldLabel? focused? formControlName? fullWidth? helperText? hidden? hiddenLabel? id? inlist? inputMode? inputProps? inputRef? is? itemID? itemProp? itemRef? itemScope? itemType? key? label? lang? margin? maxRows? minRows? multiline? name? nonce? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClick? onClickCapture? onCompositionEnd? onCompositionEndCapture? onCompositionStart? onCompositionStartCapture? onCompositionUpdate? onCompositionUpdateCapture? onContextMenu? onContextMenuCapture? onCopy? onCopyCapture? onCut? onCutCapture? onDoubleClick? onDoubleClickCapture? onDrag? onDragCapture? onDragEnd? onDragEndCapture? onDragEnter? onDragEnterCapture? onDragExit? onDragExitCapture? onDragLeave? onDragLeaveCapture? onDragOver? onDragOverCapture? onDragStart? onDragStartCapture? onDrop? onDropCapture? onDurationChange? onDurationChangeCapture? onEmptied? onEmptiedCapture? onEncrypted? onEncryptedCapture? onEnded? onEndedCapture? onError? onErrorCapture? onFocus? onFocusCapture? onGotPointerCapture? onGotPointerCaptureCapture? onInput? onInputCapture? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPress? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadStart? onLoadStartCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onProgress? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onResize? onResizeCapture? onScroll? onScrollCapture? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onTimeUpdate? onTimeUpdateCapture? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionEnd? onTransitionEndCapture? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? placeholder? prefix? property? radioGroup? ref? rel? required? resource? results? rev? role? rows? security? select? size? slot? slotProps? slots? spellCheck? style? suppressContentEditableWarning? suppressHydrationWarning? sx? tabIndex? title? translate? type? typeof? unselectable? value? variant? vocab?

Properties

`Optional`FormHelperTextProps

FormHelperTextProps?: Partial<FormHelperTextProps>

Props applied to the FormHelperText element.

Deprecated

Use slotProps.formHelperText instead. This prop will be removed in v7. See Migrating from deprecated APIs for more details.

`Optional`InputLabelProps

InputLabelProps?: Partial<InputLabelProps>

Props applied to the InputLabel element. Pointer events like onClick are enabled if and only if shrink is true.

Deprecated

Use slotProps.inputLabel instead. This prop will be removed in v7. See Migrating from deprecated APIs for more details.

`Optional`InputProps

InputProps?: Partial<InputProps>

Props applied to the Input element. It will be a FilledInput, OutlinedInput or Input component depending on the variant prop value.

Deprecated

Use slotProps.input instead. This prop will be removed in v7. See Migrating from deprecated APIs for more details.

`Optional`SelectProps

SelectProps?: Partial<SelectProps>

Props applied to the Select element.

Deprecated

Use slotProps.select instead. This prop will be removed in v7. See Migrating from deprecated APIs for more details.

`Optional`about

about?: string

`Optional`accessKey

accessKey?: string

`Optional`aria-activedescendant

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

`Optional`aria-atomic

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

`Optional`aria-autocomplete

aria-autocomplete?:
    | "none"
    | "inline"
    | "list"
    | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

`Optional`aria-braillelabel

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

`Optional`aria-brailleroledescription

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

`Optional`aria-busy

aria-busy?: Booleanish

`Optional`aria-checked

aria-checked?:
    | boolean
    | "true"
    | "false"
    | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

aria-pressed
aria-selected.

`Optional`aria-colcount

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

`Optional`aria-colindex

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

aria-colcount
aria-colspan.

`Optional`aria-colindextext

aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

`Optional`aria-colspan

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

aria-colindex
aria-rowspan.

`Optional`aria-controls

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

`Optional`aria-current

Indicates the element that represents the current item within a container or set of related elements.

`Optional`aria-describedby

aria-describedby?: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

`Optional`aria-description

aria-description?: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

`Optional`aria-details

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

`Optional`aria-disabled

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

aria-hidden
aria-readonly.

`Optional`aria-dropeffect

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

`Optional`aria-errormessage

aria-errormessage?: string

Identifies the element that provides an error message for the object.

See

aria-invalid
aria-describedby.

`Optional`aria-expanded

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

`Optional`aria-flowto

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

`Optional`aria-grabbed

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

`Optional`aria-haspopup

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

`Optional`aria-hidden

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

`Optional`aria-invalid

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

`Optional`aria-keyshortcuts

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

`Optional`aria-label

aria-label?: string

Defines a string value that labels the current element.

See

aria-labelledby.

`Optional`aria-labelledby

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

`Optional`aria-level

aria-level?: number

Defines the hierarchical level of an element within a structure.

`Optional`aria-live

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

`Optional`aria-modal

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

`Optional`aria-multiline

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

`Optional`aria-multiselectable

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

`Optional`aria-orientation

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

`Optional`aria-owns

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

`Optional`aria-placeholder

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

`Optional`aria-posinset

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

`Optional`aria-pressed

aria-pressed?:
    | boolean
    | "true"
    | "false"
    | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

aria-checked
aria-selected.

`Optional`aria-readonly

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

`Optional`aria-relevant

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

`Optional`aria-required

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

`Optional`aria-roledescription

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

`Optional`aria-rowcount

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

`Optional`aria-rowindex

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

aria-rowcount
aria-rowspan.

`Optional`aria-rowindextext

aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

`Optional`aria-rowspan

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

See

aria-rowindex
aria-colspan.

`Optional`aria-selected

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

See

aria-checked
aria-pressed.

`Optional`aria-setsize

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-posinset.

`Optional`aria-sort

aria-sort?:
    | "none"
    | "ascending"
    | "descending"
    | "other"

Indicates if items in a table or grid are sorted in ascending or descending order.

`Optional`aria-valuemax

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

`Optional`aria-valuemin

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

`Optional`aria-valuenow

aria-valuenow?: number

Defines the current value for a range widget.

See

aria-valuetext.

`Optional`aria-valuetext

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

`Optional`autoCapitalize

autoCapitalize?:
    | string & {}
    | "none"
    | "off"
    | "on"
    | "sentences"
    | "words"
    | "characters"

`Optional`autoComplete

autoComplete?: string

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.

`Optional`autoCorrect

autoCorrect?: string

`Optional`autoFocus

autoFocus?: boolean

If true, the input element is focused during the first mount.

Default

false

`Optional`autoSave

autoSave?: string

`Optional`className

className?: string

`Optional`classes

classes?: Partial<TextFieldClasses>

Override or extend the styles applied to the component.

`Optional`color

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Default

'primary'

`Optional`component

component?: ElementType<any, (keyof IntrinsicElements)>

`Optional`content

content?: string

`Optional`contentEditable

contentEditable?: "inherit" | Booleanish | "plaintext-only"

`Optional`contextMenu

contextMenu?: string

`Optional`dangerouslySetInnerHTML

dangerouslySetInnerHTML?: {
__html: string | TrustedHTML;
}

`Optional`datatype

datatype?: string

`Optional`defaultChecked

defaultChecked?: boolean

`Optional`defaultValue

defaultValue?: unknown

The default value. Use when the component is not controlled.

`Optional`dir

dir?: string

`Optional`disabled

disabled?: boolean

If true, the component is disabled.

Default

false

`Optional`draggable

draggable?: Booleanish

`Optional`enterKeyHint

`Optional`error

error?: boolean

If true, the label is displayed in an error state.

Default

false

`Optional`fieldLabel

fieldLabel?: string

`Optional`focused

focused?: boolean

If true, the component is displayed in focused state.

`Optional`formControlName

formControlName?: string

`Optional`fullWidth

fullWidth?: boolean

If true, the input will take up the full width of its container.

Default

false

`Optional`helperText

helperText?: ReactNode

The helper text content.

`Optional`hidden

hidden?: boolean

`Optional`hiddenLabel

hiddenLabel?: 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

`Optional`id

id?: string

The id of the input element. Use this prop to make label and helperText accessible for screen readers.

`Optional`inlist

inlist?: any

`Optional`inputMode

Hints at the type of data that might be entered by the user while editing the element or its contents

See

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

`Optional`inputProps

inputProps?: InputBaseComponentProps

Attributes applied to the input element.

Deprecated

Use slotProps.htmlInput instead. This prop will be removed in v7. See Migrating from deprecated APIs for more details.

`Optional`inputRef

inputRef?: Ref<any>

Pass a ref to the input element.

`Optional`is

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

See

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

`Optional`itemID

itemID?: string

`Optional`itemProp

itemProp?: string

`Optional`itemRef

itemRef?: string

`Optional`itemScope

itemScope?: boolean

`Optional`itemType

itemType?: string

`Optional`key

key?: null | Key

`Optional`label

label?: ReactNode

The label content.

`Optional`lang

lang?: string

`Optional`margin

margin?: "none" | "normal" | "dense"

If dense or normal, will adjust vertical spacing of this and contained components.

Default

'none'

`Optional`maxRows

maxRows?: string | number

Maximum number of rows to display when multiline option is set to true.

`Optional`minRows

minRows?: string | number

Minimum number of rows to display when multiline option is set to true.

`Optional`multiline

multiline?: boolean

If true, a textarea element is rendered instead of an input.

Default

false

`Optional`name

name?: string

Name attribute of the input element.

`Optional`nonce

nonce?: string

`Optional`onAbort

onAbort?: ReactEventHandler<HTMLDivElement>

`Optional`onAbortCapture

onAbortCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onAnimationEnd

onAnimationEnd?: AnimationEventHandler<HTMLDivElement>

`Optional`onAnimationEndCapture

onAnimationEndCapture?: AnimationEventHandler<HTMLDivElement>

`Optional`onAnimationIteration

onAnimationIteration?: AnimationEventHandler<HTMLDivElement>

`Optional`onAnimationIterationCapture

onAnimationIterationCapture?: AnimationEventHandler<HTMLDivElement>

`Optional`onAnimationStart

onAnimationStart?: AnimationEventHandler<HTMLDivElement>

`Optional`onAnimationStartCapture

onAnimationStartCapture?: AnimationEventHandler<HTMLDivElement>

`Optional`onAuxClick

onAuxClick?: MouseEventHandler<HTMLDivElement>

`Optional`onAuxClickCapture

onAuxClickCapture?: MouseEventHandler<HTMLDivElement>

`Optional`onBeforeInput

onBeforeInput?: FormEventHandler<HTMLDivElement>

`Optional`onBeforeInputCapture

onBeforeInputCapture?: FormEventHandler<HTMLDivElement>

`Optional`onBlur

onBlur?: FocusEventHandler<HTMLTextAreaElement | HTMLInputElement>

`Optional`onBlurCapture

onBlurCapture?: FocusEventHandler<HTMLDivElement>

`Optional`onCanPlay

onCanPlay?: ReactEventHandler<HTMLDivElement>

`Optional`onCanPlayCapture

onCanPlayCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onCanPlayThrough

onCanPlayThrough?: ReactEventHandler<HTMLDivElement>

`Optional`onCanPlayThroughCapture

onCanPlayThroughCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onChange

onChange?: ChangeEventHandler<HTMLTextAreaElement | HTMLInputElement>

Callback fired when the value is changed.

Param: event

The event source of the callback. You can pull out the new value by accessing event.target.value (string).

`Optional`onChangeCapture

onChangeCapture?: FormEventHandler<HTMLDivElement>

`Optional`onClick

onClick?: MouseEventHandler<HTMLDivElement>

`Optional`onClickCapture

onClickCapture?: MouseEventHandler<HTMLDivElement>

`Optional`onCompositionEnd

onCompositionEnd?: CompositionEventHandler<HTMLDivElement>

`Optional`onCompositionEndCapture

onCompositionEndCapture?: CompositionEventHandler<HTMLDivElement>

`Optional`onCompositionStart

onCompositionStart?: CompositionEventHandler<HTMLDivElement>

`Optional`onCompositionStartCapture

onCompositionStartCapture?: CompositionEventHandler<HTMLDivElement>

`Optional`onCompositionUpdate

onCompositionUpdate?: CompositionEventHandler<HTMLDivElement>

`Optional`onCompositionUpdateCapture

onCompositionUpdateCapture?: CompositionEventHandler<HTMLDivElement>

`Optional`onContextMenu

onContextMenu?: MouseEventHandler<HTMLDivElement>

`Optional`onContextMenuCapture

onContextMenuCapture?: MouseEventHandler<HTMLDivElement>

`Optional`onCopy

onCopy?: ClipboardEventHandler<HTMLDivElement>

`Optional`onCopyCapture

onCopyCapture?: ClipboardEventHandler<HTMLDivElement>

`Optional`onCut

onCut?: ClipboardEventHandler<HTMLDivElement>

`Optional`onCutCapture

onCutCapture?: ClipboardEventHandler<HTMLDivElement>

`Optional`onDoubleClick

onDoubleClick?: MouseEventHandler<HTMLDivElement>

`Optional`onDoubleClickCapture

onDoubleClickCapture?: MouseEventHandler<HTMLDivElement>

`Optional`onDrag

onDrag?: DragEventHandler<HTMLDivElement>

`Optional`onDragCapture

onDragCapture?: DragEventHandler<HTMLDivElement>

`Optional`onDragEnd

onDragEnd?: DragEventHandler<HTMLDivElement>

`Optional`onDragEndCapture

onDragEndCapture?: DragEventHandler<HTMLDivElement>

`Optional`onDragEnter

onDragEnter?: DragEventHandler<HTMLDivElement>

`Optional`onDragEnterCapture

onDragEnterCapture?: DragEventHandler<HTMLDivElement>

`Optional`onDragExit

onDragExit?: DragEventHandler<HTMLDivElement>

`Optional`onDragExitCapture

onDragExitCapture?: DragEventHandler<HTMLDivElement>

`Optional`onDragLeave

onDragLeave?: DragEventHandler<HTMLDivElement>

`Optional`onDragLeaveCapture

onDragLeaveCapture?: DragEventHandler<HTMLDivElement>

`Optional`onDragOver

onDragOver?: DragEventHandler<HTMLDivElement>

`Optional`onDragOverCapture

onDragOverCapture?: DragEventHandler<HTMLDivElement>

`Optional`onDragStart

onDragStart?: DragEventHandler<HTMLDivElement>

`Optional`onDragStartCapture

onDragStartCapture?: DragEventHandler<HTMLDivElement>

`Optional`onDrop

onDrop?: DragEventHandler<HTMLDivElement>

`Optional`onDropCapture

onDropCapture?: DragEventHandler<HTMLDivElement>

`Optional`onDurationChange

onDurationChange?: ReactEventHandler<HTMLDivElement>

`Optional`onDurationChangeCapture

onDurationChangeCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onEmptied

onEmptied?: ReactEventHandler<HTMLDivElement>

`Optional`onEmptiedCapture

onEmptiedCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onEncrypted

onEncrypted?: ReactEventHandler<HTMLDivElement>

`Optional`onEncryptedCapture

onEncryptedCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onEnded

onEnded?: ReactEventHandler<HTMLDivElement>

`Optional`onEndedCapture

onEndedCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onError

onError?: ReactEventHandler<HTMLDivElement>

`Optional`onErrorCapture

onErrorCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onFocus

onFocus?: FocusEventHandler<HTMLTextAreaElement | HTMLInputElement>

`Optional`onFocusCapture

onFocusCapture?: FocusEventHandler<HTMLDivElement>

`Optional`onGotPointerCapture

onGotPointerCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onGotPointerCaptureCapture

onGotPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onInput

onInput?: FormEventHandler<HTMLDivElement>

`Optional`onInputCapture

onInputCapture?: FormEventHandler<HTMLDivElement>

`Optional`onInvalid

onInvalid?: FormEventHandler<HTMLDivElement>

`Optional`onInvalidCapture

onInvalidCapture?: FormEventHandler<HTMLDivElement>

`Optional`onKeyDown

onKeyDown?: KeyboardEventHandler<HTMLDivElement>

`Optional`onKeyDownCapture

onKeyDownCapture?: KeyboardEventHandler<HTMLDivElement>

`Optional`onKeyPress

onKeyPress?: KeyboardEventHandler<HTMLDivElement>

Deprecated

Use onKeyUp or onKeyDown instead

`Optional`onKeyPressCapture

onKeyPressCapture?: KeyboardEventHandler<HTMLDivElement>

Deprecated

Use onKeyUpCapture or onKeyDownCapture instead

`Optional`onKeyUp

onKeyUp?: KeyboardEventHandler<HTMLDivElement>

`Optional`onKeyUpCapture

onKeyUpCapture?: KeyboardEventHandler<HTMLDivElement>

`Optional`onLoad

onLoad?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadCapture

onLoadCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadStart

onLoadStart?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadStartCapture

onLoadStartCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadedData

onLoadedData?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadedDataCapture

onLoadedDataCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadedMetadata

onLoadedMetadata?: ReactEventHandler<HTMLDivElement>

`Optional`onLoadedMetadataCapture

onLoadedMetadataCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onLostPointerCapture

onLostPointerCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onLostPointerCaptureCapture

onLostPointerCaptureCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onMouseDown

onMouseDown?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseDownCapture

onMouseDownCapture?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseEnter

onMouseEnter?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseLeave

onMouseLeave?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseMove

onMouseMove?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseMoveCapture

onMouseMoveCapture?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseOut

onMouseOut?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseOutCapture

onMouseOutCapture?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseOver

onMouseOver?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseOverCapture

onMouseOverCapture?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseUp

onMouseUp?: MouseEventHandler<HTMLDivElement>

`Optional`onMouseUpCapture

onMouseUpCapture?: MouseEventHandler<HTMLDivElement>

`Optional`onPaste

onPaste?: ClipboardEventHandler<HTMLDivElement>

`Optional`onPasteCapture

onPasteCapture?: ClipboardEventHandler<HTMLDivElement>

`Optional`onPause

onPause?: ReactEventHandler<HTMLDivElement>

`Optional`onPauseCapture

onPauseCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onPlay

onPlay?: ReactEventHandler<HTMLDivElement>

`Optional`onPlayCapture

onPlayCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onPlaying

onPlaying?: ReactEventHandler<HTMLDivElement>

`Optional`onPlayingCapture

onPlayingCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onPointerCancel

onPointerCancel?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerCancelCapture

onPointerCancelCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerDown

onPointerDown?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerDownCapture

onPointerDownCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerEnter

onPointerEnter?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerLeave

onPointerLeave?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerMove

onPointerMove?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerMoveCapture

onPointerMoveCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerOut

onPointerOut?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerOutCapture

onPointerOutCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerOver

onPointerOver?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerOverCapture

onPointerOverCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerUp

onPointerUp?: PointerEventHandler<HTMLDivElement>

`Optional`onPointerUpCapture

onPointerUpCapture?: PointerEventHandler<HTMLDivElement>

`Optional`onProgress

onProgress?: ReactEventHandler<HTMLDivElement>

`Optional`onProgressCapture

onProgressCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onRateChange

onRateChange?: ReactEventHandler<HTMLDivElement>

`Optional`onRateChangeCapture

onRateChangeCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onReset

onReset?: FormEventHandler<HTMLDivElement>

`Optional`onResetCapture

onResetCapture?: FormEventHandler<HTMLDivElement>

`Optional`onResize

onResize?: ReactEventHandler<HTMLDivElement>

`Optional`onResizeCapture

onResizeCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onScroll

onScroll?: UIEventHandler<HTMLDivElement>

`Optional`onScrollCapture

onScrollCapture?: UIEventHandler<HTMLDivElement>

`Optional`onSeeked

onSeeked?: ReactEventHandler<HTMLDivElement>

`Optional`onSeekedCapture

onSeekedCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onSeeking

onSeeking?: ReactEventHandler<HTMLDivElement>

`Optional`onSeekingCapture

onSeekingCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onSelect

onSelect?: ReactEventHandler<HTMLDivElement>

`Optional`onSelectCapture

onSelectCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onStalled

onStalled?: ReactEventHandler<HTMLDivElement>

`Optional`onStalledCapture

onStalledCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onSubmit

onSubmit?: FormEventHandler<HTMLDivElement>

`Optional`onSubmitCapture

onSubmitCapture?: FormEventHandler<HTMLDivElement>

`Optional`onSuspend

onSuspend?: ReactEventHandler<HTMLDivElement>

`Optional`onSuspendCapture

onSuspendCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onTimeUpdate

onTimeUpdate?: ReactEventHandler<HTMLDivElement>

`Optional`onTimeUpdateCapture

onTimeUpdateCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onTouchCancel

onTouchCancel?: TouchEventHandler<HTMLDivElement>

`Optional`onTouchCancelCapture

onTouchCancelCapture?: TouchEventHandler<HTMLDivElement>

`Optional`onTouchEnd

onTouchEnd?: TouchEventHandler<HTMLDivElement>

`Optional`onTouchEndCapture

onTouchEndCapture?: TouchEventHandler<HTMLDivElement>

`Optional`onTouchMove

onTouchMove?: TouchEventHandler<HTMLDivElement>

`Optional`onTouchMoveCapture

onTouchMoveCapture?: TouchEventHandler<HTMLDivElement>

`Optional`onTouchStart

onTouchStart?: TouchEventHandler<HTMLDivElement>

`Optional`onTouchStartCapture

onTouchStartCapture?: TouchEventHandler<HTMLDivElement>

`Optional`onTransitionEnd

onTransitionEnd?: TransitionEventHandler<HTMLDivElement>

`Optional`onTransitionEndCapture

onTransitionEndCapture?: TransitionEventHandler<HTMLDivElement>

`Optional`onVolumeChange

onVolumeChange?: ReactEventHandler<HTMLDivElement>

`Optional`onVolumeChangeCapture

onVolumeChangeCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onWaiting

onWaiting?: ReactEventHandler<HTMLDivElement>

`Optional`onWaitingCapture

onWaitingCapture?: ReactEventHandler<HTMLDivElement>

`Optional`onWheel

onWheel?: WheelEventHandler<HTMLDivElement>

`Optional`onWheelCapture

onWheelCapture?: WheelEventHandler<HTMLDivElement>

`Optional`placeholder

placeholder?: string

The short hint displayed in the input before the user enters a value.

`Optional`prefix

prefix?: string

`Optional`property

property?: string

`Optional`radioGroup

radioGroup?: string

`Optional`ref

ref?: null | ((instance: null | HTMLDivElement) => void) | RefObject<HTMLDivElement>

`Optional`rel

rel?: string

`Optional`required

required?: boolean

If true, the label is displayed as required and the input element is required.

Default

false

`Optional`resource

resource?: string

`Optional`results

results?: number

`Optional`rev

rev?: string

`Optional`role

role?: AriaRole

`Optional`rows

rows?: string | number

Number of rows to display when multiline option is set to true.

`Optional`security

security?: string

`Optional`select

select?: boolean

Render a 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.

Default

false

`Optional`size

size?: OverridableStringUnion<"small" | "medium", TextFieldPropsSizeOverrides>

The size of the component.

`Optional`slot

slot?: string

`Optional`slotProps

slotProps?: {
    formHelperText?: SlotProps<ElementType<FormHelperTextProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
    htmlInput?: SlotProps<ElementType<undefined | InputBaseComponentProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
    input?: SlotProps<ElementType<InputProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
    inputLabel?: SlotProps<ElementType<InputLabelProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
    select?: SlotProps<ElementType<SelectProps, (keyof IntrinsicElements)>, {}, BaseTextFieldProps>;
}

The props used for each slot inside.

Default

{}

`Optional`slots

slots?: Partial<TextFieldSlots>

The components used for each slot inside.

Default

{}

`Optional`spellCheck

spellCheck?: Booleanish

`Optional`style

style?: CSSProperties

`Optional`suppressContentEditableWarning

suppressContentEditableWarning?: boolean

`Optional`suppressHydrationWarning

suppressHydrationWarning?: boolean

`Optional`sx

sx?: SxProps<Theme>

The system prop that allows defining system overrides as well as additional CSS styles.

`Optional`tabIndex

tabIndex?: number

`Optional`title

title?: string

`Optional`translate

translate?: "yes" | "no"

`Optional`type

type?: HTMLInputTypeAttribute

Type of the input element. It should be a valid HTML5 input type.

`Optional`typeof

typeof?: string

`Optional`unselectable

unselectable?: "off" | "on"

`Optional`value

value?: unknown

The value of the input element, required for a controlled component.

`Optional`variant

variant?: "standard"

The variant to use.

Default

'outlined'

`Optional`vocab

vocab?: string

Interface WithFormControlProps

Hierarchy (view full)

Index

Properties

Properties

OptionalFormHelperTextProps

Deprecated

OptionalInputLabelProps

Deprecated

OptionalInputProps

Deprecated

OptionalSelectProps

Deprecated

Optionalabout

OptionalaccessKey

Optionalaria-activedescendant

Optionalaria-atomic

Optionalaria-autocomplete

Optionalaria-braillelabel

See

Optionalaria-brailleroledescription

See

Optionalaria-busy

Optionalaria-checked

See

Optionalaria-colcount

See

Optionalaria-colindex

See

Optionalaria-colindextext

See

Optionalaria-colspan

See

Optionalaria-controls

See

Optionalaria-current

Optionalaria-describedby

See

Optionalaria-description

See

Optionalaria-details

See

Optionalaria-disabled

See

Optionalaria-dropeffect

Deprecated

Optionalaria-errormessage

See

Optionalaria-expanded

Optionalaria-flowto

Optionalaria-grabbed

Deprecated

Optionalaria-haspopup

Optionalaria-hidden

See

Optionalaria-invalid

See

Optionalaria-keyshortcuts

Optionalaria-label

See

Optionalaria-labelledby

See

Optionalaria-level

Optionalaria-live

Optionalaria-modal

Optionalaria-multiline

Optionalaria-multiselectable

Optionalaria-orientation

Optionalaria-owns

See

Optionalaria-placeholder

Optionalaria-posinset

See

Optionalaria-pressed

See

Optionalaria-readonly

See

Optionalaria-relevant

See

Optionalaria-required

`Optional`FormHelperTextProps

`Optional`InputLabelProps

`Optional`InputProps

`Optional`SelectProps

`Optional`about

`Optional`accessKey

`Optional`aria-activedescendant

`Optional`aria-atomic

`Optional`aria-autocomplete

`Optional`aria-braillelabel

`Optional`aria-brailleroledescription

`Optional`aria-busy

`Optional`aria-checked

`Optional`aria-colcount

`Optional`aria-colindex

`Optional`aria-colindextext

`Optional`aria-colspan

`Optional`aria-controls

`Optional`aria-current

`Optional`aria-describedby

`Optional`aria-description

`Optional`aria-details

`Optional`aria-disabled

`Optional`aria-dropeffect

`Optional`aria-errormessage

`Optional`aria-expanded

`Optional`aria-flowto

`Optional`aria-grabbed

`Optional`aria-haspopup

`Optional`aria-hidden

`Optional`aria-invalid

`Optional`aria-keyshortcuts

`Optional`aria-label

`Optional`aria-labelledby

`Optional`aria-level

`Optional`aria-live

`Optional`aria-modal

`Optional`aria-multiline

`Optional`aria-multiselectable

`Optional`aria-orientation

`Optional`aria-owns

`Optional`aria-placeholder

`Optional`aria-posinset

`Optional`aria-pressed

`Optional`aria-readonly

`Optional`aria-relevant

`Optional`aria-required

`Optional`aria-roledescription

`Optional`aria-rowcount

`Optional`aria-rowindex

`Optional`aria-rowindextext

`Optional`aria-rowspan

`Optional`aria-selected

`Optional`aria-setsize

`Optional`aria-sort

`Optional`aria-valuemax

`Optional`aria-valuemin

`Optional`aria-valuenow

`Optional`aria-valuetext

`Optional`autoCapitalize

`Optional`autoComplete

`Optional`autoCorrect

`Optional`autoFocus

`Optional`autoSave

`Optional`className

`Optional`classes

`Optional`color

`Optional`component

`Optional`content

`Optional`contentEditable

`Optional`contextMenu

`Optional`dangerouslySetInnerHTML

`Optional`datatype

`Optional`defaultChecked

`Optional`defaultValue

`Optional`dir

`Optional`disabled

`Optional`draggable

`Optional`enterKeyHint

`Optional`error