Interface Prop

Interface representing a property definition.

This interface defines the structure for a property, including its name, type, default value, and other optional settings.

interface Prop {
    comments?: string[];
    default?: any;
    deprecated?: boolean;
    group?: string;
    groupCollapsed?: boolean;
    groupPriority?: number;
    isConstructorProp?: boolean;
    name: string;
    optional?: boolean;
    order?: number;
    priority?: number;
    readonly?: boolean;
    showInUI?: boolean;
    type: Type;
    values?: Values[];
}

Properties

comments? default? deprecated? group? groupCollapsed? groupPriority? isConstructorProp? name optional? order? priority? readonly? showInUI? type values?

Properties

Optionalcomments

comments?: string[]

Optionaldefault

default?: any

Optionaldeprecated

deprecated?: boolean

Optionalgroup

group?: string

OptionalgroupCollapsed

groupCollapsed?: boolean

OptionalgroupPriority

groupPriority?: number

OptionalisConstructorProp

isConstructorProp?: boolean

name

name: string

Optionaloptional

optional?: boolean

Optionalorder

order?: number

Optionalpriority

priority?: number

Optionalreadonly

readonly?: boolean

OptionalshowInUI

showInUI?: boolean

type

type: Type

Optionalvalues

values?: Values[]

Settings

Member Visibility

On This Page

commentsdefaultdeprecatedgroupgroupCollapsedgroupPriorityisConstructorPropnameoptionalorderpriorityreadonlyshowInUItypevalues