Skip to main content

Introducing Workflow Engine, try for FREE workflowengine.io.

Interface: MuiSelectProps

The MuiSelect component properties.

Extends

  • Omit<SelectProps<string>, "onChange">

Properties

about?

optional about: string

Inherited from

Omit.about


accessKey?

optional accessKey: string

Inherited from

Omit.accessKey


aria-activedescendant?

optional aria-activedescendant: string

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

Inherited from

Omit.aria-activedescendant


aria-atomic?

optional 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.

Inherited from

Omit.aria-atomic


aria-autocomplete?

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

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.

Inherited from

Omit.aria-autocomplete


aria-braillelabel?

optional aria-braillelabel: string

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

See

aria-label.

Inherited from

Omit.aria-braillelabel


aria-brailleroledescription?

optional 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.

Inherited from

Omit.aria-brailleroledescription


aria-busy?

optional aria-busy: Booleanish

Inherited from

Omit.aria-busy


aria-checked?

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

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

See

  • aria-pressed
  • aria-selected.

Inherited from

Omit.aria-checked


aria-colcount?

optional aria-colcount: number

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

See

aria-colindex.

Inherited from

Omit.aria-colcount


aria-colindex?

optional 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.

Inherited from

Omit.aria-colindex


aria-colindextext?

optional aria-colindextext: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

Inherited from

Omit.aria-colindextext


aria-colspan?

optional 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.

Inherited from

Omit.aria-colspan


aria-controls?

optional aria-controls: string

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

See

aria-owns.

Inherited from

Omit.aria-controls


aria-current?

optional aria-current: boolean | "date" | "time" | "true" | "false" | "page" | "step" | "location"

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

Inherited from

Omit.aria-current


aria-describedby?

optional aria-describedby: string

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

See

aria-labelledby

Inherited from

Omit.aria-describedby


aria-description?

optional aria-description: string

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

See

related aria-describedby.

Inherited from

Omit.aria-description


aria-details?

optional aria-details: string

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

See

aria-describedby.

Inherited from

Omit.aria-details


aria-disabled?

optional aria-disabled: Booleanish

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

See

  • aria-hidden
  • aria-readonly.

Inherited from

Omit.aria-disabled


aria-dropeffect?

optional aria-dropeffect: "link" | "none" | "copy" | "move" | "execute" | "popup"

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

Deprecated

in ARIA 1.1

Inherited from

Omit.aria-dropeffect


aria-errormessage?

optional aria-errormessage: string

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

See

  • aria-invalid
  • aria-describedby.

Inherited from

Omit.aria-errormessage


aria-expanded?

optional aria-expanded: Booleanish

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

Inherited from

Omit.aria-expanded


aria-flowto?

optional 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.

Inherited from

Omit.aria-flowto


aria-grabbed?

optional aria-grabbed: Booleanish

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

Deprecated

in ARIA 1.1

Inherited from

Omit.aria-grabbed


aria-haspopup?

optional aria-haspopup: boolean | "true" | "false" | "dialog" | "menu" | "grid" | "listbox" | "tree"

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

Inherited from

Omit.aria-haspopup


aria-hidden?

optional aria-hidden: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

Inherited from

Omit.aria-hidden


aria-invalid?

optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

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

See

aria-errormessage.

Inherited from

Omit.aria-invalid


aria-keyshortcuts?

optional aria-keyshortcuts: string

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

Inherited from

Omit.aria-keyshortcuts


aria-label?

optional aria-label: string

Defines a string value that labels the current element.

See

aria-labelledby.

Inherited from

Omit.aria-label


aria-labelledby?

optional aria-labelledby: string

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

See

aria-describedby.

Inherited from

Omit.aria-labelledby


aria-level?

optional aria-level: number

Defines the hierarchical level of an element within a structure.

Inherited from

Omit.aria-level


aria-live?

optional 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.

Inherited from

Omit.aria-live


aria-modal?

optional aria-modal: Booleanish

Indicates whether an element is modal when displayed.

Inherited from

Omit.aria-modal


aria-multiline?

optional aria-multiline: Booleanish

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

Inherited from

Omit.aria-multiline


aria-multiselectable?

optional aria-multiselectable: Booleanish

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

Inherited from

Omit.aria-multiselectable


aria-orientation?

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

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

