Keybinding hint

In plain words

A quiet line that teaches a shortcut: “Open file Ctrl P”.

A muted hint that pairs an action with its shortcut, for footers and empty states.

ui.keybinding_hint · Category: Feedback · Full reference →

Preview

Code

pz.column([
    ui.keybinding_hint("Open file", "ctrl-p"),
    ui.keybinding_hint("Command palette", "ctrl-shift-p"),
    ui.keybinding_hint("Toggle terminal", "ctrl-j"),
], spacing=10, align="center")

When to use

• In empty editors and footers, to teach the shortcuts of the most useful actions.

Usage

import pyzed as pz
from pyzed import ui

pz.column([
    ui.keybinding_hint("Open file", "ctrl-p"),
    ui.keybinding_hint("Command palette", "ctrl-shift-p"),
    ui.keybinding_hint("Toggle terminal", "ctrl-j"),
], spacing=10, align="center")

Variants

About these captures

Each capture is recorded by pyzed itself, off-screen at 2x, in One Dark or One Light to match this site’s theme, and cropped to the component so it shows at its real size. The pointer hovers, presses or types into it; a component that does not react to the pointer cycles through a few themes. With reduced motion you see the first frame. Open Code under a capture to see the snippet that draws it; free names such as on_save stand for your own callbacks.

Examples

One key

Code

ui.keybinding_hint("Search", "/")

Combination

Code

ui.keybinding_hint("Command palette", "ctrl-shift-p")

Chord

Code

ui.keybinding_hint("Keyboard shortcuts", "ctrl-k ctrl-s")

Events

Keybinding hint has no events of its own: it shows what you give it. Like every widget it also has the 18 common events (click, double_click, right_click, mouse_enter, drag, key_down, resize…), attached with .on(...): see Events and Events of every component.

Properties and API

ui.keybinding_hint

keybinding_hint(text, keys, *, theme=None)

A muted hint like “Open file Ctrl P” for footers and empty states.

Property	Default	Description
text	required	Text.
keys	required	Shortcut shown at the end, written as a string: "ctrl-s", "cmd-k cmd-s".
theme	None	Theme to use instead of the current one (pyzed.theme.current()).

Full reference →

Related

KbdKeyboard shortcuts drawn as keys, with symbols on macOS.

Empty stateA centered placeholder for empty lists and searches.

ShortcutsA searchable list of key bindings, grouped.