podman-desktop/api/interfaces/InputBoxOptions.html

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-interfaces/InputBoxOptions" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.0.0">
<title data-rh="true">Interface: InputBoxOptions | Podman Desktop</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" name="twitter:image" content="https://podman-desktop.io/img/banner_podman-desktop.png"><meta data-rh="true" property="og:url" content="https://podman-desktop.io/api/interfaces/InputBoxOptions"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-api-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-api-current"><meta data-rh="true" property="og:title" content="Interface: InputBoxOptions | Podman Desktop"><meta data-rh="true" name="description" content="Options to configure the behavior of the input box UI."><meta data-rh="true" property="og:description" content="Options to configure the behavior of the input box UI."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://podman-desktop.io/api/interfaces/InputBoxOptions"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/InputBoxOptions" hreflang="en"><link data-rh="true" rel="alternate" href="https://podman-desktop.io/api/interfaces/InputBoxOptions" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://MR01ANKQ9S-dsn.algolia.net" crossorigin="anonymous"><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Podman Desktop RSS Feed">
<link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Podman Desktop Atom Feed">
<link rel="alternate" type="application/json" href="/blog/feed.json" title="Podman Desktop JSON Feed">


<link rel="search" type="application/opensearchdescription+xml" title="Podman Desktop" href="/opensearch.xml">

