• Public
  • Public/Protected
  • All

Interface DropdownMenuButtonProps


@since 5.0.0






about?: string
accessKey?: string
anchor?: PositionAnchor

The PositionAnchor to use for the menu. Here's the default value for the anchor:

  • horizontal - BELOW_CENTER_ANCHOR
  • a submenu - TOP_RIGHT_ANCHOR
appear?: boolean

Boolean if the transition should occur immediately once the component mounts if the TransitionOptions.transitionIn is true



aria-activedescendant?: string

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

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.

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

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

aria-busy?: Booleanish

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-checked?: boolean | "true" | "false" | "mixed"

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


aria-pressed @see aria-selected.

aria-colcount?: number

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



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.


aria-colcount @see aria-colspan.

aria-colspan?: number

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


aria-colindex @see aria-rowspan.

aria-controls?: string

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



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

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

aria-describedby?: string

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



aria-details?: string

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



aria-disabled?: Booleanish

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


aria-hidden @see aria-readonly.

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

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


in ARIA 1.1

aria-errormessage?: string

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


aria-invalid @see aria-describedby.

aria-expanded?: Booleanish

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

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.

aria-grabbed?: Booleanish

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


in ARIA 1.1

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

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

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.



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

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



aria-keyshortcuts?: string

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

aria-label?: string

Defines a string value that labels the current element.



aria-labelledby?: string

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



aria-level?: number

Defines the hierarchical level of an element within a structure.

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.

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

aria-multiline?: Booleanish

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

aria-multiselectable?: Booleanish

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

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

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

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.



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.

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.



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

Indicates the current "pressed" state of toggle buttons.


aria-checked @see aria-selected.

aria-readonly?: Booleanish

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



aria-relevant?: "text" | "additions" | "additions removals" | "additions text" | "all" | "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.



aria-required?: Booleanish

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

aria-roledescription?: string

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

aria-rowcount?: number

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



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.


aria-rowcount @see aria-rowspan.

aria-rowspan?: number

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


aria-rowindex @see aria-colspan.

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.


aria-checked @see aria-pressed.

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.



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

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

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

aria-valuenow?: number

Defines the current value for a range widget.



aria-valuetext?: string

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

autoCapitalize?: string
autoCorrect?: string
autoFocus?: boolean
autoSave?: string
buttonChildren: ReactNode

The children to display in the button. This should normally be text or an icon.

Note: If this is an icon, set the buttonType to "icon" to get the correct styling and remove the dropdown icon.

buttonType?: ButtonType

This is the specific material design button type to use. This can either be set to "text" or "icon". When this is set to "text", the styles applied will make buttons with just text or text with icons render nicely. When this is set to "icon", the styles applied will make icon only buttons render nicely.

children?: ReactNode

Any children to render within the button. This will normally just be text or an icon.

Please note that it is considered invalid html to have a <div> as a descendant of a <button>.

className?: string

An optional className to also apply to the button for additional theming and styling. This will be merged with the Button.theme class name styles.

classNames?: CSSTransitionClassNames








closeOnResize?: boolean

Boolean if the menu should close instead of repositioning itself if the browser window is resized.



closeOnScroll?: boolean

Boolean if the menu should close if the page is scrolled. The default behavior is to just update the position of the menu relative to the menu button until it can no longer be visible within the viewport.



color?: string
contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
disableDropdownIcon?: boolean

Boolean if the dropdown icon should be included with the button children.


buttonType === "icon"

disableEnterClick?: boolean

Boolean if the enter keyboard click polyfill should be completely disabled. This is generally used if the keyboard functionality is already built-in to the element like buttons or labels.

disableFocusOnMount?: boolean

Boolean if the menu component should not gain focus once it has mounted. This should really only be set to true if the enter transition has been disabled.


timeout === 0

disableFocusOnUnmount?: boolean

Boolean if the toggle element should no longer gain focus when the menu loses visibility.

Note: The toggle element will not gain focus if:

  • the menu closed via resizing the browser window
  • the menu closes because the menu is no longer within the viewport
  • the current document.activeElement has moved outside of the menu
    • this generally means the MenuItem's action cause the focus to move already
  • the current document.activeElement is an link (<a href="">)
    • links should generally handle focus behavior themselves

timeout === 0

disablePressedFallback?: boolean

Boolean if the component should fallback to using the custom pressed class names when ripples are disabled.



disableProgrammaticRipple?: boolean

