Skip to content

halsten-dev/bubblehelp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bubblehelp

A manager to render, contextualize and manage BubbleTea (https://github.com/charmbracelet/bubbletea) keybinds globally

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.

About

A manager to render, contextualize and manage BubbleTea keybinds globally

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages