Kbd

In plain words

Draws keyboard keys, so people learn the shortcut: Ctrl + S.

Draws a shortcut written as a string ("ctrl-shift-p", chords like "cmd-k cmd-s") as key caps. On macOS it uses symbols (⌘⇧P) and words elsewhere; pyzed.ui.base.KEY_STYLE forces "symbols" or "words". ui.format_keys returns the labels if you draw them yourself.

ui.kbd · Category: Display · Full reference →

Preview

Code

pz.column([
    ui.kbd("ctrl-shift-p"),
    ui.kbd("ctrl-k ctrl-s"),
    pz.row([ui.kbd("escape", size="xs"), ui.kbd("enter", size="xs"), ui.kbd("tab", size="xs")], spacing=8),
], spacing=12, align="center")

When to use

• In menus, tooltips, palettes and help screens, to teach shortcuts.
• Most components already accept keys= and draw it for you (button, menu item, tooltip).

Usage

import pyzed as pz
from pyzed import ui

pz.column([
    ui.kbd("ctrl-shift-p"),
    ui.kbd("ctrl-k ctrl-s"),
    pz.row([ui.kbd("escape", size="xs"), ui.kbd("enter", size="xs"), ui.kbd("tab", size="xs")], spacing=8),
], spacing=12, 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.

Keys

Write shortcuts as "ctrl-s"; on macOS ctrl becomes ⌃ and cmd ⌘ automatically.

One key

Code

ui.kbd("enter")

Combination

Code

ui.kbd("ctrl-shift-p")

Chord

Code

ui.kbd("ctrl-k ctrl-s")

Special keys

Code

pz.row([ui.kbd("escape"), ui.kbd("tab"), ui.kbd("backspace"), ui.kbd("up")], spacing=6)

Size

size="xs"

Code

ui.kbd("ctrl-p", size="xs")

size="sm"

Code

ui.kbd("ctrl-p", size="sm")

Events

Kbd 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.kbd

kbd(keys, *, size='sm', theme=None)

Draws a shortcut as keys: "ctrl-shift-p", "cmd-k cmd-s". Uses symbols on macOS (⌘⇧P) and words elsewhere.

Property	Default	Description
keys	required	The shortcut.
size	"sm"	"xs" or "sm".
theme	None	Theme to use instead of the current one (pyzed.theme.current()).

Full reference →

ui.format_keys

format_keys(keys)

Splits a shortcut into labels per chord: format_keys("ctrl-shift-p") == [["Ctrl", "Shift", "P"]]. The style is controlled by pyzed.ui.base.KEY_STYLE ("auto", "symbols" or "words").

Property	Default	Description
keys	required	The shortcut.

Full reference →

ui.keys_text

keys_text(keys)

A shortcut as plain text for a label or a status line: keys_text("ctrl-shift-p") == "Ctrl+Shift+P" ("⌃⇧P" with macOS symbols), chords separated by a space. Tooltips, buttons and menus take keys= instead and draw key caps, so never write the keys into their text.

Property	Default	Description
keys	required	The shortcut.

Full reference →

Related

Keybinding hintA muted “Open file Ctrl P” hint.

ShortcutsA searchable list of key bindings, grouped.

TooltipA hint shown on hover, optionally with its shortcut.