Skip to content
@ng-doc/app / Class

NgDocPageProcessorComponent

Renders HTML into its host element and replaces the nodes that the page processors (NG_DOC_PAGE_PROCESSOR, NG_DOC_PAGE_CUSTOM_PROCESSOR) select with Angular components.

Each change of the HTML or of contentVersion destroys the components of the previous pass and schedules a new pass for the next microtask, after the HTML is in the DOM. A pass that a newer change superseded, or that ends after the component is destroyed, emits nothing.

Decorators
@Component
Selectors
[ngDocPageProcessor]
DeclarationTypeScript
@Component({ … })
export class NgDocPageProcessorComponent { … }

Members

Constructor

1
()
—

Properties

13
afterRender: OutputEmitterRef<void>
readonly output()

Emits after a pass has created its components and rendered them.

applicationRef: ApplicationRef
protectedreadonly
—
contentProcessed: OutputEmitterRef<number>
readonly output()

Emits the version of each pass that completed.

contentVersion: InputSignal<number>
readonly input()

Version of the HTML. A new version processes the HTML again, even when it is unchanged.

customProcessors: NgDocPageProcessor<unknown>[]
—
elementRef: ElementRef<HTMLElement>
protectedreadonly
—
errorHandler: ErrorHandler
protectedreadonly
—
readonly input()

The HTML to render and process.

injector: Injector
protectedreadonly
—
readonly output()

Emits the version and the error of a pass that a processor failed. Without a listener, the error goes to the ErrorHandler instead.

processors: NgDocPageProcessor<unknown>[]
—
renderer: Renderer2
protectedreadonly
—
viewContainerRef: ViewContainerRef
protectedreadonly
—
Symbol
Kind
Class
Decorators
@Component
Selectors
[ngDocPageProcessor]
Scope
@ng-doc/app
Edit this page