Logo for jsDocs.io

@angular2-material/sidenav

  • Version 2.0.0-alpha.8-3
  • Published
  • No dependencies
  • MIT license

Install

npm i @angular2-material/sidenav
yarn add @angular2-material/sidenav
pnpm add @angular2-material/sidenav

Overview

Angular 2 Material sidenav

Index

Classes

Classes

class MdDuplicatedSidenavError

class MdDuplicatedSidenavError extends MdError {}

  • Exception thrown when two MdSidenav are matching the same side.

constructor

constructor(align: string);

    class MdSidenav

    class MdSidenav {}

    • component.

      This component corresponds to the drawer of the sidenav.

      Please refer to README.md for examples on how to use it.

    constructor

    constructor(_elementRef: ElementRef);

    • Parameter _elementRef

      The DOM element reference. Used for transition and width calculation. If not available we do not hook on transitions.

    property align

    align: 'start' | 'end';

    • Alignment of the sidenav (direction neutral); whether 'start' or 'end'.

    property mode

    mode: 'over' | 'push' | 'side';

    • Mode of the sidenav; whether 'over' or 'side'.

    property onClose

    onClose: EventEmitter<void>;

    • Event emitted when the sidenav is fully closed.

    property onCloseStart

    onCloseStart: EventEmitter<void>;

    • Event emitted when the sidenav is being closed. Use this to synchronize animations.

    property onOpen

    onOpen: EventEmitter<void>;

    • Event emitted when the sidenav is fully opened.

    property onOpenStart

    onOpenStart: EventEmitter<void>;

    • Event emitted when the sidenav is being opened. Use this to synchronize animations.

    property opened

    opened: boolean;

    • Whether the sidenav is opened. We overload this because we trigger an event when it starts or end.

    method close

    close: () => Promise<void>;

    • Close this sidenav, and return a Promise that will resolve when it's fully closed (or get rejected if it didn't).

    method open

    open: () => Promise<void>;

    • Open this sidenav, and return a Promise that will resolve when it's fully opened (or get rejected if it didn't).

    method toggle

    toggle: (isOpen?: boolean) => Promise<void>;

    • Toggle this sidenav. This is equivalent to calling open() when it's already opened, or close() when it's closed.

      Parameter isOpen

    class MdSidenavLayout

    class MdSidenavLayout implements AfterContentInit {}

    • component.

      This is the parent component to one or two s that validates the state internally and coordinate the backdrop and content styling.

    constructor

    constructor(_dir: Dir, _element: ElementRef, _renderer: Renderer);

      property end

      readonly end: MdSidenav;

        property start

        readonly start: MdSidenav;

          method ngAfterContentInit

          ngAfterContentInit: () => void;

          • TODO: internal

          class MdSidenavModule

          class MdSidenavModule {}

            method forRoot

            static forRoot: () => ModuleWithProviders;

              Package Files (2)

              Dependencies (0)

              No dependencies.

              Dev Dependencies (0)

              No dev dependencies.

              Peer Dependencies (1)

              Badge

              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@angular2-material/sidenav.

              • Markdown
                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@angular2-material/sidenav)
              • HTML
                <a href="https://www.jsdocs.io/package/@angular2-material/sidenav"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>