SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias IntSetting

    IntSetting: Message<"soulfire.v1.IntSetting"> & {
        def: number;
        description: string;
        disabled: boolean;
        max: number;
        min: number;
        placeholder: string;
        step: number;
        thousandSeparator: boolean;
        uiName: string;
    }

    UI definition for an integer number setting. Used to render numeric input fields with validation constraints. Supports range limits, step increments, and locale-aware formatting.

    Type Declaration

    • def: number

      The default value used when no value is configured.

      from field: int32 def = 3;

    • description: string

      A longer description explaining what this setting does.

      from field: string description = 2;

    • disabled: boolean

      Whether this setting is disabled (read-only) in the UI.

      from field: bool disabled = 9;

    • max: number

      The maximum allowed value (inclusive).

      from field: int32 max = 5;

    • min: number

      The minimum allowed value (inclusive).

      from field: int32 min = 4;

    • placeholder: string

      Placeholder text shown when the input is empty.

      from field: string placeholder = 7;

    • step: number

      The step increment for value adjustments (e.g., for spinbox controls). A value of 0 means any integer is valid within the min/max range.

      from field: int32 step = 6;

    • thousandSeparator: boolean

      Whether to display the number with thousand separators (e.g., 1,000,000). Improves readability for large numbers.

      from field: bool thousand_separator = 8;

    • uiName: string

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

      from field: string ui_name = 1;

    from message soulfire.v1.IntSetting

    Settings
    Member Visibility