Stay organized with collections
Save and categorize content based on your preferences.
blockly > dialog > setPrompt
dialog.setPrompt() function
Sets the function to be run when Blockly.dialog.prompt() is called.
**Important**: When overridding this, be aware that non-native prompt experiences may require managing ephemeral focus in FocusManager. This isn't needed for the native window prompt because it prevents focus from being changed while open.
Signature:
export declare function setPrompt(promptFunction?: (message: string, defaultValue: string, callback: (result: string | null) => void) => void): void;
Parameters
| Parameter |
Type |
Description |
| promptFunction |
(message: string, defaultValue: string, callback: (result: string | null) => void) => void |
(Optional) The function to be run, or undefined to restore the default implementation. |
Returns:
void
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-16 UTC."],[[["Blockly's `dialog.setPrompt()` function assigns a custom function to be executed when the `Blockly.dialog.prompt()` is called, enabling developers to define the behavior of prompt dialogs."],["The assigned `promptFunction` receives three arguments: a title string, a message string, and a callback function to handle the user's input."]]],["The `dialog.setPrompt()` function sets a custom function to be executed when `Blockly.dialog.prompt()` is invoked. This function accepts a `promptFunction` as a parameter, which itself takes three arguments: two strings (`p1`, `p2`) and a callback function (`p3`). The callback function takes a string or null as input. The `setPrompt` function does not return any value. Its key action is to assign the passed custom function.\n"]]