Boolean if the ripple component should not be triggered after a "programmatic" ripple effect. This would be if the .click() function is called on an element through javascript or some other means.

disableRipple?: boolean

Boolean if the ripple effect should be disabled for all child components that use the Ripple states.

disabled?: boolean

Enabling this prop will apply the disabled styles to a Button. When this is also applied to the button component, the button will be updated so that it can no longer be interacted with.

draggable?: Booleanish
enablePressedAndRipple?: boolean

Boolean if the element should be able to gain both the ripple effect and the pressed states changes. This will only be enabled if both the disableRipple and disabledPressedFallback are still false

enter?: boolean

Boolean if the transition should occur whenever the TransitionOptions.transitionIn is switch to true after the component has been rendered in the DOM.



exit?: boolean

Boolean if the transition should occur whenever the TransitionOptions.transitionIn is switch to false after the component has been rendered in the DOM.



fixedPositionOptions?: Readonly<CalculateFixedPositionOptions>

{@inheritDoc CalculateFixedPositionOptions}

floating?: FABPosition

The position within the viewport to display the button as a floating action button.

floatingProps?: PropsWithRef<FABProps, HTMLSpanElement>

Any additional props to provide the to FAB container element when the floating prop is provided

form?: string
formAction?: string
formEncType?: string
formMethod?: string
formNoValidate?: boolean
formTarget?: string
handlers?: MergableRippleHandlers<HTMLButtonElement>

An optional object of event handlers to merge with the required ripple trigger event handlers.

hidden?: boolean
horizontal?: boolean

Boolean if the menu should be rendered horizontally instead of vertically. This will also update the aria-orientation.



icon?: ReactNode | ReactElement<any, string | JSXElementConstructor<any>>

An optional icon to display with a text button. This is invalid for icon buttons. If this is a single element, a new class name will be cloned into the element to get correct spacing so if you have a custom icon element, you must also pass that class name down. If you are using one of the react-md icon component packages, this is handled automatically.

If this is not a valid react element, the icon will be wrapped in a <span> instead with the class names applied.

iconAfter?: boolean

Boolean if the icon should appear after the text instead of before.

iconRotatorProps?: Readonly<MenuButtonIconRotatorProps>

Any additional props to pass to the IconRotator component that surrounds the buttonChildren

id: string

An id required for accessibility and will be passed to the <Button> component.



inlist?: any
inputMode?: "none" | "search" | "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



is?: string

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



itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
lang?: string
listClassName?: string

An optional className to provide to the List component that surrounds the MenuItem within a Menu.

listProps?: Readonly<PropsWithRef<Omit<ListProps, "horizontal">, ListElement>>

Any additional props to pass to the List component that surrounds the Menu's MenuItems.

listStyle?: CSSProperties

An optional style to provide to the List component that surrounds the MenuItem within a Menu.

menuClassName?: string

An optional className that should be passed to the menu component.

menuLabel?: string

An optional aria-label that should be applied to the Menu component. If this is undefined, an aria-labelledby will be provided to the Menu instead linking to the id of the Button.

menuProps?: Readonly<Omit<MenuWidgetProps, "children" | "id">>

Any additional props that should be passed to the Menu component.

Note: use the menuStyle and menuClassName props instead of including style or className here.

menuStyle?: CSSProperties

An optional style object that should be merged with the menu's fixed positioning styles.

