Struct Theme 

pub struct Theme { /* private fields */ }

The theme of the file explorer.

This struct is used to customize the look of the file explorer. It allows to set the style of the widget and the style of the files. You can also wrap the widget in a block with the with_block method and add dinamic titles to it with with_title_top and with_title_bottom.

Implementations

impl Theme

pub const fn new() -> Self

Create a new empty theme.

The theme will not have any style set. To get a theme with the default style, use default.

Example

let theme = Theme::new();

pub fn add_default_title(self) -> Self

Add a top title to the theme. The title is the current working directory.

Example

Suppose you have this tree file, with passport.png selected inside file_explorer:

/
├── .git
└── Documents
    ├── passport.png  <- selected
    └── resume.pdf

You will end up with something like this:

┌/Documents────────────────────────┐
│ ../                              │
│ passport.png                     │
│ resume.pdf                       │
└──────────────────────────────────┘

With this code:

use ratatui::widgets::*;
use ratatui_explorer::{FileExplorerBuilder, Theme};

let theme = Theme::default()
    .with_block(Block::default().borders(Borders::ALL))
    .add_default_title();

let file_explorer = FileExplorerBuilder::build_with_theme(theme).unwrap();

/* user select `password.png` */

let widget = file_explorer.widget();
/* render the widget */

