This function can't be called in early-execution mode.
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:profilesettings` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:profilesettings" || !(sourceEntity instanceof Player)) return;
const form = new ModalFormData();
form.title("Profile Settings");
form.textField("Display Name", "Enter name");
form.divider();
form.toggle("Show Online Status", { defaultValue: true });
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) return;
const [name, onlineStatus] = response.formValues;
sourceEntity.sendMessage(`Saved: Name = ${name}, Online = ${onlineStatus}`);
});
});
The label to display for the dropdown.
The selectable items for the dropdown.
OptionaldropdownOptions: ModalFormDataDropdownOptions
The optional additional values for the dropdown creation.
This function can't be called in early-execution mode.
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:gamedifficulty` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:gamedifficulty" || !(sourceEntity instanceof Player)) return;
const difficulties = ["Easy", "Normal", "Hard"];
const form = new ModalFormData();
form.title("Game Settings");
form.dropdown("Difficulty", difficulties, { defaultValueIndex: 1 });
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) return;
const [difficultyIndex] = response.formValues;
const difficulty = typeof difficultyIndex === "number" ? difficulties[difficultyIndex] : undefined;
if (difficulty) {
sourceEntity.sendMessage(`Selected difficulty: ${difficulty}.`);
}
});
});
Text to display.
This function can't be called in early-execution mode.
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:audiopreferences` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:audiopreferences" || !(sourceEntity instanceof Player)) return;
const form = new ModalFormData();
form.title("Preferences");
form.header("Audio Controls");
form.slider("Volume", 0, 100, { defaultValue: 80, valueStep: 10 });
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) return;
const [volume] = response.formValues;
sourceEntity.sendMessage(`Saved volume: ${volume}`);
});
});
Text to display.
This function can't be called in early-execution mode.
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:guildregistration` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:guildregistration" || !(sourceEntity instanceof Player)) return;
const form = new ModalFormData();
form.title("Registration");
form.label("Enter your guild application details below.");
form.textField("Guild Tag", "3 to 4 letters");
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) return;
const [tag] = response.formValues;
sourceEntity.sendMessage(`Applied with tag: ${tag}`);
});
});
The image below is a demo of a label that says 'Hello, world!' in form.

Image from xKingDark
Player to show this dialog to.
Creates and shows this modal popup form. Returns asynchronously when the player confirms or cancels the dialog.
This function can't be called in restricted-execution mode.
This function can't be called in early-execution mode.
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:playerfeedback` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:playerfeedback" || !(sourceEntity instanceof Player)) return;
const form = new ModalFormData();
form.title("Player Feedback");
form.textField("Comments", "Type here");
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) {
sourceEntity.sendMessage("Feedback form canceled.");
return;
}
const [comments] = response.formValues;
sourceEntity.sendMessage(`Feedback submitted: ${comments}`);
});
});
The label to display for the slider.
The minimum selectable possible value.
The maximum selectable possible value.
OptionalsliderOptions: ModalFormDataSliderOptions
The optional additional values for the slider creation.
This function can't be called in early-execution mode.
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:musicvolume` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:musicvolume" || !(sourceEntity instanceof Player)) return;
const form = new ModalFormData();
form.title("Audio Setup");
form.slider("Music Volume", 0, 100, { defaultValue: 50, valueStep: 5 });
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) return;
const [volume] = response.formValues;
sourceEntity.sendMessage(`Music volume set to: ${volume}`);
});
});
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:bugreport` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:bugreport" || !(sourceEntity instanceof Player)) return;
const form = new ModalFormData();
form.title("Bug Report");
form.textField("Summary", "Describe what happened");
form.submitButton("Send Report");
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) return;
const [summary] = response.formValues;
sourceEntity.sendMessage(`Report sent: ${summary}`);
});
});
The label to display for the textfield.
The place holder text to display.
OptionaltextFieldOptions: ModalFormDataTextFieldOptions
The optional additional values for the textfield creation.
This function can't be called in early-execution mode.
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:createclan` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:createclan" || !(sourceEntity instanceof Player)) return;
const form = new ModalFormData();
form.title("Clan Creation");
form.textField("Clan Name", "e.g. Ironclads", { defaultValue: "Miners" });
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) return;
const [clanName] = response.formValues;
sourceEntity.sendMessage(`Clan created: ${clanName}`);
});
});
This function can't be called in early-execution mode.
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:worldoptions` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:worldoptions" || !(sourceEntity instanceof Player)) return;
const form = new ModalFormData();
form.title("Custom World Options");
form.toggle("Keep Inventory", { defaultValue: true });
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) return;
const [keepInventory] = response.formValues;
sourceEntity.sendMessage(`Keep Inventory set to: ${keepInventory}`);
});
});
The label to display for the toggle.
OptionaltoggleOptions: ModalFormDataToggleOptions
The optional additional values for the toggle creation.
This function can't be called in early-execution mode.
import { Player, system } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
// Run `/scriptevent example:whispersettings` in chat to open the form.
system.afterEvents.scriptEventReceive.subscribe(({ id, sourceEntity }) => {
if (id !== "example:whispersettings" || !(sourceEntity instanceof Player)) return;
const form = new ModalFormData();
form.title("Chat Settings");
form.toggle("Receive Private Whispers", { defaultValue: true });
form.show(sourceEntity).then((response) => {
if (response.canceled || !response.formValues) return;
const [whispersEnabled] = response.formValues;
sourceEntity.sendMessage(`Whispers enabled: ${whispersEnabled}`);
});
});

Image from xKingDark
Used to create a fully customizable pop-up form for a player.
Example: showBasicModalForm.ts
Example: Effect Generator Form
Example Code (v2)
Example Code (v1)
Modal Form v2.0.0-beta features
@minecraft/server-ui v2.0.0-beta module currently adds headers, dividers, labels and more. The following images demostrates those features (subject to change).
Source