name?: string
onAbort?: ReactEventHandler<HTMLButtonElement>
onAbortCapture?: ReactEventHandler<HTMLButtonElement>
onAnimationEnd?: AnimationEventHandler<HTMLButtonElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLButtonElement>
onAnimationIteration?: AnimationEventHandler<HTMLButtonElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLButtonElement>
onAnimationStart?: AnimationEventHandler<HTMLButtonElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLButtonElement>
onAuxClick?: MouseEventHandler<HTMLButtonElement>
onAuxClickCapture?: MouseEventHandler<HTMLButtonElement>
onBeforeInput?: FormEventHandler<HTMLButtonElement>
onBeforeInputCapture?: FormEventHandler<HTMLButtonElement>
onBlur?: FocusEventHandler<HTMLButtonElement>
onBlurCapture?: FocusEventHandler<HTMLButtonElement>
onCanPlay?: ReactEventHandler<HTMLButtonElement>
onCanPlayCapture?: ReactEventHandler<HTMLButtonElement>
onCanPlayThrough?: ReactEventHandler<HTMLButtonElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLButtonElement>
onChange?: FormEventHandler<HTMLButtonElement>
onChangeCapture?: FormEventHandler<HTMLButtonElement>
onClick?: MouseEventHandler<HTMLButtonElement>
onClickCapture?: MouseEventHandler<HTMLButtonElement>
onCompositionEnd?: CompositionEventHandler<HTMLButtonElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLButtonElement>
onCompositionStart?: CompositionEventHandler<HTMLButtonElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLButtonElement>
onCompositionUpdate?: CompositionEventHandler<HTMLButtonElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLButtonElement>
onContextMenu?: MouseEventHandler<HTMLButtonElement>
onContextMenuCapture?: MouseEventHandler<HTMLButtonElement>
onCopy?: ClipboardEventHandler<HTMLButtonElement>
onCopyCapture?: ClipboardEventHandler<HTMLButtonElement>
onCut?: ClipboardEventHandler<HTMLButtonElement>
onCutCapture?: ClipboardEventHandler<HTMLButtonElement>
onDoubleClick?: MouseEventHandler<HTMLButtonElement>
onDoubleClickCapture?: MouseEventHandler<HTMLButtonElement>
onDrag?: DragEventHandler<HTMLButtonElement>
onDragCapture?: DragEventHandler<HTMLButtonElement>
onDragEnd?: DragEventHandler<HTMLButtonElement>
onDragEndCapture?: DragEventHandler<HTMLButtonElement>
onDragEnter?: DragEventHandler<HTMLButtonElement>
onDragEnterCapture?: DragEventHandler<HTMLButtonElement>
onDragExit?: DragEventHandler<HTMLButtonElement>
onDragExitCapture?: DragEventHandler<HTMLButtonElement>
onDragLeave?: DragEventHandler<HTMLButtonElement>
onDragLeaveCapture?: DragEventHandler<HTMLButtonElement>
onDragOver?: DragEventHandler<HTMLButtonElement>
onDragOverCapture?: DragEventHandler<HTMLButtonElement>
onDragStart?: DragEventHandler<HTMLButtonElement>
onDragStartCapture?: DragEventHandler<HTMLButtonElement>
onDrop?: DragEventHandler<HTMLButtonElement>
onDropCapture?: DragEventHandler<HTMLButtonElement>
onDurationChange?: ReactEventHandler<HTMLButtonElement>
onDurationChangeCapture?: ReactEventHandler<HTMLButtonElement>
onEmptied?: ReactEventHandler<HTMLButtonElement>
onEmptiedCapture?: ReactEventHandler<HTMLButtonElement>
onEncrypted?: ReactEventHandler<HTMLButtonElement>
onEncryptedCapture?: ReactEventHandler<HTMLButtonElement>
onEnded?: ReactEventHandler<HTMLButtonElement>
onEndedCapture?: ReactEventHandler<HTMLButtonElement>
onEnter?: TransitionEnterHandler

This function will be called once the TransitionStage has been set to "enter".



onEntered?: TransitionEnterHandler

This function will be called once the TransitionStage has been set to "entering".



onEntering?: TransitionEnterHandler

This function will be called once the TransitionStage has been set to "enter".



onError?: ReactEventHandler<HTMLButtonElement>
onErrorCapture?: ReactEventHandler<HTMLButtonElement>
onExit?: TransitionExitHandler

This function will be called once the TransitionStage has been set to "entered".



onExited?: TransitionExitHandler

This function will be called once the TransitionStage has been set to "exited".



onExiting?: TransitionExitHandler

This function will be called once the TransitionStage has been set to "exiting".



