MDCDialog | material-components-web

Hierarchy

MDCComponent<MDCDialogFoundation>
- MDCDialog

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

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 MDCDialog

Properties

Protected foundation_

foundation_: MDCDialogFoundation

Protected root_

root_: Element

Accessors

autoStackButtons

get autoStackButtons(): boolean
set autoStackButtons(autoStack: boolean): void

- Defined in mdc-dialog/component.ts:58
Returns boolean
- Defined in mdc-dialog/component.ts:62
Parameters
- autoStack: boolean
Returns void

escapeKeyAction

get escapeKeyAction(): string
set escapeKeyAction(action: string): void

- Defined in mdc-dialog/component.ts:42
Returns string
- Defined in mdc-dialog/component.ts:46
Parameters
- action: string
Returns void

isOpen

get isOpen(): boolean

- Defined in mdc-dialog/component.ts:38
Returns boolean

scrimClickAction

get scrimClickAction(): string
set scrimClickAction(action: string): void

- Defined in mdc-dialog/component.ts:50
Returns string
- Defined in mdc-dialog/component.ts:54
Parameters
- action: string
Returns void

Methods

close

close(action?: string): void

- Defined in mdc-dialog/component.ts:149
Parameters
- Default value action: string = ""
Returns void

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-dialog/component.ts:130
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(): MDCDialogFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-dialog/component.ts:153
Returns MDCDialogFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

Overrides MDCComponent.initialSyncWithDOM
- Defined in mdc-dialog/component.ts:107
Returns void

initialize

initialize(focusTrapFactory?: MDCDialogFocusTrapFactory, initialFocusEl?: HTMLElement): void

Overrides MDCComponent.initialize
- Defined in mdc-dialog/component.ts:86
Parameters
- Optional focusTrapFactory: MDCDialogFocusTrapFactory
- Optional initialFocusEl: HTMLElement
Returns void

layout

layout(): void

- Defined in mdc-dialog/component.ts:141
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

open

open(): void

- Defined in mdc-dialog/component.ts:145
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): MDCDialog

Overrides MDCComponent.attachTo
- Defined in mdc-dialog/component.ts:66
Parameters
- root: Element
Returns MDCDialog

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCDialog

Properties

Protected foundation_

Protected root_

Accessors

autoStackButtons

Returns boolean

Parameters

autoStack: boolean

Returns void

escapeKeyAction

Returns string

Parameters

action: string

Returns void

isOpen

Returns boolean

scrimClickAction

Returns string

Parameters

action: string

Returns void

Methods

close

Parameters

Default value action: string = ""

Returns void

destroy

Returns void

emit

Type parameters

T: object

Parameters

evtType: string

evtData: T

Default value shouldBubble: boolean = false

Returns void

getDefaultFoundation

Returns MDCDialogFoundation

initialSyncWithDOM

Returns void

initialize

Parameters

Optional focusTrapFactory: MDCDialogFocusTrapFactory

Optional initialFocusEl: HTMLElement

Returns void

layout

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

open

Returns void

unlisten

Type parameters

K: EventType

Parameters

evtType: K