CngxOverlay

InjectablePrimaryv0.1.0WCAG AA

projects/ui/overlay/overlay.service.ts

GitHub

Info
API

Import#

import { CngxOverlay } from '@cngx/ui/overlay'

Description#

Thin service over CDK Overlay that returns a typed CngxOverlayRef.

Must be provided via provideOverlay() in application or component providers.

// app.config.ts
provideOverlay()

// usage
const ref = overlayService.open(MyComponent, { hasBackdrop: true });
ref.afterClosed$.subscribe(result => console.log(result));

Index#

Methods

open

Methods#

open#CngxOverlayRef

open(component: Type, config: CngxOverlayConfig)

Opens component in a CDK overlay panel and returns a typed ref.

Defaults to a centered, backdropped panel that closes on Escape or a backdrop click; pass disableClose to opt out. Focus returns to the element that was focused at open time. Merge config to override position strategy, scroll strategy, or any other CDK OverlayConfig option.

@paramcomponentType

Component class to attach as a portal.

@paramconfigCngxOverlayConfig= {}

Overlay configuration overrides (CDK options + disableClose).