onFocus?: FocusEventHandler<HTMLButtonElement>
onFocusCapture?: FocusEventHandler<HTMLButtonElement>
onGotPointerCapture?: PointerEventHandler<HTMLButtonElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
onInput?: FormEventHandler<HTMLButtonElement>
onInputCapture?: FormEventHandler<HTMLButtonElement>
onInvalid?: FormEventHandler<HTMLButtonElement>
onInvalidCapture?: FormEventHandler<HTMLButtonElement>
onKeyDown?: KeyboardEventHandler<HTMLButtonElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLButtonElement>
onKeyPress?: KeyboardEventHandler<HTMLButtonElement>
onKeyPressCapture?: KeyboardEventHandler<HTMLButtonElement>
onKeyUp?: KeyboardEventHandler<HTMLButtonElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLButtonElement>
onLoad?: ReactEventHandler<HTMLButtonElement>
onLoadCapture?: ReactEventHandler<HTMLButtonElement>
onLoadStart?: ReactEventHandler<HTMLButtonElement>
onLoadStartCapture?: ReactEventHandler<HTMLButtonElement>
onLoadedData?: ReactEventHandler<HTMLButtonElement>
onLoadedDataCapture?: ReactEventHandler<HTMLButtonElement>
onLoadedMetadata?: ReactEventHandler<HTMLButtonElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLButtonElement>
onLostPointerCapture?: PointerEventHandler<HTMLButtonElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLButtonElement>
onMouseDown?: MouseEventHandler<HTMLButtonElement>
onMouseDownCapture?: MouseEventHandler<HTMLButtonElement>
onMouseEnter?: MouseEventHandler<HTMLButtonElement>
onMouseLeave?: MouseEventHandler<HTMLButtonElement>
onMouseMove?: MouseEventHandler<HTMLButtonElement>
onMouseMoveCapture?: MouseEventHandler<HTMLButtonElement>
onMouseOut?: MouseEventHandler<HTMLButtonElement>
onMouseOutCapture?: MouseEventHandler<HTMLButtonElement>
onMouseOver?: MouseEventHandler<HTMLButtonElement>
onMouseOverCapture?: MouseEventHandler<HTMLButtonElement>
onMouseUp?: MouseEventHandler<HTMLButtonElement>
onMouseUpCapture?: MouseEventHandler<HTMLButtonElement>
onPaste?: ClipboardEventHandler<HTMLButtonElement>
onPasteCapture?: ClipboardEventHandler<HTMLButtonElement>
onPause?: ReactEventHandler<HTMLButtonElement>
onPauseCapture?: ReactEventHandler<HTMLButtonElement>
onPlay?: ReactEventHandler<HTMLButtonElement>
onPlayCapture?: ReactEventHandler<HTMLButtonElement>
onPlaying?: ReactEventHandler<HTMLButtonElement>
onPlayingCapture?: ReactEventHandler<HTMLButtonElement>
onPointerCancel?: PointerEventHandler<HTMLButtonElement>
onPointerCancelCapture?: PointerEventHandler<HTMLButtonElement>
onPointerDown?: PointerEventHandler<HTMLButtonElement>
onPointerDownCapture?: PointerEventHandler<HTMLButtonElement>
onPointerEnter?: PointerEventHandler<HTMLButtonElement>
onPointerEnterCapture?: PointerEventHandler<HTMLButtonElement>
onPointerLeave?: PointerEventHandler<HTMLButtonElement>
onPointerLeaveCapture?: PointerEventHandler<HTMLButtonElement>
onPointerMove?: PointerEventHandler<HTMLButtonElement>
onPointerMoveCapture?: PointerEventHandler<HTMLButtonElement>
onPointerOut?: PointerEventHandler<HTMLButtonElement>
onPointerOutCapture?: PointerEventHandler<HTMLButtonElement>
onPointerOver?: PointerEventHandler<HTMLButtonElement>
onPointerOverCapture?: PointerEventHandler<HTMLButtonElement>
onPointerUp?: PointerEventHandler<HTMLButtonElement>
onPointerUpCapture?: PointerEventHandler<HTMLButtonElement>
onProgress?: ReactEventHandler<HTMLButtonElement>
onProgressCapture?: ReactEventHandler<HTMLButtonElement>
onRateChange?: ReactEventHandler<HTMLButtonElement>
onRateChangeCapture?: ReactEventHandler<HTMLButtonElement>
onReset?: FormEventHandler<HTMLButtonElement>
onResetCapture?: FormEventHandler<HTMLButtonElement>
onScroll?: UIEventHandler<HTMLButtonElement>
onScrollCapture?: UIEventHandler<HTMLButtonElement>
onSeeked?: ReactEventHandler<HTMLButtonElement>
onSeekedCapture?: ReactEventHandler<HTMLButtonElement>
onSeeking?: ReactEventHandler<HTMLButtonElement>
onSeekingCapture?: ReactEventHandler<HTMLButtonElement>
onSelect?: ReactEventHandler<HTMLButtonElement>
onSelectCapture?: ReactEventHandler<HTMLButtonElement>
onStalled?: ReactEventHandler<HTMLButtonElement>
onStalledCapture?: ReactEventHandler<HTMLButtonElement>
onSubmit?: FormEventHandler<HTMLButtonElement>
onSubmitCapture?: FormEventHandler<HTMLButtonElement>
onSuspend?: ReactEventHandler<HTMLButtonElement>
onSuspendCapture?: ReactEventHandler<HTMLButtonElement>
onTimeUpdate?: ReactEventHandler<HTMLButtonElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLButtonElement>
onTouchCancel?: TouchEventHandler<HTMLButtonElement>
onTouchCancelCapture?: TouchEventHandler<HTMLButtonElement>
onTouchEnd?: TouchEventHandler<HTMLButtonElement>
onTouchEndCapture?: TouchEventHandler<HTMLButtonElement>
onTouchMove?: TouchEventHandler<HTMLButtonElement>
onTouchMoveCapture?: TouchEventHandler<HTMLButtonElement>
onTouchStart?: TouchEventHandler<HTMLButtonElement>
onTouchStartCapture?: TouchEventHandler<HTMLButtonElement>
onTransitionEnd?: TransitionEventHandler<HTMLButtonElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLButtonElement>
onVolumeChange?: ReactEventHandler<HTMLButtonElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLButtonElement>
onWaiting?: ReactEventHandler<HTMLButtonElement>
onWaitingCapture?: ReactEventHandler<HTMLButtonElement>
onWheel?: WheelEventHandler<HTMLButtonElement>
onWheelCapture?: WheelEventHandler<HTMLButtonElement>
placeholder?: string
portal?: boolean