Inherited from

Omit.aria-orientation


aria-owns?

optional 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.

Inherited from

Omit.aria-owns


aria-placeholder?

optional 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.

Inherited from

Omit.aria-placeholder


aria-posinset?

optional 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.

Inherited from

Omit.aria-posinset


aria-pressed?

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

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.

Inherited from

Omit.aria-pressed


aria-readonly?

optional aria-readonly: Booleanish

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

See

aria-disabled.

Inherited from

Omit.aria-readonly


aria-relevant?

optional aria-relevant: "text" | "all" | "additions" | "additions removals" | "additions text" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

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

See

aria-atomic.

Inherited from

Omit.aria-relevant


aria-required?

optional aria-required: Booleanish

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

Inherited from

Omit.aria-required


aria-roledescription?

optional aria-roledescription: string

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

Inherited from

Omit.aria-roledescription


aria-rowcount?

optional aria-rowcount: number

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

See

aria-rowindex.

Inherited from

Omit.aria-rowcount


aria-rowindex?

optional 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.

Inherited from

Omit.aria-rowindex


aria-rowindextext?

optional aria-rowindextext: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

Inherited from

Omit.aria-rowindextext


aria-rowspan?

optional 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.

Inherited from

Omit.aria-rowspan


aria-selected?

optional aria-selected: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.

Inherited from

Omit.aria-selected


aria-setsize?

optional 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.

Inherited from

Omit.aria-setsize


aria-sort?

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

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

Inherited from

Omit.aria-sort


aria-valuemax?

optional aria-valuemax: number

Defines the maximum allowed value for a range widget.

Inherited from

Omit.aria-valuemax


aria-valuemin?

optional aria-valuemin: number

Defines the minimum allowed value for a range widget.

Inherited from

Omit.aria-valuemin


aria-valuenow?

optional aria-valuenow: number

Defines the current value for a range widget.

See

aria-valuetext.

Inherited from

Omit.aria-valuenow


aria-valuetext?

optional aria-valuetext: string

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

Inherited from

Omit.aria-valuetext


autoCapitalize?

optional autoCapitalize: "none" | string & object | "off" | "on" | "sentences" | "words" | "characters"

Inherited from

Omit.autoCapitalize


autoComplete?

optional 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.

Inherited from

Omit.autoComplete


autoCorrect?

optional autoCorrect: string

Inherited from

Omit.autoCorrect


autoFocus?

optional autoFocus: boolean

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

Inherited from

Omit.autoFocus


autoSave?

optional autoSave: string

Inherited from

Omit.autoSave


autoWidth?

optional autoWidth: boolean

If true, the width of the popover will automatically be set according to the items inside the menu, otherwise it will be at least the width of the select input.

Default

false

Inherited from

Omit.autoWidth


children?

optional children: ReactNode

The option elements to populate the select with. Can be some MenuItem when native is false and option when native is true.

⚠️The MenuItem elements must be direct descendants when native is false.

Inherited from

Omit.children


classes?

optional classes: Partial<SelectClasses>

Override or extend the styles applied to the component.

Default

{}

Inherited from

Omit.classes


className?

optional className: string

Inherited from

Omit.className


color?

optional color: OverridableStringUnion<"error" | "success" | "primary" | "secondary" | "warning" | "info", InputBasePropsColorOverrides>

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide. The prop defaults to the value ('primary') inherited from the parent FormControl component.

Inherited from

Omit.color


components?

optional components: object

The components used for each slot inside.

Input?

optional Input: ElementType<any, keyof IntrinsicElements>

Root?

optional Root: ElementType<any, keyof IntrinsicElements>

Deprecated

use the slots prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.

Default

{}

Inherited from

Omit.components


componentsProps?

optional componentsProps: object

The extra props for the slot components. You can override the existing props or add new ones.

input?

optional input: InputHTMLAttributes<HTMLInputElement> & InputBaseComponentsPropsOverrides

root?

optional root: HTMLAttributes<HTMLDivElement> & InputBaseComponentsPropsOverrides

Deprecated

use the slotProps prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.

Default

{}

Inherited from

Omit.componentsProps


content?

optional content: string

Inherited from

Omit.content


contentEditable?

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

Inherited from

Omit.contentEditable


contextMenu?

optional contextMenu: string

Inherited from

