Action

Actions tell the Command Bar to perform a side effect (e.g. open a URL or copy something to the clipboard). They can be used in two places:

• at the root of Command Response as CommandResponse.action

• in the Option of the List View or Masonry View as CommandResponse.view.options[].action

export type Action =
  | ActionOpenURL
  | ActionPaste
  | ActionCopy
  | ActionShowToast
  | ActionMove;
  
type ActionMove = ActionMoveAddParam;

ActionOpenURL

Opens a given URL using the system's default handler.

• type: "open-url"

• url: The URL to open. You can use any valid URI schema. For example, "https://", "file://", "ssh://", "slack://" (native app). Provide a string to open a single URL or an array of strings to open multiple URLs at once.

Open a URL in the browser

{
  "action": {
    "type": "open-url",
    "url": "https://slapdash.com/",
  }
}

Open multiple URLs at once

{
  "action": {
    "type": "open-url",
    "url": [
        "https://google.com/",
        "https://bing.com/"
    ]
  }
}

List View: open Google and Bing URLs

{
  "view": {
    "type": "list",
    "options": [
      {
        "title": "Open Google",
        "action": {
          "type": "open-url",
          "url": "https://www.google.com/"
        }
      },
      {
        "title": "Open Bing",
        "action": {
          "type": "open-url",
          "url": "https://www.bing.com/"
        }
      }
    ]
  }
}

Open a local folder in Finder

{
  "action": {
    "type": "open-url",
    "url": "file:///Users/Johny/Downloads",
  }
}

Open a Slack channel in the Slack desktop app

{
  "action": {
    "type": "open-url",
    "url": "slack://channel?team=TA4PV0NH4&id=CR7EDED9Q"
  }
}

ActionPaste

Pastes some text to the active app.

• type: "paste"

• value: The string that will be pasted to the active app.

Paste text to the active app

{
  "action": {
    "type": "paste",
    "value": "Hello, world!"
  }
}

List View: paste an email address to the active app

{
  "view": {
    "type": "list",
    "options": [
      {
        "title": "Paste My Email",
        "action": {
          "type": "paste",
          "value": "[email protected]"
        }
      }
    ]
  }
}

ActionCopy

Copies some text to the clipboard.

• type: "copy"

• value: The string that will be copied to the clipboard.

Copy text to clipboard

{
  "action": {
    "type": "copy",
    "value": "Hello, world!"
  }
}

List View: option to copy a URL to clipboard

{
  "view": {
    "type": "list",
    "options": [
      {
        "title": "Copy Google URL",
        "action": {
          "type": "copy",
          "value": "https://www.google.com/"
        }
      }
    ]
  }
}

ActionShowToast

Shows a message in a toast (an ephemeral message displayed on the screen).

• type: "show-toast"

• message: The message that will be displayed in a toast.

Show a confirmation message in a toast

{
  "view": {
    "type": "list",
    "options": [
      {
        "title": "Show a Message",
        "action": {
          "type": "show-toast",
          "message": "The task has been successfully completed!"
        }
      }
    ]
  }
}

ActionMoveAddParam

Allows to change the location of the Command Bar. Currently, there is only one Move Action supported – add a param. Location parameters are then passed to the Command when it's run.

Typically, the "add-param" Action is used in the moveAction property of some Option that can be triggered by pressing Tab.

• type: "add-param"

• name: The name of the parameter.

• value: The value of the parameter.

Masonry View: option with Main and Move Actions

{
  "view": {
    "type": "masonry",
    "options": [
      {
        "imageURL": "https://images.unsplash.com/photo-1481819613568-3701cbc70156",
        "action": {
          "type": "open-url",
          "url": "https://images.unsplash.com/photo-1481819613568-3701cbc70156"
        },
        "moveAction": {
          "type": "add-param",
          "name": "image",
          "value": "moon"
        }
      }
    ]
  }
}