Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/core / Interface

NgDocPlaygroundOptions

List of possible playground options

Properties

NameTypeDescription
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.

selectors
string | string[] | undefined

List of selectors that will be used to render the playground (renders all selectors by default)