SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias DoubleSetting

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

    UI definition for a floating-point number setting. Used to render decimal number input fields with precision control. Supports range limits, step increments, and decimal formatting options.

    Type Declaration

    • decimalScale: number

      The number of decimal places to display/allow. Used for formatting and input validation.

      from field: int32 decimal_scale = 9;

    • def: number

      The default value used when no value is configured.

      from field: double 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 = 11;

    • fixedDecimalScale: boolean

      Whether to always show the exact number of decimal places specified by decimal_scale. If true, trailing zeros are preserved (e.g., 1.50 instead of 1.5).

      from field: bool fixed_decimal_scale = 10;

    • max: number

      The maximum allowed value (inclusive).

      from field: double max = 5;

    • min: number

      The minimum allowed value (inclusive).

      from field: double 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. A value of 0 means any decimal is valid within the min/max range.

      from field: double step = 6;

    • thousandSeparator: boolean

      Whether to display the integer part with thousand separators.

      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.DoubleSetting

    Settings
    Member Visibility