3 unstable releases

0.2.0 Jul 3, 2024
0.1.1 May 14, 2024
0.1.0 May 14, 2024

#6 in #form

Download history 203/week @ 2024-05-12 35/week @ 2024-05-19 5/week @ 2024-05-26 78/week @ 2024-06-02 15/week @ 2024-06-09 7/week @ 2024-06-16 8/week @ 2024-06-23 120/week @ 2024-06-30 96/week @ 2024-07-07

232 downloads per month
Used in hello_egui

MIT license

110KB
413 lines

egui_form

egui_ver Latest version Documentation unsafe forbidden License

egui_form adds form validation to egui. It can either use validator or garde for validation. This also means, if you use rust you can use the same validation logic on the server and the client.

Check the docs for the validator implementation or the garde implementation to get started.

You can also build a custom implementation by implementing the EguiValidationReport for the result of whatever form validation crate you use.

Showcase

You can try the Signup Form example in hello_egui showcase app.

Also, here's a screenshot from HelloPaint's profile form:

screenshot

Should I use validator or garde?

For small / prototype projects, I'd recommend garde, since it has built in error messages. For bigger projects that might require i18n, it might make sense to use validator, since it allows for custom error messages (garde as of now has no i18n support).

In HelloPaint I'm using garde, since it seems a bit cleaner and more active, hoping that i18n will be solved before it becomes a problem for HelloPaint.

Minimal example using garde

From egui_form_minimal.rs

use eframe::NativeOptions;
use egui::{TextEdit, Ui};
use egui_form::garde::{GardeReport, field_path};
use egui_form::{Form, FormField};
use garde::Validate;


#[derive(Debug, Default, Validate)]
struct Fields {
    #[garde(length(min = 2, max = 50))]
    user_name: String,
}

fn form_ui(ui: &mut Ui, fields: &mut Fields) {
    let mut form = Form::new().add_report(GardeReport::new(fields.validate(&())));

    FormField::new(&mut form, field_path!("user_name"))
        .label("User Name")
        .ui(ui, TextEdit::singleline(&mut fields.user_name));

    if let Some(Ok(())) = form.handle_submit(&ui.button("Submit"), ui) {
        println!("Submitted: {:?}", fields);
    }
}

Dependencies

~5–11MB
~104K SLoC