build based on 1582b78

disberd · Dec 6, 2024 · 46d8140 · 46d8140
1 parent f1725c9
commit 46d8140
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 15 deletions.
diff --git a/dev/basic_widgets/index.html b/dev/basic_widgets/index.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Basic Widgets · PlutoExtras.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">PlutoExtras.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">PlutoExtras</a></li><li class="is-active"><a class="tocitem" href>Basic Widgets</a><ul class="internal"><li><a class="tocitem" href="#Editable"><span>Editable</span></a></li><li><a class="tocitem" href="#StringOnEnter"><span>StringOnEnter</span></a></li></ul></li><li><a class="tocitem" href="../latex_equations/">LaTeX Equations</a></li><li><a class="tocitem" href="../toc/">Extended ToC</a></li><li><a class="tocitem" href="../structbond/">StructBond Module</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Basic Widgets</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Basic Widgets</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/disberd/PlutoExtras.jl/blob/master/docs/src/basic_widgets.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Basic-Widgets"><a class="docs-heading-anchor" href="#Basic-Widgets">Basic Widgets</a><a id="Basic-Widgets-1"></a><a class="docs-heading-anchor-permalink" href="#Basic-Widgets" title="Permalink"></a></h1><p>This Package exports two basic widgets: <code>Editable</code> and <code>StringOnEnter</code></p><h2 id="Editable"><a class="docs-heading-anchor" href="#Editable">Editable</a><a id="Editable-1"></a><a class="docs-heading-anchor-permalink" href="#Editable" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="PlutoExtras.Editable" href="#PlutoExtras.Editable"><code>PlutoExtras.Editable</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Editable(x::Real; [prefix, suffix, format])</code></pre><p>Create a Pluto widget similar to <a href="@ref"><code>Scrubbable</code></a> from PlutoUI but that can contain an arbitrary (Real) number provided as input.</p><p>The displayed HTML will create a span with a blue background which contains the number and is preceded by an optional text <code>prefix</code> and an optional text <code>suffix</code>. If <code>format</code> is specified, it will be used to format the shown number using the <a href="https://github.com/d3/d3-format#locale_format">d3-format</a> specification.</p><p>The widget will trigger a bond update only upon pressing Enter or moving the focus out of the widget itself.</p><p><img src="https://github.com/disberd/PlutoExtras.jl/assets/12846528/cb0f19e3-7dcb-46d6-88b1-1bbe1592dd1c" alt="79f77981-2c53-4ff0-bd13-8213519e0bca"/></p><p><strong>Keyword Arguments</strong></p><ul><li><code>prefix::AbstractString</code>: A string that will be inserted in the displayed HTML before the number. Clicking on the suffix will select the full text defining the number</li><li><code>suffix::AbstractString</code>: A string that will be inserted in the displayed HTML after the number. Clicking on the suffix will select the full text defining the number</li><li><code>format::AbstractString</code>: A string specifing the format to use for displaying the number in HTML. Uses the <a href="https://github.com/d3/d3-format#locale_format">d3-format</a> specification</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/disberd/PlutoExtras.jl/blob/4f923116cbb864a99edd3fd9dcff1403e67c6231/src/basic_widgets.jl#L18-L32">source</a></section><section><div><pre><code class="nohighlight hljs">Editable(x::Bool[, true_string=&quot;true&quot;, false_string=&quot;false&quot;)</code></pre><p>Create a Pluto widget that contain a Boolean value.</p><p>The displayed HTML will create a span with a green background that displays the custom string <code>true_string</code> when true and the <code>false_string</code> when false. If not provided, the second argument <code>true_string</code> defaults to &quot;true&quot; and the third one the &quot;false&quot;.</p><p>The widget will trigger a bond update when clicking on it.</p><p><img src="https://github.com/disberd/PlutoExtras.jl/assets/12846528/f12e3bc3-f78c-45b5-b5fd-06f2083fc5c4" alt="991b712a-d62d-4036-b096-fe0fc52c9b25"/></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/disberd/PlutoExtras.jl/blob/4f923116cbb864a99edd3fd9dcff1403e67c6231/src/basic_widgets.jl#L36-L45">source</a></section></article><h2 id="StringOnEnter"><a class="docs-heading-anchor" href="#StringOnEnter">StringOnEnter</a><a id="StringOnEnter-1"></a><a class="docs-heading-anchor-permalink" href="#StringOnEnter" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="PlutoExtras.StringOnEnter" href="#PlutoExtras.StringOnEnter"><code>PlutoExtras.StringOnEnter</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">StringOnEnter(default::AbstractString)</code></pre><p>Creates a Pluto widget that allows to provide a string as output when used with <code>@bind</code>.</p><p>Unlike the custom &quot;TextField&quot; from PlutoUI this only triggers a bond update upon pressing Enter or moving the focus out of the widget (similar to <a href="#PlutoExtras.Editable"><code>Editable</code></a>)</p><p>When rendered in HTML, the widget text will be shown with a dark yellow background.</p><p><img src="https://github.com/disberd/PlutoExtras.jl/assets/12846528/782360f2-595a-4bbe-9769-5ddfaa144611" alt="868c1c6e-8731-4465-959e-58cf551b9f61"/></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/disberd/PlutoExtras.jl/blob/4f923116cbb864a99edd3fd9dcff1403e67c6231/src/basic_widgets.jl#L233-L242">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« PlutoExtras</a><a class="docs-footer-nextpage" href="../latex_equations/">LaTeX Equations »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 6 December 2024 15:20">Friday 6 December 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Basic Widgets · PlutoExtras.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">PlutoExtras.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">PlutoExtras</a></li><li class="is-active"><a class="tocitem" href>Basic Widgets</a><ul class="internal"><li><a class="tocitem" href="#Editable"><span>Editable</span></a></li><li><a class="tocitem" href="#StringOnEnter"><span>StringOnEnter</span></a></li></ul></li><li><a class="tocitem" href="../latex_equations/">LaTeX Equations</a></li><li><a class="tocitem" href="../toc/">Extended ToC</a></li><li><a class="tocitem" href="../structbond/">StructBond Module</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Basic Widgets</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Basic Widgets</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/disberd/PlutoExtras.jl/blob/master/docs/src/basic_widgets.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Basic-Widgets"><a class="docs-heading-anchor" href="#Basic-Widgets">Basic Widgets</a><a id="Basic-Widgets-1"></a><a class="docs-heading-anchor-permalink" href="#Basic-Widgets" title="Permalink"></a></h1><p>This Package exports two basic widgets: <code>Editable</code> and <code>StringOnEnter</code></p><h2 id="Editable"><a class="docs-heading-anchor" href="#Editable">Editable</a><a id="Editable-1"></a><a class="docs-heading-anchor-permalink" href="#Editable" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="PlutoExtras.Editable" href="#PlutoExtras.Editable"><code>PlutoExtras.Editable</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Editable(x::Real; [prefix, suffix, format])</code></pre><p>Create a Pluto widget similar to <a href="@ref"><code>Scrubbable</code></a> from PlutoUI but that can contain an arbitrary (Real) number provided as input.</p><p>The displayed HTML will create a span with a blue background which contains the number and is preceded by an optional text <code>prefix</code> and an optional text <code>suffix</code>. If <code>format</code> is specified, it will be used to format the shown number using the <a href="https://github.com/d3/d3-format#locale_format">d3-format</a> specification.</p><p>The widget will trigger a bond update only upon pressing Enter or moving the focus out of the widget itself.</p><p><img src="https://github.com/disberd/PlutoExtras.jl/assets/12846528/cb0f19e3-7dcb-46d6-88b1-1bbe1592dd1c" alt="79f77981-2c53-4ff0-bd13-8213519e0bca"/></p><p><strong>Keyword Arguments</strong></p><ul><li><code>prefix::AbstractString</code>: A string that will be inserted in the displayed HTML before the number. Clicking on the suffix will select the full text defining the number</li><li><code>suffix::AbstractString</code>: A string that will be inserted in the displayed HTML after the number. Clicking on the suffix will select the full text defining the number</li><li><code>format::AbstractString</code>: A string specifing the format to use for displaying the number in HTML. Uses the <a href="https://github.com/d3/d3-format#locale_format">d3-format</a> specification</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/disberd/PlutoExtras.jl/blob/1582b78817aca057b3e83035a032742c5240985a/src/basic_widgets.jl#L18-L32">source</a></section><section><div><pre><code class="nohighlight hljs">Editable(x::Bool[, true_string=&quot;true&quot;, false_string=&quot;false&quot;)</code></pre><p>Create a Pluto widget that contain a Boolean value.</p><p>The displayed HTML will create a span with a green background that displays the custom string <code>true_string</code> when true and the <code>false_string</code> when false. If not provided, the second argument <code>true_string</code> defaults to &quot;true&quot; and the third one the &quot;false&quot;.</p><p>The widget will trigger a bond update when clicking on it.</p><p><img src="https://github.com/disberd/PlutoExtras.jl/assets/12846528/f12e3bc3-f78c-45b5-b5fd-06f2083fc5c4" alt="991b712a-d62d-4036-b096-fe0fc52c9b25"/></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/disberd/PlutoExtras.jl/blob/1582b78817aca057b3e83035a032742c5240985a/src/basic_widgets.jl#L36-L45">source</a></section></article><h2 id="StringOnEnter"><a class="docs-heading-anchor" href="#StringOnEnter">StringOnEnter</a><a id="StringOnEnter-1"></a><a class="docs-heading-anchor-permalink" href="#StringOnEnter" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="PlutoExtras.StringOnEnter" href="#PlutoExtras.StringOnEnter"><code>PlutoExtras.StringOnEnter</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">StringOnEnter(default::AbstractString)</code></pre><p>Creates a Pluto widget that allows to provide a string as output when used with <code>@bind</code>.</p><p>Unlike the custom &quot;TextField&quot; from PlutoUI this only triggers a bond update upon pressing Enter or moving the focus out of the widget (similar to <a href="#PlutoExtras.Editable"><code>Editable</code></a>)</p><p>When rendered in HTML, the widget text will be shown with a dark yellow background.</p><p><img src="https://github.com/disberd/PlutoExtras.jl/assets/12846528/782360f2-595a-4bbe-9769-5ddfaa144611" alt="868c1c6e-8731-4465-959e-58cf551b9f61"/></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/disberd/PlutoExtras.jl/blob/1582b78817aca057b3e83035a032742c5240985a/src/basic_widgets.jl#L233-L242">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« PlutoExtras</a><a class="docs-footer-nextpage" href="../latex_equations/">LaTeX Equations »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 6 December 2024 15:22">Friday 6 December 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>