2025-03-17 09:57:37 +00:00
<!doctype html>
< html lang = "en" dir = "ltr" class = "docs-wrapper plugin-docs plugin-id-api docs-version-current docs-doc-page docs-doc-id-@podman-desktop/namespaces/window/functions/showInputBox" data-has-hydrated = "false" >
< head >
< meta charset = "UTF-8" >
< meta name = "generator" content = "Docusaurus v3.7.0" >
< title data-rh = "true" > Function: showInputBox() | 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/@podman-desktop/namespaces/window/functions/showInputBox" > < 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 = "Function: showInputBox() | Podman Desktop" > < meta data-rh = "true" name = "description" content = "showInputBox(options?, token?): Promise\" > < meta data-rh = "true" property = "og:description" content = "showInputBox(options?, token?): Promise\" > < link data-rh = "true" rel = "icon" href = "/img/favicon.ico" > < link data-rh = "true" rel = "canonical" href = "https://podman-desktop.io/api/@podman-desktop/namespaces/window/functions/showInputBox" > < link data-rh = "true" rel = "alternate" href = "https://podman-desktop.io/api/@podman-desktop/namespaces/window/functions/showInputBox" hreflang = "en" > < link data-rh = "true" rel = "alternate" href = "https://podman-desktop.io/api/@podman-desktop/namespaces/window/functions/showInputBox" 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" >
2025-04-28 13:47:13 +00:00
< 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.28115879.css" >
< script src = "/assets/js/runtime~main.e5ebba96.js" defer = "defer" > < / script >
< script src = "/assets/js/main.4ed745e5.js" defer = "defer" > < / script >
2025-03-17 09:57:37 +00:00
< / head >
< body class = "navigation-with-keyboard" >
2025-04-10 13:49:35 +00:00
< 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 window . 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 = "/downloads" > Downloads< / a > < a class = "navbar__item navbar__link" href = "/community" > Community< / a > < div class = "navbar__item dropdown dropdown--hoverable" > < a href = "#" aria-haspopup = "true" aria-expanded = "false" role = "button" class = "navbar__link" > Resources< / a > < ul class = "dropdown__menu" > < li > < a class = "dropdown__link" href = "/features" > Features< / a > < / li > < li > < a class = "dropdown__link" href = "/tutorial" > Tutorials< / a > < / li > < li > < a class = "dropdown__link" href = "/extend" > Extend< / a > < / li > < / ul > < / div > < a class = "navbar__item navbar__link" href = "/blog" > Blog< / a > < / div > < div class = "navbar__items navbar__items--right" > < div > < a class = "hidden lg:flex font-semibold no-underline hover:no-underline items-center text-white hover:text-white bg-gradient-to-b from-violet-500 to-violet-600 border-0 py-3 px-6 focus:outline-hidden hover:from-violet-600 hover:to-violet-700 rounded-lg text-base mt-0 mb-0 ml-4" href = "/downloads" > Download< / a > < / div > < a href = "https://github.com/podman-desktop/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" aria-pressed = "true" > < 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
2025-03-17 09:57:37 +00:00
< blockquote >
2025-04-10 05:20:11 +00:00
< p > < strong > showInputBox< / strong > (< code > options?< / code > , < code > token?< / code > ): < code > Promise< / code > < < code > undefined< / code > | < code > string< / code > > < / p >
2025-03-17 09:57:37 +00:00
< / blockquote >
2025-04-28 13:47:13 +00:00
< p > Defined in: < a href = "https://github.com/podman-desktop/podman-desktop/blob/ef470d09503c9c2a073e251a55392f96028b284b/packages/extension-api/src/extension-api.d.ts#L2292" target = "_blank" rel = "noopener noreferrer" > packages/extension-api/src/extension-api.d.ts:2292< / a > < / p >
2025-03-17 09:57:37 +00:00
< p > Opens an input box to ask the user for input.< / p >
< p > The returned value will be < code > undefined< / code > if the input box was canceled (e.g. pressing ESC). Otherwise the
returned value will be the string typed by the user or an empty string if the user did not type
anything but dismissed the input box with OK.< / p >
< h2 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 > < / h2 >
< h3 class = "anchor anchorWithStickyNavbar_JmGV" id = "options" > options?< a href = "#options" class = "hash-link" aria-label = "Direct link to options?" title = "Direct link to options?" > < / a > < / h3 >
< p > < a href = "/api/interfaces/InputBoxOptions" > < code > InputBoxOptions< / code > < / a > < / p >
< p > Configures the behavior of the input box.< / p >
< h3 class = "anchor anchorWithStickyNavbar_JmGV" id = "token" > token?< a href = "#token" class = "hash-link" aria-label = "Direct link to token?" title = "Direct link to token?" > < / a > < / h3 >
< p > < a href = "/api/interfaces/CancellationToken" > < code > CancellationToken< / code > < / a > < / p >
< p > A token that can be used to signal cancellation.< / p >
< h2 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 > < / h2 >
< p > < code > Promise< / code > < < code > undefined< / code > | < code > string< / code > > < / p >
2025-04-14 17:49:47 +00:00
< p > A promise that resolves to a string the user provided or to < code > undefined< / code > in case of dismissal.< / 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/@podman-desktop/namespaces/window/functions/showInformationMessage" > < div class = "pagination-nav__sublabel" > Previous< / div > < div class = "pagination-nav__label" > showInformationMessage< / div > < / a > < a class = "pagination-nav__link pagination-nav__link--next" href = "/api/@podman-desktop/namespaces/window/functions/showNotification" > < div class = "pagination-nav__sublabel" > Next< / div > < div class = "pagination-nav__label" > showNotification< / 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 = "#parameters" class = "table-of-contents__link toc-highlight" > Parameters< / a > < ul > < li > < a href = "#options" class = "table-of-contents__link toc-highlight" > options?< / a > < / li > < li > < a href = "#token" class = "table-of-contents__link toc-highlight" > token?< / a > < / li > < / ul > < / li > < li > < a href = "#returns" class = "table-of-contents__link toc-highlight" > Returns< / a > < / 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/podman-desktop/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/podman-desktop/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-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/orgs/podman-desktop/projects/4/views/3" target = "_blank" rel = "noopener noreferrer" class = "footer__link-item" > Current Sprint< 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 > < / ul > < / div > < / div > < div class = "footer__bottom text--center" > < div class = "footer__copyright" >
< div class = "flex flex-col items-start text-left gap-4" >
< div class = "w-96 mt-8 mb-8" >
< img class = "dark:hidden" alt = "Cloud Native Computing Foundation" src = "/img/cncf-logo.svg" >
< img class = "hidden dark:inline" alt = "Cloud Native Computing Foundation" src = "/img/cncf-logo-dark.svg" >
< / div >
< div class = "text-sm" >
< p class = "mb-1" > We are a < a href = "https://cncf.io/" class = "underline" > Cloud Native Computing Foundation< / a > sandbox project.< / p >
< p class = "mb-1" > © Copyright Podman Desktop Contributors 2025. © 2025 The Linux Foundation. All rights reserved.< / p >
< p class = "mb-1" > The Linux Foundation has registered trademarks and uses trademarks.
For a list of trademarks of The Linux Foundation, please see our
< a href = "https://www.linuxfoundation.org/trademark-usage/" class = "underline" > Trademark Usage< / a > page.< / p >
< / div >
< / div >
< / div > < / div > < / div > < / footer > < / div >
2025-03-17 09:57:37 +00:00
< / body >
< / html >
