Type alias ConfigMetadataAlpha

ConfigMetadata: {
    configComponent?: {
        name: string;
        props?: Record<string, unknown>;
    };
    description?: string;
    icon?: string | Icon;
    tags?: string[];
    title?: string;
}

Metadata for a configured resource

A resource can be anything that is registered in the client, e.g. web component or command

See

Type declaration

  • Optional configComponent?: {
        name: string;
        props?: Record<string, unknown>;
    }

    Component that can be used to configure the given resource

    • name: string

      Tag name of the web component

    • Optional props?: Record<string, unknown>

      Properties to initialize the component with

  • Optional description?: string

    Description of the resource

  • Optional icon?: string | Icon

    Icon representing the resource

  • Optional tags?: string[]

    List of tags describing the resource. A client may use the tags to determine if a resource is suitable for a given context

  • Optional title?: string

    Human readable name for the resource

Settings

Member Visibility

Theme