NgDocPlaygroundOptions · API

List of possible playground options

DeclarationTypeScript

export interface NgDocPlaygroundOptions { … }

Members

Properties 9
data?: `Record<string, unknown> \| undefined`	Custom data that you can use in the templates (e.g. `{{data.providedProperty}}`)
defaults?: `Record<string, unknown> \| undefined`	Specifies default values for the playground inputs that will be used for the side panel instead of default values from the component. These values don't override default values of the playground component they will be used only for initialization and "Reset" button in the side panel.
expanded?: `boolean \| undefined`	Defines whether the playground should be expanded (false by default)
hiddenInputs?: `string[] \| undefined`	List of inputs that will be hidden in the playground (e.g. `['myInputName']`)
hideSidePanel?: `boolean \| undefined`	Specifies whether the side panel should be hidden (false by default)
inputs?: `Record<string, unknown> \| undefined`	Specifies input values for the playground that will be set to playground component. These values will be used only once, when the playground is rendered. If user resets the playground, these values will be overridden by default values.
inspectorPosition?: `"bottom" \| "right" \| undefined`	Where the inspector (the side panel with the controls) goes: `'right'` of the demos (the default), or `'bottom'`, below them, so the demos get the full width. Playgrounds narrower than 640px always show it below.
recreate?: `"always" \| boolean \| undefined`	Whether the demo is created again each time an input changes, for components that read an input only once. `true` starts with the "Recreate" setting on, and the reader can turn it off; `'always'` keeps it on and hides the setting. Off by default.
selectors?: `string \| string[] \| undefined`	List of selectors that will be used to render the playground (renders all selectors by default)

Members

Properties