1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
//! # egui_dialogs
//!
//! Platform-agnostic, customizable dialogs for egui library.
//!
//! ## Quick start
//!
//! ### Run the example
//!
//! ```bash
//! # cd into the crate directory
//! cargo run --example dialogs
//! ```
//!
//! ### Basic usage
//!
//! Install the crate:
//!
//! ```bash
//! cargo add egui_dialogs
//! ```
//!
//! Then add a `Dialogs` field to your `App` struct:
//!
//! ```
//! use egui_dialogs::Dialogs;
//!
//! pub struct MyApp<'a> {
//! // ... your other app states
//! dialogs: Dialogs<'a>,
//! }
//! ```
//!
//! Then somewhere in your `App::update` function:
//!
//! ```
//! # use egui_dialogs::Dialogs;
//! #
//! # pub struct MyApp<'a> {
//! # // ... your other app states
//! # dialogs: Dialogs<'a>,
//! # }
//!
//! impl MyApp<'_> {
//! // ... your other app logic
//!
//! pub fn update(&mut self, ctx: &egui::Context) {
//! self.dialogs.show(ctx);
//!
//! // ... your other rendering logic
//! }
//! }
//! ```
//!
//! And when you want to show a dialog:
//!
//! ```
//! # use egui_dialogs::Dialogs;
//! #
//! # pub struct MyApp<'a> {
//! # // ... your other app states
//! # dialogs: Dialogs<'a>,
//! # }
//! #
//! # impl MyApp<'_> {
//! # // ... your other app logic
//! #
//! # pub fn update(&mut self, ctx: &egui::Context) {
//! # self.dialogs.show(ctx);
//! #
//! # // ... your other rendering logic
//! self.dialogs.info("Information", "This is an info dialog");
//! # }
//! # }
//! ```
//!
//! ### Handle reply
//!
//! Use `DialogDetails` struct to build
//! a dialog with custom attributes.
//!
//! The following is an example to comfirm a window close request:
//!
//! ```
//! use std::{cell::RefCell, rc::Rc};
//!
//! use egui_dialogs::{DialogDetails, StandardReply};
//!
//! # use egui_dialogs::Dialogs;
//! #
//! # pub struct MyApp<'a> {
//! # // ... your other app states
//! # dialogs: Dialogs<'a>,
//! // in your app state
//! pub allow_to_close: Rc<RefCell<bool>>,
//! // and initialize it with false
//!
//! # }
//! #
//! # impl MyApp<'_> {
//! # // ... your other app logic
//! #
//! # pub fn update(&mut self, ctx: &egui::Context) {
//! # self.dialogs.show(ctx);
//! #
//! # // ... your other rendering logic
//! #
//! // when received a close request in the update function
//! if ctx.input(|i| i.viewport().close_requested()) {
//! let ctx = ctx.clone();
//! let allow_to_close = Rc::clone(&self.allow_to_close);
//!
//! if *allow_to_close.borrow() {
//! // run your close logic
//! } else {
//! // build and show a confirm dialog
//! DialogDetails::confirm("Close", "Are you sure you want to close the window?")
//! .on_reply(move |res| {
//! if res == StandardReply::Ok {
//! *allow_to_close.borrow_mut() = true;
//! ctx.send_viewport_cmd(egui::ViewportCommand::Close);
//! }
//! })
//! .show(&mut self.dialogs);
//! }
//! }
//! #
//! # }
//! # }
//! ```
//!
//! ## Customization
//!
//! ### Customize standard dialog
//!
//! You can show a customized dialog based on the standard dialogs:
//!
//! ```
//! use egui::include_image;
//! use egui_dialogs::{DialogDetails, StandardDialog, StandardReply};
//!
//! # use egui_dialogs::Dialogs;
//! #
//! # pub struct MyApp<'a> {
//! # // ... your other app states
//! # dialogs: Dialogs<'a>,
//! # }
//! #
//! # impl MyApp<'_> {
//! # // ... your other app logic
//! #
//! # pub fn update(&mut self, ctx: &egui::Context) {
//! # self.dialogs.show(ctx);
//! #
//! # // ... your other rendering logic
//! let standard_dialog = StandardDialog::info("Information", "Now you can customize the dialog!")
//! .buttons(vec![
//! // use the standard buttons
//! StandardReply::Yes.into(),
//! // or add custom buttons with specific replies
//! ("What?".into(), StandardReply::No)
//! ])
//! .image(include_image!("assets/info.svg"));
//!
//! DialogDetails::new(standard_dialog)
//! .on_reply(|res| {
//! match res {
//! StandardReply::Yes => println!("That's great!"),
//! StandardReply::No => println!("Emm...maybe you can try to see the example?"),
//! _ => panic!("I've never added such a reply!")
//! }
//! })
//! .show(&mut self.dialogs);
//! # }
//! # }
//!
//! ```
//!
//! ### Customize dialog appearance and behavior
//!
//! To show a completely customized dialog, you can first design your dialog state struct like this:
//!
//! ```
//! pub struct NameConfirmDialog {
//! name: String,
//! }
//! ```
//!
//! Then implement the `Dialog` trait to implement dialog logic
//! with a generic type parameter to specify the dialog reply type:
//!
//! ```
//! # pub struct NameConfirmDialog {
//! # name: String,
//! # }
//! #
//! use egui_dialogs::{dialog_window, Dialog, DialogContext};
//!
//! impl Dialog<String> for NameConfirmDialog {
//! fn show(&mut self, ctx: &egui::Context, dctx: &DialogContext) -> Option<String> {
//! // return None if the user hasn't replied
//! let mut res = None;
//!
//! // draw the dialog
//! dialog_window(ctx, dctx, "Confirm name")
//! .show(ctx, |ui| {
//! ui.label("What's your name: ");
//! ui.text_edit_singleline(&mut self.name);
//! if ui.button("Done").clicked() {
//! // set the reply and end the dialog
//! res = Some(self.name.clone());
//! }
//! });
//!
//! res
//! }
//! }
//! ```
//!
//! The `dialog_window` function is a helper function
//! to draw a suggested dialog window with a title.
//!
//! Now you can show your customized dialog:
//!
//! ```
//! # pub struct NameConfirmDialog {
//! # name: String,
//! # }
//! #
//! # use egui_dialogs::{dialog_window, Dialog, DialogDetails, DialogContext};
//! #
//! # impl Dialog<String> for NameConfirmDialog {
//! # fn show(&mut self, ctx: &egui::Context, dctx: &DialogContext) -> Option<String> {
//! # // return None if the user hasn't replied
//! # let mut res = None;
//! #
//! # // draw the dialog
//! # dialog_window(ctx, dctx, "Confirm name")
//! # .show(ctx, |ui| {
//! # ui.label("What's your name: ");
//! # ui.text_edit_singleline(&mut self.name);
//! # if ui.button("Done").clicked() {
//! # // set the reply and end the dialog
//! # res = Some(self.name.clone());
//! # }
//! # });
//! #
//! # res
//! # }
//! # }
//! # use egui_dialogs::Dialogs;
//! #
//! # pub struct MyApp<'a> {
//! # // ... your other app states
//! # dialogs: Dialogs<'a>,
//! # }
//! #
//! # impl MyApp<'_> {
//! # // ... your other app logic
//! #
//! # pub fn update(&mut self, ctx: &egui::Context) {
//! # self.dialogs.show(ctx);
//! #
//! # // ... your other rendering logic
//! DialogDetails::new(NameConfirmDialog { name: "".into() })
//! .on_reply(|res| {
//! println!("Your name is {}", res);
//! })
//! .show(&mut self.dialogs);
//! # }
//! # }
//! ```
mod dialog_details;
mod dialogs;
mod standard_dialog;
pub use dialog_details::*;
pub use dialogs::*;
pub use standard_dialog::*;