Class TextInput

Hierarchy

Constructors

Properties

customID: string
disabled: boolean
label: string
load: any

this method is meant to be for internal use only, don't use it, as it may break or change at a moments notice

maxLength?: number
minLength?: number
placeholder?: string
required?: boolean
value?: string

Methods

  • Disable this component.

    Returns Builders.TextInput

  • Enable this component.

    Returns Builders.TextInput

  • Set the custom id of this text input.

    Parameters

    • customID: string

      A developer-defined identifier for the input, max 100 characters.

    Returns Builders.TextInput

  • Set the label of this text input.

    Parameters

    • label: string

      The label to display on this text input.

    Returns Builders.TextInput

  • Set the minimum/maximum length of this text input.

    Parameters

    • Optional min: number

      The minimum length.

    • Optional max: number

      The maximum length.

    Returns Builders.TextInput

  • Make this text input optional.

    Returns Builders.TextInput

  • Set the placeholder of this text input.

    Parameters

    • placeholder: string

      Custom placeholder text if nothing is selected, max 100 characters.

    Returns Builders.TextInput

  • Make this text input required.

    Parameters

    • Optional required: boolean

      If this text input should be required or not - default true, setOptional also exists.

    Returns Builders.TextInput

  • Set the style of this text input.

    Parameters

    Returns Builders.TextInput

  • Set the initial value of this text input.

    Parameters

    • value: string

      A pre-filled value for this component, max 4000 characters.

    Returns Builders.TextInput

  • Returns TextInput

  • Returns RawTextInput

Generated using TypeDoc