@hunteroi/discord-form
    Preparing search index...

    Interface FormManagerOptions

    The manager options.

    FormManagerOptions

    interface FormManagerOptions {
        buttonLabel: string;
        canRetakeForm?: boolean;
        formEntries: OneToFiveElements<FormEntry>;
        formResponseWhenSubmitted: string | MessageEditOptions;
        formTitle: string;
        introductionMessage?: string | MessageCreateOptions;
    }
    Index

    Properties

    buttonLabel canRetakeForm? formEntries formResponseWhenSubmitted formTitle introductionMessage?

    Properties

    buttonLabel: string

    The label used for the button component.

    canRetakeForm?: boolean

    Whether the form should stay in the DM or not, to allow users to submit answers again or not.

    FormManagerOptions

    formEntries: OneToFiveElements<FormEntry>

    The form entries. The array is limited to maximum 5 elements. This limit is enforced by Discord's modal component system, which allows up to 5 top-level components per modal.

    Supported component types:

    • text_input: TextInputBuilder - short or paragraph text input
    • string_select: StringSelectMenuBuilder - predefined selection options
    • file_upload: FileUploadBuilder - file upload (1-10 files)

    Each component is automatically wrapped with a LabelBuilder to display the label and optional description.

    formResponseWhenSubmitted: string | MessageEditOptions

    The message sent when a form is submitted.

    formTitle: string

    The title of the form modal.

    introductionMessage?: string | MessageCreateOptions

    The message sent with the button component.

    Settings

    Member Visibility

    On This Page

    Properties