UXP Toolkit
    Preparing search index...

    Interface Entrypoints

    https://developer.adobe.com/photoshop/uxp/2022/uxp/reference-js/Modules/uxp/Entry Points/EntryPoints/

    interface Entrypoints {
        commands?: {
            [key: string]:
                | CommandConfig
                | ((this: UxpCommandInfo) => Promise<void>)
                | undefined;
        };
        getCommand: (id: string) => UxpCommandInfo;
        getPanel: (id: string) => UxpPanelInfo;
        panels?: {
            [key: string]:
                | PanelConfig
                | ((this: UxpPanelInfo) => Promise<void>)
                | undefined;
        };
        plugin?: PluginConfig
        | ((this: UxpPluginInfo) => Promise<void>);
        setup: (entrypoints: Entrypoints) => void;
    }
    Index

    Properties

    commands? getCommand getPanel panels? plugin? setup

    Properties

    commands?: {
        [key: string]:
            | CommandConfig
            | ((this: UxpCommandInfo) => Promise<void>)
            | undefined;
    }

    This object contains a list of key-value pairs where each key is the command id and value is command's data whose type can be an object or function. If a function, it is assumed to be 'run' method. If an objet, it can contain following properties but 'run' is must to specify.

    getCommand: (id: string) => UxpCommandInfo

    Get command with specified ID.

    Type Declaration

    getPanel: (id: string) => UxpPanelInfo

    Get panel with specified ID.

    Type Declaration

      • (id: string): UxpPanelInfo

      • Parameters

        • id: string

          Panel ID.

        Returns UxpPanelInfo

        Panel object for a valid ID null for an invalid ID.

    panels?: {
        [key: string]:
            | PanelConfig
            | ((this: UxpPanelInfo) => Promise<void>)
            | undefined;
    }

    This contains a list of key-value pairs where each key is a panel id (string) and value is the data for the panel whose type can be object/function. If a function, it is assumed to be the 'show' method. If an object, it can contain following properties but it is must to define either of 'create' or 'show'.

    plugin?: PluginConfig | ((this: UxpPluginInfo) => Promise<void>)

    This can be an object or a function. If this is a function, it is assumed as the 'create' handler

    setup: (entrypoints: Entrypoints) => void

    API for plugin to add handlers and menu items for entrypoints defined in manifest. This API can only be called once and there after other apis can be used to modify menu items. The function throws in case of any error in entrypoints data or if its called more than once.

    Type Declaration

      • (entrypoints: Entrypoints): void

      • Parameters

        • entrypoints: Entrypoints

          Describes your plugin's entrypoint functions and properties.

        Returns void

    Settings

    Member Visibility

    On This Page

    Properties