Dooit

Appearance

Setting up Keys ​

Setting up keys in dooit is pretty straightforward

Basic key binding ​

Key manager is available via api's keys variable and the general method looks something like this:

python
api.keys.set(keybind, callback, description, group)

Example:

python
from dooit.ui.api import DooitAPI, subscribe
from dooit.ui.api.events import Startup

@subscribe(Startup)
def setup(api: DooitAPI, _):
    api.keys.set("j", api.move_down, "my custom vim keys")
    api.keys.set("k", api.move_up, "my custom vim keys")

where description and group are optional

This would show up in the help menu like this:

Keybind Preview 1

Multiple key binding ​

If you'd like to set multiple keybinding for same function, you can send all the keys in a list

For example, you'd like to use +/- keys for increasing or decreasing urgency but on QWERTY US layout, the + key needs shift as well So you could set something like this:

python
from dooit.ui.api import DooitAPI, subscribe
from dooit.ui.api.events import Startup

@subscribe(Startup)
def setup(api: DooitAPI, _):
    api.keys.set(["=","+"], api.increase_urgency)
    api.keys.set(["-","_"], api.decrease_urgency)

Removing a keybind ​

If you want to remove some default keybind, you can set function callback to api.no_op
For example, if you use a different layout keyboard and + and - are enough for you

❕ NOTE

This will also hide the keybinds from help menu

python
from dooit.ui.api import DooitAPI, subscribe
from dooit.ui.api.events import Startup

@subscribe(Startup)
def setup(api: DooitAPI, _):
    api.keys.set("=", api.no_op)
    api.keys.set("_", api.no_op)

🔥 EXTRA

You can also pass custom functions as callbacks Check out Backend API