SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias ComboSetting

    ComboSetting: Message<"soulfire.v1.ComboSetting"> & {
        def: string;
        description: string;
        disabled: boolean;
        options: ComboSetting_Option[];
        uiName: string;
    }

    UI definition for a dropdown/select setting with predefined options. Used to render combo boxes or dropdown menus where users select from a fixed list. Each option has an ID (stored value) and a display name (shown to user).

    Type Declaration

    • def: string

      The default option ID used when no value is configured. Must match one of the option IDs in the options list.

      from field: string def = 4;

    • 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 = 5;

    • options: ComboSetting_Option[]

      The list of available options to choose from. The order determines display order in the dropdown.

      from field: repeated soulfire.v1.ComboSetting.Option options = 3;

    • uiName: string

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

      from field: string ui_name = 1;

    from message soulfire.v1.ComboSetting

    Settings
    Member Visibility