NgDocPaneComponent

Two panes side by side with a resizer between them. Drag the resizer, click it or use the arrow keys on it to reveal the back pane; Enter or Space toggles it.

Decorators: @Component
Selectors: ng-doc-pane

DeclarationTypeScript

@Component({ … })
export class NgDocPaneComponent { … }

Members

Constructor

()

—

Signature

constructor(
	
): NgDocPaneComponent;

Properties

dragging: WritableSignal<boolean>

protectedreadonly

Whether the resizer is being dragged.

expanded: InputSignal<boolean>

readonly input()

Whether the back pane is revealed.

resizer: Signal<ElementRef<HTMLElement>>

readonly

The resizer between the panes.

valueNow: WritableSignal<number>

protectedreadonly

Share of the pane the back pane takes, in percent, for assistive technology.

width: WritableSignal<string>

readonly

Width of the back pane, as a CSS length.

Methods

(…): void

protected

Moves the resizer with the keyboard.

Signature

protected onKeydown(event: KeyboardEvent): void;

Parameters

Name	Type	Description
event	`KeyboardEvent`	The key press on the resizer.

Returns

void

(): void

Reveals the back pane when it is mostly hidden, and hides it otherwise.

Signature

toggle(): void;

Returns

void