https://github.com/theogainey/deno-xbar
Write xbar app plugins using TypeScript/JavaScript and Deno
https://github.com/theogainey/deno-xbar
deno typescript xbar xbar-plugins
Last synced: 4 months ago
JSON representation
Write xbar app plugins using TypeScript/JavaScript and Deno
- Host: GitHub
- URL: https://github.com/theogainey/deno-xbar
- Owner: theogainey
- License: mit
- Created: 2022-04-04T13:18:26.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T13:22:51.000Z (about 2 years ago)
- Last Synced: 2025-10-22T20:43:33.184Z (8 months ago)
- Topics: deno, typescript, xbar, xbar-plugins
- Language: JavaScript
- Homepage: https://deno.land/x/xbar
- Size: 344 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Deno xbar
Write xbar app plugins using JavaScript and Deno
## Installation
### Deno
[Deno](https://github.com/denoland/deno) is a simple, modern and secure runtime
for JavaScript and TypeScript that uses V8 and is built in Rust.
Shell (Mac, Linux):
```sh
curl -fsSL https://deno.land/x/install/install.sh | sh
```
[Homebrew](https://formulae.brew.sh/formula/deno) (Mac):
```sh
brew install deno
```
See
[deno_install](https://github.com/denoland/deno_install/blob/master/README.md)
and [releases](https://github.com/denoland/deno/releases) for other options.
### xbar
[xbar](https://github.com/matryer/xbar) lets you put the output from any
script/program in your macOS menu bar.
[Download the latest release of xbar](https://github.com/matryer/xbar/releases).
## Usage
In the xbar plugins directory create a file named with the following format:
`{name}.{refreshTime}.js`
On the first line of that file include a shebang in the following format:
`#!/usr/bin/env -S -P/${HOME}/.deno/bin:/opt/homebrew/bin deno run `
This module can be imported to the plugin with the following code:
`import { xbar, separator, isDarkMode } from "https://deno.land/x/xbar@LATEST_VERSION/mod.ts";`
Deno is secure by default. Therefore, unless you specifically enable it, a
program run with Deno has no file, network, or environment access. Replace
`` with the permissions required for the plugin. See
[Deno Manual](https://deno.land/manual/getting_started/permissions) for more.
Ensure that the file is executable by using the command `chmod +x filename.js`.
[Read more.](https://github.com/matryer/xbar#installing-plugins)
### Example
```
#!/usr/bin/env -S -P/${HOME}/.deno/bin:/opt/homebrew/bin deno run --allow-env
import { xbar, separator, isDarkMode } from "https://deno.land/x/xbar@LATEST_VERSION/mod.ts";
const darkMode = await isDarkMode();
xbar([
{
text: 'plugin text on the menu bar',
color: darkMode ? 'white' : 'red',
},
separator,
{
text: 'plugin text below the menu bar',
color: '#85b56d',
submenu: [
{
text: 'plugin text in a submenu menu that is long and is word wrapped',
wordWrap: 40
},
]
},
]);
```
See [examples](/examples) for more.
## API
### xbar
Prints output to xbar and returns printed output as an array of strings
Type: `(Array) => string[]`
Takes an array of MenuItem objects, that represent xbar menu items, as input.
#### MenuItem
Type: `object`
MenuItem can contain any of the following fields:
```
{
text: string;
submenu: Array;
...options
}
```
#### submenu
Type: `Array`
It will add a submenu to the current menu item. A submenu is composed of an
array of menu items. Submenus can contain nested submenus.
#### options
Type: `option: any`
You can use any of the xbar
[supported options](https://github.com/matryer/xbar-plugins/blob/main/CONTRIBUTING.md#plugin-api).
Additionally this module enables an additional `wordWrap` option.
`wordWrap`
Enabling the wordWrap option will result in the improved readability of long
text by outputting the text as multiple lines with out breaking any apart words.
Example:
```
{
text: 'Douglas Crockford',
submenu: [
{
text: 'In JavaScript, there is a beautiful, elegant, highly expressive language that is buried under a steaming pile of good intentions and blunders.',
wordWrap: 40,
}
]
}
```
### separator
The menu items below `separator` will appear in the plugin's drop down, but will
not appear in the menu bar itself.
### isDarkMode
Async function to query if dark mode is enabled.
Type: `async () => Promise`
Will always return `false` if environment permission has not previously been
granted `--allow-env`
```
#!/usr/bin/env -S -P/${HOME}/.deno/bin:/opt/homebrew/bin deno run --allow-env
import { isDarkMode } from "https://deno.land/x/xbar@LATEST_VERSION/mod.ts";
const darkMode = await isDarkMode();
```