Omit.contextMenu


dangerouslySetInnerHTML?

optional dangerouslySetInnerHTML: object

__html

__html: string | TrustedHTML

Inherited from

Omit.dangerouslySetInnerHTML


datatype?

optional datatype: string

Inherited from

Omit.datatype


defaultChecked?

optional defaultChecked: boolean

Inherited from

Omit.defaultChecked


defaultOpen?

optional defaultOpen: boolean

If true, the component is initially open. Use when the component open state is not controlled (i.e. the open prop is not defined). You can only use it when the native prop is false (default).

Default

false

Inherited from

Omit.defaultOpen


defaultValue?

optional defaultValue: string

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

Inherited from

Omit.defaultValue


dir?

optional dir: string

Inherited from

Omit.dir


disabled?

optional disabled: boolean

If true, the component is disabled. The prop defaults to the value (false) inherited from the parent FormControl component.

Inherited from

Omit.disabled


disableInjectingGlobalStyles?

optional disableInjectingGlobalStyles: boolean

If true, GlobalStyles for the auto-fill keyframes will not be injected/removed on mount/unmount. Make sure to inject them at the top of your application. This option is intended to help with boosting the initial rendering performance if you are loading a big amount of Input components at once.

Default

false

Inherited from

Omit.disableInjectingGlobalStyles


disableUnderline?

optional disableUnderline: boolean

If true, the input will not have an underline.

Default

false

Inherited from

Omit.disableUnderline


displayEmpty?

optional displayEmpty: boolean

If true, a value is displayed even if no items are selected.

In order to display a meaningful value, a function can be passed to the renderValue prop which returns the value to be displayed when no items are selected.

⚠️ When using this prop, make sure the label doesn't overlap with the empty displayed value. The label should either be hidden or forced to a shrunk state.

Default

false

Inherited from

Omit.displayEmpty


draggable?

optional draggable: Booleanish

Inherited from

Omit.draggable


endAdornment?

optional endAdornment: ReactNode

End InputAdornment for this component.

Inherited from

Omit.endAdornment


enterKeyHint?

optional enterKeyHint: "search" | "done" | "enter" | "go" | "next" | "previous" | "send"

Inherited from

Omit.enterKeyHint


error?

optional error: boolean

If true, the input will indicate an error. The prop defaults to the value (false) inherited from the parent FormControl component.

Inherited from

Omit.error


exportparts?

optional exportparts: string

See

https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts

Inherited from

Omit.exportparts


fullWidth?

optional fullWidth: boolean

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

Default

false

Inherited from

Omit.fullWidth


hidden?

optional hidden: boolean

Inherited from

Omit.hidden


IconComponent?

optional IconComponent: ElementType<any, keyof IntrinsicElements>

The icon that displays the arrow.

Default

ArrowDropDownIcon

Inherited from

Omit.IconComponent


id?

optional id: string

The id of the wrapper element or the select element when native.

Inherited from

Omit.id


inert?

optional inert: boolean

See

https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert

Inherited from

Omit.inert


inlist?

optional inlist: any

Inherited from

Omit.inlist


input?

optional input: ReactElement<unknown, any>

An Input element; does not have to be a material-ui specific Input.

Inherited from

Omit.input


inputComponent?

optional inputComponent: ElementType<InputBaseComponentProps, keyof IntrinsicElements>

The component used for the input element. Either a string to use a HTML element or a component.

Default

'input'

Inherited from

Omit.inputComponent


inputMode?

optional inputMode: "search" | "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

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

Inherited from

Omit.inputMode


inputProps?

optional inputProps: InputBaseComponentProps

Attributes applied to the input element. When native is true, the attributes are applied on the select element.

Inherited from

Omit.inputProps


inputRef?

optional inputRef: Ref<any>

Pass a ref to the input element.

Inherited from

Omit.inputRef


is?

optional 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

Inherited from

Omit.is


itemID?

optional itemID: string

Inherited from

Omit.itemID


itemProp?

optional itemProp: string

Inherited from

Omit.itemProp


itemRef?

optional itemRef: string

Inherited from

Omit.itemRef


items?

optional items: LabeledValue[]

The select items.


itemScope?

optional itemScope: boolean

Inherited from

Omit.itemScope


itemType?

optional itemType: string

Inherited from

