MDCSnackbar | material-components-web

Hierarchy

MDCComponent<MDCSnackbarFoundation>
- MDCSnackbar

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

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 MDCSnackbar

Properties

Protected foundation_

foundation_: MDCSnackbarFoundation

Protected root_

root_: Element

Accessors

actionButtonText

get actionButtonText(): string
set actionButtonText(actionButtonText: string): void

- Defined in mdc-snackbar/component.ts:139
Returns string
- Defined in mdc-snackbar/component.ts:143
Parameters
- actionButtonText: string
Returns void

closeOnEscape

get closeOnEscape(): boolean
set closeOnEscape(closeOnEscape: boolean): void

- Defined in mdc-snackbar/component.ts:117
Returns boolean
- Defined in mdc-snackbar/component.ts:121
Parameters
- closeOnEscape: boolean
Returns void

isOpen

get isOpen(): boolean

- Defined in mdc-snackbar/component.ts:125
Returns boolean

labelText

get labelText(): string
set labelText(labelText: string): void

- Defined in mdc-snackbar/component.ts:129
Returns string
- Defined in mdc-snackbar/component.ts:135
Parameters
- labelText: string
Returns void

timeoutMs

get timeoutMs(): number
set timeoutMs(timeoutMs: number): void

- Defined in mdc-snackbar/component.ts:109
Returns number
- Defined in mdc-snackbar/component.ts:113
Parameters
- timeoutMs: number
Returns void

Methods

close

close(reason?: string): void

- Defined in mdc-snackbar/component.ts:90
Parameters
- Default value reason: string = ""
  
  Why the snackbar was closed. Value will be passed to CLOSING_EVENT and CLOSED_EVENT via the event.detail.reason property. Standard values are REASON_ACTION and REASON_DISMISS, but custom client-specific values may also be used if desired.
Returns void

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-snackbar/component.ts:75
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(): MDCSnackbarFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-snackbar/component.ts:94
Returns MDCSnackbarFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

Overrides MDCComponent.initialSyncWithDOM
- Defined in mdc-snackbar/component.ts:56
Returns void

initialize

initialize(announcerFactory?: MDCSnackbarAnnouncerFactory): void

Overrides MDCComponent.initialize
- Defined in mdc-snackbar/component.ts:52
Parameters
- Default value announcerFactory: MDCSnackbarAnnouncerFactory = () => util.announce
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-snackbar/component.ts:81
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): MDCSnackbar

Overrides MDCComponent.attachTo
- Defined in mdc-snackbar/component.ts:39
Parameters
- root: Element
Returns MDCSnackbar

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCSnackbar

Properties

Protected foundation_

Protected root_

Accessors

actionButtonText

Returns string

Parameters

actionButtonText: string

Returns void

closeOnEscape

Returns boolean

Parameters

closeOnEscape: boolean

Returns void

isOpen

Returns boolean

labelText

Returns string

Parameters

labelText: string

Returns void

timeoutMs

Returns number

Parameters

timeoutMs: number

Returns void

Methods

close

Parameters

Default value reason: 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 MDCSnackbarFoundation

initialSyncWithDOM

Returns void

initialize

Parameters

Default value announcerFactory: MDCSnackbarAnnouncerFactory = () => util.announce

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