swiftbar/SwiftBar
1
1
Fork 0
mirror of https://github.com/swiftbar/SwiftBar.git synced 2024-08-17 12:00:27 +03:00
Code Issues Projects Releases Wiki Activity

Edit and amend URL scheme documentation

Browse Source 
There's two changes here:

First, I moved the "disclaimers" section up between the URL scheme table and the headline to make it harder to miss.

Second, I added a hint to use `-g` with `open`, because the problem described in issue 268 bit me as well, and just like @shepazon, I wasn't really aware what the problem was, nor that `-g` would fix it.
This commit is contained in:
Flisk 2022-11-15 18:47:55 +01:00 committed by GitHub
parent 473db82a80
commit 9d3a0a1e7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -270,6 +270,12 @@ echo "Test 2"
You can mark a plugin as streamable with a special metadata property `<swiftbar.type>streamable</swiftbar.type>`
## URL Scheme
Some notes:
* Instead of the plugin [name](#plugin-naming), you can (and probably should) use the plugin file name. This considered a unique plugin ID, whereas `name` can be the same between multiple plugins. If your plugin's filepath is `~/Documents/SwiftBar/myplugin.1m.sh`, then the name is `myplugin` and the ID `myplugin.1m.sh`
* When using `open(1)` to trigger scheme URLs, use `-g` to prevent the command from stealing focus from your active app.
| Endpoint | Parameter | Description | Example |
| ------------- | ------------- |------------- | ------------- |
| refreshallplugins | none | Force refresh all loaded plugins | `swiftbar://refreshallplugins` |
@ -281,8 +287,6 @@ You can mark a plugin as streamable with a special metadata property `<swiftbar.
| addplugin | `src` source URL to plugin file | Add plugin to Swiftbar from URL | `swiftbar://addplugin?src=https://coolplugin` |
| notify | `name` or `plugin` plugin [name](#plugin-naming). Notification fields: `title`, `subtitle`, `body`. `href` to open an URL on click (including custom URL schemes). `silent=true` to disable sound | Show notification | `swiftbar://notify?plugin=MyPlugin&title=title&subtitle=subtitle&body=body&silent=true` |
LTP: instead of plugin [name](#plugin-naming) you can(and probably should) use plugin file name, this considered a unique plugin ID where name can be the same between multiple plugins. If your plugin's filepath is `~/Documents/SwiftBar/myplugin.1m.sh` then name is `myplugin` and ID `myplugin.1m.sh`
## Preferences aka 'defaults'
List of preferences that are not exposed in SwiftBar UI: