Add a description to modals

[quirky-bluejay]

Modals are really good for getting user input, but right now they don't give much towards explaining to the user what the modal does / will do. Currently the only options for displaying data to the user while they are filling out a modal is the title and the text components, which are fairly limited.
A description would allow more information to be presented to the user while they are filling out a modal.

[Hyperclaw79]

Please implement this as priority.
Lack of a description prevents a lot of migrations from user input via messages to Modals.
Since Modals can only be sent in the initial response to the Interaction, it's not even possible to send a prior message with the description.

[JDJGInc]

you can do a followup as a response, but at that point, they have a massive modal in their view, thus preventing them from seeing the emoherall message, this is especially important on mobile.

[Hyperclaw79]

yes exactly

[quirky-bluejay]

You can also have a message with a button for that (and open the modal in response to the button's interaction) but that's not ideal ux

[TheKing-OfTime]

In addition to the suggestion, I'd like to add that if modals to contain a description, then the components should become optional. Right now, modals can only be for inputting information, but using them as a confirmation of some action is also good UX and is used by some of the built-in features of the Discord client. (A modal will need to have either a description or components or both. If the modal has no components, it is better to change the button label from Submit to Confirm)

It would also be cool if the descriptions supported markdown.

[TheKing-OfTime]

I've been thinking about this option. Full access to style and label of the button would be ideal. However, the number of characters would be very limited.

[kingmigdor]

Why not just call it "submit vote"?

[TheKing-OfTime]

That's exactly what I did. After some thought, I realized that this option would be better

[bleonard252]

Maybe generic pre-translated options could be good, so Yes, No, Confirm, Accept, Deny, Cancel, and OK could be viable options (Next and Back not here because those would make more sense with pagination)

[ManHatos]

Maybe just the same styles as normal buttons (excluding emojis and link buttons)

[sevenc-nanashi]

I would like it if it's implemented as component, because if it's component we can do this:

Test Modal

Description here...
[Foo ]
Other...
[Bar ]
[Hoge ]

[kingmigdor]

It would pretty make sense if you want to style your stuff, yeah. But normally, the normal text does not count as a component, because it does not have a value after the modal has been submitted

[Tais993]

Any updates? This would be a really good addition, which would improve UX for my users drastically.

[seailz]

bump - I really need this!

[TheKing-OfTime]

It looks like this is now planned Q&A

[seailz]

Great!

[ss-zheng]

I also need this, comment here to receive notification

[TheKing-OfTime]

Looks like it's now implemented and will be available very soon. Original

[stevefrench39]

Has anyone gotten this to work yet?

[ManHatos]

@stevefrench39 this hasn't been released / officially announced, yet

[Quaraxkad]

Has there been any news about this being implemented?

[TwilightZebby]

Technically as a workaround you could use Text Display Components as a makeshift "description", which recently got allowed in Modals.

[Soheab]

This can now be achieved using one or two components:

1. Label is a new top-level component, replacing ActionRow and TextInput's label and has an optional description field that shows up below label.
2. TextDisplay, part of "components v2”, can also be used as a top-level component as of this week.

A Modal with only TextDisplays is possible too.

Read the following changelog entries for more information:

• https://discord.com/developers/docs/change-log#introducing-new-modal-components
• https://discord.com/developers/docs/change-log#adding-more-modal-components