Modal

Represents a modal for user interactions.

Example

const modal = new Modal();
modal.setTitle("Sample Modal");
modal.addComponents(
  new ActionRow<TextInput>()
  .addComponents(new TextInput().setLabel("Enter text"))
));
modal.run((interaction) => {
  // Handle modal submission
});
const json = modal.toJSON();

Type parameters

Type parameter	Value	Description
T extends ModalBuilderComponents	TextInput	The type of components allowed in the modal.

Constructors

new Modal(data)

new Modal<T>(data: Partial<APIModalInteractionResponseCallbackData>): Modal<T>

Creates a new Modal instance.

Parameters

Parameter	Type	Description
data	Partial<APIModalInteractionResponseCallbackData>	Optional data for the modal.

Returns

Modal<T>

Source

seyfert/src/builders/Modal.ts:38

Properties

Property	Modifier	Type	Description
components	public	ActionRow<T>[]	-
data	public	Partial<APIModalInteractionResponseCallbackData>	Optional data for the modal.

Methods

addComponents()

addComponents(...components: RestOrArray<ActionRow<T>>): this

Adds components to the modal.

Parameters

Parameter	Type	Description
…components	RestOrArray<ActionRow<T>>	Components to be added to the modal.

Returns

this

The current Modal instance.

Source

seyfert/src/builders/Modal.ts:47

---

run()

run(func: ModalSubmitCallback): this

Sets the callback function to be executed when the modal is submitted.

Parameters

Parameter	Type	Description
func	ModalSubmitCallback	The callback function.

Returns

this

The current Modal instance.

Source

seyfert/src/builders/Modal.ts:87

---

setComponents()

setComponents(component: ActionRow<T>[]): this

Set the components to the modal.

Parameters

Parameter	Type	Description
component	ActionRow<T>[]	The components to set into the modal.

Returns

this

The current Modal instance.

Source

seyfert/src/builders/Modal.ts:57

---

setCustomId()

setCustomId(id: string): this

Sets the custom ID of the modal.

Parameters

Parameter	Type	Description
id	string	The custom ID for the modal.

Returns

this

The current Modal instance.

Source

seyfert/src/builders/Modal.ts:77

---

setTitle()

setTitle(title: string): this

Sets the title of the modal.

Parameters

Parameter	Type	Description
title	string	The title of the modal.

Returns

this

The current Modal instance.

Source

seyfert/src/builders/Modal.ts:67

---

toJSON()

toJSON(): APIModalInteractionResponseCallbackData

Converts the modal to JSON format.

Returns

APIModalInteractionResponseCallbackData

The modal data in JSON format.

Source

seyfert/src/builders/Modal.ts:96