OptionalaboutOptionalaccessOptionalactionAn HTML element, or a function that returns one. It's used to set the position of the menu.
OptionalanchorThis is the point on the anchor where the popover's
anchorEl will attach to. This is not used when the
anchorReference is 'anchorPosition'.
Options: vertical: [top, center, bottom]; horizontal: [left, center, right].
OptionalanchorThis is the position that may be used to set the position of the popover. The coordinates are relative to the application's client area.
OptionalanchorThis determines which anchor prop to refer to when setting the position of the popover.
Optionalaria-Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optionalaria-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.
Optionalaria-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.
Optionalaria-Defines a string value that labels the current element, which is intended to be converted into Braille.
Optionalaria-Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
Optionalaria-Optionalaria-Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
Optionalaria-Defines the total number of columns in a table, grid, or treegrid.
Optionalaria-Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-colindex.
Optionalaria-Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Identifies the element (or elements) whose contents or presence are controlled by the current element.
Optionalaria-Indicates the element that represents the current item within a container or set of related elements.
Optionalaria-Identifies the element (or elements) that describes the object.
Optionalaria-Defines a string value that describes or annotates the current element.
Optionalaria-Identifies the element that provides a detailed, extended description for the object.
Optionalaria-Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Optionalaria-Indicates what functions can be performed when a dragged object is released on the drop target.
Optionalaria-Identifies the element that provides an error message for the object.
Optionalaria-Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optionalaria-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.
Optionalaria-Indicates an element's "grabbed" state in a drag-and-drop operation.
Optionalaria-Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Optionalaria-Indicates whether the element is exposed to an accessibility API.
Optionalaria-Indicates the entered value does not conform to the format expected by the application.
Optionalaria-Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optionalaria-Defines a string value that labels the current element.
Optionalaria-Identifies the element (or elements) that labels the current element.
Optionalaria-Defines the hierarchical level of an element within a structure.
Optionalaria-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.
Optionalaria-Indicates whether an element is modal when displayed.
Optionalaria-Indicates whether a text box accepts multiple lines of input or only a single line.
Optionalaria-Indicates that the user may select more than one item from the current selectable descendants.
Optionalaria-Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optionalaria-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.
Optionalaria-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.
Optionalaria-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.
Optionalaria-Indicates the current "pressed" state of toggle buttons.
Optionalaria-Indicates that the element is not editable, but is otherwise operable.
Optionalaria-Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Optionalaria-Indicates that user input is required on the element before a form may be submitted.
Optionalaria-Defines a human-readable, author-localized description for the role of an element.
Optionalaria-Defines the total number of rows in a table, grid, or treegrid.
Optionalaria-Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-rowindex.
Optionalaria-Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Indicates the current "selected" state of various widgets.
Optionalaria-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.
Optionalaria-Indicates if items in a table or grid are sorted in ascending or descending order.
Optionalaria-Defines the maximum allowed value for a range widget.
Optionalaria-Defines the minimum allowed value for a range widget.
Optionalaria-Defines the current value for a range widget.
Optionalaria-Defines the human readable text alternative of aria-valuenow for a range widget.
OptionalautoOptionalautoOptionalautoIf true (Default) will focus the [role="menu"] if no focusable child is found. Disabled
children are not focusable. If you set this prop to false focus will be placed
on the parent modal container. This has severe accessibility implications
and should only be considered if you manage focus otherwise.
OptionalautoOptionalBackdropA backdrop component. This prop enables custom backdrop rendering.
Use slots.backdrop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalBackdropProps applied to the Backdrop element.
Use slotProps.backdrop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalchildrenMenu contents, normally MenuItems.
OptionalclassesOverride or extend the styles applied to the component.
OptionalcloseWhen set to true the Modal waits until a nested Transition is completed before closing.
OptionalcolorOptionalcomponentOptionalcomponentsThe components used for each slot inside.
Use the slots prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalcomponentsThe extra props for the slot components. You can override the existing props or add new ones.
Use the slotProps prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalcontainerAn HTML element, component instance, or function that returns either.
The container will passed to the Modal component.
By default, it uses the body of the anchorEl's top-level document object,
so it's simply document.body most of the time.
OptionalcontentOptionalcontentOptionalcontextOptionaldangerouslyOptionaldatatypeOptionaldefaultOptionaldefaultOptionaldirOptionaldisableIf true, the modal will not automatically shift focus to itself when it opens, and
replace it to the last focused element when it closes.
This also works correctly with any modal children that have the disableAutoFocus prop.
Generally this should never be set to true as it makes the modal less
accessible to assistive technologies, like screen readers.
OptionaldisableWhen opening the menu will not focus the active item but the [role="menu"]
unless autoFocus is also set to false. Not using the default means not
following WAI-ARIA authoring practices. Please be considerate about possible
accessibility implications.
OptionaldisableIf true, the modal will not prevent focus from leaving the modal while open.
Generally this should never be set to true as it makes the modal less
accessible to assistive technologies, like screen readers.
OptionaldisableIf true, hitting escape will not fire the onClose callback.
OptionaldisableThe children will be under the DOM hierarchy of the parent component.
OptionaldisableIf true, the modal will not restore focus to previously focused element once
modal is hidden or unmounted.
OptionaldisableDisable the scroll lock behavior.
OptionaldraggableOptionalelevationThe elevation of the popover.
OptionalenterOptionalexportpartsOptionalhiddenOptionalhideIf true, the backdrop is not rendered.
OptionalidOptionalinlistOptionalinputHints at the type of data that might be entered by the user while editing the element or its contents
OptionalisSpecify that a standard HTML element should behave like a defined custom built-in element
OptionalisOptionalitemOptionalitemOptionalitemOptionalitemOptionalitemOptionalkeepAlways keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.
OptionalkeyOptionallangOptionalmarginSpecifies how close to the edge of the window the popover can appear. If null, the popover will not be constrained by the window.
OptionalMenuProps applied to the MenuList element.
use the slotProps.list prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionalnonceOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonCallback fired when the component requests to be closed.
The event source of the callback.
Can be: "escapeKeyDown", "backdropClick", "tabKeyDown".
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonA function called when a transition enters.
OptionalonA function called when a transition has exited.
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalopenIf true, the component is shown.
OptionalPaperProps applied to the Paper element.
This prop is an alias for slotProps.paper and will be overridden by it if both are used.
OptionalpartOptionalPopoverclasses prop applied to the Popover element.
OptionalprefixOptionalpropertyOptionalradioOptionalrefOptionalrelOptionalresourceOptionalresultsOptionalrevOptionalroleOptionalsecurityOptionalslotOptionalslotThe props used for each slot inside.
Optionalbackdrop?: SlotProps<Props forwarded to the backdrop slot. By default, the available props are based on the Backdrop component.
Optionallist?: SlotProps<Props forwarded to the list slot. By default, the available props are based on the MenuList component.
Optionalpaper?: SlotProps<Props forwarded to the paper slot. By default, the available props are based on the Paper component.
Optionalroot?: SlotProps<Props forwarded to the root slot. By default, the available props are based on the Popover component.
Optionaltransition?: SlotComponentProps<Props forwarded to the transition slot. By default, the available props are based on the Grow component.
OptionalslotsThe components used for each slot inside.
OptionalspellOptionalstyleOptionalsuppressOptionalsuppressOptionalsxThe system prop that allows defining system overrides as well as additional CSS styles.
OptionaltabOptionaltitleOptionaltransformThis is the point on the popover which will attach to the anchor's origin.
Options: vertical: [top, center, bottom, x(px)]; horizontal: [left, center, right, x(px)].
OptionalTransitionThe component used for the transition. Follow this guide to learn more about the requirements for this component.
use the slots.transition prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionaltransitionThe length of the transition in ms, or 'auto'
OptionalTransitionProps applied to the transition element.
By default, the element is based on this Transition component.
use the slotProps.transition prop instead. This prop will be removed in a future major release. See Migrating from deprecated APIs for more details.
OptionaltranslateOptionaltypeofOptionalunselectableOptionalvariantThe variant to use. Use menu to prevent selected items from impacting the initial focus.
Optionalvocab
A ref for imperative actions. It currently only supports updatePosition() action.