contextual-apps.md

description
CushyApps can be started form both context menu. this page shows how your custom app can support that

Contextual Apps

Contextual apps allow you start any app (workflow) from an existing image ( image-comtext-menu.md) or selection (unified-canvas)

Make your app compatible

1. Add canStartFromImage

app({
   ...
   canStartFromImage: true,
})

2. update your run handler to take a third param

    //                  👇👇👇👇👇
    run: async (run, ui, startImg) => {

Add new entries to the image context menu

once your CushyApp is start-from-image enabled, you can just create new drafts of your app.

Every draft will show as a new menu entry

Support both beeing run as context action or standalone

Supporting both is easy.

    run: async (run, ui, startImg) => {
        //  if  startImg is null, it will take ui.startImage instead
        let img = startImg ?? ui.startImage
    }

Built-in examples to look at

look at the library/quick-actions/*

• library/built-in/quick-actions/quick-dispace.ts
• library/built-in/quick-actions/quick-refine.ts
• ...