@material/drawer

constructor

constructor(adapter?: Partial<MDCDrawerAdapter>);

property cssClasses

static readonly cssClasses: {
    ANIMATE: string;
    CLOSING: string;
    DISMISSIBLE: string;
    MODAL: string;
    OPEN: string;
    OPENING: string;
    ROOT: string;
};

property defaultAdapter

static readonly defaultAdapter: MDCDrawerAdapter;

property strings

static readonly strings: {
    APP_CONTENT_SELECTOR: string;
    CLOSE_EVENT: string;
    OPEN_EVENT: string;
    SCRIM_SELECTOR: string;
    LIST_SELECTOR: string;
    LIST_ITEM_ACTIVATED_SELECTOR: string;
};

method close

close: () => void;

• Closes the drawer from the open state.

method closed

protected closed: () => void;

• Extension point for when drawer finishes close animation.

method destroy

destroy: () => void;

method handleKeydown

handleKeydown: (evt: KeyboardEvent) => void;

• Keydown handler to close drawer when key is escape.

method handleTransitionEnd

handleTransitionEnd: (evt: TransitionEvent) => void;

• Handles the transitionend event when the drawer finishes opening/closing.

method isClosing

isClosing: () => boolean;

• Returns true if the drawer is animating closed. true if drawer is animating closed.

method isOpen

isOpen: () => boolean;

• Returns true if the drawer is in the open position. true if drawer is in open state.

method isOpening

isOpening: () => boolean;

• Returns true if the drawer is animating open. true if drawer is animating open.

method open

open: () => void;

• Opens the drawer from the closed state.

method opened

protected opened: () => void;

• Extension point for when drawer finishes open animation.

property list

readonly list: any;

property open

open: boolean;

• boolean Proxies to the foundation's open/close methods. Also returns true if drawer is in the open position.

method attachTo

static attachTo: (root: Element) => MDCDrawer;

method destroy

destroy: () => void;

method getDefaultFoundation

getDefaultFoundation: () => MDCDismissibleDrawerFoundation;

method initialize

initialize: (
    focusTrapFactory?: MDCDrawerFocusTrapFactory,
    listFactory?: MDCListFactory
) => void;

method initialSyncWithDOM

initialSyncWithDOM: () => void;

method closed

protected closed: () => void;

• Called when drawer finishes close animation.

method handleScrimClick

handleScrimClick: () => void;

• Handles click event on scrim.

method opened

protected opened: () => void;

• Called when drawer finishes open animation.

method addClass

addClass: (className: string) => void;

• Adds a class to the root Element.

method elementHasClass

elementHasClass: (element: Element, className: string) => boolean;

• Returns true if the element contains the given class.

  Parameter element

  target element to verify class name

  Parameter className

  class name

method focusActiveNavigationItem

focusActiveNavigationItem: () => void;

• Focuses the active / selected navigation item.

method hasClass

hasClass: (className: string) => boolean;

• Returns true if the root Element contains the given class.

method notifyClose

notifyClose: () => void;

• Emits a custom event "MDCDrawer:closed" denoting the drawer has closed.

method notifyOpen

notifyOpen: () => void;

• Emits a custom event "MDCDrawer:opened" denoting the drawer has opened.

method releaseFocus

releaseFocus: () => void;

• Releases focus trap from root element which was set by trapFocus and restores focus to where it was prior to calling trapFocus.

method removeClass

removeClass: (className: string) => void;

• Removes a class from the root Element.

method restoreFocus

restoreFocus: () => void;

• Restores focus to element previously saved with 'saveFocus'.

method saveFocus

saveFocus: () => void;

• Saves the focus of currently active element.

method trapFocus

trapFocus: () => void;

• Traps focus on root element and focuses the active navigation element.

function createFocusTrapInstance

createFocusTrapInstance: (
    surfaceEl: HTMLElement,
    focusTrapFactory: MDCDrawerFocusTrapFactory
) => FocusTrap;

type MDCDrawerFocusTrapFactory

type MDCDrawerFocusTrapFactory = (
    element: HTMLElement,
    options: FocusOptions
) => FocusTrap;