Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BaseMenuRendererProps

remarks

@since 5.0.0

Hierarchy

Index

Properties

horizontal?: boolean

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

defaultvalue

false

menuClassName?: string

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

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.

portal?: boolean

Boolean if the portal should be used.

portalInto?: PortalInto
portalIntoId?: string
renderAsSheet?: RenderMenuAsSheet

{@inheritDoc RenderMenuAsSheet}

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

defaultvalue

null

sheetHeader?: ReactNode

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

defaultvalue

null

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
see

SheetPosition

defaultvalue

"bottom"

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
see

SheetVerticalSize

defaultvalue

"touch"

Generated using TypeDoc