Files
signed/crates/ui/src/components/kbd.rs
T
reya a0f69b6450
Rust / build (macos-latest, stable) (push) Waiting to run
Rust / build (ubuntu-latest, stable) (push) Waiting to run
Rust / build (windows-latest, stable) (push) Waiting to run
chore: replace pixel metrics with rem-based sizing across ui
2026-11-19 15:47:50 +07:00

313 lines
8.8 KiB
Rust

//! Renders keyboard keys and shortcuts as small key caps.
//!
//! # Examples
//!
//! ```no_run
//! use gpui::{Keystroke, ParentElement as _};
//! use ui::kbd::{Kbd, KbdGroup};
//!
//! let save = Kbd::new(Keystroke::parse("cmd-s").unwrap());
//! let combo = KbdGroup::new()
//! .child(Kbd::new(Keystroke::parse("ctrl-b").unwrap()))
//! .child(Kbd::new(Keystroke::parse("ctrl-k").unwrap()));
//! ```
use gpui::prelude::FluentBuilder as _;
use gpui::{
Action, AnyElement, App, FocusHandle, InteractiveElement as _, IntoElement, KeyBinding,
KeyContext, Keystroke, OperatingSystem, ParentElement as _, RenderOnce, SharedString,
StyleRefinement, Styled as _, Window, div, relative,
};
use crate::components::common::{StyledExt as _, h_flex};
use crate::theme::ActiveTheme as _;
/// A key or shortcut shown as a small key cap, like `⌘S` or `Ctrl+S`.
#[derive(IntoElement, Clone, Debug)]
#[must_use]
pub struct Kbd {
stroke: Keystroke,
appearance: bool,
style: StyleRefinement,
}
impl From<Keystroke> for Kbd {
fn from(stroke: Keystroke) -> Self {
Self::new(stroke)
}
}
impl Kbd {
/// Creates a key cap showing `stroke`.
pub fn new(stroke: Keystroke) -> Self {
Self {
stroke,
appearance: true,
style: StyleRefinement::default(),
}
}
/// The keystroke this key cap shows.
pub fn keystroke(&self) -> &Keystroke {
&self.stroke
}
/// When false, paints the formatted shortcut as plain text without the key cap.
pub fn appearance(mut self, appearance: bool) -> Self {
self.appearance = appearance;
self
}
/// Returns a key cap for the highest-precedence binding of `action`.
pub fn binding_for_action(
action: &dyn Action,
context: Option<&str>,
window: &Window,
) -> Option<Self> {
let binding = match context.and_then(|context| KeyContext::parse(context).ok()) {
Some(context) => {
window.highest_precedence_binding_for_action_in_context(action, context)
}
None => window.highest_precedence_binding_for_action(action),
}?;
Self::from_binding(&binding)
}
/// Returns a key cap for the binding of `action`.
pub fn binding_for_action_in(
action: &dyn Action,
focus_handle: &FocusHandle,
window: &Window,
) -> Option<Self> {
let binding = window.highest_precedence_binding_for_action_in(action, focus_handle)?;
Self::from_binding(&binding)
}
/// Returns a key cap for the binding of `action` registered without a key context.
pub fn global_binding_for_action(action: &dyn Action, window: &Window) -> Option<Self> {
let binding = window
.highest_precedence_binding_for_action_in_context(action, KeyContext::default())?;
Self::from_binding(&binding)
}
/// Shows the binding's keystroke as the keymap holds it.
fn from_binding(binding: &KeyBinding) -> Option<Self> {
binding.keystrokes().first().map(|stroke| {
Self::new(Keystroke {
modifiers: *stroke.modifiers(),
key: stroke.key().into(),
key_char: None,
})
})
}
/// Formats `stroke` for `os`: modifier symbols on macOS, `Ctrl+` words elsewhere.
pub fn format(stroke: &Keystroke, os: OperatingSystem) -> String {
let mac = os == OperatingSystem::Mac;
let separator = if mac { "" } else { "+" };
let mut parts: Vec<&str> = Vec::new();
// macOS reads ⌃⌥⇧⌘; other platforms read Ctrl+Alt+Shift+Win.
if stroke.modifiers.control {
parts.push(if mac { "⌃" } else { "Ctrl" });
}
if stroke.modifiers.alt {
parts.push(if mac { "⌥" } else { "Alt" });
}
if stroke.modifiers.shift {
parts.push(if mac { "⇧" } else { "Shift" });
}
if stroke.modifiers.platform {
parts.push(match os {
OperatingSystem::Mac => "⌘",
OperatingSystem::Windows => "Win",
_ => "Super",
});
}
let key = Self::key_label(&stroke.key, os);
parts.push(&key);
parts.join(separator)
}
/// The label for a key, with modifier glyphs on macOS and words elsewhere.
fn key_label(key: &str, os: OperatingSystem) -> String {
let mac = os == OperatingSystem::Mac;
let label: &str = match key {
"cmd" | "platform" => {
if mac {
"⌘"
} else {
"Win"
}
}
"ctrl" | "control" => {
if mac {
"⌃"
} else {
"Ctrl"
}
}
"alt" => {
if mac {
"⌥"
} else {
"Alt"
}
}
"shift" => {
if mac {
"⇧"
} else {
"Shift"
}
}
"function" => "Fn",
"backspace" => {
if mac {
"⌫"
} else {
"Backspace"
}
}
"delete" => {
if mac {
"⌦"
} else {
"Delete"
}
}
"enter" | "return" => {
if mac {
"⏎"
} else {
"Enter"
}
}
"escape" => {
if mac {
"⎋"
} else {
"Esc"
}
}
"tab" => {
if mac {
"⇥"
} else {
"Tab"
}
}
"space" => "Space",
"pageup" => "Page Up",
"pagedown" => "Page Down",
"left" => {
if mac {
"←"
} else {
"Left"
}
}
"right" => {
if mac {
"→"
} else {
"Right"
}
}
"up" => {
if mac {
"↑"
} else {
"Up"
}
}
"down" => {
if mac {
"↓"
} else {
"Down"
}
}
key => key,
};
let mut chars = label.chars();
match chars.next() {
Some(first) => first.to_uppercase().collect::<String>() + chars.as_str(),
None => String::new(),
}
}
}
impl gpui::Styled for Kbd {
fn style(&mut self) -> &mut StyleRefinement {
&mut self.style
}
}
impl RenderOnce for Kbd {
fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement {
let theme = cx.theme();
let os = cx.platform_info().os;
let selector = format!("kbd:{}", self.stroke.unparse(os));
let label = SharedString::from(Self::format(&self.stroke, os));
div()
// Lets a test ask whether this shortcut hint was painted this frame.
.debug_selector(move || selector)
.when(self.appearance, |key| {
key.flex_none()
.border_1()
.border_color(theme.colors.border)
.bg(theme.colors.muted)
.text_color(theme.colors.muted_foreground)
.py_0p5()
.px_1()
.min_w_5()
.rounded(theme.radius.sm)
.text_center()
.line_height(relative(1.))
.text_xs()
})
.refine_style(&self.style)
.child(label)
}
}
/// A row of key caps, grouping the keys of a multi-key hint.
#[derive(IntoElement, Default)]
#[must_use]
pub struct KbdGroup {
style: StyleRefinement,
children: Vec<AnyElement>,
}
impl KbdGroup {
/// Creates an empty group.
pub fn new() -> Self {
Self::default()
}
}
impl gpui::ParentElement for KbdGroup {
fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>) {
self.children.extend(elements);
}
}
impl gpui::Styled for KbdGroup {
fn style(&mut self) -> &mut StyleRefinement {
&mut self.style
}
}
impl RenderOnce for KbdGroup {
fn render(self, _window: &mut Window, _cx: &mut App) -> impl IntoElement {
h_flex()
.flex_none()
.gap_1()
.refine_style(&self.style)
.children(self.children)
}
}