Skip to main content

Theme

ratatui_interact::theme

Struct Theme

pub struct Theme {
    pub name: String,
    pub palette: ColorPalette,
}

Expand description

A named theme with a ColorPalette.

Fields§

§name: String

Display name for this theme.

§palette: ColorPalette

The color palette.

Implementations§

impl Theme

pub fn dark() -> Self

Create the dark theme, matching the existing hardcoded defaults.

pub fn light() -> Self

Create a light theme suitable for light terminal backgrounds.

pub fn style<S: for<'a> From<&'a Theme>>(&self) -> S

Convenience method to derive any widget style from this theme.

§Example

use ratatui_interact::theme::Theme;
use ratatui_interact::components::ButtonStyle;

let theme = Theme::dark();
let style: ButtonStyle = theme.style();

Trait Implementations§

impl Clone for Theme

fn clone(&self) -> Theme

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

impl Debug for Theme

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

Formats the value using the given formatter. Read more

impl Default for Theme

fn default() -> Self

Returns the “default value” for a type. Read more

impl From<&Theme> for AccordionStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for AnimatedTextStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for BreadcrumbStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for ButtonStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for CheckBoxStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for ContextMenuStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for DiffViewerStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for FileExplorerStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for HotkeyDialogStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for InputStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for ListPickerStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for LogLevelColors

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for LogViewerStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for MarqueeStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for MenuBarStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for MousePointerStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for ProgressStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for ScrollableContentStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for SelectStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for SpinnerStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for SplitPaneStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for StepDisplayStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for TabViewStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for TextAreaStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl From<&Theme> for TreeStyle

fn from(theme: &Theme) -> Self

Converts to this type from the input type.

impl PartialEq for Theme

fn eq(&self, other: &Theme) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Theme

impl StructuralPartialEq for Theme

Auto Trait Implementations§

impl Freeze for Theme

impl RefUnwindSafe for Theme

impl Send for Theme

impl Sync for Theme

impl Unpin for Theme

impl UnsafeUnpin for Theme

impl UnwindSafe for Theme

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.