hub / github.com/matryer/xbar
github.com/matryer/xbar @v2.1.7-beta sqlite
310 symbols
896 edges
54 files
157 documented · 51%
README
Welcome to xbar
xbar (the BitBar reboot) lets you put the output from any script/program in your macOS menu bar.
- Complete rewrite from the ground up - in Go by @matryer and @leaanthony - using Wails.app (build cross-platform desktop apps using Go & HTML/CSS/JS)
- Completely open source
- Download latest xbar release - requires macOS Catalina or newer (>= 10.15)
- Visit the app homepage at https://xbarapp.com
- Get started and installing plugins
Digging deeper:
And finally...
Get started
Install
Installing plugins
From an xbar menu, choose Preferences > Plugins... to use the xbar app to discover and manage plugins.
You can browse all the plugins online, or write your own.
The Plugin Directory
The plugin directory is folder on your Mac where the plugins live, located at ~/Library/Application Support/xbar/plugins.
- If you're transitioning from Bitbar, move your plugins into this new folder to install them
Contributing
If you'd like to contribute a plugin, head over to https://github.com/matryer/xbar-plugins to get started.
Please do not send pull requests to this repo. Open an issue and start a conversation first. PRs will likely not be accepted.
- Get started with our Writing plugins guide
Thanks
- Special thanks to @leaanthony at https://wails.app and @ianfoo, @gingerbeardman, @iosdeveloper, @muhqu, @m-cat, @mpicard, @tylerb for their help
- Thanks to Chris Ryer for the app logo - and to @mazondo for the original
- Thanks for all our plugin contributors who have come up with some pretty genius things
Extension points exported contracts — how you extend this code
EachFunc (FuncType)EachFunc is the callback that recievesplugins described with metadata.Plugin.
tools/sitegen/repo.go
DebugFunc (FuncType)
DebugFunc is a function that writes debug information. Use DebugfNoop for silence.
pkg/metadata/plugin_metadata.go
SelectAssetFunc (FuncType)
SelectAssetFunc selects the Asset to install.
pkg/update/update.go
RefreshFunc (FuncType)
RefreshFunc is a callback fired after a Plugin is refreshed.
pkg/plugins/plugin.go
CycleFunc (FuncType)
CycleFunc is a callback fired after a Plugin's CycleIndex has changed.
pkg/plugins/plugin.go
DebugFunc (FuncType)
DebugFunc is a function that records debug information.
pkg/plugins/plugin.go
ActionFunc (FuncType)
ActionFunc is a function that handles the menu item clicks/selections.
pkg/plugins/action.go
Core symbols most depended-on inside this repo
Runcalled by 28
pkg/plugins/plugin.go
parseOutput
called by 19
pkg/plugins/parse.go
Error
called by 18
pkg/plugins/plugin.go
Refresh
called by 10
pkg/plugins/plugin.go
IsPluginEnabled
called by 10
pkg/plugins/installed_plugins.go
CurrentCycleItem
called by 9
pkg/plugins/plugin.go
parseBool
called by 8
pkg/plugins/item_params.go
String
called by 8
pkg/plugins/refresh_interval.go
Shape
Languages
Go99%
TypeScript1%
Modules by API surface
app/app.go31 symbols
pkg/plugins/plugin.go28 symbols
pkg/metadata/plugin_metadata.go26 symbols
tools/sitegen/main.go25 symbols
app/plugins_service.go16 symbols
pkg/plugins/plugin_test.go14 symbols
pkg/update/update.go11 symbols
pkg/plugins/item_params_test.go11 symbols
pkg/plugins/item_params.go11 symbols
app/command_service.go10 symbols
tools/sitegen/docs.go9 symbols
pkg/plugins/parse_test.go9 symbols
Dependencies from manifests, versioned
github.com/Masterminds/semver/v3v3.1.1 · 1×
github.com/dsnet/compressv0.0.1 · 1×
github.com/frankban/quicktestv1.13.0 · 1×
github.com/go-ole/go-olev1.2.5 · 1×
github.com/golang/protobufv1.4.2 · 1×
github.com/golang/snappyv0.0.3 · 1×
github.com/gomarkdown/markdownv0.0.0-2021020817541 · 1×
github.com/google/btreev1.0.1 · 1×
github.com/google/go-githubv17.0.0+incompatible · 1×
github.com/google/go-querystringv1.0.0 · 1×
github.com/google/uuidv1.2.0 · 1×
github.com/gorilla/websocketv1.4.2 · 1×