├── .github └── workflows │ └── publish.yml ├── LICENSE ├── README.md ├── index.js └── package.json /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Package to npmjs 2 | on: 3 | release: 4 | types: [published] 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | permissions: 9 | contents: read 10 | id-token: write 11 | steps: 12 | - uses: actions/checkout@v4 13 | # Setup .npmrc file to publish to npm 14 | - uses: actions/setup-node@v4 15 | with: 16 | node-version: '20.x' 17 | registry-url: 'https://registry.npmjs.org' 18 | - run: npm publish --provenance --access public 19 | env: 20 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 21 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Prompts 2 | 3 | [![npm version](https://img.shields.io/npm/v/prompts-js)](https://www.npmjs.com/package/prompts-js) 4 | [![License: Apache2](https://img.shields.io/badge/License-Apache2-blue.svg)](https://opensource.org/license/apache-2-0) 5 | 6 | A lightweight, dependency-free JavaScript library for creating accessible modal alert, confirm, and prompt dialogs. This library implements an async promise-based approach as an alternative to the browser built-in `alert()`, `confirm()`, and `prompt()` functions. 7 | 8 | ## Features 9 | 10 | * **Keyboard accessible:** Built with keyboard navigation in mind, including focus trapping and keyboard navigation (Tab, Shift+Tab, Escape, Enter). 11 | * **Promise-based:** Uses Promises to allow for easy async/await usage. 12 | * **No Dependencies:** Written in pure JavaScript, requiring no external libraries or frameworks. 13 | * **Lightweight:** The library is small and designed to add minimal overhead to your project. 14 | 15 | ## Installation 16 | 17 | ```bash 18 | npm install prompts-js 19 | ``` 20 | Or use it from a CDN: 21 | ```html 22 | 23 | ``` 24 | 25 | ## Usage 26 | 27 | ```javascript 28 | // Alert 29 | await Prompts.alert("This is an alert message!"); 30 | console.log("Alert closed"); 31 | 32 | // Confirm 33 | const confirmed = await Prompts.confirm("Are you sure you want to proceed?"); 34 | if (confirmed) { 35 | console.log("User confirmed"); 36 | } else { 37 | console.log("User canceled"); 38 | } 39 | 40 | // Prompt for a string 41 | const userInput = await Prompts.prompt("Please enter your name:"); 42 | if (userInput) { 43 | console.log("User entered:", userInput); 44 | } else { 45 | console.log("User canceled or entered nothing"); 46 | } 47 | ``` 48 | 49 | ## API 50 | 51 | ### `await Prompts.alert(message)` 52 | 53 | Displays an alert dialog with an "OK" button. 54 | 55 | * `message` (string): The message to display in the alert. 56 | 57 | ### `await Prompts.confirm(message)` 58 | 59 | Displays a confirmation dialog with "OK" and "Cancel" buttons. 60 | 61 | * `message` (string): The message to display in the confirmation dialog. 62 | * Resolves: `true` if the user clicks "OK", `false` if they click "Cancel" or press escape. 63 | 64 | ### `await Prompts.prompt(message)` 65 | 66 | Displays a prompt dialog with a text input field and "OK" and "Cancel" buttons. 67 | 68 | * `message` (string): The message to display above the input field. 69 | * Resolves: the user's input (string) if they click "OK", `null` if they click "Cancel" or press escape. 70 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const Prompts = (function () { 2 | // Common styles 3 | const dialogStyle = { 4 | border: "none", 5 | borderRadius: "6px", 6 | padding: "20px", 7 | minWidth: "300px", 8 | maxWidth: "80%", 9 | boxSizing: "border-box", 10 | fontFamily: "sans-serif", 11 | boxShadow: "0 2px 10px rgba(0,0,0,0.2)", 12 | background: "#fff", 13 | }; 14 | 15 | const messageStyle = { 16 | marginBottom: "20px", 17 | fontSize: "16px", 18 | color: "#333", 19 | whiteSpace: "pre-wrap", 20 | wordWrap: "break-word", 21 | }; 22 | 23 | const buttonRowStyle = { 24 | textAlign: "right", 25 | marginTop: "20px", 26 | }; 27 | 28 | const buttonStyle = { 29 | backgroundColor: "#007bff", 30 | color: "#fff", 31 | border: "none", 32 | borderRadius: "4px", 33 | padding: "8px 12px", 34 | fontSize: "14px", 35 | cursor: "pointer", 36 | marginLeft: "8px", 37 | }; 38 | 39 | const cancelButtonStyle = { 40 | backgroundColor: "#6c757d", 41 | }; 42 | 43 | const inputStyle = { 44 | width: "100%", 45 | boxSizing: "border-box", 46 | padding: "8px", 47 | fontSize: "16px", 48 | marginBottom: "20px", 49 | borderRadius: "4px", 50 | border: "1px solid #ccc", 51 | }; 52 | 53 | function applyStyles(element, styles) { 54 | Object.assign(element.style, styles); 55 | } 56 | 57 | function createDialog(message) { 58 | const dialog = document.createElement("dialog"); 59 | applyStyles(dialog, dialogStyle); 60 | dialog.setAttribute("role", "dialog"); 61 | dialog.setAttribute("aria-modal", "true"); 62 | 63 | const form = document.createElement("form"); 64 | form.method = "dialog"; // Allows form to close the dialog on submission. 65 | 66 | const msg = document.createElement("div"); 67 | applyStyles(msg, messageStyle); 68 | msg.textContent = message; 69 | 70 | form.appendChild(msg); 71 | dialog.appendChild(form); 72 | 73 | return { dialog, form }; 74 | } 75 | 76 | function createButton(label, value, customStyles = {}, type = "submit") { 77 | const btn = document.createElement("button"); 78 | applyStyles(btn, buttonStyle); 79 | applyStyles(btn, customStyles); 80 | btn.type = type; 81 | btn.value = value; // form submission will set dialog.returnValue to this 82 | btn.textContent = label; 83 | return btn; 84 | } 85 | 86 | async function alert(message) { 87 | return new Promise((resolve) => { 88 | const { dialog, form } = createDialog(message); 89 | 90 | const buttonRow = document.createElement("div"); 91 | applyStyles(buttonRow, buttonRowStyle); 92 | 93 | const okBtn = createButton("OK", "ok"); 94 | buttonRow.appendChild(okBtn); 95 | form.appendChild(buttonRow); 96 | 97 | dialog.addEventListener("close", () => { 98 | resolve(); 99 | dialog.remove(); 100 | }); 101 | 102 | document.body.appendChild(dialog); 103 | dialog.showModal(); 104 | okBtn.focus(); 105 | }); 106 | } 107 | 108 | async function confirm(message) { 109 | return new Promise((resolve) => { 110 | const { dialog, form } = createDialog(message); 111 | 112 | const buttonRow = document.createElement("div"); 113 | applyStyles(buttonRow, buttonRowStyle); 114 | 115 | const cancelBtn = createButton("Cancel", "cancel", cancelButtonStyle); 116 | const okBtn = createButton("OK", "ok"); 117 | 118 | buttonRow.appendChild(cancelBtn); 119 | buttonRow.appendChild(okBtn); 120 | form.appendChild(buttonRow); 121 | 122 | dialog.addEventListener("close", () => { 123 | // dialog.returnValue will be "ok", "cancel", or "" (if ESC pressed) 124 | const val = dialog.returnValue; 125 | resolve(val === "ok"); 126 | dialog.remove(); 127 | }); 128 | 129 | document.body.appendChild(dialog); 130 | dialog.showModal(); 131 | // Set focus to the OK button so pressing Enter will confirm 132 | okBtn.focus(); 133 | }); 134 | } 135 | 136 | async function prompt(message) { 137 | return new Promise((resolve) => { 138 | const { dialog, form } = createDialog(message); 139 | 140 | const input = document.createElement("input"); 141 | applyStyles(input, inputStyle); 142 | input.type = "text"; 143 | input.name = "promptInput"; 144 | 145 | form.appendChild(input); 146 | 147 | const buttonRow = document.createElement("div"); 148 | applyStyles(buttonRow, buttonRowStyle); 149 | 150 | const cancelBtn = createButton("Cancel", "cancel", cancelButtonStyle, "button"); 151 | const okBtn = createButton("OK", "ok"); 152 | 153 | buttonRow.appendChild(cancelBtn); 154 | buttonRow.appendChild(okBtn); 155 | form.appendChild(buttonRow); 156 | 157 | cancelBtn.addEventListener("click", () => { 158 | dialog.close(null); 159 | }); 160 | dialog.addEventListener("close", () => { 161 | const val = dialog.returnValue === "ok" ? input.value : null; 162 | resolve(val); 163 | dialog.remove(); 164 | }); 165 | 166 | document.body.appendChild(dialog); 167 | dialog.showModal(); 168 | input.focus(); 169 | }); 170 | } 171 | 172 | return { alert, confirm, prompt }; 173 | })(); -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "prompts-js", 3 | "version": "0.0.4", 4 | "description": "async alternatives to browser alert() and prompt() and confirm()", 5 | "main": "index.js", 6 | "homepage": "https://github.com/simonw/prompts-js", 7 | "scripts": { 8 | "test": "echo \"Error: no test specified\" && exit 1" 9 | }, 10 | "author": "Simon Willison", 11 | "license": "Apache-2.0", 12 | "repository": { 13 | "type": "git", 14 | "url": "git+https://github.com/simonw/prompts-js.git" 15 | }, 16 | "keywords": [ 17 | "alert", 18 | "prompt", 19 | "confirm", 20 | "async", 21 | "promise", 22 | "dialog" 23 | ], 24 | "files": [ 25 | "index.js", 26 | "README.md", 27 | "LICENSE" 28 | ] 29 | } 30 | --------------------------------------------------------------------------------