Skip to content
@ng-doc/core / Interface

NgDocPlaygroundConfig

Playground configuration

Extends
NgDocPlaygroundOptions
DeclarationTypeScript
export interface NgDocPlaygroundConfig extends NgDocPlaygroundOptions { … }

Members

Properties

13
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?: Record<string, unknown> | undefined
inherited from NgDocPlaygroundOptions

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

defaults?: Record<string, unknown> | undefined
inherited from NgDocPlaygroundOptions

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
inherited from NgDocPlaygroundOptions

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

hiddenInputs?: string[] | undefined
inherited from NgDocPlaygroundOptions

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

hideSidePanel?: boolean | undefined
inherited from NgDocPlaygroundOptions

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

inputs?: Record<string, unknown> | undefined
inherited from NgDocPlaygroundOptions

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
inherited from NgDocPlaygroundOptions

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
inherited from NgDocPlaygroundOptions

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
inherited from NgDocPlaygroundOptions

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

Symbol
Kind
Interface
Extends
NgDocPlaygroundOptions
Scope
@ng-doc/core
Edit this page