Omit.itemType


label?

optional label: ReactNode

See OutlinedInput#label

Inherited from

Omit.label


labelId?

optional labelId: string

The ID of an element that acts as an additional label. The Select will be labelled by the additional label and the selected value.

Inherited from

Omit.labelId


lang?

optional lang: string

Inherited from

Omit.lang


margin?

optional margin: "none" | "dense"

If dense, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value ('none') inherited from the parent FormControl component.

Inherited from

Omit.margin


maxRows?

optional maxRows: string | number

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

Inherited from

Omit.maxRows


optional MenuProps: Partial<MenuProps>

Props applied to the Menu element.

Inherited from

Omit.MenuProps


minRows?

optional minRows: string | number

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

Inherited from

Omit.minRows


multiline?

optional multiline: boolean

If true, a TextareaAutosize element is rendered.

Default

false

Inherited from

Omit.multiline


multiple?

optional multiple: boolean

If true, value must be an array and the menu will support multiple selections.

Default

false

Inherited from

Omit.multiple


name?

optional name: string

Name attribute of the input element.

Inherited from

Omit.name


native?

optional native: boolean

If true, the component uses a native select element.

Default

false

Inherited from

Omit.native


nonce?

optional nonce: string

Inherited from

Omit.nonce


onAbort?

optional onAbort: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onAbort


onAbortCapture?

optional onAbortCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onAbortCapture


onAnimationEnd?

optional onAnimationEnd: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationEnd


onAnimationEndCapture?

optional onAnimationEndCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationEndCapture


onAnimationIteration?

optional onAnimationIteration: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationIteration


onAnimationIterationCapture?

optional onAnimationIterationCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationIterationCapture


onAnimationStart?

optional onAnimationStart: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationStart


onAnimationStartCapture?

optional onAnimationStartCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

Omit.onAnimationStartCapture


onAuxClick?

optional onAuxClick: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onAuxClick


onAuxClickCapture?

optional onAuxClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onAuxClickCapture


onBeforeInput?

optional onBeforeInput: InputEventHandler<HTMLDivElement>

Inherited from

Omit.onBeforeInput


onBeforeInputCapture?

optional onBeforeInputCapture: FormEventHandler<HTMLDivElement>

Inherited from

Omit.onBeforeInputCapture


onBeforeToggle?

optional onBeforeToggle: ToggleEventHandler<HTMLDivElement>

Inherited from

Omit.onBeforeToggle


onBlur?

optional onBlur: FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>

Callback fired when the input is blurred.

Notice that the first argument (event) might be undefined.

Inherited from

Omit.onBlur


onBlurCapture?

optional onBlurCapture: FocusEventHandler<HTMLDivElement>

Inherited from

Omit.onBlurCapture


onCanPlay?

optional onCanPlay: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onCanPlay


onCanPlayCapture?

optional onCanPlayCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onCanPlayCapture


onCanPlayThrough?

optional onCanPlayThrough: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onCanPlayThrough


onCanPlayThroughCapture?

optional onCanPlayThroughCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onCanPlayThroughCapture


onChangeCapture?

optional onChangeCapture: FormEventHandler<HTMLDivElement>

Inherited from

Omit.onChangeCapture


onClick?

optional onClick: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onClick


onClickCapture?

optional onClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onClickCapture


onClose()?

optional onClose: (event) => void

Callback fired when the component requests to be closed. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select collapses).

Parameters

event

SyntheticEvent

The event source of the callback.

Returns

void

Inherited from

Omit.onClose


onCompositionEnd?

optional onCompositionEnd: CompositionEventHandler<HTMLDivElement>

Inherited from

Omit.onCompositionEnd


onCompositionEndCapture?

optional onCompositionEndCapture: CompositionEventHandler<HTMLDivElement>

Inherited from

Omit.onCompositionEndCapture


onCompositionStart?

optional onCompositionStart: CompositionEventHandler<HTMLDivElement>

Inherited from

Omit.onCompositionStart


onCompositionStartCapture?

optional onCompositionStartCapture: CompositionEventHandler<HTMLDivElement>

Inherited from

Omit.onCompositionStartCapture


onCompositionUpdate?

optional onCompositionUpdate: CompositionEventHandler<HTMLDivElement>

Inherited from

Omit.onCompositionUpdate


