PluginSettingsState<PluginSettings>

A snapshot of plugin settings state, including raw input values, effective (validated) values, and per-property validation messages.

Import:

import type { PluginSettingsState } from 'obsidian-dev-utils/obsidian/components/plugin-settings-component';

Signature:

export interface PluginSettingsState<PluginSettings extends object>

Properties

Property	Type	Description
effectiveValues	PluginSettings	The effective settings values used by the plugin. Invalid properties are replaced with defaults.
inputValues	PluginSettings	The raw input values as entered by the user. May contain invalid values.
validationMessages	Record<StringKeys<PluginSettings>, string>	Per-property validation messages. Empty string means valid.

---

Links to this page:

• ReadonlyPluginSettingsState