Skip to content
@ng-doc/ui-kit / Interface

NgDocOverlayHost

No documentation has been provided.

Extends
NgDocOverlayProperties
DeclarationTypeScript
export interface NgDocOverlayHost extends NgDocOverlayProperties { … }

Members

Properties

17
borderOffset?: number | undefined
inherited from NgDocOverlayProperties
—
closeIfInnerClick?: boolean | undefined
inherited from NgDocOverlayProperties
—
closeIfOutsideClick?: boolean | undefined
inherited from NgDocOverlayProperties
—
contactBorder?: boolean | undefined
inherited from NgDocOverlayProperties
—
direction?: Directionality | Direction | undefined
inherited from NgDocOverlayProperties
—
disposeOnNavigation?: OverlayDisposeOnNavigation | undefined
inherited from NgDocOverlayProperties

Closes the overlay when the user navigates. It is passed to the CDK overlay unchanged, so it has the type of OverlayConfig.disposeOnNavigation of the installed @angular/cdk: boolean up to 22.1, and boolean | 'url-change' | 'pop-state' from 22.2, where true means 'pop-state' (only the browser's back and forward buttons) and 'url-change' closes it on any URL change.

The type follows the CDK so that NgDocOverlayConfig, which extends both this interface and OverlayConfig, compiles with every supported CDK version.

disposeOnRouteNavigation?: boolean | undefined
inherited from NgDocOverlayProperties
—
height?: string | number | undefined
inherited from NgDocOverlayProperties
—
maxHeight?: string | number | undefined
inherited from NgDocOverlayProperties
—
maxWidth?: string | number | undefined
inherited from NgDocOverlayProperties
—
minHeight?: string | number | undefined
inherited from NgDocOverlayProperties
—
minWidth?: string | number | undefined
inherited from NgDocOverlayProperties
—
origin?: FlexibleConnectedPositionStrategyOrigin | undefined
inherited from NgDocOverlayProperties
—
panelClass?: string | string[] | undefined
inherited from NgDocOverlayProperties
—
positions?: NgDocOverlayPosition[] | NgDocOverlayPosition | undefined
inherited from NgDocOverlayProperties
—
width?: string | number | undefined
inherited from NgDocOverlayProperties
—
withPointer?: boolean | undefined
inherited from NgDocOverlayProperties
—
Symbol
Kind
Interface
Extends
NgDocOverlayProperties
Scope
@ng-doc/ui-kit
Edit this page