https://github.com/halsten-dev/bubblehelp
A manager to render, contextualize and manage BubbleTea keybinds globally
https://github.com/halsten-dev/bubblehelp
Last synced: 3 months ago
JSON representation
A manager to render, contextualize and manage BubbleTea keybinds globally
- Host: GitHub
- URL: https://github.com/halsten-dev/bubblehelp
- Owner: halsten-dev
- License: mit
- Created: 2025-07-13T04:43:30.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-07-13T06:35:25.000Z (7 months ago)
- Last Synced: 2025-07-13T07:36:42.024Z (7 months ago)
- Language: Go
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bubblehelp
A manager to render, contextualize and manage BubbleTea (https://github.com/charmbracelet/bubbletea) keybinds globally
```go
import "github.com/halsten-dev/bubblehelp"
```
# Introduction
When working on a complex application in the terminal, it's important to have a good
way of managing multiple contexts with different keybinds, same keys but different outcome,
and so on.
I was facing troubles, when trying to manage dynamic keybinds and on top of that the need
of rendering help. The BubbleTea library is amazing, but it lack something to manage the
keybinds well.
That's why I've created bubblehelp. It's just a coat of quality of life to help you write
contextualized TUI application with complex ever-changing help for your users.
Take a look at the example and let your imagination do the rest.
# Need help
Do not hesitate to create an issue if you need any kind of help about bubblehelp.
# License
MIT License
Copyright (c) 2025 Lionel Leeser
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.