6 releases (breaking)

0.5.0 Mar 30, 2024
0.4.0 Feb 29, 2024
0.3.1 Feb 20, 2024
0.2.0 Feb 7, 2024
0.1.0 Feb 3, 2024

#170 in Filesystem

Download history 6/week @ 2024-02-04 250/week @ 2024-02-18 155/week @ 2024-02-25 54/week @ 2024-03-03 23/week @ 2024-03-10 11/week @ 2024-03-17 89/week @ 2024-03-24 76/week @ 2024-03-31 12/week @ 2024-04-07 6/week @ 2024-04-14 23/week @ 2024-04-21 16/week @ 2024-04-28 12/week @ 2024-05-05 20/week @ 2024-05-12

72 downloads per month

MIT license

160KB
2K SLoC

egui-file-dialog

Latest version Documentation Dependency status Crates.io Total Downloads Total lines of code MIT

This repository provides an easy-to-use and customizable file dialog (a.k.a. file explorer, file picker) for egui.

The file dialog is intended for use by desktop applications, allowing the use of a file dialog directly within the egui application without relying on the operating system's file explorer. This also ensures that the file dialog looks the same and provides the same functionality on all platforms.

The project is currently in a very early version. Some planned features are still missing and some improvements still need to be made. See the Planned features section for some of the features to be implemented in the future.

The latest changes included in the next release can be found in the CHANGELOG.md file on the develop branch.

Currently only tested on Linux and Windows!

Features

  • Select a file or a directory
  • Save a file (Prompt user for a destination path)
  • Create a new folder
  • Navigation buttons to open the parent or previous directories
  • Search for items in a directory
  • Shortcut for user directories (Home, Documents, ...) and system disks
  • Manually edit the path via text
  • Customization highlights:
    • Customize which areas and functions of the dialog are visible
    • Customize the text labels used by the dialog to enable multilingual support
    • Customize file and folder icons
    • Add custom quick access sections to the left sidebar

Planned features

The following lists some of the features that are currently missing but are planned for the future!

  • Selection of multiple directory items at once
  • Pinnable folders for quick access #42
  • Only show files with a specific file extension (The user can already filter files by file extension using the search, but there is currently no backend method for this or a dropdown to be able to select from predefined file extensions.)
  • Keyboard input #70
  • Context menus, for example for renaming, deleting or copying files or directories
  • Option to show or hide hidden files and folders

Example

Detailed examples that can be run can be found in the examples folder.

The following example shows the basic use of the file dialog with eframe to select a file.

Cargo.toml:

[dependencies]
eframe = "0.27.1"
egui-file-dialog = "0.5.0"

main.rs:

use std::path::PathBuf;

use eframe::egui;
use egui_file_dialog::FileDialog;

struct MyApp {
    file_dialog: FileDialog,
    selected_file: Option<PathBuf>,
}

impl MyApp {
    pub fn new(_cc: &eframe::CreationContext) -> Self {
        Self {
            // Create a new file dialog object
            file_dialog: FileDialog::new(),
            selected_file: None,
        }
    }
}

impl eframe::App for MyApp {
    fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
        egui::CentralPanel::default().show(ctx, |ui| {
            if ui.button("Select file").clicked() {
                // Open the file dialog to select a file.
                self.file_dialog.select_file();
            }

            ui.label(format!("Selected file: {:?}", self.selected_file));

            // Update the dialog and check if the user selected a file
            if let Some(path) = self.file_dialog.update(ctx).selected() {
                self.selected_file = Some(path.to_path_buf());
            }
        });
    }
}

fn main() -> eframe::Result<()> {
    eframe::run_native(
        "File dialog demo",
        eframe::NativeOptions::default(),
        Box::new(|ctx| Box::new(MyApp::new(ctx))),
    )
}

Customization

Many things can be customized so that the dialog can be used in different situations.
A few highlights of the customization are listed below. For all possible customization options, see the documentation on docs.rs.

  • Set which areas and functions of the dialog are visible using FileDialog::show_* methods
  • Update the text labels that the dialog uses. See Multilingual support
  • Customize file and folder icons using FileDialog::set_file_icon (Currently only unicode is supported)

Since the dialog uses the egui style to look like the rest of the application, the appearance can be customized with egui::Style and egui::Context::set_style.

The following example shows how a single file dialog can be customized.
If you need to configure multiple file dialog objects with the same or almost the same options, it is a good idea to use FileDialogConfig and FileDialog::with_config (See FileDialogConfig on docs.rs).

use std::path::PathBuf;
use std::sync::Arc;

use egui_file_dialog::FileDialog;

FileDialog::new()
    .initial_directory(PathBuf::from("/path/to/app"))
    .default_file_name("app.cfg")
    .default_size([600.0, 400.0])
    .resizable(false)
    .show_new_folder_button(false)
    .show_search(false)
    .show_path_edit_button(false)
    // Add a new quick access section to the left sidebar
    .add_quick_access("Project", |s| {
        s.add_path("β˜†  Examples", "examples");
        s.add_path("πŸ“·  Media", "media");
        s.add_path("πŸ“‚  Source", "src");
    })
    // Markdown and text files should use the "document with text (U+1F5B9)" icon
    .set_file_icon(
        "πŸ–Ή",
        Arc::new(|path| {
            match path
                .extension()
                .unwrap_or_default()
                .to_str()
                .unwrap_or_default()
            {
                "md" => true,
                "txt" => true,
                _ => false,
            }
        }),
    )
    // .gitignore files should use the "web-github (U+E624)" icon
    .set_file_icon(
        "",
        Arc::new(|path| path.file_name().unwrap_or_default() == ".gitignore"),
    );

With the options the dialog then looks like this:

The smallest possible dialog can be generated with the following configuration:

FileDialog::new()
    .title_bar(false)
    .show_top_panel(false)
    .show_left_panel(false)

Multilingual support

For desktop applications it is often necessary to offer different languages. While the dialog currently only offers English labels by default, the labels are fully customizable. This makes it possible to adapt the labels to different languages.

The following example shows how the labels can be changed to display the file dialog in English or German.
Checkout examples/multilingual for the full example.

use egui_file_dialog::{FileDialog, FileDialogLabels};

enum Language {
    English,
    German,
}

fn get_labels_german() -> FileDialogLabels {
    FileDialogLabels {
        title_select_directory: "πŸ“ Ordner Γ–ffnen".to_string(),
        title_select_file: "πŸ“‚ Datei Γ–ffnen".to_string(),
        title_save_file: "πŸ“₯ Datei Speichern".to_string(),

        // ... See examples/multilingual for the other labels

        ..Default::default()
    }
}

/// Updates the labels of the file dialog.
/// Should be called every time the user selects a different language.
fn update_labels(language: &Language, file_dialog: &mut FileDialog) {
    *file_dialog.labels_mut() = match language {
        // English labels are used by default
        Language::English => FileDialogLabels::default(),
        // Use custom labels for German
        Language::German => get_labels_german(),
    };
}

Dependencies

~5–36MB
~490K SLoC