Class ModalBuilder

constructor

• new ModalBuilder(
      data?: Partial<APIModalInteractionResponseCallbackData>,
  ): ModalBuilder

  Creates a new modal from API data.

  Parameters

  • Optionaldata: Partial<APIModalInteractionResponseCallbackData>

    The API data to create this modal with

  Returns ModalBuilder

Readonlycomponents

Readonlydata

addActionRowComponents

• addActionRowComponents(
      ...components: RestOrArray<
          | ActionRowBuilder<TextInputBuilder>
          | APIActionRowComponent<APITextInputComponent>
          | (
              (
                  builder: ActionRowBuilder<TextInputBuilder>,
              ) => ActionRowBuilder<TextInputBuilder>
          ),
      >,
  ): this

  Adds action rows to this modal.

  Parameters

  • ...components: RestOrArray<
        | ActionRowBuilder<TextInputBuilder>
        | APIActionRowComponent<APITextInputComponent>
        | (
            (
                builder: ActionRowBuilder<TextInputBuilder>,
            ) => ActionRowBuilder<TextInputBuilder>
        ),
    >

    The components to add

  Returns this

  Deprecated

  Use ModalBuilder.addLabelComponents instead

addComponents

• addComponents(
      ...components: RestOrArray<
          | APITextDisplayComponent
          | APITextInputComponent
          | APILabelComponent
          | TextInputBuilder
          | TextDisplayBuilder
          | LabelBuilder
          | ActionRowBuilder<TextInputBuilder>
          | APIActionRowComponent<APITextInputComponent>,
      >,
  ): this

  Adds components to this modal.

  Parameters

  • ...components: RestOrArray<
        | APITextDisplayComponent
        | APITextInputComponent
        | APILabelComponent
        | TextInputBuilder
        | TextDisplayBuilder
        | LabelBuilder
        | ActionRowBuilder<TextInputBuilder>
        | APIActionRowComponent<APITextInputComponent>,
    >

    The components to add

  Returns this

  Deprecated

  Use ModalBuilder.addLabelComponents or ModalBuilder.addTextDisplayComponents instead

addLabelComponents

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

  Adds label components to this modal.

  Parameters

  • ...components: RestOrArray<
        | APILabelComponent
        | LabelBuilder
        | ((builder: LabelBuilder) => LabelBuilder),
    >

    The components to add

  Returns this

addTextDisplayComponents

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

  Adds text display components to this modal.

  Parameters

  • ...components: RestOrArray<
        | APITextDisplayComponent
        | TextDisplayBuilder
        | ((builder: TextDisplayBuilder) => TextDisplayBuilder),
    >

    The components to add

  Returns this

setComponents

• setComponents(
      ...components: RestOrArray<
          TextDisplayBuilder
          | LabelBuilder
          | ActionRowBuilder<TextInputBuilder>,
      >,
  ): this

  Sets components for this modal.

  Parameters

  • ...components: RestOrArray<
        TextDisplayBuilder
        | LabelBuilder
        | ActionRowBuilder<TextInputBuilder>,
    >

    The components to set

  Returns this

  Deprecated

  Use ModalBuilder.setLabelComponents instead

setCustomId

• setCustomId(customId: string): this

  Sets the custom id of this modal.

  Parameters

  • customId: string

    The custom id to use

  Returns this

setLabelComponents

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

  Sets the labels for this modal.

  Parameters

  • ...components: RestOrArray<
        | APILabelComponent
        | LabelBuilder
        | ((builder: LabelBuilder) => LabelBuilder),
    >

    The components to set

  Returns this

setTitle

• setTitle(title: string): this

  Sets the title of this modal.

  Parameters

  • title: string

    The title to use

  Returns this

spliceLabelComponents

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

  Removes, replaces, or inserts labels for this modal.

  Parameters

  • index: number

    The index to start at

  • deleteCount: number

    The number of labels to remove

  • ...labels: (APILabelComponent | LabelBuilder | ((builder: LabelBuilder) => LabelBuilder))[]

    The replacing label objects

  Returns this

  Remarks

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

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

  Example

  Remove the first label:

  modal.spliceLabelComponents(0, 1);
  Copy

  Example

  Remove the first n labels:

  const n = 4;
  modal.spliceLabelComponents(0, n);
  Copy

  Example

  Remove the last label:

  modal.spliceLabelComponents(-1, 1);
  Copy

toJSON

• toJSON(): APIModalInteractionResponseCallbackData

  Serializes this builder to API-compatible JSON data.

  Returns APIModalInteractionResponseCallbackData

  Remarks

  This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.