bitbar-js

1.0.1 • Public • Published

bitbar-js

一个 BitBar js 脚本辅助工具。

灵感来源于 sindresorhus/bitbar

Inspired by sindresorhus/bitbar

使用方法

在 BitBar 的插件目录,首先安装依赖

npm install bitbar-js

之后可以编写你的模块了,比如建立文件 test.1d.js

#!/usr/bin/env /usr/local/bin/node
const bitbar = require('bitbar-js');

bitbar([
  {
    text: '❤',
    color: 'red',
    dropdown: false
  }
])

API

bitbar(items, options?) 或 bitbar.create(items, options?)

配置每个栏目item的例子

// 一个简单的例子
{
  text: '❤',
  color: 'red'
}

// 带有子栏目的例子
{
  text: 'AA',
  color: 'red',
  submenu: [
    {
      text: 'AA-1',
      color: 'blue'
    },
    'AA-2' // 对于只有 text 的情况,可以简写为字符串形式
  ]
}

text 为显示的内容,submenu 为子栏目。其它选项,参考 BitBar-Plugin-API

options

如果每个栏目都有相同的配置,可以直接配置到 options 上。例如:

bitbar([
  { 
    text: 'AA',
  },
  {
    text: 'BB',
  },
  {
    text: 'CC',
    color: 'blue',
  }
], {color: 'red'})

等同于:

bitbar([
  {
    text: 'AA',
    color: 'red',
  },
  {
    text: 'BB',
    color: 'red',
  },
  {
    text: 'CC',
    color: 'blue',
  }
])

bitbar.separator

分隔符,也可以用字符串 --- 代替。

bitbar.darkMode

是否为深色模式。

已知问题

  1. 内容中含有引号 " ',我也不知道如何处理。sindresorhus/bitbar 对 URL 进行了转义。

错误码

错误码 原因
1001 栏目item类型错误,每行数据支持 string / object
1002 栏目item缺少字段,需要提供 text 字段
1003 栏目item中,字段的值类型错误,支持 string/number/boolean

Package Sidebar

Install

npm i bitbar-js

Weekly Downloads

1

Version

1.0.1

License

MIT

Unpacked Size

4.73 kB

Total Files

3

Last publish

Collaborators

  • yukapril