Skip to content

OpenSettingsTabParams

Parameters for Lib.openSettingsTab.

Import:

import type { OpenSettingsTabParams } from 'obsidian-integration-testing';

Signature:

export interface OpenSettingsTabParams

Properties

PropertyTypeDescription
tabIdstringThe 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.
timeoutInMilliseconds?numberThe maximum time to wait for the modal to open and for the requested tab to render its content.

Links to this page: