Modals

Creating a Responder for Modals

Below you can see a code snippet responding to a command interaction by showing a modal:

command.ts

import { createModalFields } from "@magicyan/discord";
// ...
interaction.showModal({
    customId: "/form/modal",
    title: "Form",
    components: createModalFields({
        name:{
            label: "What's your name?",
            style: TextInputStyle.Short
        },
        age:{
            label: "What's your age?",
            style: TextInputStyle.Short
        },
    })
});
// ...

To reply to a modal with Responder, add ResponderType.Modal to the types:

responder.ts

createResponder({
    customId: "/form/modal",
    types: [ResponderType.Modal], cache: "cached",
    async run(interaction) {
        const { fields, member } = interaction;
        const name = fields.getTextInputValue("name");
        const age = fields.getTextInputValue("age");

        await registerMember(member, { name, age }); // Example function

        interaction.reply({ flags: ["Ephemeral"], content: `Registered as ${name}` });
    },
});

If the modal is showed from a component:

responder.ts

createResponder({
    customId: "/open/form",
    types: [ResponderType.Button], cache: "cached",
    async run(interaction) {
        await interaction.showModal({
            customId: "/form/modal",
            title: "Form",
            components: createModalFields({
                name:{
                    label: "What's your name?",
                    style: TextInputStyle.Short
                },
                age:{
                    label: "What's your age?",
                    style: TextInputStyle.Short
                },
            })
        });
    },
});

You can use the ResponderType.ModalComponent type:

responder.ts

createResponder({
    customId: "/form/modal",
    types: [ResponderType.ModalComponent], cache: "cached",
    async run(interaction) {
        // ...
    },
});

If you create code that can display the same modal from both a command and a component, simply include both types in the Responder's types array:

import { myCustomModals } from "#modals" // Example

createCommand({
    name: "form",
    async run(interaction) {
        await interaction.showModal(
            myCustomModals.formModal()
        );
    },
});

responder.ts

createResponder({
    customId: "/form/modal",
    types: [
        ResponderType.Modal,
        ResponderType.ModalComponent
    ], cache: "cached",
    async run(interaction) {
        // ...
    },
});

Modals

Creating a Responder for Modals

Reply to modal interaction

On this page