MDCMenuSurface | material-components-web

Hierarchy

MDCComponent<MDCMenuSurfaceFoundation>
- MDCMenuSurface

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

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 MDCMenuSurface

Properties

anchorElement

anchorElement: Element | null

Protected foundation_

foundation_: MDCMenuSurfaceFoundation

Protected root_

root_: HTMLElement

Accessors

open

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

- Defined in mdc-menu-surface/component.ts:81
Returns boolean
- Defined in mdc-menu-surface/component.ts:85
Parameters
- value: boolean
Returns void

quickOpen

set quickOpen(quickOpen: boolean): void

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

Methods

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-menu-surface/component.ts:74
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(): MDCMenuSurfaceFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-menu-surface/component.ts:147
Returns MDCMenuSurfaceFoundation

hoistMenuToBody

hoistMenuToBody(): void

- Defined in mdc-menu-surface/component.ts:104
Removes the menu-surface from it's current location and appends it to the body to overcome any overflow:hidden issues.

Returns void

initialSyncWithDOM

initialSyncWithDOM(): void

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

initialize

initialize(..._args: Array<unknown>): void

Inherited from MDCComponent.initialize
- Defined in material-components-web/node_modules/@material/auto-init/node_modules/@material/base/component.ts:54
Parameters
- Rest ..._args: Array<unknown>
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-surface/component.ts:131
Sets the absolute x/y position to position based on. Requires the menu to be hoisted.

Parameters
- x: number
- y: number
Returns void

setAnchorCorner

setAnchorCorner(corner: Corner): void

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

setAnchorMargin

setAnchorMargin(margin: Partial<MDCMenuDistance>): void

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

setFixedPosition

setFixedPosition(isFixed: boolean): void

- Defined in mdc-menu-surface/component.ts:120
Sets the menu-surface to position: fixed.

Parameters
- isFixed: boolean
Returns void

setIsHoisted

setIsHoisted(isHoisted: boolean): void

- Defined in mdc-menu-surface/component.ts:110
Sets the foundation to use page offsets for an positioning when the menu is hoisted to the body.

Parameters
- isHoisted: boolean
Returns void

setMenuSurfaceAnchorElement

setMenuSurfaceAnchorElement(element: Element): void

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

Parameters
- element: Element
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): MDCMenuSurface

Overrides MDCComponent.attachTo
- Defined in mdc-menu-surface/component.ts:37
Parameters
- root: Element
Returns MDCMenuSurface

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCMenuSurface

Properties

anchorElement

Protected foundation_

Protected root_

Accessors

open

Returns boolean

Parameters

value: boolean

Returns void

quickOpen

Parameters

quickOpen: 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 MDCMenuSurfaceFoundation

hoistMenuToBody

Returns void

initialSyncWithDOM

Returns void

initialize

Parameters

Rest ..._args: Array<unknown>

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

Returns void

setAnchorMargin

Parameters

margin: Partial<MDCMenuDistance>

Returns void

setFixedPosition

Parameters

isFixed: boolean

Returns void

setIsHoisted

Parameters