Theia API Documentation v1.76.0
    Preparing search index...

    Interface Walkthrough

    A walkthrough as it is contributed, either by a plugin or by a WalkthroughProvider.

    interface Walkthrough {
        description: string;
        icon?: string;
        id: string;
        pluginIcon?: string;
        pluginId?: string;
        steps: WalkthroughStep[];
        title: string;
        when?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    description icon? id pluginIcon? pluginId? steps title when?

    Properties

    description: string
    icon?: string

    Name of the codicon shown on the card and in the detail header, without the codicon- prefix.

    id: string
    pluginIcon?: string

    Icon of the contributing extension, as a backend relative path.

    pluginId?: string

    Id of the contributing plugin, or undefined for a walkthrough contributed by a Theia extension.

    steps: WalkthroughStep[]
    title: string
    when?: string

    Settings

    Member Visibility

    On This Page

    Properties