Edit page

Menu

Base on Popup

Related component

  • MenuItem

Icon

Basic usage

import { Menu } from '@doopage/react-ui-kit'
const Example = () => {
return (
<Menu
label={'menu'}
options={[{id: '1', name: 'option1', onClick: () => {console.log('on click')}}]}
/>
);
}
export default Example;

Playground

Basic

Hover

menu

Context Menu

Right click to open menu

Properties

Option

Prop nameTypeDefaultRequiredDescription
closeOnClickboolean | undefinedfalse
onClick(item: MenuOptionProps, e?: any) => voidtrue
titlestring | undefinedfalse
disabledboolean | undefinedfalse
onChange((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
classesPartial<Record<MenuItemClassKey, string>> | undefinedfalse

Override or extend the styles applied to the component.

defaultCheckedboolean | undefinedfalse
defaultValuestring | number | readonly string[] | undefinedfalse
suppressContentEditableWarningboolean | undefinedfalse
suppressHydrationWarningboolean | undefinedfalse
accessKeystring | undefinedfalse
classNamestring | undefinedfalse
contentEditableboolean | "true" | "false" | "inherit" | undefinedfalse
contextMenustring | undefinedfalse
dirstring | undefinedfalse
draggableboolean | "true" | "false" | undefinedfalse
hiddenboolean | undefinedfalse
idstring | undefinedfalse
langstring | undefinedfalse
placeholderstring | undefinedfalse
slotstring | undefinedfalse
spellCheckboolean | "true" | "false" | undefinedfalse
styleCSSProperties | undefinedfalse
tabIndexnumber | undefinedfalse
translate"yes" | "no" | undefinedfalse
radioGroupstring | undefinedfalse
rolestring | undefinedfalse
aboutstring | undefinedfalse
datatypestring | undefinedfalse
inlistanyfalse
prefixstring | undefinedfalse
propertystring | undefinedfalse
resourcestring | undefinedfalse
typeofstring | undefinedfalse
vocabstring | undefinedfalse
autoCapitalizestring | undefinedfalse
autoCorrectstring | undefinedfalse
autoSavestring | undefinedfalse
colorstring | undefinedfalse
itemPropstring | undefinedfalse
itemScopeboolean | undefinedfalse
itemTypestring | undefinedfalse
itemIDstring | undefinedfalse
itemRefstring | undefinedfalse
resultsnumber | undefinedfalse
securitystring | undefinedfalse
unselectable"on" | "off" | undefinedfalse
inputMode"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefinedfalse

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

isstring | undefinedfalse

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

aria-activedescendantstring | undefinedfalse

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

aria-atomicboolean | "true" | "false" | undefinedfalse

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.

aria-autocomplete"none" | "inline" | "list" | "both" | undefinedfalse

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.

aria-busyboolean | "true" | "false" | undefinedfalse

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

aria-checkedboolean | "true" | "false" | "mixed" | undefinedfalse

Indicates the current “checked” state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected.

aria-colcountnumber | undefinedfalse

Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex.

aria-colindexnumber | undefinedfalse

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 @see aria-colspan.

aria-colspannumber | undefinedfalse

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan.

aria-controlsstring | undefinedfalse

Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns.

aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefinedfalse

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

aria-describedbystring | undefinedfalse

Identifies the element (or elements) that describes the object. @see aria-labelledby

aria-detailsstring | undefinedfalse

Identifies the element that provides a detailed, extended description for the object. @see aria-describedby.

aria-disabledboolean | "true" | "false" | undefinedfalse

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly.

aria-dropeffect"none" | "copy" | "execute" | "link" | "move" | "popup" | undefinedfalse

Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1

aria-errormessagestring | undefinedfalse

Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby.

aria-expandedboolean | "true" | "false" | undefinedfalse

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

aria-flowtostring | undefinedfalse

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.

aria-grabbedboolean | "true" | "false" | undefinedfalse

Indicates an element’s “grabbed” state in a drag-and-drop operation. @deprecated in ARIA 1.1

aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefinedfalse

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

aria-hiddenboolean | "true" | "false" | undefinedfalse

Indicates whether the element is exposed to an accessibility API. @see aria-disabled.

aria-invalidboolean | "true" | "false" | "grammar" | "spelling" | undefinedfalse

Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage.

aria-keyshortcutsstring | undefinedfalse

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

aria-labelstring | undefinedfalse

Defines a string value that labels the current element. @see aria-labelledby.

aria-labelledbystring | undefinedfalse

Identifies the element (or elements) that labels the current element. @see aria-describedby.

aria-levelnumber | undefinedfalse

Defines the hierarchical level of an element within a structure.

aria-live"off" | "assertive" | "polite" | undefinedfalse

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.

aria-modalboolean | "true" | "false" | undefinedfalse

Indicates whether an element is modal when displayed.

aria-multilineboolean | "true" | "false" | undefinedfalse

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

aria-multiselectableboolean | "true" | "false" | undefinedfalse

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

aria-orientation"horizontal" | "vertical" | undefinedfalse

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

aria-ownsstring | undefinedfalse

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.

aria-placeholderstring | undefinedfalse

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.

aria-posinsetnumber | undefinedfalse

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.

aria-pressedboolean | "true" | "false" | "mixed" | undefinedfalse

Indicates the current “pressed” state of toggle buttons. @see aria-checked @see aria-selected.

aria-readonlyboolean | "true" | "false" | undefinedfalse

Indicates that the element is not editable, but is otherwise operable. @see aria-disabled.

aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefinedfalse

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic.

aria-requiredboolean | "true" | "false" | undefinedfalse

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

aria-roledescriptionstring | undefinedfalse

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

aria-rowcountnumber | undefinedfalse

Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex.

aria-rowindexnumber | undefinedfalse

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 @see aria-rowspan.

aria-rowspannumber | undefinedfalse

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan.

aria-selectedboolean | "true" | "false" | undefinedfalse

Indicates the current “selected” state of various widgets. @see aria-checked @see aria-pressed.

aria-setsizenumber | undefinedfalse

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.

aria-sort"none" | "ascending" | "descending" | "other" | undefinedfalse

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

aria-valuemaxnumber | undefinedfalse

Defines the maximum allowed value for a range widget.

aria-valueminnumber | undefinedfalse

Defines the minimum allowed value for a range widget.

aria-valuenownumber | undefinedfalse

Defines the current value for a range widget. @see aria-valuetext.

aria-valuetextstring | undefinedfalse

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

dangerouslySetInnerHTML{ __html: string; } | undefinedfalse
onCopy((event: ClipboardEvent<HTMLLIElement>) => void) | undefinedfalse
onCopyCapture((event: ClipboardEvent<HTMLLIElement>) => void) | undefinedfalse
onCut((event: ClipboardEvent<HTMLLIElement>) => void) | undefinedfalse
onCutCapture((event: ClipboardEvent<HTMLLIElement>) => void) | undefinedfalse
onPaste((event: ClipboardEvent<HTMLLIElement>) => void) | undefinedfalse
onPasteCapture((event: ClipboardEvent<HTMLLIElement>) => void) | undefinedfalse
onCompositionEnd((event: CompositionEvent<HTMLLIElement>) => void) | undefinedfalse
onCompositionEndCapture((event: CompositionEvent<HTMLLIElement>) => void) | undefinedfalse
onCompositionStart((event: CompositionEvent<HTMLLIElement>) => void) | undefinedfalse
onCompositionStartCapture((event: CompositionEvent<HTMLLIElement>) => void) | undefinedfalse
onCompositionUpdate((event: CompositionEvent<HTMLLIElement>) => void) | undefinedfalse
onCompositionUpdateCapture((event: CompositionEvent<HTMLLIElement>) => void) | undefinedfalse
onFocus((event: FocusEvent<HTMLLIElement>) => void) | undefinedfalse
onFocusCapture((event: FocusEvent<HTMLLIElement>) => void) | undefinedfalse
onBlur((event: FocusEvent<HTMLLIElement>) => void) | undefinedfalse
onBlurCapture((event: FocusEvent<HTMLLIElement>) => void) | undefinedfalse
onChangeCapture((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onBeforeInput((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onBeforeInputCapture((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onInput((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onInputCapture((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onReset((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onResetCapture((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onSubmit((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onSubmitCapture((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onInvalid((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onInvalidCapture((event: FormEvent<HTMLLIElement>) => void) | undefinedfalse
onLoad((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onLoadCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onError((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onErrorCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onKeyDown((event: KeyboardEvent<HTMLLIElement>) => void) | undefinedfalse
onKeyDownCapture((event: KeyboardEvent<HTMLLIElement>) => void) | undefinedfalse
onKeyPress((event: KeyboardEvent<HTMLLIElement>) => void) | undefinedfalse
onKeyPressCapture((event: KeyboardEvent<HTMLLIElement>) => void) | undefinedfalse
onKeyUp((event: KeyboardEvent<HTMLLIElement>) => void) | undefinedfalse
onKeyUpCapture((event: KeyboardEvent<HTMLLIElement>) => void) | undefinedfalse
onAbort((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onAbortCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onCanPlay((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onCanPlayCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onCanPlayThrough((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onCanPlayThroughCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onDurationChange((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onDurationChangeCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onEmptied((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onEmptiedCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onEncrypted((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onEncryptedCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onEnded((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onEndedCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onLoadedData((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onLoadedDataCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onLoadedMetadata((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onLoadedMetadataCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onLoadStart((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onLoadStartCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onPause((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onPauseCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onPlay((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onPlayCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onPlaying((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onPlayingCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onProgress((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onProgressCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onRateChange((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onRateChangeCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onSeeked((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onSeekedCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onSeeking((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onSeekingCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onStalled((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onStalledCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onSuspend((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onSuspendCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onTimeUpdate((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onTimeUpdateCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onVolumeChange((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onVolumeChangeCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onWaiting((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onWaitingCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onAuxClick((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onAuxClickCapture((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onClickCapture((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onContextMenu((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onContextMenuCapture((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onDoubleClick((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onDoubleClickCapture((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onDrag((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragCapture((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragEnd((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragEndCapture((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragEnter((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragEnterCapture((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragExit((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragExitCapture((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragLeave((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragLeaveCapture((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragOver((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragOverCapture((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragStart((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDragStartCapture((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDrop((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onDropCapture((event: DragEvent<HTMLLIElement>) => void) | undefinedfalse
onMouseDown((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseDownCapture((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseEnter((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseLeave((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseMove((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseMoveCapture((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseOut((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseOutCapture((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseOver((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseOverCapture((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseUp((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onMouseUpCapture((event: MouseEvent<HTMLLIElement, MouseEvent>) => void) | undefinedfalse
onSelect((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onSelectCapture((event: SyntheticEvent<HTMLLIElement, Event>) => void) | undefinedfalse
onTouchCancel((event: TouchEvent<HTMLLIElement>) => void) | undefinedfalse
onTouchCancelCapture((event: TouchEvent<HTMLLIElement>) => void) | undefinedfalse
onTouchEnd((event: TouchEvent<HTMLLIElement>) => void) | undefinedfalse
onTouchEndCapture((event: TouchEvent<HTMLLIElement>) => void) | undefinedfalse
onTouchMove((event: TouchEvent<HTMLLIElement>) => void) | undefinedfalse
onTouchMoveCapture((event: TouchEvent<HTMLLIElement>) => void) | undefinedfalse
onTouchStart((event: TouchEvent<HTMLLIElement>) => void) | undefinedfalse
onTouchStartCapture((event: TouchEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerDown((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerDownCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerMove((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerMoveCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerUp((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerUpCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerCancel((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerCancelCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerEnter((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerEnterCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerLeave((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerLeaveCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerOver((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerOverCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerOut((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onPointerOutCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onGotPointerCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onGotPointerCaptureCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onLostPointerCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onLostPointerCaptureCapture((event: PointerEvent<HTMLLIElement>) => void) | undefinedfalse
onScroll((event: UIEvent<HTMLLIElement, UIEvent>) => void) | undefinedfalse
onScrollCapture((event: UIEvent<HTMLLIElement, UIEvent>) => void) | undefinedfalse
onWheel((event: WheelEvent<HTMLLIElement>) => void) | undefinedfalse
onWheelCapture((event: WheelEvent<HTMLLIElement>) => void) | undefinedfalse
onAnimationStart((event: AnimationEvent<HTMLLIElement>) => void) | undefinedfalse
onAnimationStartCapture((event: AnimationEvent<HTMLLIElement>) => void) | undefinedfalse
onAnimationEnd((event: AnimationEvent<HTMLLIElement>) => void) | undefinedfalse
onAnimationEndCapture((event: AnimationEvent<HTMLLIElement>) => void) | undefinedfalse
onAnimationIteration((event: AnimationEvent<HTMLLIElement>) => void) | undefinedfalse
onAnimationIterationCapture((event: AnimationEvent<HTMLLIElement>) => void) | undefinedfalse
onTransitionEnd((event: TransitionEvent<HTMLLIElement>) => void) | undefinedfalse
onTransitionEndCapture((event: TransitionEvent<HTMLLIElement>) => void) | undefinedfalse
innerRef((instance: any) => void) | RefObject<any> | null | undefinedfalse
ref((instance: HTMLLIElement | null) => void) | RefObject<HTMLLIElement> | null | undefinedfalse
buttonboolean | undefinedfalse
imagestring | undefinedfalse
inputValuestring | undefinedfalse

Special props, need for allowCreate feature of auto complete com

valuestring | number | readonly string[] | undefinedfalse
keystring | number | null | undefinedfalse
autoFocusboolean | undefinedfalse
namestring | undefinedfalse
endIconReactNodefalse
focusVisibleClassNamestring | undefinedfalse
iconReactNodefalse
avatarstring | undefinedfalse
denseboolean | undefinedfalse
selectedboolean | undefinedfalse
hideboolean | undefinedfalse
descriptionstring | undefinedfalse
justContentboolean | undefinedfalse
allowRemoveboolean | undefinedfalse

Special props, use for select locale

alignItems"flex-start" | "center" | undefinedfalse
ContainerComponent"object" | "time" | "menu" | "abbr" | "address" | "article" | "aside" | "b" | "bdi" | "bdo" | "big" | "blockquote" | "caption" | "cite" | "code" | "col" | "colgroup" | "dd" | "del" | ... 61 more ... | undefinedfalse
ContainerPropsHTMLAttributes<HTMLDivElement> | undefinedfalse
disableGuttersboolean | undefinedfalse
dividerboolean | undefinedfalse
Prop nameTypeDefaultRequiredDescription
optionsMenuOptionProps[]true
dividerboolean | undefinedfalse

Apply divider for all item

hideboolean | undefinedfalse
buttonPropsButtonProps | undefinedfalse
buttonReactNodefalse
labelReactNodefalse
hoverboolean | undefinedfalse
fullWidthboolean | undefinedfalse
popupStatePopupState | undefinedfalse
getContextMenu((value: (e: SyntheticEvent<Element, Event>) => { top: number; left: number; }) => void) | undefinedfalse
titlestring | undefinedfalse
onChange((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
classesPartial<Record<PopoverClassKey, string>> | undefinedfalse

Override or extend the styles applied to the component.

defaultCheckedboolean | undefinedfalse
defaultValuestring | number | readonly string[] | undefinedfalse
suppressContentEditableWarningboolean | undefinedfalse
suppressHydrationWarningboolean | undefinedfalse
accessKeystring | undefinedfalse
classNamestring | undefinedfalse
contentEditableboolean | "true" | "false" | "inherit" | undefinedfalse
dirstring | undefinedfalse
draggableboolean | "true" | "false" | undefinedfalse
hiddenboolean | undefinedfalse
idstring | undefinedfalse
langstring | undefinedfalse
placeholderstring | undefinedfalse
slotstring | undefinedfalse
spellCheckboolean | "true" | "false" | undefinedfalse
styleCSSProperties | undefinedfalse
tabIndexnumber | undefinedfalse
translate"yes" | "no" | undefinedfalse
radioGroupstring | undefinedfalse
rolestring | undefinedfalse
aboutstring | undefinedfalse
datatypestring | undefinedfalse
inlistanyfalse
prefixstring | undefinedfalse
propertystring | undefinedfalse
resourcestring | undefinedfalse
typeofstring | undefinedfalse
vocabstring | undefinedfalse
autoCapitalizestring | undefinedfalse
autoCorrectstring | undefinedfalse
autoSavestring | undefinedfalse
colorstring | undefinedfalse
itemPropstring | undefinedfalse
itemScopeboolean | undefinedfalse
itemTypestring | undefinedfalse
itemIDstring | undefinedfalse
itemRefstring | undefinedfalse
resultsnumber | undefinedfalse
securitystring | undefinedfalse
unselectable"on" | "off" | undefinedfalse
inputMode"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefinedfalse

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

isstring | undefinedfalse

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

aria-activedescendantstring | undefinedfalse

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

aria-atomicboolean | "true" | "false" | undefinedfalse

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.

aria-autocomplete"none" | "inline" | "list" | "both" | undefinedfalse

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.

aria-busyboolean | "true" | "false" | undefinedfalse

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

aria-checkedboolean | "true" | "false" | "mixed" | undefinedfalse

Indicates the current “checked” state of checkboxes, radio buttons, and other widgets. @see aria-pressed @see aria-selected.

aria-colcountnumber | undefinedfalse

Defines the total number of columns in a table, grid, or treegrid. @see aria-colindex.

aria-colindexnumber | undefinedfalse

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 @see aria-colspan.

aria-colspannumber | undefinedfalse

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-colindex @see aria-rowspan.

aria-controlsstring | undefinedfalse

Identifies the element (or elements) whose contents or presence are controlled by the current element. @see aria-owns.

aria-currentboolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefinedfalse

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

aria-describedbystring | undefinedfalse

Identifies the element (or elements) that describes the object. @see aria-labelledby

aria-detailsstring | undefinedfalse

Identifies the element that provides a detailed, extended description for the object. @see aria-describedby.

aria-disabledboolean | "true" | "false" | undefinedfalse

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. @see aria-hidden @see aria-readonly.

aria-dropeffect"none" | "copy" | "execute" | "link" | "move" | "popup" | undefinedfalse

Indicates what functions can be performed when a dragged object is released on the drop target. @deprecated in ARIA 1.1

aria-errormessagestring | undefinedfalse

Identifies the element that provides an error message for the object. @see aria-invalid @see aria-describedby.

aria-expandedboolean | "true" | "false" | undefinedfalse

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

aria-flowtostring | undefinedfalse

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.

aria-grabbedboolean | "true" | "false" | undefinedfalse

Indicates an element’s “grabbed” state in a drag-and-drop operation. @deprecated in ARIA 1.1

aria-haspopupboolean | "true" | "false" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefinedfalse

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

aria-hiddenboolean | "true" | "false" | undefinedfalse

Indicates whether the element is exposed to an accessibility API. @see aria-disabled.

aria-invalidboolean | "true" | "false" | "grammar" | "spelling" | undefinedfalse

Indicates the entered value does not conform to the format expected by the application. @see aria-errormessage.

aria-keyshortcutsstring | undefinedfalse

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

aria-labelstring | undefinedfalse

Defines a string value that labels the current element. @see aria-labelledby.

aria-labelledbystring | undefinedfalse

Identifies the element (or elements) that labels the current element. @see aria-describedby.

aria-levelnumber | undefinedfalse

Defines the hierarchical level of an element within a structure.

aria-live"off" | "assertive" | "polite" | undefinedfalse

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.

aria-modalboolean | "true" | "false" | undefinedfalse

Indicates whether an element is modal when displayed.

aria-multilineboolean | "true" | "false" | undefinedfalse

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

aria-multiselectableboolean | "true" | "false" | undefinedfalse

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

aria-orientation"horizontal" | "vertical" | undefinedfalse

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

aria-ownsstring | undefinedfalse

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.

aria-placeholderstring | undefinedfalse

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.

aria-posinsetnumber | undefinedfalse

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.

aria-pressedboolean | "true" | "false" | "mixed" | undefinedfalse

Indicates the current “pressed” state of toggle buttons. @see aria-checked @see aria-selected.

aria-readonlyboolean | "true" | "false" | undefinedfalse

Indicates that the element is not editable, but is otherwise operable. @see aria-disabled.

aria-relevant"text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefinedfalse

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. @see aria-atomic.

aria-requiredboolean | "true" | "false" | undefinedfalse

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

aria-roledescriptionstring | undefinedfalse

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

aria-rowcountnumber | undefinedfalse

Defines the total number of rows in a table, grid, or treegrid. @see aria-rowindex.

aria-rowindexnumber | undefinedfalse

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 @see aria-rowspan.

aria-rowspannumber | undefinedfalse

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. @see aria-rowindex @see aria-colspan.

aria-selectedboolean | "true" | "false" | undefinedfalse

Indicates the current “selected” state of various widgets. @see aria-checked @see aria-pressed.

aria-setsizenumber | undefinedfalse

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.

aria-sort"none" | "ascending" | "descending" | "other" | undefinedfalse

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

aria-valuemaxnumber | undefinedfalse

Defines the maximum allowed value for a range widget.

aria-valueminnumber | undefinedfalse

Defines the minimum allowed value for a range widget.

aria-valuenownumber | undefinedfalse

Defines the current value for a range widget. @see aria-valuetext.

aria-valuetextstring | undefinedfalse

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

childrenReactNodefalse

The content of the component.

dangerouslySetInnerHTML{ __html: string; } | undefinedfalse
onCopy((event: ClipboardEvent<HTMLDivElement>) => void) | undefinedfalse
onCopyCapture((event: ClipboardEvent<HTMLDivElement>) => void) | undefinedfalse
onCut((event: ClipboardEvent<HTMLDivElement>) => void) | undefinedfalse
onCutCapture((event: ClipboardEvent<HTMLDivElement>) => void) | undefinedfalse
onPaste((event: ClipboardEvent<HTMLDivElement>) => void) | undefinedfalse
onPasteCapture((event: ClipboardEvent<HTMLDivElement>) => void) | undefinedfalse
onCompositionEnd((event: CompositionEvent<HTMLDivElement>) => void) | undefinedfalse
onCompositionEndCapture((event: CompositionEvent<HTMLDivElement>) => void) | undefinedfalse
onCompositionStart((event: CompositionEvent<HTMLDivElement>) => void) | undefinedfalse
onCompositionStartCapture((event: CompositionEvent<HTMLDivElement>) => void) | undefinedfalse
onCompositionUpdate((event: CompositionEvent<HTMLDivElement>) => void) | undefinedfalse
onCompositionUpdateCapture((event: CompositionEvent<HTMLDivElement>) => void) | undefinedfalse
onFocus((event: FocusEvent<HTMLDivElement>) => void) | undefinedfalse
onFocusCapture((event: FocusEvent<HTMLDivElement>) => void) | undefinedfalse
onBlur((event: FocusEvent<HTMLDivElement>) => void) | undefinedfalse
onBlurCapture((event: FocusEvent<HTMLDivElement>) => void) | undefinedfalse
onChangeCapture((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onBeforeInput((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onBeforeInputCapture((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onInput((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onInputCapture((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onReset((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onResetCapture((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onSubmit((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onSubmitCapture((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onInvalid((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onInvalidCapture((event: FormEvent<HTMLDivElement>) => void) | undefinedfalse
onLoad((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onLoadCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onError((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onErrorCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onKeyDown((event: KeyboardEvent<HTMLDivElement>) => void) | undefinedfalse
onKeyDownCapture((event: KeyboardEvent<HTMLDivElement>) => void) | undefinedfalse
onKeyPress((event: KeyboardEvent<HTMLDivElement>) => void) | undefinedfalse
onKeyPressCapture((event: KeyboardEvent<HTMLDivElement>) => void) | undefinedfalse
onKeyUp((event: KeyboardEvent<HTMLDivElement>) => void) | undefinedfalse
onKeyUpCapture((event: KeyboardEvent<HTMLDivElement>) => void) | undefinedfalse
onAbort((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onAbortCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onCanPlay((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onCanPlayCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onCanPlayThrough((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onCanPlayThroughCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onDurationChange((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onDurationChangeCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onEmptied((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onEmptiedCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onEncrypted((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onEncryptedCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onEnded((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onEndedCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onLoadedData((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onLoadedDataCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onLoadedMetadata((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onLoadedMetadataCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onLoadStart((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onLoadStartCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onPause((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onPauseCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onPlay((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onPlayCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onPlaying((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onPlayingCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onProgress((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onProgressCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onRateChange((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onRateChangeCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onSeeked((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onSeekedCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onSeeking((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onSeekingCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onStalled((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onStalledCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onSuspend((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onSuspendCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onTimeUpdate((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onTimeUpdateCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onVolumeChange((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onVolumeChangeCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onWaiting((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onWaitingCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onAuxClick((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onAuxClickCapture((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onClick((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onClickCapture((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onContextMenu((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onContextMenuCapture((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onDoubleClick((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onDoubleClickCapture((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onDrag((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragCapture((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragEnd((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragEndCapture((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragEnter((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragEnterCapture((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragExit((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragExitCapture((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragLeave((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragLeaveCapture((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragOver((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragOverCapture((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragStart((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDragStartCapture((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDrop((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onDropCapture((event: DragEvent<HTMLDivElement>) => void) | undefinedfalse
onMouseDown((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseDownCapture((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseEnter((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseLeave((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseMove((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseMoveCapture((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseOut((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseOutCapture((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseOver((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseOverCapture((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseUp((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onMouseUpCapture((event: MouseEvent<HTMLDivElement, MouseEvent>) => void) | undefinedfalse
onSelect((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onSelectCapture((event: SyntheticEvent<HTMLDivElement, Event>) => void) | undefinedfalse
onTouchCancel((event: TouchEvent<HTMLDivElement>) => void) | undefinedfalse
onTouchCancelCapture((event: TouchEvent<HTMLDivElement>) => void) | undefinedfalse
onTouchEnd((event: TouchEvent<HTMLDivElement>) => void) | undefinedfalse
onTouchEndCapture((event: TouchEvent<HTMLDivElement>) => void) | undefinedfalse
onTouchMove((event: TouchEvent<HTMLDivElement>) => void) | undefinedfalse
onTouchMoveCapture((event: TouchEvent<HTMLDivElement>) => void) | undefinedfalse
onTouchStart((event: TouchEvent<HTMLDivElement>) => void) | undefinedfalse
onTouchStartCapture((event: TouchEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerDown((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerDownCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerMove((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerMoveCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerUp((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerUpCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerCancel((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerCancelCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerEnter((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerEnterCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerLeave((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerLeaveCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerOver((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerOverCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerOut((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onPointerOutCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onGotPointerCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onGotPointerCaptureCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onLostPointerCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onLostPointerCaptureCapture((event: PointerEvent<HTMLDivElement>) => void) | undefinedfalse
onScroll((event: UIEvent<HTMLDivElement, UIEvent>) => void) | undefinedfalse
onScrollCapture((event: UIEvent<HTMLDivElement, UIEvent>) => void) | undefinedfalse
onWheel((event: WheelEvent<HTMLDivElement>) => void) | undefinedfalse
onWheelCapture((event: WheelEvent<HTMLDivElement>) => void) | undefinedfalse
onAnimationStart((event: AnimationEvent<HTMLDivElement>) => void) | undefinedfalse
onAnimationStartCapture((event: AnimationEvent<HTMLDivElement>) => void) | undefinedfalse
onAnimationEnd((event: AnimationEvent<HTMLDivElement>) => void) | undefinedfalse
onAnimationEndCapture((event: AnimationEvent<HTMLDivElement>) => void) | undefinedfalse
onAnimationIteration((event: AnimationEvent<HTMLDivElement>) => void) | undefinedfalse
onAnimationIterationCapture((event: AnimationEvent<HTMLDivElement>) => void) | undefinedfalse
onTransitionEnd((event: TransitionEvent<HTMLDivElement>) => void) | undefinedfalse
onTransitionEndCapture((event: TransitionEvent<HTMLDivElement>) => void) | undefinedfalse
elevationnumber | undefinedfalse

The elevation of the popover.

innerRef((instance: any) => void) | RefObject<any> | null | undefinedfalse
ref((instance: unknown) => void) | RefObject<unknown> | null | undefinedfalse
TransitionComponentComponentClass<TransitionProps & { children?: ReactElement<any, any> | undefined; }, any> | FunctionComponent<TransitionProps & { children?: ReactElement<any, any> | undefined; }> | undefinedfalse

The component used for the transition. Follow this guide to learn more about the requirements for this component.

TransitionPropsTransitionProps | undefinedfalse

Props applied to the Transition element.

disablePortalboolean | undefinedfalse
onClose((event: {}, reason: "backdropClick" | "escapeKeyDown") => void) | undefinedfalse

Callback fired when the component requests to be closed.

action((instance: PopoverActions | null) => void) | RefObject<PopoverActions> | null | undefinedfalse

A ref for imperative actions. It currently only supports updatePosition() action.

onEnter((node: HTMLElement, isAppearing: boolean) => void) | undefinedfalse

Callback fired before the component is entering.

onEntering((node: HTMLElement, isAppearing: boolean) => void) | undefinedfalse

Callback fired when the component is entering.

onEntered((node: HTMLElement, isAppearing: boolean) => void) | undefinedfalse

Callback fired when the component has entered.

onExit((node: HTMLElement) => void) | undefinedfalse

Callback fired before the component is exiting.

onExiting((node: HTMLElement) => void) | undefinedfalse

Callback fired when the component is exiting.

onExited((node: HTMLElement) => void) | undefinedfalse

Callback fired when the component has exited.

BackdropComponentComponentClass<BackdropProps, any> | FunctionComponent<BackdropProps> | undefinedfalse
BackdropPropsPartial<BackdropProps> | undefinedfalse
closeAfterTransitionboolean | undefinedfalse
containerElement | Component<any, {}, any> | (() => Element | Component<any, {}, any> | null) | null | undefinedfalse

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

disableAutoFocusboolean | undefinedfalse
disableBackdropClickboolean | undefinedfalse
disableEnforceFocusboolean | undefinedfalse
disableEscapeKeyDownboolean | undefinedfalse
disableRestoreFocusboolean | undefinedfalse
disableScrollLockboolean | undefinedfalse
hideBackdropboolean | undefinedfalse
keepMountedboolean | undefinedfalse
managerModalManager | undefinedfalse
onBackdropClick((event: SyntheticEvent<{}, Event>) => void) | undefinedfalse
onEscapeKeyDown((event: SyntheticEvent<{}, Event>) => void) | undefinedfalse
onRendered(() => void) | undefinedfalse
anchorElElement | ((element: Element) => Element) | null | undefinedfalse

A HTML element, or a function that returns it. It’s used to set the position of the popover.

anchorOriginPopoverOrigin | undefinedfalse

This 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].

anchorPositionPopoverPosition | undefinedfalse

This is the position that may be used to set the position of the popover. The coordinates are relative to the application’s client area.

anchorReference"none" | "anchorEl" | "anchorPosition" | undefinedfalse

This determines which anchor prop to refer to to set the position of the popover.

getContentAnchorEl((element: Element) => Element) | null | undefinedfalse

This function is called in order to retrieve the content anchor element. It’s the opposite of the anchorEl prop. The content anchor element should be an element inside the popover. It’s used to correctly scroll and set the position of the popover. The positioning strategy tries to make the content anchor element just above the anchor element.

marginThresholdnumber | undefinedfalse

Specifies how close to the edge of the window the popover can appear.

PaperPropsPartial<PaperProps> | undefinedfalse

Props applied to the Paper element.

transformOriginPopoverOrigin | undefinedfalse

This 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)].

transitionDurationnumber | "auto" | { appear?: number | undefined; enter?: number | undefined; exit?: number | undefined; } | { appear?: number | undefined; enter?: number | undefined; exit?: number | undefined; } | undefinedfalse

Set to ‘auto’ to automatically calculate transition time based on height.