NgDocPlaygroundComponent

A playground: an inspector with a control per input and content slot of its target, and a demo per selector (or the pipe) rendered with the chosen values.

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

DeclarationTypeScript

@Component({ … })
export class NgDocPlaygroundComponent<T extends NgDocPlaygroundProperties = NgDocPlaygroundProperties>
  implements AfterViewInit { … }

Members

Properties 9
configuration: `Signal<NgDocPlaygroundConfig>` readonly	The playground configuration of the page, extended by the options.
defaultValues: `WritableSignal<Record<string, unknown> \| undefined>` readonly	The default values of the target's inputs, reported by the first demo.
formGroup: `WritableSignal<FormGroup<NgDocPlaygroundForm> \| undefined>` readonly	The values of the inputs and content slots.
id: `InputSignal<string>` readonly `input()`required	The name of the playground in the page configuration.
options: `InputSignal<NgDocPlaygroundOptions>` readonly `input()`	Options of the playground action; they extend the playground configuration.
pipeName: `InputSignal<string>` readonly `input()`	The name of the pipe, when the target is a pipe.
properties: `InputSignal<T \| undefined>` readonly `input()`	The inputs of the target.
recreateDemo: `WritableSignal<boolean>` readonly	Whether the demo is created again each time a value changes.
selectors: `InputSignal<string[]>` readonly `input()`	The selectors of the target to render a demo for.
Methods 3
(): `boolean` protected	—
Signature `protected isDefaultState(): boolean;` Returns `boolean`
(): `void` implements `AfterViewInit`	—
Signature `ngAfterViewInit(): void;` Returns `void`
(): `void`	Sets every input and content slot back to its default value.
Signature `resetForm(): void;` Returns `void`

Members

Properties

Methods