Skip to content

open-obsidian-settings-tab

Opens Obsidian’s settings modal on a given tab in the instance the current test context is already driving.

The renderer-side work lives in the injected lib bag (lib.openSettingsTab), where a callback that also probes the rendered DOM can reach it. This is the context-resolving entry point for the far more common case — a screenshot suite that only wants the tab on screen before it calls captureObsidianScreenshot, and would otherwise write the same evalInObsidian wrapper in every plugin.

InterfaceDescription
OpenObsidianSettingsTabParamsParameters for openObsidianSettingsTab.
FunctionDescription
openObsidianSettingsTabOpens Obsidian’s settings modal on a given tab and waits until that tab has actually rendered, resolving the transport and vault from the current test context. See Lib.openSettingsTab for why app.setting.open() can put the modal in a second Electron window, and why the container is attached before it on a vault that lacks the harness’s settingsPopoutWindow: false default. Close it again from a callback with app.setting.close(); re-opening works, because the attach is idempotent.