Class Modal<T>

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

T extends ModalBuilderComponents = TextInput
The type of components allowed in the modal.

Index

Constructors

constructor

new Modal<T extends TextInput = TextInput>(
data?: Partial<APIModalInteractionResponseCallbackData>,
): Modal<T>
Creates a new Modal instance.
Type Parameters
- T extends TextInput = TextInput
Parameters
- data: Partial<APIModalInteractionResponseCallbackData> = {}
  Optional data for the modal.
Returns Modal<T>
- Defined in src/builders/Modal.ts:38

Properties

components

components: ActionRow<T>[] = []

data

data: Partial<APIModalInteractionResponseCallbackData> = {}

Optional data for the modal.

Methods

addComponents

addComponents(...components: RestOrArray<ActionRow<T>>): this
Adds components to the modal.
Parameters
- ...components: RestOrArray<ActionRow<T>>
  Components to be added to the modal.
Returns this
The current Modal instance.
- Defined in src/builders/Modal.ts:47

run

run(func: ModalSubmitCallback): this
Sets the callback function to be executed when the modal is submitted.
Parameters
- func: ModalSubmitCallback
  The callback function.
Returns this
The current Modal instance.
- Defined in src/builders/Modal.ts:87

setComponents

setComponents(component: ActionRow<T>[]): this
Set the components to the modal.
Parameters
- component: ActionRow<T>[]
  The components to set into the modal.
Returns this
The current Modal instance.
- Defined in src/builders/Modal.ts:57

setCustomId

setCustomId(id: string): this
Sets the custom ID of the modal.
Parameters
- id: string
  The custom ID for the modal.
Returns this
The current Modal instance.
- Defined in src/builders/Modal.ts:77

setTitle

setTitle(title: string): this
Sets the title of the modal.
Parameters
- title: string
  The title of the modal.
Returns this
The current Modal instance.
- Defined in src/builders/Modal.ts:67

toJSON

toJSON(): APIModalInteractionResponseCallbackData
Converts the modal to JSON format.

Returns APIModalInteractionResponseCallbackData
The modal data in JSON format.
- Defined in src/builders/Modal.ts:96

Class Modal<T>

Example

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Modal<T>

Properties

components

data

Methods

addComponents

Parameters

Returns this

run

Parameters

Returns this

setComponents

Parameters

Returns this

setCustomId

Parameters

Returns this

setTitle

Parameters

Returns this

toJSON

Returns APIModalInteractionResponseCallbackData

Settings

On This Page