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

NgDocPlaygroundConfig

Playground configuration

Properties

NameTypeDescription
content
Record<string, NgDocPlaygroundContent> | undefined

Dynamic content that you can provide to create content toggle button The object key should be used in the playground's template to define the place where the current content should be rendered (e.g. {{content.providedKey}})

controls
Record<string, string | NgDocPlaygroundControlConfig> | undefined

List of playground controls that will be used to render the side panel. NgDoc will try to guess playground controls from the component inputs, but you can override them here or add new ones.

Object key is the class property name, and value is a type of the control. If your input name and property name are different, you can provide NgDocPlaygroundControlConfig object instead of a string to specify the input alias.

data
inherited from NgDocPlaygroundOptions
Record<string, unknown> | undefined

Custom data that you can use in the templates (e.g. {{data.providedProperty}})

defaults
inherited from NgDocPlaygroundOptions
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
inherited from NgDocPlaygroundOptions
boolean | undefined

Defines whether the playground should be expanded (false by default)

hiddenInputs
inherited from NgDocPlaygroundOptions
string[] | undefined

List of inputs that will be hidden in the playground (e.g. ['myInputName'])

hideSidePanel
inherited from NgDocPlaygroundOptions
boolean | undefined

Specifies whether the side panel should be hidden (false by default)

inputs
inherited from NgDocPlaygroundOptions
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
inherited from NgDocPlaygroundOptions
string | string[] | undefined

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

target
any

Component or directive that will be used for the playground

template
string

Template that should be used to render playground