NgDocContentController

Owns one body or header content source for one component instance. Provide it in the component's providers; it holds a pending task from each load until the processors accept the loaded HTML.

Decorators: @Injectable

DeclarationTypeScript

@Injectable()
export class NgDocContentController { … }

Members

Constructor

()

—

Signature

constructor(
	
): NgDocContentController;

Properties

error: WritableSignal<Error | undefined>

readonly

The load or processing error of the current source.

html: WritableSignal<string>

readonly

The loaded HTML.

settled: WritableSignal<boolean>

readonly

Whether the latest load of the current source has been rendered: its version was processed, or the load or its processing failed. False while a load or its processing is pending.

version: WritableSignal<number>

readonly

Increments whenever the HTML must be processed again.

Methods

(…): void

Loads the source and reloads it whenever the source reports a change. Connecting the connected source again does nothing.

Signature

connect(source: NgDocContentSource): void;

Parameters

Name	Type	Description
source	`NgDocContentSource`	The content source.

Returns

void

(): void

Cancels the current load and releases its pending task. Called on destroy.

Signature

destroy(): void;

Returns

void

(): void

Drops the current source and clears the HTML.

Signature

disconnect(): void;

Returns

void

(…): void

Accepts a processing pass. Only the pass of the current version counts.

Signature

processed(version: number): void;

Parameters

Name	Type	Description
version	`number`	The content version the pass rendered.

Returns

void

(…): void

Reports a failed processing pass. Only a failure of the current version counts.

Signature

processingFailed(failure: NgDocContentRenderFailure): void;

Parameters

Name	Type	Description
failure	`NgDocContentRenderFailure`	The version and the error.

Returns

void