SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias DialogTextInput

    DialogTextInput: Message<"soulfire.v1.DialogTextInput"> & {
        initial: string;
        key: string;
        label: string;
        labelVisible: boolean;
        maxLength: number;
        multiline: boolean;
        multilineHeight: number;
        multilineMaxLines: number;
        width: number;
    }

    Text input field in a dialog.

    Type Declaration

    • initial: string

      Initial/default value.

      from field: string initial = 5;

    • key: string

      Identifier used when submitting the dialog.

      from field: string key = 1;

    • label: string

      Display label for the field.

      from field: string label = 2;

    • labelVisible: boolean

      Whether to show the label. Default: true.

      from field: bool label_visible = 4;

    • maxLength: number

      Maximum character length. Default: 32.

      from field: int32 max_length = 6;

    • multiline: boolean

      Whether to allow multi-line input.

      from field: bool multiline = 7;

    • multilineHeight: number

      Display height for multiline input in pixels.

      from field: int32 multiline_height = 9;

    • multilineMaxLines: number

      Maximum lines for multiline input.

      from field: int32 multiline_max_lines = 8;

    • width: number

      Display width in pixels. Range: 1-1024, default: 200.

      from field: int32 width = 3;

    from message soulfire.v1.DialogTextInput