onCompositionUpdateCapture?

optional onCompositionUpdateCapture: CompositionEventHandler<HTMLDivElement>

Inherited from

Omit.onCompositionUpdateCapture


onContextMenu?

optional onContextMenu: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onContextMenu


onContextMenuCapture?

optional onContextMenuCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onContextMenuCapture


onCopy?

optional onCopy: ClipboardEventHandler<HTMLDivElement>

Inherited from

Omit.onCopy


onCopyCapture?

optional onCopyCapture: ClipboardEventHandler<HTMLDivElement>

Inherited from

Omit.onCopyCapture


onCut?

optional onCut: ClipboardEventHandler<HTMLDivElement>

Inherited from

Omit.onCut


onCutCapture?

optional onCutCapture: ClipboardEventHandler<HTMLDivElement>

Inherited from

Omit.onCutCapture


onDoubleClick?

optional onDoubleClick: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onDoubleClick


onDoubleClickCapture?

optional onDoubleClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onDoubleClickCapture


onDrag?

optional onDrag: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDrag


onDragCapture?

optional onDragCapture: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragCapture


onDragEnd?

optional onDragEnd: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragEnd


onDragEndCapture?

optional onDragEndCapture: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragEndCapture


onDragEnter?

optional onDragEnter: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragEnter


onDragEnterCapture?

optional onDragEnterCapture: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragEnterCapture


onDragExit?

optional onDragExit: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragExit


onDragExitCapture?

optional onDragExitCapture: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragExitCapture


onDragLeave?

optional onDragLeave: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragLeave


onDragLeaveCapture?

optional onDragLeaveCapture: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragLeaveCapture


onDragOver?

optional onDragOver: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragOver


onDragOverCapture?

optional onDragOverCapture: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragOverCapture


onDragStart?

optional onDragStart: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragStart


onDragStartCapture?

optional onDragStartCapture: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDragStartCapture


onDrop?

optional onDrop: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDrop


onDropCapture?

optional onDropCapture: DragEventHandler<HTMLDivElement>

Inherited from

Omit.onDropCapture


onDurationChange?

optional onDurationChange: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onDurationChange


onDurationChangeCapture?

optional onDurationChangeCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onDurationChangeCapture


onEmptied?

optional onEmptied: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onEmptied


onEmptiedCapture?

optional onEmptiedCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onEmptiedCapture


onEncrypted?

optional onEncrypted: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onEncrypted


onEncryptedCapture?

optional onEncryptedCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onEncryptedCapture


onEnded?

optional onEnded: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onEnded


onEndedCapture?

optional onEndedCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onEndedCapture


onError?

optional onError: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onError


onErrorCapture?

optional onErrorCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onErrorCapture


onFocus?

optional onFocus: FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>

Inherited from

Omit.onFocus


onFocusCapture?

optional onFocusCapture: FocusEventHandler<HTMLDivElement>

Inherited from

Omit.onFocusCapture


onGotPointerCapture?

optional onGotPointerCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onGotPointerCapture


onGotPointerCaptureCapture?

optional onGotPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onGotPointerCaptureCapture


onInput?

optional onInput: FormEventHandler<HTMLDivElement>

Inherited from

Omit.onInput


onInputCapture?

optional onInputCapture: FormEventHandler<HTMLDivElement>

Inherited from

Omit.onInputCapture


onInvalid?

optional onInvalid: FormEventHandler<HTMLInputElement | HTMLTextAreaElement>

Callback fired when the input doesn't satisfy its constraints.

Inherited from

Omit.onInvalid


onInvalidCapture?

optional onInvalidCapture: FormEventHandler<HTMLDivElement>

Inherited from

Omit.onInvalidCapture


onKeyDown?

optional onKeyDown: KeyboardEventHandler<HTMLInputElement | HTMLTextAreaElement>

Inherited from

Omit.onKeyDown


onKeyDownCapture?

optional onKeyDownCapture: KeyboardEventHandler<HTMLDivElement>

Inherited from

Omit.onKeyDownCapture


onKeyPress?

optional onKeyPress: KeyboardEventHandler<HTMLDivElement>

Deprecated

Use onKeyUp or onKeyDown instead

Inherited from

Omit.onKeyPress


onKeyPressCapture?

