discord.js | ModalBuilder

Search...

ModalBuilder

export declare class ModalBuilder implements JSONEncodable<APIModalInteractionResponseCallbackData>

export declare class ModalBuilder implements JSONEncodable<APIModalInteractionResponseCallbackData>

A builder that creates API-compatible JSON data for modals.

constructor(data?)

Creates a new modal from API data.

Name	Type	Optional	Description
data	Partial<APIModalInteractionResponseCallbackData>	Yes	The API data to create this modal with

Readonly

components:readonly ActionRowBuilder[]

The components within this modal.

addActionRows(...components):this

Adds action rows to this modal.

Name	Type	Optional	Description
...components	RestOrArray<ActionRowBuilder \| APIActionRowComponent<APIModalActionRowComponent> \| ((builder: ActionRowBuilder) => ActionRowBuilder)>	No	The components to add

setActionRows(...components):this

Sets the action rows for this modal.

Name	Type	Optional	Description
...components	RestOrArray<ActionRowBuilder \| APIActionRowComponent<APIModalActionRowComponent> \| ((builder: ActionRowBuilder) => ActionRowBuilder)>	No	The components to set

setCustomId(customId):this

Sets the custom id of this modal.

Name	Type	Optional	Description
customId	string	No	The custom id to use

setTitle(title):this

Sets the title of this modal.

Name	Type	Optional	Description
title	string	No	The title to use

spliceActionRows(index, deleteCount, ...rows):this

Removes, replaces, or inserts action rows for this modal.

This method behaves similarly to Array.prototype.splice(). The maximum amount of action rows that can be added is 5.

It's useful for modifying and adjusting order of the already-existing action rows of a modal.

Remove the first action row:

embed.spliceActionRows(0, 1);

embed.spliceActionRows(0, 1);

Remove the first n action rows:

const n = 4;
embed.spliceActionRows(0, n);

const n = 4;
embed.spliceActionRows(0, n);

Remove the last action row:

embed.spliceActionRows(-1, 1);

embed.spliceActionRows(-1, 1);

Name	Type	Optional	Description
index	number	No	The index to start at
deleteCount	number	No	The number of action rows to remove
...rows	(ActionRowBuilder \| APIActionRowComponent<APIModalActionRowComponent> \| ((builder: ActionRowBuilder) => ActionRowBuilder))[]	No	The replacing action row objects

Serializes this builder to API-compatible JSON data.

Note that by disabling validation, there is no guarantee that the resulting object will be valid.

Name	Type	Optional	Description
validationOverride	boolean	Yes	Force validation to run/not run regardless of your global preference