OpenObsidianSettingsTabParams
Parameters for openObsidianSettingsTab.
Import:
import type { OpenObsidianSettingsTabParams } from 'obsidian-integration-testing';Signature:
export interface OpenObsidianSettingsTabParams extends OpenSettingsTabParamsExtends: OpenSettingsTabParams
Properties
| Property | Type | Description |
|---|---|---|
| tabId | string | The id of the settings tab to open — a plugin id for a plugin's own tab, or a core tab id ('editor', 'hotkeys', …).Required, because opening the modal without naming a tab renders **nothing** on a harness-owned instance: the modal restores the last tab the profile used, and an isolated profile has never opened one, so activeTab stays null and no row is drawn. An unknown id is rejected immediately, listing the ids that do exist.(Inherited from OpenSettingsTabParams) |
| timeoutInMilliseconds? | number | The maximum time to wait for the modal to open and for the requested tab to render its content. (Inherited from OpenSettingsTabParams) |
| transport? | ObsidianTransport | Override the transport. When omitted, the transport the current test context is driving is used. |
| vaultPath? | string | The vault whose Obsidian window to open the settings in. When omitted, the current test context's vault is used. |
Links to this page: