NgDocPlaygroundDemoComponent

One demo of a playground: it creates the generated playground class of its selector (or pipe), passes it the form's values and shows the code of the current state.

Decorators: @Component
Selectors: ng-doc-playground-demo
Generic types: T
Implements: OnChangesOnDestroy

DeclarationTypeScript

@Component({ … })
export class NgDocPlaygroundDemoComponent<T extends NgDocPlaygroundProperties = NgDocPlaygroundProperties>
  implements OnChanges, OnDestroy { … }

Members

Properties

code: WritableSignal<string>

protectedreadonly

—

configuration: InputSignal<NgDocPlaygroundConfig | undefined>

readonly input()

The playground configuration, extended by the action's options.

demoOutlet: Signal<ViewContainerRef | undefined>

readonly

Where the playground class is created.

destroyRef: DestroyRef

protectedreadonly

—

expanded: InputSignal<boolean>

readonly input()

Whether the code of the demo is shown.

form: InputSignal<FormGroup<NgDocPlaygroundForm> | undefined>

readonly input()

The values of the inputs and content slots.

id: InputSignal<string>

readonly input()

The name of the playground in the page configuration.

injector: Injector

protectedreadonly

—

pipeName: InputSignal<string>

readonly input()

The name of the pipe, when the target is a pipe.

playgroundDemo?: typeof NgDocBasePlayground | undefined

The generated playground class of this demo's selector or pipe.

properties: InputSignal<T | undefined>

readonly input()

The inputs of the target.

recreateDemo: InputSignal<boolean>

readonly input()

Whether the demo is created again each time a value changes.

selector: InputSignal<string>

readonly input()

The selector of the target this demo renders.

Methods

(…): Promise<void>

async implements OnChanges

—

Signature

async ngOnChanges({ form, id }: { [propName: string]: SimpleChange<any>; }): Promise<void>;

Parameters

Name	Type	Description
{ form, id }	`{ [propName: string]: SimpleChange<any>; }`

Returns

Promise<void>

(): void

implements OnDestroy

—

Signature

ngOnDestroy(): void;

Returns

void