NgDocOverlayRef

A handle to an opened overlay (a dropdown, a tooltip or a dialog).

NgDocOverlayService.open()() creates it, and the overlay content can inject it to close itself.

Generic types: T

DeclarationTypeScript

export class NgDocOverlayRef<T = unknown> { … }

Members

Constructor

(…)

—

Signature

constructor(
	readonly overlayRef: OverlayRef, 
	private readonly overlayConfig: NgDocOverlayConfig, 
	readonly overlayContainer: NgDocOverlayContainer, 
	private readonly injector: Injector, 
	private readonly router?: Router | undefined, 
	private readonly location?: Location | undefined
): NgDocOverlayRef<T>;

Parameters

Name	Type	Description
readonly overlayRef	`OverlayRef`	The CDK overlay that hosts the container.
readonly overlayConfig	`NgDocOverlayConfig`	The configuration the overlay was opened with.
readonly overlayContainer	`NgDocOverlayContainer`	The container component rendered inside the overlay.
readonly injector	`Injector`	Injector the overlay uses to follow application renders. It must be able to inject NgZone; the component or environment injector of the opener is enough.
readonly router	`Router \| undefined`	Closes the overlay after a navigation when `disposeOnRouteNavigation` is set.
readonly location	`Location \| undefined`	Closes the overlay on a location change when `disposeOnNavigation` is set.

Accessors

get hasAttached: boolean

Overlay has attached

get isFocused: boolean

Overlay has focus

get isOpened: boolean

Overlay is opened

Methods

(): Observable<T | null>

—

Signature

afterClose(): Observable<T | null>;

Returns

Observable<T | null>

(): Observable<void>

—

Signature

afterOpen(): Observable<void>;

Returns

Observable<void>

(): Observable<T | null>

—

Signature

beforeClose(): Observable<T | null>;

Returns

Observable<T | null>

(): Observable<void>

—

Signature

beforeOpen(): Observable<void>;

Returns

Observable<void>

(…): void

Closes overlay

Signature

close(closeResult?: T | undefined): void;

Parameters

Name	Type	Description
closeResult	`T \| undefined`	The value `beforeClose()` and `afterClose()` emit.

Returns

void

(): void

Sets focus to overlay

Signature

focus(): void;

Returns

void

(): Observable<ConnectedOverlayPositionChange>

—

Signature

positionChanges(): Observable<ConnectedOverlayPositionChange>;

Returns

Observable<ConnectedOverlayPositionChange>

Symbol

Kind: Class
Generic types: T
Scope: @ng-doc/ui-kit

Edit this page