pCon.basket - Plugin Development
    Preparing search index...

    Interface ItemDescriptionProviderPlugin

    Provides an additional description line for basket items.

    • Plugin category = ItemListExtension
    • Plugin sub category = ItemDescriptionProvider
    interface ItemDescriptionProviderPlugin {
        isAvailable?: boolean;
        name: string;
        createProvider(pEditor: ProjectEditor): Promise<ItemDescriptionProvider>;
        initialize(
            pDescriptor: PluginDescriptor,
            pSettings: unknown,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    • Plugin
      • ItemDescriptionProviderPlugin
    Index
    isAvailable?: boolean

    Optional, if false this plugin will not be used.

    name: string
    • Will be called once after the plugin was loaded.

      Parameters

      • pDescriptor: PluginDescriptor

        Plugin descriptor for this plugin.

      • pSettings: unknown

        Optional plugin specific settings which may be defined as part of the application settings.

      Returns Promise<void>