optional onKeyPressCapture: KeyboardEventHandler<HTMLDivElement>

Deprecated

Use onKeyUpCapture or onKeyDownCapture instead

Inherited from

Omit.onKeyPressCapture


onKeyUp?

optional onKeyUp: KeyboardEventHandler<HTMLInputElement | HTMLTextAreaElement>

Inherited from

Omit.onKeyUp


onKeyUpCapture?

optional onKeyUpCapture: KeyboardEventHandler<HTMLDivElement>

Inherited from

Omit.onKeyUpCapture


onLoad?

optional onLoad: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onLoad


onLoadCapture?

optional onLoadCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onLoadCapture


onLoadedData?

optional onLoadedData: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onLoadedData


onLoadedDataCapture?

optional onLoadedDataCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onLoadedDataCapture


onLoadedMetadata?

optional onLoadedMetadata: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onLoadedMetadata


onLoadedMetadataCapture?

optional onLoadedMetadataCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onLoadedMetadataCapture


onLoadStart?

optional onLoadStart: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onLoadStart


onLoadStartCapture?

optional onLoadStartCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onLoadStartCapture


onLostPointerCapture?

optional onLostPointerCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onLostPointerCapture


onLostPointerCaptureCapture?

optional onLostPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onLostPointerCaptureCapture


onMouseDown?

optional onMouseDown: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseDown


onMouseDownCapture?

optional onMouseDownCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseDownCapture


onMouseEnter?

optional onMouseEnter: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseEnter


onMouseLeave?

optional onMouseLeave: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseLeave


onMouseMove?

optional onMouseMove: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseMove


onMouseMoveCapture?

optional onMouseMoveCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseMoveCapture


onMouseOut?

optional onMouseOut: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseOut


onMouseOutCapture?

optional onMouseOutCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseOutCapture


onMouseOver?

optional onMouseOver: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseOver


onMouseOverCapture?

optional onMouseOverCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseOverCapture


onMouseUp?

optional onMouseUp: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseUp


onMouseUpCapture?

optional onMouseUpCapture: MouseEventHandler<HTMLDivElement>

Inherited from

Omit.onMouseUpCapture


onOpen()?

optional onOpen: (event) => void

Callback fired when the component requests to be opened. Use it in either controlled (see the open prop), or uncontrolled mode (to detect when the Select expands).

Parameters

event

SyntheticEvent

The event source of the callback.

Returns

void

Inherited from

Omit.onOpen


onPaste?

optional onPaste: ClipboardEventHandler<HTMLDivElement>

Inherited from

Omit.onPaste


onPasteCapture?

optional onPasteCapture: ClipboardEventHandler<HTMLDivElement>

Inherited from

Omit.onPasteCapture


onPause?

optional onPause: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onPause


onPauseCapture?

optional onPauseCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onPauseCapture


onPlay?

optional onPlay: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onPlay


onPlayCapture?

optional onPlayCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onPlayCapture


onPlaying?

optional onPlaying: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onPlaying


onPlayingCapture?

optional onPlayingCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onPlayingCapture


onPointerCancel?

optional onPointerCancel: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerCancel


onPointerCancelCapture?

optional onPointerCancelCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerCancelCapture


onPointerDown?

optional onPointerDown: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerDown


onPointerDownCapture?

optional onPointerDownCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerDownCapture


onPointerEnter?

optional onPointerEnter: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerEnter


onPointerLeave?

optional onPointerLeave: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerLeave


onPointerMove?

optional onPointerMove: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerMove


onPointerMoveCapture?

optional onPointerMoveCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerMoveCapture


onPointerOut?

optional onPointerOut: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerOut


onPointerOutCapture?

optional onPointerOutCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerOutCapture


onPointerOver?

optional onPointerOver: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerOver


onPointerOverCapture?

optional onPointerOverCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerOverCapture


onPointerUp?

optional onPointerUp: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerUp


onPointerUpCapture?

optional onPointerUpCapture: PointerEventHandler<HTMLDivElement>

Inherited from

Omit.onPointerUpCapture


onProgress?

optional onProgress: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onProgress


onProgressCapture?

optional onProgressCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onProgressCapture


onRateChange?

optional onRateChange: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onRateChange


onRateChangeCapture?

optional onRateChangeCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onRateChangeCapture


