Styles

Struct Styles 

Source
pub struct Styles {
    pub ellipsis: Style,
    pub short_key: Style,
    pub short_desc: Style,
    pub short_separator: Style,
    pub full_key: Style,
    pub full_desc: Style,
    pub full_separator: Style,
}
Expand description

A set of styles for the help component.

This structure defines all the visual styling options available for customizing the appearance of the help view. Each field controls a specific visual element, allowing fine-grained control over colors, formatting, and visual hierarchy.

§Style Categories

§Short Help Styles

  • short_key: Styling for key names in compact view
  • short_desc: Styling for descriptions in compact view
  • short_separator: Styling for bullet separators between items

§Full Help Styles

  • full_key: Styling for key names in detailed view
  • full_desc: Styling for descriptions in detailed view
  • full_separator: Styling for spacing between columns

§Utility Styles

  • ellipsis: Styling for truncation indicator when content is too wide

§Examples

§Custom Color Scheme

use bubbletea_widgets::help::Styles;
use lipgloss_extras::prelude::*;

let vibrant_styles = Styles {
    short_key: Style::new()
        .foreground(Color::from("#FF6B6B"))
        .bold(true),
    short_desc: Style::new()
        .foreground(Color::from("#4ECDC4"))
        .italic(true),
    short_separator: Style::new()
        .foreground(Color::from("#45B7D1")),
    ..Default::default()
};

§Monochrome Theme

let mono_styles = Styles {
    short_key: Style::new().bold(true),
    short_desc: Style::new().faint(true),
    full_key: Style::new().underline(true),
    full_desc: Style::new(),
    ..Default::default()
};

§Using with Help Model

let custom_styles = Styles {
    short_key: Style::new().foreground(Color::from("#00FF00")),
    ..Default::default()
};

let help = Model {
    styles: custom_styles,
    ..Default::default()
};

Fields§

§ellipsis: Style

Style for the ellipsis character when content is truncated.

§short_key: Style

Style for key names in the short help view.

§short_desc: Style

Style for descriptions in the short help view.

§short_separator: Style

Style for the separator between items in the short help view.

§full_key: Style

Style for key names in the full help view.

§full_desc: Style

Style for descriptions in the full help view.

§full_separator: Style

Style for the separator between columns in the full help view.

Trait Implementations§

Source§

impl Clone for Styles

Source§

fn clone(&self) -> Styles

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Styles

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Styles

Source§

fn default() -> Self

Creates default styles with a subtle color scheme that adapts to light and dark themes.

The default styling uses adaptive colors that work well in both light and dark terminal environments:

§Color Palette
  • Keys: Medium gray (light: #909090, dark: #626262) - provides good visibility for key names
  • Descriptions: Lighter gray (light: #B2B2B2, dark: #4A4A4A) - subtle but readable for descriptions
  • Separators: Even lighter gray (light: #DDDADA, dark: #3C3C3C) - minimal visual interruption
§Adaptive Behavior

The colors automatically adapt based on the terminal’s background:

  • Light terminals: Use darker colors for good contrast
  • Dark terminals: Use lighter colors for readability

This ensures consistent readability across different terminal themes without requiring manual configuration.

§Examples
use bubbletea_widgets::help::Styles;

let styles = Styles::default();
// All styles are configured with adaptive colors suitable for terminals
// The actual style strings contain color codes

Auto Trait Implementations§

§

impl Freeze for Styles

§

impl !RefUnwindSafe for Styles

§

impl Send for Styles

§

impl Sync for Styles

§

impl Unpin for Styles

§

impl !UnwindSafe for Styles

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.