Class TextInput

constructor

• new TextInput(): TextInput

  Creates a text input.

  Returns TextInput

custom_id

label

max_length

min_length

placeholder

required

style

type

value

setCustomID

• setCustomID(id: string): TextInput

  Set the custom id of the text input.

  Parameters

  • id: string

    The custom id of the text input.

  Returns TextInput

  See

  https://discord.com/developers/docs/interactions/message-components#custom-id

setLabel

• setLabel(label: string): TextInput

  Sets the text on the input label.

  Parameters

  • label: string

    The text to display as a label to the input.

  Returns TextInput

setMaxLength

• setMaxLength(length: number): TextInput

  Set the maximum response length the user may enter.

  Parameters

  • length: number

    Maximum user input length.

  Returns TextInput

setMinLength

• setMinLength(length: number): TextInput

  Set the minimum response length the user may enter.

  Parameters

  • length: number

    Minimum user input length.

  Returns TextInput

setPlaceholder

• setPlaceholder(placeholder: string): TextInput

  Set the placeholder text of the text input.

  Parameters

  • placeholder: string

    Placeholder text for the text input.

  Returns TextInput

setStyle

• setStyle(style: TextInputStyle): TextInput

  Sets the style of the text input.

  Parameters

  • style: TextInputStyle

    The text input style.

  Returns TextInput

  See

  https://discord.com/developers/docs/interactions/message-components#text-input-object-text-input-styles

setValue

• setValue(value: string): TextInput

  Set the default value of the text input.

  Parameters

  • value: string

    The value to pre-fill the text input with.

  Returns TextInput

toJSON

• toJSON(
      format?: JsonTypes,
      __namedParameters?: { suppressValidation?: boolean },
  ): {
      custom_id: string;
      label: string;
      max_length: undefined | number;
      min_length: undefined | number;
      placeholder: undefined | string;
      style: TextInputStyle;
      type: TextInput;
      value: undefined | string;
  }

  Returns the correct Discord format for a text input.

  Parameters

  • Optionalformat: JsonTypes
  • __namedParameters: { suppressValidation?: boolean } = ...

  Returns {
      custom_id: string;
      label: string;
      max_length: undefined | number;
      min_length: undefined | number;
      placeholder: undefined | string;
      style: TextInputStyle;
      type: TextInput;
      value: undefined | string;
  }