<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>egui-modal-diag/README.md - fork/oculante @ master</title>
<meta name="description" content="egui-modal-diag/README.md in fork/oculante at master.">
<meta property="og:title" content="egui-modal-diag/README.md - fork/oculante @ master">
<meta property="og:description" content="egui-modal-diag/README.md in fork/oculante at master.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="master" data-tip="b47bf97f1a4ef90725a12ebac9e1354f308a983e">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/oculante</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/oculante</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Johann Woelper</span><span class="commit-message" data-commit="00922d75da458a1ef3f89d9c5c9525452150242b">Merge pull request #666 from woelper/update_notan</span><span class="snapshot-sha sha" data-commit="00922d75da458a1ef3f89d9c5c9525452150242b">00922d7</span><time datetime="2025-11-14T16:05:50+01:00" title="2025-11-14 16:05:50 +0100">2025-11-14</time></p>
<header class="topbar"><details class="switcher"><summary>master</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/oculante/ref/master/">master</a><strong>tags</strong><a href="/fork/oculante/ref/0.8.19/">0.8.19</a><a href="/fork/oculante/ref/0.8.20/">0.8.20</a><a href="/fork/oculante/ref/0.8.21/">0.8.21</a><a href="/fork/oculante/ref/0.8.22/">0.8.22</a><a href="/fork/oculante/ref/0.8.23/">0.8.23</a><a href="/fork/oculante/ref/0.9.0/">0.9.0</a><a href="/fork/oculante/ref/0.9.1/">0.9.1</a><a href="/fork/oculante/ref/0.9.2/">0.9.2</a><a class="all" href="/fork/oculante/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/oculante/">oculante</a> / <a href="/fork/oculante/ref/master/tree/egui-modal-diag/">egui-modal-diag</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>1.8 KiB</span><span>62 lines</span></span><span class="actions"><a class="raw" href="/fork/oculante/raw/cda553d99a6e6eeb9eb9e5dcd9ed05b8ba8c6de7/egui-modal-diag/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>egui-modal, a modal library for <a href="https://github.com/emilk/egui"><code>egui</code></a></h1>
<p><a href="https://crates.io/crates/egui-modal"><img src="https://img.shields.io/crates/v/egui-modal" alt="crates.io" /></a>
<a href="https://docs.rs/egui-modal/latest/egui_modal/"><img src="https://docs.rs/egui-modal/badge.svg" alt="docs" /></a>
<a href="https://github.com/n00kii/egui-modal/blob/main/README.md"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="license" /></a></p>
<p><img src="https://raw.githubusercontent.com/n00kii/egui-modal/main/media/modal.png?token=GHSAT0AAAAAABVWXBGJBQSFC3PLQP4KKOG6YZJIDCA" alt="modal" /></p>
<h2>normal usage:</h2>
<pre class="language-rust"><a-c>/* calling every frame */</a-c>

<a-k>let</a-k> modal = <a-t>Modal</a-t><a-p>::</a-p><a-f>new</a-f><a-p>(</a-p>ctx<a-p>,</a-p> <a-s>&quot;my_modal&quot;</a-s><a-p>);</a-p>

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

<a-k>if</a-k> ui<a-p>.</a-p><a-f>button</a-f><a-p>(</a-p><a-s>&quot;Open the modal&quot;</a-s><a-p>).</a-p><a-f>clicked</a-f><a-p>()</a-p> <a-p>{</a-p>
    <a-c>// Show the modal</a-c>
    modal<a-p>.</a-p><a-f>open</a-f><a-p>();</a-p>
<a-p>}</a-p></pre>
<h2>dialog usage</h2>
<p><img src="https://raw.githubusercontent.com/n00kii/egui-modal/main/media/dialog.png" alt="dialog" /></p>
<p>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.</p>
<pre class="language-rust"><a-c>/* calling every frame */</a-c>

<a-k>let</a-k> modal = <a-t>Modal</a-t><a-p>::</a-p><a-f>new</a-f><a-p>(</a-p>ctx<a-p>,</a-p> <a-s>&quot;my_dialog&quot;</a-s><a-p>);</a-p>

..<a-p>.</a-p><a-pr>
...
..</a-pr><a-p>.</a-p><a-pr>

