NgDocOverlayService

Opens NgDoc overlays: a container component inside a CDK overlay.

It is provided in the root injector. A component can also list it in its providers, so the overlays it opens use that component's injector (the dropdown does).

Decorators: @Service

DeclarationTypeScript

@Service()
export class NgDocOverlayService { … }

Members

Methods

(…): FlexibleConnectedPositionStrategy

—

Signature

connectedPositionStrategy(origin: FlexibleConnectedPositionStrategyOrigin, positions: NgDocOverlayPosition[] | NgDocOverlayPosition): FlexibleConnectedPositionStrategy;

Parameters

Name	Type	Description
origin	`FlexibleConnectedPositionStrategyOrigin`
positions	`NgDocOverlayPosition[] \| NgDocOverlayPosition`

Returns

FlexibleConnectedPositionStrategy

(): GlobalPositionStrategy

—

Signature

globalPositionStrategy(): GlobalPositionStrategy;

Returns

GlobalPositionStrategy

(…): NgDocOverlayRef<R>

Opens an overlay.

Signature

open(content: NgDocContent, config: NgDocOverlayConfig, providers: StaticProvider[] = []): NgDocOverlayRef<R>;

Parameters

Name	Type	Description
content	`NgDocContent`	What the container renders: a string, a template or a component.
config	`NgDocOverlayConfig`	The overlay configuration, including the container component.
providers	`StaticProvider[]`	Extra providers for a component content; `NgDocOverlayRef` is always added.

Returns

NgDocOverlayRef<R> -

The handle of the opened overlay.

(): ScrollStrategyOptions

—

Signature

scrollStrategy(): ScrollStrategyOptions;

Returns

ScrollStrategyOptions

Symbol

Kind: Class
Decorators: @Service
Scope: @ng-doc/ui-kit

Edit this page