NgDocContentScrollIntent

Captures the public initial-navigation facts that are unavailable after component activation.

DeclarationTypeScript

@Service()
export class NgDocContentScrollIntent { … }

Members

()

—

Signature

constructor(
	
): NgDocContentScrollIntent;

currentIntent: Signal<NgDocInitialContentScrollIntent | undefined>

readonly

The pending initial intent as a signal, the same value subscribe() listeners receive.

(…): void

Consumes the current fallback after its page has either replayed or explicitly yielded it.

Signature

settle(navigationId: number): void;

Parameters

Name	Type	Description
navigationId	`number`	The navigation of the intent to consume.

Returns

void

(): void

Starts following router events. Does nothing on the server or when already started.

Signature

start(): void;

Returns

void

(…): () => void

Calls the listener with every change of the intent, and at once with the pending one.

Signature

subscribe(listener: (intent: NgDocInitialContentScrollIntent | undefined) => void): () => void;

Parameters

Name	Type	Description
listener	`(intent: NgDocInitialContentScrollIntent \| undefined) => void`	Receives the intent, or `undefined` once it is consumed or cancelled.

Returns

() => void -

A function that removes the listener.

Symbol