Skip to content

Commit

Permalink
Update actions.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pilotmoon authored Nov 19, 2024
1 parent 0af2c41 commit a66395c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion site/dev/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The following keys define properties common to all action types. All properties
| `title` | String (Localizable) | The title is displayed on the action button if there is no icon. For extensions with icons, the title is displayed in the tooltip. If omitted, the action will take the extension name as its title. |
| `icon` | String | The icon to show on the action button. See [Icons](./icons) for the icon specification format. If omitted, the action will take the extension icon as its icon. To explicitly specify no icon, set this field to `null`. |
| `identifier` | String | A string to identify this action. In shell script and AppleScript actions, the identifier is passed to the script. The script can use this to find out which action was pressed. |
| `regex` | String | A [Regular Expression](http://regularexpressions.info/) to be applied to the selected text. The action will appear only if the text matches the regex, and the matching part of the text is passed to the action. The regex engine used is Cocoa's `NSRegularExpression`, which uses the [ICU specification](https://unicode-org.github.io/icu/userguide/strings/regexp.html) for regular expressions. _Note: There is no need to use your own regex to match URLs, email addresses or file paths. Use one of the `requirements` keys `url`, `urls`, `email`, `emails` or `path` instead. Also be careful to avoid badly crafted regexes which never terminate against certain inputs._ |
| `regex` | String | A [Regular Expression](http://regularexpressions.info/) to be applied to the selected text. The action will appear only if the text matches the regex, and the matching part of the text is passed to the action. The regex engine follows the [ICU specification](https://unicode-org.github.io/icu/userguide/strings/regexp.html). _Note: There is no need to use your own regex to match URLs, email addresses or file paths. Use one of the `requirements` keys `url`, `urls`, `email`, `emails` or `path` instead. Also be careful to avoid badly crafted regexes which never terminate against certain inputs._ |
| `requirements` | Array | Array consisting of zero or more of the strings listed in [the `requirements` array](#the-requirements-array). All the requirements in the array must be satisfied for the action to appear. If the field is omitted, `[text]` is used by default. To specify no requirements, supply an empty array: `[]`. |
| `excluded apps` | Array | Array of bundle identifiers of applications. The action will not appear when PopClip is being used in any of the specified apps. |
| `required apps` | Array | Array of bundle identifiers of applications. The action will only appear when PopClip is being used in one of the specified apps. _Note: This field does not make PopClip do a check to see if the app is present on the computer. For that, use the `app` field._ |
Expand Down

0 comments on commit a66395c

Please sign in to comment.