Struct FileDialog

pub struct FileDialog {
    pub selected_file: Option<PathBuf>,
    /* private fields */
}

The file dialog.

This manages the state of the file dialog. After selecting a file, the absolute path to that file will be stored in the file dialog.

The file dialog is opened with the current working directory by default. To start the file dialog with a different directory, use FileDialog::set_dir.

Fields

selected_file: Option<PathBuf>

The file that was selected when the file dialog was open the last time.

This will reset when re-opening the file dialog.

Implementations

impl FileDialog

pub fn new(width: u16, height: u16) -> Result<Self>

Create a new file dialog.

The width and height are the size of the file dialog in percent of the terminal size. They are clamped to 100%.

Examples found in repository

examples/demo.rs (line 33)

fn main() -> Result<()> {
    enable_raw_mode()?;
    let mut stdout = io::stdout();
    execute!(stdout, EnterAlternateScreen)?;
    let backend = CrosstermBackend::new(stdout);
    let mut terminal = Terminal::new(backend)?;

    let res = run_app(&mut terminal, App::new(FileDialog::new(60, 40)?));

    disable_raw_mode()?;
    execute!(terminal.backend_mut(), LeaveAlternateScreen)?;
    terminal.show_cursor()?;

    if let Err(err) = res {
        println!("{:?}", err)
    }

    Ok(())
}

pub fn set_dir(&mut self, dir: PathBuf) -> Result<()>

The directory to open the file dialog in.

pub fn set_filter(&mut self, filter: FilePattern) -> Result<()>

Sets the filter to use when browsing files.

pub fn reset_filter(&mut self) -> Result<()>

Removes the filter.

pub fn toggle_show_hidden(&mut self) -> Result<()>

Toggles whether hidden files should be shown.

This only checks whether the file name starts with a dot.

pub fn open(&mut self)

Opens the file dialog.

Examples found in repository

examples/demo.rs (line 58)

fn run_app<B: Backend>(terminal: &mut Terminal<B>, mut app: App) -> io::Result<()> {
    loop {
        terminal.draw(|f| ui(f, &mut app))?;

        // 2. Use the `bind_keys` macro to overwrite key bindings, when the file dialog is open.
        // The first argument of the macro is the expression that should be used to access the file
        // dialog.
        bind_keys!(
            app.file_dialog,
            if let Event::Key(key) = event::read()? {
                match key.code {
                    KeyCode::Char('o') if key.modifiers == KeyModifiers::CONTROL => {
                        app.file_dialog.open()
                    }
                    KeyCode::Char('q') | KeyCode::Esc => {
                        return Ok(());
                    }
                    _ => {}
                }
            }
        )
    }
}

pub fn close(&mut self)

Closes the file dialog.

pub fn is_open(&self) -> bool

Returns whether the file dialog is currently open.

pub fn draw<B: Backend>(&mut self, f: &mut Frame<'_, B>)

Draws the file dialog in the TUI application.

Examples found in repository

examples/demo.rs (line 83)

fn ui<B: Backend>(f: &mut Frame<B>, app: &mut App) {
    let block = Block::default()
        .title(format!(
            "Selected file: {}",
            app.file_dialog
                .selected_file
                .as_ref()
                .map_or("None".to_string(), |f| f.to_string_lossy().to_string())
        ))
        .borders(Borders::ALL);
    f.render_widget(block, f.size());

    // 3. Call the draw function of the file dialog in order to render it.
    app.file_dialog.draw(f);
}

pub fn next(&mut self)

Goes to the next item in the file list.

pub fn previous(&mut self)

Goes to the previous item in the file list.

pub fn up(&mut self) -> Result<()>

Moves one directory up.

pub fn select(&mut self) -> Result<()>

Selects an item in the file list.

If the item is a directory, the file dialog will move into that directory. If the item is a file, the file dialog will close and the path to the file will be stored in FileDialog::selected_file.