Modal

By using a model, you can send forms to your bot's interacting users, such as the one below:

A Modal Built in BotWiz

When using modals, you must place the block after an interaction has been made. Including:

1. When a command has been executed; or

2. When a button or select menu option has been selected.

Creating your Modal

Modal Settings

Following the example above, in your Modal Settings, you must enter a title and a Custom ID.

Title

Your title will appear at the top of the modal, such as "BotWiz is Awesome" or "Moderator Application".

You must enter a title that has at least 1 character, otherwise you will receive an error.

Custom ID

Your Custom ID will distinguish your modal's variable, which can be used to retireve users' answers. For example, if you put hello as your custom ID, your modal's variable will be: {modal_hello_}.

Without any modal items, your variable will be incomplete and have no value, as there are no questions for users' to answer. When you add more modal items, you will create more unique variables, such as {modal_hello_question1}.

Creating a Modal Item

Modal Items are your form's questions, such as "Do you think BotWiz is awesome too?!" Interacting users will be able to answer each question (modal item) you add, allowing you to later refer to their answers by using modal variables (such as {modal_hello_question1}).

Component Identifier

This is your unique way of refering to this question, such as question1; It'll be used for your modal variable, allowing you to recite answers later on in your build.

After your have created your first modal item, at the top of your modal you'll see the modal's variables, and how your component identifiers work! See the example below:

Modal Variables

Component Identifiers must be unique per modal. For example, you cannot identify multiple questions in one modal as question1.

Component Label

Component Labels are your questions, such as "How are you today?", or "What is your username?"

A Component Label as "This is question 1".

You must enter a component label that has at least 1 character and under 46 characters, otherwise you will receive an error.

Optional Component Options

Type

You can choose to have either a Short Text answer, or a Paragraph Text answer.

Difference between Short Text & Paragraph Text

This will determine the type of answer the user should put; either a long or short one.

Length

You can choose a minimum, and / or maximum requirement (in characters) per question.

For example, with a minimum of 25, and a maximum of 200, interacting users can only enter an answer that is at least 25 characters long, and under 200 characters in total.

Required

Your questions can be left unanswered unless you toggle the question as required.

When set as required, questions will appear with a red asterisk* and users must answer the question before submitting. With this, your variable will be guaranteed to return an answer.

Placeholder

Short Text

Placeholders can be used to display text, such as "Enter your Discord Nickname here" in each question. This'll be useful to hint any paticipating users into giving an appropriate answer.

Depending on your component's type (short text or paragraph text), your placeholder can overlap and become hidden. See the example below:

Short Text Placeholder being Overlapped

Paragraph Text

However, with the paragraph text component type, you can have longer placeholders:

Paragraph Text Placeholder

Exceeding two lines with the paragraph text component type will cause an error.

Keep to roughly 100 characters to avoid this error ( though, this depends on the characters you use - in this case, some testing to see the length of your placeholder may be needed).

Default Value

The default value will be the set answer for a question. For instance, if you put "Yes", the interacting users' answer will automatically be set as "Yes", unless they change it.

Default values could be used to start off an answer, such as: "My username is ".

Default Answer Example

Do note that any default answer your enter will contribute to any minimum or maximum length requirement that you have set.

Users can modify the default answer into their own.

Selecting Components

Selecting components will allow you to modify your current questions (modal items), or delete them.