Struct KeyHintsProps 

pub struct KeyHintsProps {
    pub hints: Vec<KeyHint>,
    pub separator: KeyHintSeparator,
    pub style: KeyHintStyle,
    pub key_color: Option<Color>,
    pub action_color: Option<Color>,
    pub separator_color: Option<Color>,
    pub bold_keys: bool,
    pub dim_actions: bool,
}

Properties for the KeyHints component.

Fields

hints: Vec<KeyHint>

List of key hints to display.

separator: KeyHintSeparator

Separator between hints.

style: KeyHintStyle

Display style.

key_color: Option<Color>

Color for the key portion.

action_color: Option<Color>

Color for the action/description portion.

separator_color: Option<Color>

Color for the separator.

bold_keys: bool

Whether to bold the keys.

dim_actions: bool

Whether to dim the actions.

Implementations

impl KeyHintsProps

pub fn new<I, T>(hints: I) -> Self

where I: IntoIterator<Item = T>, T: Into<KeyHint>,

Create new KeyHintsProps with hints.

pub fn separator(self, separator: KeyHintSeparator) -> Self

Set the separator style.

pub fn style(self, style: KeyHintStyle) -> Self

Set the display style.

pub fn key_color(self, color: Color) -> Self

Set the key color.

pub fn action_color(self, color: Color) -> Self

Set the action color.

pub fn separator_color(self, color: Color) -> Self

Set the separator color.

pub fn bold_keys(self, bold: bool) -> Self

Enable/disable bold keys.

pub fn dim_actions(self, dim: bool) -> Self

Enable/disable dim actions.

pub fn hint(self, key: impl Into<String>, action: impl Into<String>) -> Self

Add a hint.

pub fn render_string(&self) -> String

Render the hints as a string.

Trait Implementations

impl Clone for KeyHintsProps

fn clone(&self) -> KeyHintsProps

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyHintsProps

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

Formats the value using the given formatter.

impl Default for KeyHintsProps

fn default() -> Self

Returns the “default value” for a type.