</a-pr><a-c>// Show the dialog</a-c><a-pr>
</a-pr><a-pr>modal</a-pr><a-p>.</a-p><a-f>show_dialog</a-f><a-p>();</a-p></pre>
<p>elsewhere,</p>
<pre class="language-rust"><a-c>/* happens once */</a-c>
<a-k>if</a-k> <a-k>let</a-k> <a-cr>Ok</a-cr><a-p>(</a-p>data<a-p>)</a-p> = <a-f>my_function</a-f><a-p>()</a-p> <a-p>{</a-p>
    modal<a-p>.</a-p><a-f>dialog</a-f><a-p>()</a-p>
        <a-p>.</a-p><a-f>with_title</a-f><a-p>(</a-p><a-s>&quot;my_function&#39;s result is...&quot;</a-s><a-p>)</a-p>
        <a-p>.</a-p><a-f>with_body</a-f><a-p>(</a-p><a-s>&quot;my_function was successful!&quot;</a-s><a-p>)</a-p>
        <a-p>.</a-p><a-f>with_icon</a-f><a-p>(</a-p><a-t>Icon</a-t><a-p>::</a-p><a-cr>Success</a-cr><a-p>)</a-p>
        <a-p>.</a-p><a-f>open</a-f><a-p>()</a-p>
<a-p>}</a-p></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>egui-modal, a modal library for [`egui`](https://github.com/emilk/egui)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text">[![crates.io](https://img.shields.io/crates/v/egui-modal)](https://crates.io/crates/egui-modal)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">[![docs](https://docs.rs/egui-modal/badge.svg)](https://docs.rs/egui-modal/latest/egui_modal/)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/n00kii/egui-modal/blob/main/README.md)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">![modal](https://raw.githubusercontent.com/n00kii/egui-modal/main/media/modal.png?token=GHSAT0AAAAAABVWXBGJBQSFC3PLQP4KKOG6YZJIDCA)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>##</a-p> <a-tt>normal usage:</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>/* calling every frame */</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>let modal = </a-p><a-t>Modal</a-t><a-p>::</a-p><a-f>new</a-f><a-p>(ctx, </a-p><a-s>&quot;my_modal&quot;</a-s><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>// What goes inside the modal</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>modal.</a-p><a-f>show</a-f><a-p>(|ui| {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>    </a-p><a-c>// these helper functions help set the ui based on the modal&#39;s</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>    </a-p><a-c>// set style, but they are not required and you can put whatever</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>    </a-p><a-c>// ui you want inside [`.show()`]</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>    modal.</a-p><a-f>title</a-f><a-p>(ui, </a-p><a-s>&quot;Hello world!&quot;</a-s><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>    modal.</a-p><a-f>frame</a-f><a-p>(ui, |ui| {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>        modal.</a-p><a-f>body</a-f><a-p>(ui, </a-p><a-s>&quot;This is a modal.&quot;</a-s><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>    });</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>    modal.</a-p><a-f>buttons</a-f><a-p>(ui, |ui| {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>        </a-p><a-c>// After clicking, the modal is automatically closed</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>        </a-p><a-k>if</a-k><a-p> modal.</a-p><a-f>button</a-f><a-p>(ui, </a-p><a-s>&quot;close&quot;</a-s><a-p>).</a-p><a-f>clicked</a-f><a-p>() {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>            </a-p><a-m>println!</a-m><a-p>(</a-p><a-s>&quot;Hello world!&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>        };</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>    }); </a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>});</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>if ui.</a-p><a-f>button</a-f><a-p>(</a-p><a-s>&quot;Open the modal&quot;</a-s><a-p>).</a-p><a-f>clicked</a-f><a-p>() {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>    </a-p><a-c>// Show the modal</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>    modal.</a-p><a-f>open</a-f><a-p>();</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>## </a-p><a-tt>dialog usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>![dialog](https://raw.githubusercontent.com/n00kii/egui-modal/main/media/dialog.png)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>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&#39;s return.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>/* calling every frame */</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>let modal = </a-p><a-t>Modal</a-t><a-p>::</a-p><a-f>new</a-f><a-p>(ctx, </a-p><a-s>&quot;my_dialog&quot;</a-s><a-p>);</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>...</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>// Show the dialog</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>modal.</a-p><a-f>show_dialog</a-f><a-p>();</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>elsewhere,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>```</a-p><a-tl>rust</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>/* happens once */</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>if </a-p><a-k>let</a-k><a-p> </a-p><a-cr>Ok</a-cr><a-p>(data) = </a-p><a-f>my_function</a-f><a-p>() {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>    modal.</a-p><a-f>dialog</a-f><a-p>()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>        .</a-p><a-f>with_title</a-f><a-p>(</a-p><a-s>&quot;my_function&#39;s result is...&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>        .</a-p><a-f>with_body</a-f><a-p>(</a-p><a-s>&quot;my_function was successful!&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>        .</a-p><a-f>with_icon</a-f><a-p>(</a-p><a-t>Icon</a-t><a-p>::</a-p><a-cr>Success</a-cr><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>        .</a-p><a-f>open</a-f><a-p>()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