<link rel="preconnect" href="https://podman-desktop-website.goatcounter.com">
<script async src="//gc.zgo.at/count.js" data-goatcounter="https://podman-desktop-website.goatcounter.com/count"></script><link rel="stylesheet" href="/assets/css/styles.fded9501.css">
<script src="/assets/js/runtime~main.c2bdddc7.js" defer="defer"></script>
<script src="/assets/js/main.7209e56f.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.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{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_oPtH" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--light_hHel" height="56"><img src="/img/logo.svg" alt="Podman Desktop Logo" class="themedComponent_siVc themedComponent--dark_yETr" height="56"></div><b class="navbar__title text--truncate">podman desktop</b></a><a class="navbar__item navbar__link" href="/docs/intro">Documentation</a><a class="navbar__item navbar__link" href="/core-values">Core Values</a><a class="navbar__item navbar__link" href="/features">Features</a><a class="navbar__item navbar__link" href="/downloads">Downloads</a><a class="navbar__item navbar__link" href="/extend">Extend</a><a class="navbar__item navbar__link" href="/blog">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link"></a><div class="toggle_ki11 colorModeToggle_Hewu"><button class="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"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_lgto"><path fill="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><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_U96C"><path fill="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,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,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.36 c-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>
<h2 class="anchor anchorWithStickyNavbar_JmGV" id="properties">Properties<a href="#properties" class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties"></a></h2>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="ignorefocusout">ignoreFocusOut?<a href="#ignorefocusout" class="hash-link" aria-label="Direct link to ignoreFocusOut?" title="Direct link to ignoreFocusOut?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>ignoreFocusOut</strong>: <code>boolean</code></p>
</blockquote>
<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>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source">Source<a href="#source" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L846" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:846</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="markdowndescription">markdownDescription?<a href="#markdowndescription" class="hash-link" aria-label="Direct link to markdownDescription?" title="Direct link to markdownDescription?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>markdownDescription</strong>: <code>any</code></p>
</blockquote>
<p>A description of the field to be show (Markdown format)</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-1">Source<a href="#source-1" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L830" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:830</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="multiline">multiline?<a href="#multiline" class="hash-link" aria-label="Direct link to multiline?" title="Direct link to multiline?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>multiline</strong>: <code>boolean</code></p>
</blockquote>
<p>Set to <code>true</code> when value represents a multi line content.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-2">Source<a href="#source-2" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L851" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:851</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="password">password?<a href="#password" class="hash-link" aria-label="Direct link to password?" title="Direct link to password?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>password</strong>: <code>boolean</code></p>
</blockquote>
<p>Controls if a password input is shown. Password input hides the typed text.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-3">Source<a href="#source-3" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L840" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:840</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="placeholder">placeHolder?<a href="#placeholder" class="hash-link" aria-label="Direct link to placeHolder?" title="Direct link to placeHolder?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>placeHolder</strong>: <code>string</code></p>
</blockquote>
<p>An optional string to show as placeholder in the input box to guide the user what to type.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-4">Source<a href="#source-4" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L835" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:835</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="prompt">prompt?<a href="#prompt" class="hash-link" aria-label="Direct link to prompt?" title="Direct link to prompt?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>prompt</strong>: <code>string</code></p>
</blockquote>
<p>The text to display underneath the input box.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-5">Source<a href="#source-5" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L825" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:825</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="title">title?<a href="#title" class="hash-link" aria-label="Direct link to title?" title="Direct link to title?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>title</strong>: <code>string</code></p>
</blockquote>
<p>An optional string that represents the title of the input box.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-6">Source<a href="#source-6" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L807" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:807</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="value">value?<a href="#value" class="hash-link" aria-label="Direct link to value?" title="Direct link to value?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>value</strong>: <code>string</code></p>
</blockquote>
<p>The value to pre-fill in the input box.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-7">Source<a href="#source-7" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L812" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:812</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="valueselection">valueSelection?<a href="#valueselection" class="hash-link" aria-label="Direct link to valueSelection?" title="Direct link to valueSelection?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>valueSelection</strong>: [<code>number</code>, <code>number</code>]</p>
</blockquote>
<p>Selection of the pre-filled <a href="/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>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-8">Source<a href="#source-8" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L820" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:820</a></p>
<h2 class="anchor anchorWithStickyNavbar_JmGV" id="methods">Methods<a href="#methods" class="hash-link" aria-label="Direct link to Methods" title="Direct link to Methods"></a></h2>
<h3 class="anchor anchorWithStickyNavbar_JmGV" id="validateinput">validateInput()?<a href="#validateinput" class="hash-link" aria-label="Direct link to validateInput()?" title="Direct link to validateInput()?"></a></h3>
<blockquote>
<p><strong><code>optional</code></strong> <strong>validateInput</strong>(<code>value</code>): <code>undefined</code> | <code>null</code> | <code>string</code> | <a href="/api/interfaces/InputBoxValidationMessage"><code>InputBoxValidationMessage</code></a> | <code>Promise</code>&lt; <code>undefined</code> | <code>null</code> | <code>string</code> | <a href="/api/interfaces/InputBoxValidationMessage"><code>InputBoxValidationMessage</code></a> &gt;</p>
</blockquote>
<p>An optional function that will be called to validate input and to give a hint
to the user.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4>
<p>• <strong>value</strong>: <code>string</code></p>
<p>The current value of the input box.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns"></a></h4>
<p><code>undefined</code> | <code>null</code> | <code>string</code> | <a href="/api/interfaces/InputBoxValidationMessage"><code>InputBoxValidationMessage</code></a> | <code>Promise</code>&lt; <code>undefined</code> | <code>null</code> | <code>string</code> | <a href="/api/interfaces/InputBoxValidationMessage"><code>InputBoxValidationMessage</code></a> &gt;</p>
<p>Either a human-readable string which is presented as an error message or an <a href="/api/interfaces/InputBoxValidationMessage">InputBoxValidationMessage</a>
which can provide a specific message severity. Return <code>undefined</code>, <code>null</code>, or the empty string when &#x27;value&#x27; is valid.</p>
<h4 class="anchor anchorWithStickyNavbar_JmGV" id="source-9">Source<a href="#source-9" class="hash-link" aria-label="Direct link to Source" title="Direct link to Source"></a></h4>
<p><a href="https://github.com/containers/podman-desktop/blob/58be625/packages/extension-api/src/extension-api.d.ts#L861" target="_blank" rel="noopener noreferrer">packages/extension-api/src/extension-api.d.ts:861</a></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/api/interfaces/ImageInspectInfo"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Interface: ImageInspectInfo</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/interfaces/InputBoxValidationMessage"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Interface: InputBoxValidationMessage</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_XG6w thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#ignorefocusout" class="table-of-contents__link toc-highlight">ignoreFocusOut?</a></li><li><a href="#markdowndescription" class="table-of-contents__link toc-highlight">markdownDescription?</a></li><li><a href="#multiline" class="table-of-contents__link toc-highlight">multiline?</a></li><li><a href="#password" class="table-of-contents__link toc-highlight">password?</a></li><li><a href="#placeholder" class="table-of-contents__link toc-highlight">placeHolder?</a></li><li><a href="#prompt" class="table-of-contents__link toc-highlight">prompt?</a></li><li><a href="#title" class="table-of-contents__link toc-highlight">title?</a></li><li><a href="#value" class="table-of-contents__link toc-highlight">value?</a></li><li><a href="#valueselection" class="table-of-contents__link toc-highlight">valueSelection?</a></li></ul></li><li><a href="#methods" class="table-of-contents__link toc-highlight">Methods</a><ul><li><a href="#validateinput" class="table-of-contents__link toc-highlight">validateInput()?</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Documentation</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installing Podman Desktop</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/migrating-from-docker">Migrating from Docker</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/kubernetes">Working with Kubernetes</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/troubleshooting">Troubleshooting</a></li></ul></div><div class="col footer__col"><div class="footer__title">Links</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/containers/podman-desktop" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://discord.com/invite/x5GzFF6QH4" target="_blank" rel="noopener noreferrer" class="footer__link-item">Chat (bridged): #podman-desktop on Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://github.com/containers/podman-desktop#communication" target="_blank" rel="noopener noreferrer" class="footer__link-item">Other ways to Communicate<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPrP"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-1
</body>
</html>