Struct KeybindingHint 

pub struct KeybindingHint { /* private fields */ }

Represents a hint for a keybinding, optionally with a prefix and suffix.

This struct allows for the creation and customization of a keybinding hint, which can be used to display keyboard shortcuts or commands in a user interface.

Examples

use gpui::{App, Hsla, KeybindingKeystroke, Keystroke};
use ui::prelude::*;
use ui::{KeyBinding, KeybindingHint};

let hint = KeybindingHint::new(
    KeyBinding::from_keystrokes(vec![KeybindingKeystroke::from_keystroke(Keystroke::parse("ctrl-s").unwrap())].into(), false),
    Hsla::black()
)
    .prefix("Save:")
    .size(Pixels::from(14.0));

Implementations

impl KeybindingHint

pub fn new(keybinding: KeyBinding, background_color: Hsla) -> Self

Creates a new KeybindingHint with the specified keybinding.

This method initializes a new KeybindingHint instance with the given keybinding, setting all other fields to their default values.

Examples

use gpui::{App, Hsla, KeybindingKeystroke, Keystroke};
use ui::prelude::*;
use ui::{KeyBinding, KeybindingHint};

let hint = KeybindingHint::new(
    KeyBinding::from_keystrokes(vec![KeybindingKeystroke::from_keystroke(Keystroke::parse("ctrl-c").unwrap())].into(), false),
    Hsla::black()
);

pub fn with_prefix( prefix: impl Into<SharedString>, keybinding: KeyBinding, background_color: Hsla, ) -> Self

Creates a new KeybindingHint with a prefix and keybinding.

This method initializes a new KeybindingHint instance with the given prefix and keybinding, setting all other fields to their default values.

Examples

use gpui::{App, Hsla, KeybindingKeystroke, Keystroke};
use ui::prelude::*;
use ui::{KeyBinding, KeybindingHint};

let hint = KeybindingHint::with_prefix(
    "Copy:",
    KeyBinding::from_keystrokes(vec![KeybindingKeystroke::from_keystroke(Keystroke::parse("ctrl-c").unwrap())].into(), false),
    Hsla::black()
);

pub fn with_suffix( keybinding: KeyBinding, suffix: impl Into<SharedString>, background_color: Hsla, ) -> Self

Creates a new KeybindingHint with a keybinding and suffix.

This method initializes a new KeybindingHint instance with the given keybinding and suffix, setting all other fields to their default values.

Examples

use gpui::{App, Hsla, KeybindingKeystroke, Keystroke};
use ui::prelude::*;
use ui::{KeyBinding, KeybindingHint};

let hint = KeybindingHint::with_suffix(
    KeyBinding::from_keystrokes(vec![KeybindingKeystroke::from_keystroke(Keystroke::parse("ctrl-v").unwrap())].into(), false),
    "Paste",
    Hsla::black()
);

pub fn prefix(self, prefix: impl Into<SharedString>) -> Self

Sets the prefix for the keybinding hint.

This method allows adding or changing the prefix text that appears before the keybinding.

Examples

use gpui::{App, Hsla, KeybindingKeystroke, Keystroke};
use ui::prelude::*;
use ui::{KeyBinding, KeybindingHint};

let hint = KeybindingHint::new(
    KeyBinding::from_keystrokes(vec![KeybindingKeystroke::from_keystroke(Keystroke::parse("ctrl-x").unwrap())].into(), false),
    Hsla::black()
)
    .prefix("Cut:");

pub fn suffix(self, suffix: impl Into<SharedString>) -> Self

Sets the suffix for the keybinding hint.

This method allows adding or changing the suffix text that appears after the keybinding.

Examples

use gpui::{App, Hsla, KeybindingKeystroke, Keystroke};
use ui::prelude::*;
use ui::{KeyBinding, KeybindingHint};

let hint = KeybindingHint::new(
    KeyBinding::from_keystrokes(vec![KeybindingKeystroke::from_keystroke(Keystroke::parse("ctrl-f").unwrap())].into(), false),
    Hsla::black()
)
    .suffix("Find");

pub fn size(self, size: impl Into<Option<Pixels>>) -> Self

Sets the size of the keybinding hint.

This method allows specifying the size of the keybinding hint in pixels.

Examples

use gpui::{App, Hsla, KeybindingKeystroke, Keystroke};
use ui::prelude::*;
use ui::{KeyBinding, KeybindingHint};

let hint = KeybindingHint::new(
    KeyBinding::from_keystrokes(vec![KeybindingKeystroke::from_keystroke(Keystroke::parse("ctrl-z").unwrap())].into(), false),
    Hsla::black()
)
    .size(Pixels::from(16.0));

Trait Implementations

impl Component for KeybindingHint

fn scope() -> ComponentScope

Returns the scope of the component.

fn description() -> Option<&'static str>

An optional description of the component.

fn preview(_window: &mut Window, cx: &mut App) -> Option<AnyElement>

The component’s preview.

fn id() -> ComponentId

The component’s unique identifier.

fn status() -> ComponentStatus

The ready status of this component.

fn name() -> &'static str

The name of the component.

fn sort_name() -> &'static str

Returns a name that the component should be sorted by.

impl Debug for KeybindingHint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl IntoElement for KeybindingHint

type Element = Component<KeybindingHint>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for KeybindingHint

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.