NgDocPlaygroundConfig
Playground configuration
- Extends
NgDocPlaygroundOptions
export interface NgDocPlaygroundConfig extends NgDocPlaygroundOptions { … }Members
Properties13 | |
content?: Record<string, | 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. |
controls?: Record<string, string | | 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 |
data?: Record<string, unknown> | undefined | Custom data that you can use in the templates (e.g. |
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) |
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: |
recreate?: "always" | boolean | undefined | Whether the demo is created again each time an input changes, for components that read an input only once. |
selectors?: 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 |