<titledata-rh="true">Interface: InputBoxOptions | Podman Desktop</title><metadata-rh="true"name="viewport"content="width=device-width,initial-scale=1"><metadata-rh="true"name="twitter:card"content="summary_large_image"><metadata-rh="true"property="og:image"content="https://podman-desktop.io/img/banner_podman-desktop.png"><metadata-rh="true"name="twitter:image"content="https://podman-desktop.io/img/banner_podman-desktop.png"><metadata-rh="true"property="og:url"content="https://podman-desktop.io/api/interfaces/InputBoxOptions"><metadata-rh="true"property="og:locale"content="en"><metadata-rh="true"name="docusaurus_locale"content="en"><metadata-rh="true"name="docsearch:language"content="en"><metadata-rh="true"name="docusaurus_version"content="current"><metadata-rh="true"name="docusaurus_tag"content="docs-api-current"><metadata-rh="true"name="docsearch:version"content="current"><metadata-rh="true"name="docsearch:docusaurus_tag"content="docs-api-current"><metadata-rh="true"property="og:title"content="Interface: InputBoxOptions | Podman Desktop"><metadata-rh="true"name="description"content="Options to configure the behavior of the input box UI."><metadata-rh="true"property="og:description"content="Options to configure the behavior of the input box UI."><linkdata-rh="true"rel="icon"href="/img/favicon.ico"><linkdata-rh="true"rel="canonical"href="https://podman-desktop.io/api/interfaces/InputBoxOptions"><linkdata-rh="true"rel="alternate"href="https://podman-desktop.io/api/interfaces/InputBoxOptions"hreflang="en"><linkdata-rh="true"rel="alternate"href="https://podman-desktop.io/api/interfaces/InputBoxOptions"hreflang="x-default"><linkdata-rh="true"rel="preconnect"href="https://MR01ANKQ9S-dsn.algolia.net"crossorigin="anonymous"><linkrel="alternate"type="application/rss+xml"href="/blog/rss.xml"title="Podman Desktop RSS Feed">
<linkrel="alternate"type="application/atom+xml"href="/blog/atom.xml"title="Podman Desktop Atom Feed">
<script>!function(){functiont(t){document.documentElement.setAttribute("data-theme",t)}vare=function(){try{returnnewURLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{returnlocalStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):window.matchMedia("(prefers-color-scheme: light)").matches?t("light"):t("dark")}(),function(){try{constc=newURLSearchParams(window.location.search).entries();for(var[t,e]ofc)if(t.startsWith("docusaurus-data-")){vara=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><divid="__docusaurus"><divrole="region"aria-label="Skip to main content"><aclass="skipToContent_oPtH"href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><navaria-label="Main"class="navbar navbar--fixed-top"><divclass="navbar__inner"><divclass="navbar__items"><buttonaria-label="Toggle navigation bar"aria-expanded="false"class="navbar__toggle clean-btn"type="button"><svgwidth="30"height="30"viewBox="0 0 30 30"aria-hidden="true"><pathstroke="currentColor"stroke-linecap="round"stroke-miterlimit="10"stroke-width="2"d="M4 7h22M4 15h22M4 23h22"></path></svg></button><aclass="navbar__brand"href="/"><divclass="navbar__logo"><imgsrc="/img/logo.svg"alt="Podman Desktop Logo"class="themedComponent_siVc themedComponent--light_hHel"height="56"><imgsrc="/img/logo.svg"alt="Podman Desktop Logo"class="themedComponent_siVc themedComponent--dark_yETr"height="56"></div><bclass="navbar__title text--truncate">podman desktop</b></a><aclass="navbar__item navbar__link"href="/docs/intro">Documentation</a><aclass="navbar__item navbar__link"href="/core-values">Core Values</a><aclass="navbar__item navbar__link"href="/features">Features</a><aclass="navbar__item navbar__link"href="/downloads">Downloads</a><aclass="navbar__item navbar__link"href="/extend">Extend</a><aclass="navbar__item navbar__link"href="/blog">Blog</a></div><divclass="navbar__items navbar__items--right"><ahref="https://github.com/containers/podman-desktop"target="_blank"rel="noopener noreferrer"class="navbar__item navbar__link header-github-link"></a><divclass="toggle_ki11 colorModeToggle_Hewu"><buttonclass="clean-btn toggleButton_MMFG toggleButtonDisabled_Uw7m"type="button"disabled=""title="Switch between dark and light mode (currently dark mode)"aria-label="Switch between dark and light mode (currently dark mode)"aria-live="polite"><svgviewBox="0 0 24 24"width="24"height="24"class="lightToggleIcon_lgto"><pathfill="currentColor"d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svgviewBox="0 0 24 24"width="24"height="24"class="darkToggleIcon_U96C"><pathfill="currentColor"d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51zM12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.9
<p>Options to configure the behavior of the input box UI.</p>
<h2class="anchor anchorWithStickyNavbar_JmGV"id="properties">Properties<ahref="#properties"class="hash-link"aria-label="Direct link to Properties"title="Direct link to Properties"></a></h2>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="ignorefocusout">ignoreFocusOut?<ahref="#ignorefocusout"class="hash-link"aria-label="Direct link to ignoreFocusOut?"title="Direct link to ignoreFocusOut?"></a></h3>
<p>Set to <code>true</code> to keep the input box open when focus moves to another part of the editor or to another window.
This setting is ignored on iPad and is always false.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source">Source<ahref="#source"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="markdowndescription">markdownDescription?<ahref="#markdowndescription"class="hash-link"aria-label="Direct link to markdownDescription?"title="Direct link to markdownDescription?"></a></h3>
<p>A description of the field to be show (Markdown format)</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-1">Source<ahref="#source-1"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="multiline">multiline?<ahref="#multiline"class="hash-link"aria-label="Direct link to multiline?"title="Direct link to multiline?"></a></h3>
<p>Set to <code>true</code> when value represents a multi line content.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-2">Source<ahref="#source-2"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="password">password?<ahref="#password"class="hash-link"aria-label="Direct link to password?"title="Direct link to password?"></a></h3>
<p>Controls if a password input is shown. Password input hides the typed text.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-3">Source<ahref="#source-3"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="placeholder">placeHolder?<ahref="#placeholder"class="hash-link"aria-label="Direct link to placeHolder?"title="Direct link to placeHolder?"></a></h3>
<p>An optional string to show as placeholder in the input box to guide the user what to type.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-4">Source<ahref="#source-4"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="prompt">prompt?<ahref="#prompt"class="hash-link"aria-label="Direct link to prompt?"title="Direct link to prompt?"></a></h3>
<p>The text to display underneath the input box.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-5">Source<ahref="#source-5"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="title">title?<ahref="#title"class="hash-link"aria-label="Direct link to title?"title="Direct link to title?"></a></h3>
<p>An optional string that represents the title of the input box.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-6">Source<ahref="#source-6"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="value">value?<ahref="#value"class="hash-link"aria-label="Direct link to value?"title="Direct link to value?"></a></h3>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-7">Source<ahref="#source-7"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="valueselection">valueSelection?<ahref="#valueselection"class="hash-link"aria-label="Direct link to valueSelection?"title="Direct link to valueSelection?"></a></h3>
<p>Selection of the pre-filled <ahref="/api/interfaces/InputBoxOptions#value"><code>value</code></a>. Defined as tuple of two number where the
first is the inclusive start index and the second the exclusive end index. When <code>undefined</code> the whole
pre-filled value will be selected, when empty (start equals end) only the cursor will be set,
otherwise the defined range will be selected.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-8">Source<ahref="#source-8"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
<h2class="anchor anchorWithStickyNavbar_JmGV"id="methods">Methods<ahref="#methods"class="hash-link"aria-label="Direct link to Methods"title="Direct link to Methods"></a></h2>
<h3class="anchor anchorWithStickyNavbar_JmGV"id="validateinput">validateInput()?<ahref="#validateinput"class="hash-link"aria-label="Direct link to validateInput()?"title="Direct link to validateInput()?"></a></h3>
<p>An optional function that will be called to validate input and to give a hint
to the user.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="parameters">Parameters<ahref="#parameters"class="hash-link"aria-label="Direct link to Parameters"title="Direct link to Parameters"></a></h4>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="returns">Returns<ahref="#returns"class="hash-link"aria-label="Direct link to Returns"title="Direct link to Returns"></a></h4>
<p>Either a human-readable string which is presented as an error message or an <ahref="/api/interfaces/InputBoxValidationMessage">InputBoxValidationMessage</a>
which can provide a specific message severity. Return <code>undefined</code>, <code>null</code>, or the empty string when 'value' is valid.</p>
<h4class="anchor anchorWithStickyNavbar_JmGV"id="source-9">Source<ahref="#source-9"class="hash-link"aria-label="Direct link to Source"title="Direct link to Source"></a></h4>
