SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias SettingsPage

    SettingsPage: Message<"soulfire.v1.SettingsPage"> & {
        enabledIdentifier?: SettingsEntryIdentifier;
        entries: SettingsEntryIdentifier[];
        iconId: string;
        id: string;
        owningPluginId?: string;
        pageName: string;
    }

    A settings page that groups related settings together for UI navigation. Pages provide a logical organization of settings with visual elements like icons and names. Each page references settings by their identifiers rather than embedding the definitions, allowing settings to be shared across pages.

    Type Declaration

    • OptionalenabledIdentifier?: SettingsEntryIdentifier

      Optional identifier for a boolean setting that controls whether this page/feature is enabled. Used primarily for plugin pages. When set, the page may show an enable/disable toggle.

      from field: optional soulfire.v1.SettingsEntryIdentifier enabled_identifier = 7;

    • entries: SettingsEntryIdentifier[]

      Ordered list of setting identifiers to display on this page. Settings are rendered in the order they appear in this list. Each identifier must correspond to a valid SettingsDefinition.

      from field: repeated soulfire.v1.SettingsEntryIdentifier entries = 5;

    • iconId: string

      Icon identifier for visual representation of this page. Uses lucide.dev icon IDs (e.g., "bot", "user", "refresh-cw"). Rendered next to the page name in navigation menus.

      from field: string icon_id = 6;

    • id: string

      Unique page identifier, URL-safe for navigation. Examples: "bot", "account", "auto-reconnect", "anti-afk". Should be lowercase with hyphens for word separation.

      from field: string id = 1;

    • OptionalowningPluginId?: string

      The ID of the plugin that owns this page (optional). Null/empty for internal SoulFire pages. Used to group pages by plugin in the UI navigation.

      from field: optional string owning_plugin_id = 2;

    • pageName: string

      The human-readable display name shown in the UI navigation. Examples: "Bot Settings", "Account", "Auto Reconnect".

      from field: string page_name = 3;

    from message soulfire.v1.SettingsPage

    Settings
    Member Visibility