Boolean if the portal should be used.

portalInto?: PortalInto
portalIntoId?: string
prefix?: string
preventScroll?: boolean

Boolean if the page should no longer be scrollable while the menu is visible.



property?: string
radioGroup?: string
renderAsSheet?: RenderMenuAsSheet

{@inheritDoc RenderMenuAsSheet}

resource?: string
results?: number
rippleClassName?: string

An optional className to apply to the ripple element.

rippleClassNames?: CSSTransitionClassNames

The class names to apply during the different stages for the ripple animation. You probably don't want to use this.

rippleContainerClassName?: string

An optional className to apply to the ripple's container element.

rippleTimeout?: TransitionTimeout

The amount of time before a ripple finishes its animation. You probably don't want to change this value unless you updated the duration in scss or changed the different class names for the ripple animation.

role?: AriaRole
security?: string
sheetClassName?: string

An optional className that should be passed to the sheet component.

sheetFooter?: ReactNode

Any children to render below the sheet's menu implementation. This would normally be something like a <DialogFooter>.



sheetHeader?: ReactNode

Any children to render above the sheet's menu implementation. This would normally be something like a <DialogHeader> or AppBar.



sheetMenuProps?: HTMLAttributes<HTMLDivElement>

Any additional props that should be added to the sheet's menu implementation. You probably won't ever need to use this.

sheetPosition?: SheetPosition




sheetProps?: Readonly<Omit<SheetProps, "children" | "id" | "visible" | "onRequestClose">>

Any additional props that should be passed to the Sheet component.

Note: use the sheetStyle and sheetClassName props instead of including style or className here.

sheetStyle?: CSSProperties

An optional style object that should be passed to the sheet.

sheetVerticalSize?: SheetVerticalSize




slot?: string
spellCheck?: Booleanish
style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
temporary?: boolean
textIconSpacingProps?: Readonly<Omit<TextIconSpacingProps, "children" | "icon" | "iconAfter">>

Any additional props to pass to the TextIconSpacing component that surrounds the optional dropdown icon.

theme?: ButtonTheme

The material design theme to apply to the button. The theme prop will update the look and feel of the button by applying different background and/or foreground colors.

themeType?: ButtonThemeType

The material design theme type to apply. The themeTYpe prop will update the look and feel of the button by applying different border or box shadow.

timeout?: TransitionTimeout

{@inheritDoc TransitionTimeout}

title?: string
translate?: "yes" | "no"
type?: "button" | "reset" | "submit"

The button's type attribute. This is set to "button" by default so that forms are not accidentally submitted when this prop is omitted since buttons without a type attribute work as submit by default.

typeof?: string
unselectable?: "on" | "off"
value?: string | number | readonly string[]
vocab?: string


  • getFixedPositionOptions(): Readonly<CalculateFixedPositionOptions>

Generated using TypeDoc