Actions
Our API includes a few built-in actions that can be used for common interactions, such as opening a link or copying some content to the clipboard. By using them, you make sure to follow our human interface guidelines. If you need something custom, use the Action
component. All built-in actions are just abstractions on top of it.
API Reference
Action
A context-specific action that can be performed by the user.
Assign keyboard shortcuts to items to make it easier for users to perform frequently used actions.
Example
Props
title*
The title displayed for the Action.
string
-
autoFocus
Indicates whether the Action should be focused automatically when the parent ActionPanel (or Actionpanel.Submenu) opens.
boolean
-
icon
The icon displayed for the Action.
-
shortcut
The keyboard shortcut for the Action.
-
style
Defines the visual style of the Action.
onAction
Callback that is triggered when the Action is selected.
() => void
-
Action.CopyToClipboard
Action that copies the content to the clipboard.
The main window is closed, and a HUD is shown after the content was copied to the clipboard.
Example
Props
content*
The contents that will be copied to the clipboard.
-
concealed
Indicates whether the content be treated as confidential. If true
, it will not be recorded in the Clipboard History.
boolean
false
icon
A optional icon displayed for the Action.
shortcut
The keyboard shortcut for the Action.
-
title
An optional title for the Action.
string
"Copy to Clipboard"
onCopy
Callback when the content was copied to clipboard.
-
Action.Open
An action to open a file or folder with a specific application, just as if you had double-clicked the file's icon.
The main window is closed after the file is opened.
Example
Props
target*
The file, folder or URL to open.
string
-
title*
The title for the Action.
string
-
application
The application name to use for opening the file.
-
icon
The icon displayed for the Action.
shortcut
The keyboard shortcut for the Action.
-
onOpen
Callback when the file or folder was opened.
(target: string) => void
-
Action.OpenInBrowser
Action that opens a URL in the default browser.
The main window is closed after the URL is opened in the browser.
Example
Props
url*
The URL to open.
string
-
icon
The icon displayed for the Action.
shortcut
The optional keyboard shortcut for the Action.
-
title
An optional title for the Action.
string
"Open in Browser"
onOpen
Callback when the URL was opened in the browser.
(url: string) => void
-
Action.OpenWith
Action that opens a file or URL with a specific application.
The action opens a sub-menu with all applications that can open the file or URL. The main window is closed after the item is opened in the specified application.
Example
Props
path*
The path to open.
string
-
icon
The icon displayed for the Action.
shortcut
The keyboard shortcut for the Action.
-
title
The title for the Action.
string
"Open With"
onOpen
Callback when the file or folder was opened.
(path: string) => void
-
Action.Paste
Action that pastes the content to the front-most applications.
The main window is closed after the content is pasted to the front-most application.
Example
Props
content*
The contents that will be pasted to the frontmost application.
-
icon
The icon displayed for the Action.
shortcut
The keyboard shortcut for the Action.
-
title
An optional title for the Action.
string
"Paste in Active App"
onPaste
Callback when the content was pasted into the front-most application.
-
Action.Push
Action that pushes a new view to the navigation stack.
Example
Props
target*
The target view that will be pushed to the navigation stack.
React.ReactNode
-
title*
The title displayed for the Action.
string
-
icon
The icon displayed for the Action.
-
shortcut
The keyboard shortcut for the Action.
-
onPop
Callback when the target view will be popped.
() => void
-
onPush
Callback when the target view was pushed.
() => void
-
Action.ShowInFinder
Action that shows a file or folder in the Finder.
The main window is closed after the file or folder is revealed in the Finder.
Example
Props
path*
The path to open.
-
icon
A optional icon displayed for the Action.
shortcut
The keyboard shortcut for the Action.
-
title
An optional title for the Action.
string
"Show in Finder"
onShow
Callback when the file or folder was shown in the Finder.
-
Action.SubmitForm
Action that adds a submit handler for capturing form values.
Example
Props
icon
The icon displayed for the Action.
-
shortcut
The keyboard shortcut for the Action.
-
style
Defines the visual style of the Action.
title
The title displayed for the Action.
string
"Submit Form"
onSubmit
Callback when the Form was submitted. The handler receives a the values object containing the user input.
-
Action.Trash
Action that moves a file or folder to the Trash.
Example
Props
paths*
The item or items to move to the trash.
-
icon
A optional icon displayed for the Action.
shortcut
The optional keyboard shortcut for the Action.
-
title
An optional title for the Action.
string
"Move to Trash"
onTrash
Callback when all items were moved to the trash.
-
Action.CreateSnippet
Action that navigates to the the Create Snippet command with some or all of the fields prefilled.
Example
Props
snippet*
-
icon
-
shortcut
The keyboard shortcut for the Action.
-
title
An optional title for the Action.
string
-
Action.CreateQuicklink
Action that navigates to the the Create Quicklink command with some or all of the fields prefilled.
Example
Props
quicklink*
-
icon
-
shortcut
The keyboard shortcut for the Action.
-
title
An optional title for the Action.
string
-
Action.ToggleQuickLook
Action that toggles the Quick Look to preview a file.
Example
Props
icon
The icon displayed for the Action.
shortcut
The keyboard shortcut for the Action.
-
title
The title for the Action.
string
"Quick Look"
Action.PickDate
Action to pick a date.
Example
Props
title*
A title for the Action.
string
-
onChange*
Callback when the Date was picked
(date: Date) => void
-
icon
A optional icon displayed for the Action.
max
The maximum date (inclusive) allowed for selection.
Date
-
min
The minimum date (inclusive) allowed for selection.
Date
-
shortcut
The keyboard shortcut for the Action.
-
type
Indicates what types of date components can be picked
-
Types
Snippet
Properties
text*
The snippet contents.
string
keyword
The keyword to trigger the snippet.
string
name
The snippet name.
string
Quicklink
Properties
link*
The URL or file path, optionally including placeholders such as in "https://google.com/search?q={Query}"
string
application
The application that the quicklink should be opened in.
icon
The icon to display for the quicklink.
name
The quicklink name
string
Action.Style
Defines the visual style of the Action.
Use Action.Style.Regular for displaying a regular actions. Use Action.Style.Destructive when your action has something that user should be careful about. Use the confirmation Alert if the action is doing something that user cannot revert.
Action.PickDate.Type
The types of date components the user can pick with an Action.PickDate
.
Enumeration members
DateTime
Hour and second can be picked in addition to year, month and day
Date
Only year, month, and day can be picked
Action.PickDate.isFullDay
A method that determines if a given date represents a full day or a specific time.
Last updated