Skip to content
@ng-doc/app / Class

NgDocPlaygroundHostComponent

Shows one target of a playground on a page of the demo application, for an isolated playground: the generated playground class of the route's playground and target, without the inspector, which stays on the documentation page. The state comes from the URL fragment, and a new fragment applies a new state without a reload (the documentation page replaces it with location.replace). The page tells the documentation page, with postMessage, the target's default input values once it exists, each state it applied, and what failed.

Like the demo host, it skips hydration: the server renders the target with its defaults, and the browser renders it again with the fragment's state, which only the browser has.

Decorators
@Component
Selectors
ng-doc-playground-host
Implements
ɵNgDocPlaygroundContainer
DeclarationTypeScript
@Component({ … })
export class NgDocPlaygroundHostComponent
  implements ɵNgDocPlaygroundContainer { … }

Members

Constructor

1
()
—

Properties

4
defaultValues: WritableSignal<Record<string, unknown> | undefined>
readonly implements ɵNgDocPlaygroundContainer

The default values of the target's inputs, reported by the generated class.

missing: boolean
protectedreadonly

Whether the route names a playground or a target the page doesn't have.

properties: WritableSignal<Readonly<Record<string, unknown>> | undefined>
readonly implements ɵNgDocPlaygroundContainer

The target's inputs, by name, from the state: a pipe's parameters are positional.

protectedreadonly
—
Symbol
Kind
Class
Decorators
@Component
Selectors
ng-doc-playground-host
Implements
ɵNgDocPlaygroundContainer
Scope
@ng-doc/app
Edit this page