NgDocPlaygroundControlConfig · API

Playground control configuration

DeclarationTypeScript

export interface NgDocPlaygroundControlConfig { … }

Members

Properties 7
alias?: `string \| undefined`	Input alias that will be used to set the input value (e.g. `myInputAlias`)
description?: `string \| undefined`	Input description that will be used to display the tooltip on the playground control
group?: `string \| undefined`	The group of the input in the inspector: inputs of the same group are listed together under its name, after the inputs without a group. New engine only.
label?: `string \| undefined`	The name shown for the input in the inspector, instead of the input's name (e.g. `Primary color`). New engine only.
options?: `string[] \| undefined`	List of possible options, it can be list of Type Alias items
order?: `number \| undefined`	The position of the input in the inspector, lowest first, and its group's position among the groups. Inputs with an `order` come before the others. New engine only.
type?: `string \| undefined`	Input type that will be used to display the playground control (e.g. `string`, `number`, `boolean`, `MyOwnType`). Leave it out to keep the control NgDoc chose for an input of the target and change only how its row is shown: its label, group, order or description. New engine only.