@synergy-design-system/angular/components/drawer/index.d.ts

Angular wrappers for the Synergy Design System

import * as i0 from '@angular/core';
import { ElementRef, NgZone, EventEmitter } from '@angular/core';
import { SynDrawer, SynShowEvent, SynAfterShowEvent, SynHideEvent, SynAfterHideEvent, SynInitialFocusEvent, SynRequestCloseEvent } from '@synergy-design-system/components';
export { SynAfterHideEvent, SynAfterShowEvent, SynHideEvent, SynInitialFocusEvent, SynRequestCloseEvent, SynShowEvent } from '@synergy-design-system/components';

/**
 * @summary Drawers slide in from a container to expose additional options and information.
 * @documentation https://synergy-design-system.github.io/?path=/docs/components-syn-drawer--docs
 * @status stable
 * @since 2.0
 *
 * @dependency syn-icon-button
 *
 * @slot - The drawer's main content.
 * @slot label - The drawer's label. Alternatively, you can use the `label` attribute.
 * @slot header-actions - Optional actions to add to the header. Works best with `<syn-icon-button>`.
 * @slot footer - The drawer's footer, usually one or more buttons representing various options.
 *
 * @event syn-show - Emitted when the drawer opens.
 * @event syn-after-show - Emitted after the drawer opens and all animations are complete.
 * @event syn-hide - Emitted when the drawer closes.
 * @event syn-after-hide - Emitted after the drawer closes and all animations are complete.
 * @event syn-initial-focus - Emitted when the drawer opens and is ready to receive focus. Calling
 *   `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.
 * @event {{ source: 'close-button' | 'keyboard' | 'overlay' }} syn-request-close - Emitted when the user attempts to
 *   close the drawer by clicking the close button, clicking the overlay, or pressing escape. Calling
 *   `event.preventDefault()` will keep the drawer open. Avoid using this unless closing the drawer will result in
 *   destructive behavior such as data loss.
 *
 * @csspart base - The component's base wrapper.
 * @csspart overlay - The overlay that covers the screen behind the drawer.
 * @csspart panel - The drawer's panel (where the drawer and its content are rendered).
 * @csspart header - The drawer's header. This element wraps the title and header actions.
 * @csspart header-actions - Optional actions to add to the header. Works best with `<syn-icon-button>`.
 * @csspart title - The drawer's title.
 * @csspart close-button - The close button, an `<syn-icon-button>`.
 * @csspart close-button__base - The close button's exported `base` part.
 * @csspart body - The drawer's body.
 * @csspart footer - The drawer's footer.
 *
 * @cssproperty --size - The preferred size of the drawer. This will be applied to the drawer's width or height
 *   depending on its `placement`. Note that the drawer will shrink to accommodate smaller screens.
 * @cssproperty --header-spacing - The amount of padding to use for the header.
 * @cssproperty --body-spacing - The amount of padding to use for the body.
 * @cssproperty --footer-spacing - The amount of padding to use for the footer.
 *
 * @animation drawer.showTop - The animation to use when showing a drawer with `top` placement.
 * @animation drawer.showEnd - The animation to use when showing a drawer with `end` placement.
 * @animation drawer.showBottom - The animation to use when showing a drawer with `bottom` placement.
 * @animation drawer.showStart - The animation to use when showing a drawer with `start` placement.
 * @animation drawer.hideTop - The animation to use when hiding a drawer with `top` placement.
 * @animation drawer.hideEnd - The animation to use when hiding a drawer with `end` placement.
 * @animation drawer.hideBottom - The animation to use when hiding a drawer with `bottom` placement.
 * @animation drawer.hideStart - The animation to use when hiding a drawer with `start` placement.
 * @animation drawer.denyClose - The animation to use when a request to close the drawer is denied.
 * @animation drawer.overlay.show - The animation to use when showing the drawer's overlay.
 * @animation drawer.overlay.hide - The animation to use when hiding the drawer's overlay.
 *
 * @property modal - Exposes the internal modal utility that controls focus trapping. To temporarily disable focus
 *   trapping and allow third-party modals spawned from an active Synergy modal, call `modal.activateExternal()` when
 *   the third-party modal opens. Upon closing, call `modal.deactivateExternal()` to restore Synergy's focus trapping.
 */
declare class SynDrawerComponent {
    nativeElement: SynDrawer;
    private _ngZone;
    constructor(e: ElementRef, ngZone: NgZone);
    /**
  * Indicates whether or not the drawer is open.
  * You can toggle this attribute to show and hide the drawer, or you can
  use the `show()` and `hide()` methods and this attribute will reflect the drawer's open state.
   */
    set open(v: '' | SynDrawer['open']);
    get open(): SynDrawer['open'];
    /**
  * The drawer's label as displayed in the header.
  * You should always include a relevant label even when using
  `no-header`, as it is required for proper accessibility.
  * If you need to display HTML, use the `label` slot instead.
   */
    set label(v: SynDrawer['label']);
    get label(): SynDrawer['label'];
    /**
     * The direction from which the drawer will open.
     */
    set placement(v: SynDrawer['placement']);
    get placement(): SynDrawer['placement'];
    /**
  * By default, the drawer slides out of its containing block (usually the viewport).
  * To make the drawer slide out of
  its parent element, set this attribute and add `position: relative` to the parent.
   */
    set contained(v: '' | SynDrawer['contained']);
    get contained(): SynDrawer['contained'];
    /**
  * Removes the header.
  * This will also remove the default close button, so please ensure you provide an easy,
  accessible way for users to dismiss the drawer.
   */
    set noHeader(v: '' | SynDrawer['noHeader']);
    get noHeader(): SynDrawer['noHeader'];
    /**
     * Emitted when the drawer opens.
     */
    synShowEvent: EventEmitter<SynShowEvent>;
    /**
     * Emitted after the drawer opens and all animations are complete.
     */
    synAfterShowEvent: EventEmitter<SynAfterShowEvent>;
    /**
     * Emitted when the drawer closes.
     */
    synHideEvent: EventEmitter<SynHideEvent>;
    /**
     * Emitted after the drawer closes and all animations are complete.
     */
    synAfterHideEvent: EventEmitter<SynAfterHideEvent>;
    /**
     * Emitted when the drawer opens and is ready to receive focus.
     * Calling `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.
     */
    synInitialFocusEvent: EventEmitter<SynInitialFocusEvent>;
    /**
     * Emitted when the user attempts to close the drawer by clicking the close button, clicking the overlay, or pressing escape.
     * Calling `event.preventDefault()` will keep the drawer open.
     * Avoid using this unless closing the drawer will result in destructive behavior such as data loss.
     */
    synRequestCloseEvent: EventEmitter<SynRequestCloseEvent>;
    static ɵfac: i0.ɵɵFactoryDeclaration<SynDrawerComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<SynDrawerComponent, "syn-drawer", never, { "open": { "alias": "open"; "required": false; }; "label": { "alias": "label"; "required": false; }; "placement": { "alias": "placement"; "required": false; }; "contained": { "alias": "contained"; "required": false; }; "noHeader": { "alias": "noHeader"; "required": false; }; }, { "synShowEvent": "synShowEvent"; "synAfterShowEvent": "synAfterShowEvent"; "synHideEvent": "synHideEvent"; "synAfterHideEvent": "synAfterHideEvent"; "synInitialFocusEvent": "synInitialFocusEvent"; "synRequestCloseEvent": "synRequestCloseEvent"; }, never, ["*"], true, never>;
}

export { SynDrawerComponent };