API Reference

---

API Reference / @dasch-ng/material-right-sheet / MatRightSheetContainer

Class: MatRightSheetContainer

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:62

Internal component that wraps user-provided bottom sheet content.

Docs-private

Extends

• CdkDialogContainer

Implements

• OnDestroy

Constructors

Constructor

new MatRightSheetContainer(): MatRightSheetContainer

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:78

Returns

MatRightSheetContainer

Overrides

CdkDialogContainer.constructor

Properties

_animationsDisabled

protected _animationsDisabled: boolean

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:64

---

_animationState

_animationState: "void" | "visible" | "hidden" = 'void'

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:67

The state of the bottom sheet animations.

---

_animationStateChanged

_animationStateChanged: EventEmitter<{ phase: "start" | "done"; toState: "visible" | "hidden"; }>

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:70

Emits whenever the state of the animation changes.

---

_ariaLabelledByQueue

_ariaLabelledByQueue: string[]

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:193

Queue of the IDs of the dialog's label element, based on their definition order. The first ID will be used as the aria-labelledby value. We use a queue here to handle the case where there are two or more titles in the DOM at a time and the first one is destroyed while the rest are present.

Inherited from

CdkDialogContainer._ariaLabelledByQueue

---

_attachedPortal

protected _attachedPortal: Portal<any> | null

Defined in: node_modules/@angular/cdk/types/_portal-directives-chunk.d.ts:111

The portal currently attached to the host.

Inherited from

CdkDialogContainer._attachedPortal

---

_changeDetectorRef

protected readonly _changeDetectorRef: ChangeDetectorRef

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:170

Inherited from

CdkDialogContainer._changeDetectorRef

---

_closeInteractionType

_closeInteractionType: FocusOrigin

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:186

Type of interaction that led to the dialog being closed. This is used to determine whether the focus style will be applied when returning focus to its original location after the dialog is closed.

Inherited from

CdkDialogContainer._closeInteractionType

---

_config

readonly _config: DialogConfig

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:165

Inherited from

CdkDialogContainer._config

---

_document

protected _document: Document

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:173

Inherited from

CdkDialogContainer._document

---

_elementRef

protected _elementRef: ElementRef<HTMLElement>

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:163

Inherited from

CdkDialogContainer._elementRef

---

_focusTrapFactory

protected _focusTrapFactory: FocusTrapFactory

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:164

Inherited from

CdkDialogContainer._focusTrapFactory

---

_focusTrapped

_focusTrapped: Observable<void>

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:176

Inherited from

CdkDialogContainer._focusTrapped

---

_ngZone

protected _ngZone: NgZone

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:167

Inherited from

CdkDialogContainer._ngZone

---

_portalOutlet

_portalOutlet: CdkPortalOutlet

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:175

The portal outlet inside of this container into which the dialog content will be loaded.

Inherited from

CdkDialogContainer._portalOutlet

---

attachDomPortal

attachDomPortal: (portal) => void

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:221

Attaches a DOM portal to the dialog container.

Parameters

portal

DomPortal

Portal to be attached.

Returns

void

Deprecated

To be turned into a method.

Breaking-change

10.0.0

Inherited from

CdkDialogContainer.attachDomPortal

---

ɵcmp

static ɵcmp: unknown

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:249

Inherited from

CdkDialogContainer.ɵcmp

---

ɵfac

static ɵfac: ɵɵFactoryDeclaration<CdkDialogContainer<any>, never>

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:248

Inherited from

CdkDialogContainer.ɵfac

Methods

_addAriaLabelledBy()

_addAriaLabelledBy(id): void

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:196

Parameters

id

string

Returns

void

Inherited from

CdkDialogContainer._addAriaLabelledBy

---

_captureInitialFocus()

protected _captureInitialFocus(): void

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:203

