Slapdash Platform
GitHub
  • Ahoy, world!
  • Command Bar 101
    • How it Works
    • Core Terminology
    • Commands
    • Local Commands
    • Cloud Commands
    • Build Your First Command
    • Publish Command
    • Hooks
  • Command Tutorials
    • Toggle Dark Mode
    • Emoji Paster
    • Copy Special Character
    • Send Slack Message
  • Reference
    • Command Response
    • Action
    • View
    • List View
    • Masonry View
    • Form View
    • Tokens
    • Icon
    • Config
Powered by GitBook
On this page
  • ActionOpenURL
  • ActionPaste
  • ActionCopy
  • ActionShowToast
  • ActionMoveAddParam
  1. Reference

Action

PreviousCommand ResponseNextView

Last updated 3 years ago

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 as CommandResponse.action

  • in the Option of the or 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.

{
  "action": {
    "type": "open-url",
    "url": "https://slapdash.com/",
  }
}
{
  "action": {
    "type": "open-url",
    "url": [
        "https://google.com/",
        "https://bing.com/"
    ]
  }
}
{
  "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/"
        }
      }
    ]
  }
}
{
  "action": {
    "type": "open-url",
    "url": "file:///Users/Johny/Downloads",
  }
}
{
  "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.

{
  "action": {
    "type": "paste",
    "value": "Hello, world!"
  }
}
{
  "view": {
    "type": "list",
    "options": [
      {
        "title": "Paste My Email",
        "action": {
          "type": "paste",
          "value": "my-personal-email@gmail.com"
        }
      }
    ]
  }
}

ActionCopy

Copies some text to the clipboard.

  • type: "copy"

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

{
  "action": {
    "type": "copy",
    "value": "Hello, world!"
  }
}
{
  "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.

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

ActionMoveAddParam

  • type: "add-param"

  • name: The name of the parameter.

  • value: The value of the parameter.

{
  "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"
        }
      }
    ]
  }
}

Allows to change the . 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 that can be triggered by pressing Tab.

Command Response
List View
Masonry View
location of the Command Bar
Option