class ModalBuilder

export declare class ModalBuilder implements JSONEncodable<APIModalInteractionResponseCallbackData>

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

components
data
addActionRowComponents
addComponents
addLabelComponents
addTextDisplayComponents
setComponents
setCustomId
setLabelComponents
setTitle
spliceLabelComponents
toJSON

Constructors

constructor(
data?: Partial<APIModalInteractionResponseCallbackData>
)

Creates a new modal from API data.

readonly
components : (ActionRowBuilder<ModalActionRowComponentBuilder> | LabelBuilder | TextDisplayBuilder)[]

The components within this modal.

readonly
data : Partial<APIModalInteractionResponseCallbackData>

The API data associated with this modal.

deprecated
addActionRowComponents(
...components: RestOrArray<ActionRowBuilder<ModalActionRowComponentBuilder> | APIActionRowComponent<APIComponentInModalActionRow> | ((builder: ActionRowBuilder<ModalActionRowComponentBuilder>) => ActionRowBuilder<ModalActionRowComponentBuilder>)>
) : this

Adds action rows to this modal.

deprecated
addComponents(
...components: RestOrArray<ActionRowBuilder<ModalActionRowComponentBuilder> | APIActionRowComponent<APIComponentInModalActionRow> | APILabelComponent | APITextDisplayComponent | APITextInputComponent | LabelBuilder | TextDisplayBuilder | TextInputBuilder>
) : this

Adds components to this modal.

addLabelComponents(
...components: RestOrArray<APILabelComponent | LabelBuilder | ((builder: LabelBuilder) => LabelBuilder)>
) : this

Adds label components to this modal.

addTextDisplayComponents(
...components: RestOrArray<APITextDisplayComponent | TextDisplayBuilder | ((builder: TextDisplayBuilder) => TextDisplayBuilder)>
) : this

Adds text display components to this modal.

deprecated
setComponents(
...components: RestOrArray<ActionRowBuilder<ModalActionRowComponentBuilder> | LabelBuilder | TextDisplayBuilder>
) : this

Sets components for this modal.

setCustomId(
customId: string
) : this

Sets the custom id of this modal.

setLabelComponents(
...components: RestOrArray<APILabelComponent | LabelBuilder | ((builder: LabelBuilder) => LabelBuilder)>
) : this

Sets the labels for this modal.

setTitle(
title: string
) : this

Sets the title of this modal.

spliceLabelComponents(
index: number
deleteCount: number
...labels: (APILabelComponent | LabelBuilder | ((builder: LabelBuilder) => LabelBuilder))[]
) : this

Removes, replaces, or inserts labels for this modal.

Examples:Remove the first label:
modal.spliceLabelComponents(0, 1);
Remove the first n labels:
const n = 4;
modal.spliceLabelComponents(0, n);
Remove the last label:
modal.spliceLabelComponents(-1, 1);

toJSON() : APIModalInteractionResponseCallbackData

Serializes this builder to API-compatible JSON data.