pub fn with_block(self, block: Block<'static>) -> Self

Wrap the file explorer with a custom Block widget.

Behind the scene, it use the List::block method. See its documentation for more.

You can use with_title_top and with_title_bottom to add dynamic titles to the block.

Example

let theme = Theme::default().with_block(Block::default().borders(Borders::ALL));

pub fn with_style<S: Into<Style>>(self, style: S) -> Self

Set the style of the widget.

Behind the scene, it use the List::style method. See its documentation for more.

Example

let theme = Theme::default().with_style(Style::default().fg(Color::Yellow));

pub fn with_item_style<S: Into<Style>>(self, item_style: S) -> Self

Set the style of all non directories items. To set the style of the directories, use with_dir_style.

Behind the scene, it use the Span::styled method. See its documentation for more.

Example

let theme = Theme::default().with_item_style(Style::default().fg(Color::White));

pub fn with_dir_style<S: Into<Style>>(self, dir_style: S) -> Self

Set the style of all directories items. To set the style of the non directories, use with_item_style.

Behind the scene, it use the Span::styled method. See its documentation for more.

Example

let theme = Theme::default().with_dir_style(Style::default().fg(Color::Blue));

pub fn with_highlight_item_style<S: Into<Style>>( self, highlight_item_style: S, ) -> Self

Set the style of all highlighted non directories items. To set the style of the highlighted directories, use with_highlight_dir_style.

Behind the scene, it use the List::highlight_style method. See its documentation for more.

Example

let theme = Theme::default().with_highlight_item_style(Style::default().add_modifier(Modifier::BOLD));

pub fn with_highlight_dir_style<S: Into<Style>>( self, highlight_dir_style: S, ) -> Self

Set the style of all highlighted directories items. To set the style of the highlighted non directories, use with_highlight_item_style.

Behind the scene, it use the List::highlight_style method. See its documentation for more.

Example

let theme = Theme::default().with_highlight_dir_style(Style::default().fg(Color::Blue).add_modifier(Modifier::BOLD));

pub fn with_highlight_symbol(self, highlight_symbol: &str) -> Self

Set the symbol used to highlight the selected item.

Behind the scene, it use the List::highlight_symbol method. See its documentation for more.

Example

let theme = Theme::default().with_highlight_symbol("> ");

pub fn with_highlight_spacing(self, highlight_spacing: HighlightSpacing) -> Self

Set the spacing between the highlighted item and the other items.

Behind the scene, it use the List::highlight_spacing method. See its documentation for more.

Example

let theme = Theme::default().with_highlight_spacing(HighlightSpacing::Never);

pub fn with_scroll_padding(self, scroll_padding: usize) -> Self

Sets the number of items around the currently selected item that should be kept visible.

/// Behind the scene, it use the List::scroll_padding method. See its documentation for more.

Example

let theme = Theme::default().with_scroll_padding(1);

pub fn with_title_top( self, title_top: impl Fn(&FileExplorer) -> Line<'_> + 'static + Send + Sync, ) -> Self

Add a top title factory to the theme.

title_top is a function that take a reference to the current FileExplorer and returns a Line to be displayed as a title at the top of the wrapping block (if it exist) of the file explorer. You can call this function multiple times to add multiple titles.

Behind the scene, it use the Block::title_top method. See its documentation for more.

Example

let theme = Theme::default()
    .with_title_top(|file_explorer: &FileExplorer| {
        Line::from(format!("cwd - {}", file_explorer.cwd().display()))
    })
    .with_title_top(|file_explorer: &FileExplorer| {
        Line::from(format!("{} files", file_explorer.files().len() - 1)).right_aligned()
    });

pub fn with_title_bottom( self, title_bottom: impl Fn(&FileExplorer) -> Line<'_> + 'static + Send + Sync, ) -> Self

Add a bottom title factory to the theme.

title_bottom is a function that take a reference to the current FileExplorer and returns a Line to be displayed as a title at the bottom of the wrapping block (if it exist) of the file explorer. You can call this function multiple times to add multiple titles.

Behind the scene, it use the Block::title_bottom method. See its documentation for more.

Example

let theme = Theme::default()
    .with_title_bottom(|file_explorer: &FileExplorer| {
        Line::from(format!("cwd - {}", file_explorer.cwd().display()))
    })
    .with_title_bottom(|file_explorer: &FileExplorer| {
        Line::from(format!("{} files", file_explorer.files().len() - 1)).right_aligned()
    });

pub const fn block(&self) -> Option<&Block<'static>>

Returns the wrapping block (if it exist) of the file explorer of the theme.

pub const fn style(&self) -> &Style

Returns the style of the widget of the theme.

pub const fn item_style(&self) -> &Style

Returns the style of the non directories items of the theme.

pub const fn dir_style(&self) -> &Style

Returns the style of the directories items of the theme.

pub const fn highlight_item_style(&self) -> &Style

Returns the style of the highlighted non directories items of the theme.

pub const fn highlight_dir_style(&self) -> &Style

Returns the style of the highlighted directories items of the theme.

pub fn highlight_symbol(&self) -> Option<&str>

Returns the symbol used to highlight the selected item of the theme.

pub const fn highlight_spacing(&self) -> &HighlightSpacing

Returns the spacing between the highlighted item and the other items of the theme.

pub const fn scroll_padding(&self) -> usize

Returns the number of items around the currently selected item that should be kept visible.

pub fn title_top<'a>(&self, file_explorer: &'a FileExplorer) -> Vec<Line<'a>>

Returns the generated top titles of the theme.

pub fn title_bottom<'a>(&self, file_explorer: &'a FileExplorer) -> Vec<Line<'a>>

Returns the generated bottom titles of the theme.

Trait Implementations

impl Clone for Theme

fn clone(&self) -> Theme

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Theme

where Option<Block<'static>>: Debug, Style: Debug, HighlightSpacing: Debug, Option<String>: Debug, usize: Debug,

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

Formats the value using the given formatter.

impl Default for Theme

fn default() -> Self

Return a slightly customized default theme. To get a theme with no style set, use new.

The theme will have a block with all borders, a white style for the items, a light blue style for the directories, a dark gray background for all the highlighted items.

Example

let theme = Theme::default();

impl Eq for Theme

where Option<Block<'static>>: PartialEq, Style: PartialEq, HighlightSpacing: PartialEq, Option<String>: PartialEq, usize: PartialEq,

impl Hash for Theme

where Option<Block<'static>>: Hash, Style: Hash, HighlightSpacing: Hash, Option<String>: Hash, usize: Hash,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Theme

where Option<Block<'static>>: PartialEq, Style: PartialEq, HighlightSpacing: PartialEq, Option<String>: PartialEq, usize: PartialEq,

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

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

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

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