MDCDrawer | material-components-web

Hierarchy

MDCComponent<MDCDismissibleDrawerFoundation>
- MDCDrawer

Index

Constructors

constructor

Properties

Accessors

list
open

Methods

Constructors

constructor

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

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 MDCDrawer

Properties

Protected foundation_

foundation_: MDCDismissibleDrawerFoundation

Protected root_

root_: Element

Accessors

list

get list(): MDCList | undefined

- Defined in mdc-drawer/component.ts:71
Returns MDCList | undefined

open

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

- Defined in mdc-drawer/component.ts:45
Returns true if drawer is in the open position.

Returns boolean
- Defined in mdc-drawer/component.ts:52
Toggles the drawer open and closed.

Parameters
- isOpen: boolean
Returns void

Methods

destroy

destroy(): void

Overrides MDCComponent.destroy
- Defined in mdc-drawer/component.ts:106
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(): MDCDismissibleDrawerFoundation

Overrides MDCComponent.getDefaultFoundation
- Defined in mdc-drawer/component.ts:122
Returns MDCDismissibleDrawerFoundation

initialSyncWithDOM

initialSyncWithDOM(): void

Overrides MDCComponent.initialSyncWithDOM
- Defined in mdc-drawer/component.ts:87
Returns void

initialize

initialize(focusTrapFactory?: MDCDrawerFocusTrapFactory, listFactory?: MDCListFactory): void

Overrides MDCComponent.initialize
- Defined in mdc-drawer/component.ts:75
Parameters
- Default value focusTrapFactory: MDCDrawerFocusTrapFactory = createFocusTrap as unknown as MDCDrawerFocusTrapFactory
- 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

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): MDCDrawer

Overrides MDCComponent.attachTo
- Defined in mdc-drawer/component.ts:38
Parameters
- root: Element
Returns MDCDrawer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

root: Element

Optional foundation: FoundationType

Rest ...args: Array<unknown>

Returns MDCDrawer

Properties

Protected foundation_

Protected root_

Accessors

list

Returns MDCList | undefined

open

Returns boolean

Parameters

isOpen: 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 MDCDismissibleDrawerFoundation

initialSyncWithDOM

Returns void

initialize

Parameters

Default value focusTrapFactory: MDCDrawerFocusTrapFactory = createFocusTrap as unknown as MDCDrawerFocusTrapFactory

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

unlisten

Type parameters

K: EventType

Parameters

evtType: K

handler: SpecificEventListener<K>

Returns void

Type parameters

E: Event

Parameters

evtType: string

handler: CustomEventListener<E>

Returns void

Static attachTo

Parameters

root: Element

Returns MDCDrawer