onReset?

optional onReset: FormEventHandler<HTMLDivElement>

Inherited from

Omit.onReset


onResetCapture?

optional onResetCapture: FormEventHandler<HTMLDivElement>

Inherited from

Omit.onResetCapture


onScroll?

optional onScroll: UIEventHandler<HTMLDivElement>

Inherited from

Omit.onScroll


onScrollCapture?

optional onScrollCapture: UIEventHandler<HTMLDivElement>

Inherited from

Omit.onScrollCapture


onScrollEnd?

optional onScrollEnd: UIEventHandler<HTMLDivElement>

Inherited from

Omit.onScrollEnd


onScrollEndCapture?

optional onScrollEndCapture: UIEventHandler<HTMLDivElement>

Inherited from

Omit.onScrollEndCapture


onSeeked?

optional onSeeked: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onSeeked


onSeekedCapture?

optional onSeekedCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onSeekedCapture


onSeeking?

optional onSeeking: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onSeeking


onSeekingCapture?

optional onSeekingCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onSeekingCapture


onSelect?

optional onSelect: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onSelect


onSelectCapture?

optional onSelectCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onSelectCapture


onStalled?

optional onStalled: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onStalled


onStalledCapture?

optional onStalledCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onStalledCapture


onSubmit?

optional onSubmit: FormEventHandler<HTMLDivElement>

Inherited from

Omit.onSubmit


onSubmitCapture?

optional onSubmitCapture: FormEventHandler<HTMLDivElement>

Inherited from

Omit.onSubmitCapture


onSuspend?

optional onSuspend: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onSuspend


onSuspendCapture?

optional onSuspendCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onSuspendCapture


onTimeUpdate?

optional onTimeUpdate: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onTimeUpdate


onTimeUpdateCapture?

optional onTimeUpdateCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onTimeUpdateCapture


onToggle?

optional onToggle: ToggleEventHandler<HTMLDivElement>

Inherited from

Omit.onToggle


onTouchCancel?

optional onTouchCancel: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchCancel


onTouchCancelCapture?

optional onTouchCancelCapture: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchCancelCapture


onTouchEnd?

optional onTouchEnd: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchEnd


onTouchEndCapture?

optional onTouchEndCapture: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchEndCapture


onTouchMove?

optional onTouchMove: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchMove


onTouchMoveCapture?

optional onTouchMoveCapture: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchMoveCapture


onTouchStart?

optional onTouchStart: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchStart


onTouchStartCapture?

optional onTouchStartCapture: TouchEventHandler<HTMLDivElement>

Inherited from

Omit.onTouchStartCapture


onTransitionCancel?

optional onTransitionCancel: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionCancel


onTransitionCancelCapture?

optional onTransitionCancelCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionCancelCapture


onTransitionEnd?

optional onTransitionEnd: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionEnd


onTransitionEndCapture?

optional onTransitionEndCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionEndCapture


onTransitionRun?

optional onTransitionRun: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionRun


onTransitionRunCapture?

optional onTransitionRunCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionRunCapture


onTransitionStart?

optional onTransitionStart: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionStart


onTransitionStartCapture?

optional onTransitionStartCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

Omit.onTransitionStartCapture


onVolumeChange?

optional onVolumeChange: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onVolumeChange


onVolumeChangeCapture?

optional onVolumeChangeCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onVolumeChangeCapture


onWaiting?

optional onWaiting: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onWaiting


onWaitingCapture?

optional onWaitingCapture: ReactEventHandler<HTMLDivElement>

Inherited from

Omit.onWaitingCapture


onWheel?

optional onWheel: WheelEventHandler<HTMLDivElement>

Inherited from

Omit.onWheel


onWheelCapture?

optional onWheelCapture: WheelEventHandler<HTMLDivElement>

Inherited from

Omit.onWheelCapture


open?

optional open: boolean

If true, the component is shown. You can only use it when the native prop is false (default).

Inherited from

Omit.open


part?

optional part: string

See

https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part

Inherited from

Omit.part


popover?

optional popover: "" | "hint" | "auto" | "manual"

Inherited from

Omit.popover


popoverTarget?

optional popoverTarget: string

Inherited from

Omit.popoverTarget


popoverTargetAction?

optional popoverTargetAction: "toggle" | "show" | "hide"