Can be used by child classes to customize the initial focus capturing behavior (e.g. if it's tied to an animation).

Returns

void

Inherited from

CdkDialogContainer._captureInitialFocus

---

_contentAttached()

protected _contentAttached(): void

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:198

Returns

void

Inherited from

CdkDialogContainer._contentAttached

---

_handleAnimationEvent()

protected _handleAnimationEvent(isStart, animationName): void

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:139

Parameters

isStart

boolean

animationName

string

Returns

void

---

_recaptureFocus()

_recaptureFocus(): void

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:223

Captures focus if it isn't already inside the dialog.

Returns

void

Inherited from

CdkDialogContainer._recaptureFocus

---

_removeAriaLabelledBy()

_removeAriaLabelledBy(id): void

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:197

Parameters

id

string

Returns

void

Inherited from

CdkDialogContainer._removeAriaLabelledBy

---

_trapFocus()

protected _trapFocus(): void

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:130

Moves the focus inside the focus trap. When autoFocus is not set to 'dialog', if focus cannot be moved then focus will go to the dialog container.

Returns

void

Overrides

CdkDialogContainer._trapFocus

---

attach()

Call Signature

attach<T>(portal): ComponentRef<T>

Defined in: node_modules/@angular/cdk/types/_portal-directives-chunk.d.ts:118

Attaches a portal to this outlet.

Type Parameters

T

T

Parameters

portal

ComponentPortal<T>

Returns

ComponentRef<T>

Inherited from

CdkDialogContainer.attach

Call Signature

attach<T>(portal): EmbeddedViewRef<T>

Defined in: node_modules/@angular/cdk/types/_portal-directives-chunk.d.ts:119

Type Parameters

T

T

Parameters

portal

TemplatePortal<T>

Returns

EmbeddedViewRef<T>

Inherited from

CdkDialogContainer.attach

Call Signature

attach(portal): any

Defined in: node_modules/@angular/cdk/types/_portal-directives-chunk.d.ts:120

Parameters

portal

any

Returns

any

Inherited from

CdkDialogContainer.attach

---

attachComponentPortal()

attachComponentPortal<T>(portal): ComponentRef<T>

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:209

Attach a ComponentPortal as content to this dialog container.

Type Parameters

T

T

Parameters

portal

ComponentPortal<T>

Portal to be attached as the dialog content.

Returns

ComponentRef<T>

Inherited from

CdkDialogContainer.attachComponentPortal

---

attachTemplatePortal()

attachTemplatePortal<T>(portal): EmbeddedViewRef<T>

Defined in: node_modules/@angular/cdk/types/dialog.d.ts:214

Attach a TemplatePortal as content to this dialog container.

Type Parameters

T

T

Parameters

portal

TemplatePortal<T>

Portal to be attached as the dialog content.

Returns

EmbeddedViewRef<T>

Inherited from

CdkDialogContainer.attachTemplatePortal

---

detach()

detach(): void

Defined in: node_modules/@angular/cdk/types/_portal-directives-chunk.d.ts:125

Detaches a previously attached portal.

Returns

void

Inherited from

CdkDialogContainer.detach

---

dispose()

dispose(): void

Defined in: node_modules/@angular/cdk/types/_portal-directives-chunk.d.ts:127

Permanently dispose of this portal host.

Returns

void

Inherited from

CdkDialogContainer.dispose

---

enter()

enter(): void

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:94

Begin animation of bottom sheet entrance into view.

Returns

void

---

exit()

exit(): void

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:106

Begin animation of the bottom sheet exiting from view.

Returns

void

---

hasAttached()

hasAttached(): boolean

Defined in: node_modules/@angular/cdk/types/_portal-directives-chunk.d.ts:117

Whether this host has an attached portal.

Returns

boolean

Inherited from

CdkDialogContainer.hasAttached

---

ngOnDestroy()

ngOnDestroy(): void

Defined in: libs/material/right-sheet/src/lib/right-sheet.container.ts:117

Returns

void

Implementation of

OnDestroy.ngOnDestroy

Overrides

CdkDialogContainer.ngOnDestroy

---

setDisposeFn()

setDisposeFn(fn): void

Defined in: node_modules/@angular/cdk/types/_portal-directives-chunk.d.ts:129

Parameters

fn

() => void

Returns

void

Docs-private

Inherited from

CdkDialogContainer.setDisposeFn