Interface ComponentInfo

Interface representing information about a component.

This interface defines the structure for specifying details about a component, including its name, file location, type, properties, and other attributes.

interface ComponentInfo {
    allowedChildren: string[];
    allowedParents?: string[];
    comments?: string[];
    constructorProps: {
        [id: string]: Prop;
    };
    defaultChildren?: DefaultChild[];
    deprecated?: boolean;
    file: string;
    group?: string;
    icon?: string;
    isDefault?: boolean;
    name: string;
    props: {
        [id: string]: Prop;
    };
    streams: StreamInfo[];
    streamsObjects: {
        [id: string]: string;
    };
    tags: string[];
    type: ComponentInfoType;
}

Properties

allowedChildren allowedParents? comments? constructorProps defaultChildren? deprecated? file group? icon? isDefault? name props streams streamsObjects tags type

Properties

allowedChildren

allowedChildren: string[]

OptionalallowedParents

allowedParents?: string[]

Optionalcomments

comments?: string[]

constructorProps

constructorProps: {
    [id: string]: Prop;
}

OptionaldefaultChildren

defaultChildren?: DefaultChild[]

Optionaldeprecated

deprecated?: boolean

file

file: string

Optionalgroup

group?: string

Optionalicon

icon?: string

OptionalisDefault

isDefault?: boolean

name

name: string

props

props: {
    [id: string]: Prop;
}

streams

streams: StreamInfo[]

streamsObjects

streamsObjects: {
    [id: string]: string;
}

tags

tags: string[]

type

type: ComponentInfoType

Settings

Member Visibility

On This Page

allowedChildrenallowedParentscommentsconstructorPropsdefaultChildrendeprecatedfilegroupiconisDefaultnamepropsstreamsstreamsObjectstagstype