Crate egui_file_dialog

egui-file-dialog

An easy-to-use and customizable file dialog (a.k.a. file explorer, file picker) for egui.

The project is currently in a very early version. Some planned features are still missing and some improvements still need to be made.

Currently only tested on Linux and Windows!

Read more about the project: https://github.com/fluxxcode/egui-file-dialog

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
• Customization highlights:
  • Customize which areas and functions of the dialog are visible
  • Multilingual support: Customize the text labels that the dialog uses
  • Customize file and folder icons

A simple example

The following example shows of how you can use the file dialog to let the user select a file.
See the full example at https://github.com/fluxxcode/egui-file-dialog/tree/master/examples/select_file

use egui_file_dialog::FileDialog;

struct MyApp {
    file_dialog: FileDialog,
}

impl MyApp {
    pub fn new() -> Self {
        Self {
            // Create a new FileDialog instance
            file_dialog: FileDialog::new(),
        }
    }
}

impl MyApp {
    fn update(&mut self, ctx: &egui::Context, ui: &mut egui::Ui) {
        if ui.button("Select file").clicked() {
            // Open the file dialog to select a file
            self.file_dialog.select_file();
        }

        // Update the dialog and check if the user selected a file
        if let Some(path) = self.file_dialog.update(ctx).selected() {
            println!("Selected file: {:?}", path);
        }
    }
}

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. (More customization will be implemented in the future!)

• 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.

The following example shows how a 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

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)
    // 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"),
    );

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(),
    };
}

Structs

• FileDialog
  Represents a file dialog instance.
• FileDialogConfig
  Contains configuration values of a file dialog.
• FileDialogLabels
  Contains the text labels that the file dialog uses.

Enums

• DialogMode
  Represents the mode the file dialog is currently in.
• DialogState
  Represents the state the file dialog is currently in.