NgDocPlaygroundProperty · API

Playground property data

DeclarationTypeScript

export interface NgDocPlaygroundProperty { … }

Members

Properties 8
description?: `string \| undefined`	Commend for the property
group?: `string \| undefined`	The group the inspector lists the property under, from the playground's `controls`
inputName: `string`	The name of the input in the code (it can be different from property name)
isManual?: `boolean \| undefined`	Determines if the property is manually added by the user
label?: `string \| undefined`	The name shown in the inspector instead of `inputName`, from the playground's `controls`
options?: `(string \| NgDocPlaygroundOption)[] \| undefined`	List of possible options: the members of a union type as written in code (such as `'small'`, evaluated by the playground), plain values when `isManual` is set, or the name and value of an enum member
order?: `number \| undefined`	The position of the property in the inspector, from the playground's `controls`
type: `string`	Type of the property