egui-modal

Crates.ioegui-modal
lib.rsegui-modal
version0.5.0
sourcesrc
created_at2022-09-20 04:12:32.84962
updated_at2024-09-30 02:50:11.935244
descriptiona modal library for egui
homepage
repositoryhttps://github.com/n00kii/egui-modal
max_upload_size
id669604
size151,728
nookii (n00kii)

documentation

README

egui-modal, a modal library for egui

crates.io docs license

modal

normal usage:

/* calling every frame */

let modal = Modal::new(ctx, "my_modal");

// What goes inside the modal
modal.show(|ui| {
    // these helper functions help set the ui based on the modal's
    // set style, but they are not required and you can put whatever
    // ui you want inside [`.show()`]
    modal.title(ui, "Hello world!");
    modal.frame(ui, |ui| {
        modal.body(ui, "This is a modal.");
    });
    modal.buttons(ui, |ui| {
        // After clicking, the modal is automatically closed
        if modal.button(ui, "close").clicked() {
            println!("Hello world!")
        };
    }); 
});

if ui.button("Open the modal").clicked() {
    // Show the modal
    modal.open();
}

dialog usage

dialog

in some use cases, it may be more convenient to both open and style the modal as a dialog as a one-time action, like on the single instance of a function's return.

/* calling every frame */

let modal = Modal::new(ctx, "my_dialog");

...
...
...

// Show the dialog
modal.show_dialog();

elsewhere,

/* happens once */
if let Ok(data) = my_function() {
    modal.dialog()
        .with_title("my_function's result is...")
        .with_body("my_function was successful!")
        .with_icon(Icon::Success)
        .open()
}
Commit count: 78

cargo fmt