ModalFormData Class
Used to create a fully customizable pop-up form for a player.
Examples
showBasicModalForm.ts
import { world, DimensionLocation } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
function showBasicModalForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
const players = world.getPlayers();
const modalForm = new ModalFormData().title("Example Modal Controls for §o§7ModalFormData§r");
modalForm.toggle("Toggle w/o default");
modalForm.toggle("Toggle w/ default", true);
modalForm.slider("Slider w/o default", 0, 50, 5);
modalForm.slider("Slider w/ default", 0, 50, 5, 30);
modalForm.dropdown("Dropdown w/o default", ["option 1", "option 2", "option 3"]);
modalForm.dropdown("Dropdown w/ default", ["option 1", "option 2", "option 3"], 2);
modalForm.textField("Input w/o default", "type text here");
modalForm.textField("Input w/ default", "type text here", "this is default");
modalForm
.show(players[0])
.then((formData) => {
players[0].sendMessage(`Modal form results: ${JSON.stringify(formData.formValues, undefined, 2)}`);
})
.catch((error: Error) => {
log("Failed to show form: " + error);
return -1;
});
}
(preview) Work with this sample on the MCTools.dev code sandbox.
Methods
constructor
new ModalFormData()
Creates a new modal form builder.
Returns ModalFormData
divider
divider(): ModalFormData
Adds a section divider to the form.
Returns ModalFormData
Caution
This function is still in pre-release. Its signature may change or it may be removed in future releases.
dropdown
dropdown(label: minecraftserver.RawMessage | string, options: (minecraftserver.RawMessage | string)[], defaultValueIndex?: number): ModalFormData
Adds a dropdown with choices to the form.
Parameters
- label: @minecraft/server.RawMessage | string
- options: (@minecraft/server.RawMessage | string)[]
- defaultValueIndex?: number =
null
Returns ModalFormData
header
header(text: minecraftserver.RawMessage | string): ModalFormData
Adds a header to the form.
Parameters
text: @minecraft/server.RawMessage | string
Text to display.
Returns ModalFormData
Caution
This function is still in pre-release. Its signature may change or it may be removed in future releases.
label
label(text: minecraftserver.RawMessage | string): ModalFormData
Adds a label to the form.
Parameters
text: @minecraft/server.RawMessage | string
Text to display.
Returns ModalFormData
Caution
This function is still in pre-release. Its signature may change or it may be removed in future releases.
show
show(player: minecraftserver.Player): Promise<ModalFormResponse>
Creates and shows this modal popup form. Returns asynchronously when the player confirms or cancels the dialog.
Parameters
player: @minecraft/server.Player
Player to show this dialog to.
Returns Promise<ModalFormResponse>
Notes:
- This function can't be called in read-only mode.
- This function can throw errors.
slider
slider(label: minecraftserver.RawMessage | string, minimumValue: number, maximumValue: number, valueStep: number, defaultValue?: number): ModalFormData
Adds a numeric slider to the form.
Parameters
- label: @minecraft/server.RawMessage | string
- minimumValue: number
- maximumValue: number
- valueStep: number
- defaultValue?: number =
null
Returns ModalFormData
submitButton
submitButton(submitButtonText: minecraftserver.RawMessage | string): ModalFormData
Parameters
- submitButtonText: @minecraft/server.RawMessage | string
Returns ModalFormData
textField
textField(label: minecraftserver.RawMessage | string, placeholderText: minecraftserver.RawMessage | string, defaultValue?: minecraftserver.RawMessage | string): ModalFormData
Adds a textbox to the form.
Parameters
- label: @minecraft/server.RawMessage | string
- placeholderText: @minecraft/server.RawMessage | string
- defaultValue?: @minecraft/server.RawMessage | string =
null
Returns ModalFormData
title
title(titleText: minecraftserver.RawMessage | string): ModalFormData
This builder method sets the title for the modal dialog.
Parameters
- titleText: @minecraft/server.RawMessage | string
Returns ModalFormData
toggle
toggle(label: minecraftserver.RawMessage | string, defaultValue?: boolean): ModalFormData
Adds a toggle checkbox button to the form.
Parameters
- label: @minecraft/server.RawMessage | string
- defaultValue?: boolean =
null
Returns ModalFormData
Examples
showBasicModalForm.ts
import { world, DimensionLocation } from "@minecraft/server";
import { ModalFormData } from "@minecraft/server-ui";
function showBasicModalForm(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
const players = world.getPlayers();
const modalForm = new ModalFormData().title("Example Modal Controls for §o§7ModalFormData§r");
modalForm.toggle("Toggle w/o default");
modalForm.toggle("Toggle w/ default", true);
modalForm.slider("Slider w/o default", 0, 50, 5);
modalForm.slider("Slider w/ default", 0, 50, 5, 30);
modalForm.dropdown("Dropdown w/o default", ["option 1", "option 2", "option 3"]);
modalForm.dropdown("Dropdown w/ default", ["option 1", "option 2", "option 3"], 2);
modalForm.textField("Input w/o default", "type text here");
modalForm.textField("Input w/ default", "type text here", "this is default");
modalForm
.show(players[0])
.then((formData) => {
players[0].sendMessage(`Modal form results: ${JSON.stringify(formData.formValues, undefined, 2)}`);
})
.catch((error: Error) => {
log("Failed to show form: " + error);
return -1;
});
}
(preview) Work with this sample on the MCTools.dev code sandbox.