Inherited from

Omit.popoverTargetAction


prefix?

optional prefix: string

Inherited from

Omit.prefix


property?

optional property: string

Inherited from

Omit.property


radioGroup?

optional radioGroup: string

Inherited from

Omit.radioGroup


readOnly?

optional readOnly: boolean

It prevents the user from changing the value of the field (not from interacting with the field).

Inherited from

Omit.readOnly


ref?

optional ref: null | (instance) => void | () => VoidOrUndefinedOnly | RefObject<unknown>

Inherited from

Omit.ref


rel?

optional rel: string

Inherited from

Omit.rel


renderSuffix()?

optional renderSuffix: (state) => ReactNode

Parameters

state
disabled?

boolean

error?

boolean

filled?

boolean

focused?

boolean

margin?

"none" | "normal" | "dense"

required?

boolean

startAdornment?

ReactNode

Returns

ReactNode

Inherited from

Omit.renderSuffix


renderValue()?

optional renderValue: (value) => ReactNode

Render the selected value. You can only use it when the native prop is false (default).

Parameters

value

string

The value provided to the component.

Returns

ReactNode

Inherited from

Omit.renderValue


required?

optional required: boolean

If true, the input element is required. The prop defaults to the value (false) inherited from the parent FormControl component.

Inherited from

Omit.required


resource?

optional resource: string

Inherited from

Omit.resource


results?

optional results: number

Inherited from

Omit.results


rev?

optional rev: string

Inherited from

Omit.rev


role?

optional role: AriaRole

Inherited from

Omit.role


rows?

optional rows: string | number

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

Inherited from

Omit.rows


security?

optional security: string

Inherited from

Omit.security


SelectDisplayProps?

optional SelectDisplayProps: HTMLAttributes<HTMLDivElement>

Props applied to the clickable div element.

Inherited from

Omit.SelectDisplayProps


size?

optional size: OverridableStringUnion<"small" | "medium", InputBasePropsSizeOverrides>

The size of the component.

Inherited from

Omit.size


slot?

optional slot: string

Inherited from

Omit.slot


slotProps?

optional slotProps: { input?: InputHTMLAttributes<HTMLInputElement> & InputBaseComponentsPropsOverrides & object; root?: HTMLAttributes<HTMLDivElement> & InputBaseComponentsPropsOverrides & object; } | object & object

The extra props for the slot components. You can override the existing props or add new ones.

This prop is an alias for the componentsProps prop, which will be deprecated in the future.

Default

{}

Inherited from

Omit.slotProps


slots?

optional slots: { input?: ElementType<any, keyof IntrinsicElements>; root?: ElementType<any, keyof IntrinsicElements>; } | Partial<OutlinedInputSlots> & object

The components used for each slot inside.

This prop is an alias for the components prop, which will be deprecated in the future.

Default

{}

Inherited from

Omit.slots


spellCheck?

optional spellCheck: Booleanish

Inherited from

Omit.spellCheck


startAdornment?

optional startAdornment: ReactNode

Start InputAdornment for this component.

Inherited from

Omit.startAdornment


style?

optional style: CSSProperties

Inherited from

Omit.style


suppressContentEditableWarning?

optional suppressContentEditableWarning: boolean

Inherited from

Omit.suppressContentEditableWarning


suppressHydrationWarning?

optional suppressHydrationWarning: boolean

Inherited from

Omit.suppressHydrationWarning


sx?

optional sx: SxProps<Theme>

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

Inherited from

Omit.sx


tabIndex?

optional tabIndex: number

Inherited from

Omit.tabIndex


title?

optional title: string

Inherited from

Omit.title


translate?

optional translate: "yes" | "no"

Inherited from

Omit.translate


type?

optional type: string

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

Default

'text'

Inherited from

Omit.type


typeof?

optional typeof: string

Inherited from

Omit.typeof


unselectable?

optional unselectable: "off" | "on"

Inherited from

Omit.unselectable


value?

optional value: string

The select value.

Overrides

Omit.value


variant?

optional variant: "filled" | "outlined" | "standard"

The variant to use.

Default

'outlined'

Inherited from

Omit.variant


vocab?

optional vocab: string

Inherited from

Omit.vocab

Stay in the know
Quickly Build Drag-and-Drop Forms
Star us on GitHub