MDCMenu | material-components-web

Hierarchy

MDCComponent<MDCMenuFoundation>
- MDCMenu

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MDCMenu(root: Element, foundation?: FoundationType, ...args: Array<unknown>): MDCMenu

Inherited from MDCComponent.__constructor
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:37
Parameters
- root: Element
- Optional foundation: FoundationType
- Rest ...args: Array<unknown>
Returns MDCMenu

Properties

Protected foundation_

foundation_: MDCMenuFoundation

Protected root_

root_: Element

Accessors

items

get items(): Element[]

- Defined in mdc-menu/component.ts:117
Return the items within the menu. Note that this only contains the set of elements within the items container that are proper list items, and not supplemental / presentational DOM elements.

Returns Element[]

open

get open(): boolean
set open(value: boolean): void

- Defined in mdc-menu/component.ts:94
Returns boolean
- Defined in mdc-menu/component.ts:98
Parameters
- value: boolean
Returns void

quickOpen

set quickOpen(quickOpen: boolean): void

- Defined in mdc-menu/component.ts:121
Parameters
- quickOpen: boolean
Returns void

wrapFocus

get wrapFocus(): boolean
set wrapFocus(value: boolean): void

- Defined in mdc-menu/component.ts:102
Returns boolean
- Defined in mdc-menu/component.ts:106
Parameters
- value: boolean
Returns void

Methods

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-menu/component.ts:82
Returns void

emit

emit<T>(evtType: string, evtData: T, shouldBubble?: boolean): void

Inherited from MDCComponent.emit
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:103
Fires a cross-browser-compatible custom event from the component root of the given type, with the given data.

Type parameters
- T: object
Parameters
- evtType: string
- evtData: T
- Default value shouldBubble: boolean = false
Returns void

getDefaultFoundation

getDefaultFoundation(): MDCMenuFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-menu/component.ts:182
Returns MDCMenuFoundation

getOptionByIndex

getOptionByIndex(index: number): Element | null

- Defined in mdc-menu/component.ts:149
Parameters
- index: number
Returns Element | null

The item within the menu at the index specified.

hoistMenuToBody

hoistMenuToBody(): void

- Defined in mdc-menu/component.ts:163
Returns void

initialSyncWithDOM

initialSyncWithDOM(): void

Overrides MDCComponent.initialSyncWithDOM
- Defined in mdc-menu/component.ts:62
Returns void

initialize

initialize(menuSurfaceFactory?: MDCMenuSurfaceFactory, listFactory?: MDCListFactory): void

Overrides MDCComponent.initialize
- Defined in mdc-menu/component.ts:55
Parameters
- Default value menuSurfaceFactory: MDCMenuSurfaceFactory = (el) => new MDCMenuSurface(el)
- Default value listFactory: MDCListFactory = (el) => new MDCList(el)
Returns void

listen

listen<K>(evtType: K, handler: SpecificEventListener<K>): void
listen<E>(evtType: string, handler: CustomEventListener<E>): void

Inherited from MDCComponent.listen
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:84
Wrapper method to add an event listener to the component's root element. This is most useful when listening for custom events.

Type parameters
- K: EventType
Parameters
- evtType: K
- handler: SpecificEventListener<K>
Returns void
Inherited from MDCComponent.listen
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:85
Type parameters
- E: Event
Parameters
- evtType: string
- handler: CustomEventListener<E>
Returns void

setAbsolutePosition

setAbsolutePosition(x: number, y: number): void

- Defined in mdc-menu/component.ts:171
Parameters
- x: number
- y: number
Returns void

setAnchorCorner

setAnchorCorner(corner: Corner): void

- Defined in mdc-menu/component.ts:138
Parameters
- corner: Corner
  
  Default anchor corner alignment of top-left menu corner.
Returns void

setAnchorElement

setAnchorElement(element: Element): void

- Defined in mdc-menu/component.ts:178
Sets the element that the menu-surface is anchored to.

Parameters
- element: Element
Returns void

setAnchorMargin

setAnchorMargin(margin: Partial<MDCMenuDistance>): void

- Defined in mdc-menu/component.ts:142
Parameters
- margin: Partial<MDCMenuDistance>
Returns void

setDefaultFocusState

setDefaultFocusState(focusState: DefaultFocusState): void

- Defined in mdc-menu/component.ts:131
Sets default focus state where the menu should focus every time when menu is opened. Focuses the list root (DefaultFocusState.LIST_ROOT) element by default.

Parameters
- focusState: DefaultFocusState
  
  Default focus state.
Returns void

setFixedPosition

setFixedPosition(isFixed: boolean): void

- Defined in mdc-menu/component.ts:159
Parameters
- isFixed: boolean
Returns void

setIsHoisted

setIsHoisted(isHoisted: boolean): void

- Defined in mdc-menu/component.ts:167
Parameters
- isHoisted: boolean
Returns void

unlisten

unlisten<K>(evtType: K, handler: SpecificEventListener<K>): void
unlisten<E>(evtType: string, handler: CustomEventListener<E>): void

Inherited from MDCComponent.unlisten
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:94
Wrapper method to remove an event listener to the component's root element. This is most useful when unlistening for custom events.

Type parameters
- K: EventType
Parameters
- evtType: K
- handler: SpecificEventListener<K>
Returns void
Inherited from MDCComponent.unlisten
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:95
Type parameters
- E: Event
Parameters
- evtType: string
- handler: CustomEventListener<E>
Returns void

Static attachTo

attachTo(root: Element): MDCMenu

Overrides MDCComponent.attachTo
- Defined in mdc-menu/component.ts:41
Parameters
- root: Element
Returns MDCMenu

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCMenu

Properties

Protected foundation_

Protected root_

Accessors

items

Returns Element[]

open

Returns boolean

Parameters

value: boolean

Returns void

quickOpen

Parameters

quickOpen: boolean

Returns void

wrapFocus

Returns boolean

Parameters

value: boolean

Returns void

Methods

destroy

Returns void

emit

Type parameters

T: object

Parameters

evtType: string

evtData: T

Default value shouldBubble: boolean = false

Returns void

getDefaultFoundation

Returns MDCMenuFoundation

getOptionByIndex

Parameters

index: number

Returns Element | null

hoistMenuToBody

Returns void

initialSyncWithDOM

Returns void

initialize

Parameters

Default value menuSurfaceFactory: MDCMenuSurfaceFactory = (el) => new MDCMenuSurface(el)

Default value listFactory: MDCListFactory = (el) => new MDCList(el)

Returns void

listen

Type parameters

K: EventType

Parameters

evtType: K

handler: SpecificEventListener<K>

Returns void

Type parameters

E: Event

Parameters

evtType: string

handler: CustomEventListener<E>

Returns void

setAbsolutePosition

Parameters

x: number

y: number

Returns void

setAnchorCorner

Parameters

corner: Corner