SoulFire TypeScript SDK 2.10.3
    Preparing search index...
    StringSetting: Message<"soulfire.v1.StringSetting"> & {
        def: string;
        description: string;
        disabled: boolean;
        inputType: StringSetting_InputType;
        maxLength: number;
        minLength: number;
        pattern: string;
        placeholder: string;
        uiName: string;
    }

    UI definition for a string/text setting. Used to render text input fields in the client UI with appropriate validation and visual styling based on the input type.

    Type Declaration

    • def: string

      The default value used when no value is configured.

      from field: string def = 3;

    • description: string

      A longer description explaining what this setting does. Typically shown as a tooltip or help text.

      from field: string description = 2;

    • disabled: boolean

      Whether this setting is disabled (read-only) in the UI. Disabled settings display their value but cannot be modified.

      from field: bool disabled = 11;

    • inputType: StringSetting_InputType

      The type of input field to render (affects keyboard, validation, and display).

      from field: soulfire.v1.StringSetting.InputType input_type = 10;

    • maxLength: number

      Maximum allowed string length (0 means no maximum).

      from field: int32 max_length = 8;

    • minLength: number

      Minimum required string length (0 means no minimum).

      from field: int32 min_length = 7;

    • pattern: string

      Regular expression pattern for value validation. Empty string means no pattern validation.

      from field: string pattern = 9;

    • placeholder: string

      Placeholder text shown when the input is empty. Provides a hint about expected format or content.

      from field: string placeholder = 6;

    • uiName: string

      The display name shown in the UI label for this setting.

      from field: string ui_name = 1;

    from message soulfire.v1.StringSetting