PluginSettingsComponentBase<PluginSettings>

Base class for plugin settings components.

Manages settings data, persistence, validation, and events. Plugin authors extend this class and implement createDefaultSettings.

Import:

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

Signature:

export class PluginSettingsComponentBase<PluginSettings extends object> extends ComponentEx implements AsyncEventSource<PluginSettingsComponentBaseEventMap<PluginSettings>>

Extends: ComponentEx

Implements: AsyncEventSource<PluginSettingsComponentBaseEventMap<PluginSettings>>

Constructor

new PluginSettingsComponentBase(params: PluginSettingsComponentBaseConstructorParams<PluginSettings>)

Creates a new plugin settings component.

Properties

Property	Type	Description
[ASYNC_EVENT_MAP]?	PluginSettingsComponentBaseEventMap<PluginSettings>	Phantom marker that makes `EventMap` inferable from an AsyncEventSource (e.g. via `Source extends AsyncEventSource<infer EventMap>`). Never present at runtime. (Inherited from AsyncEventSource)
dataHandler	DataHandler	The data handler used to load and save the plugin settings.
defaultSettings	ReadonlyDeep<PluginSettings>	Gets the readonly default settings.
pluginEventSource	PluginEventSource	The plugin event source the component listens to for external settings changes.
pluginSettingsClass	Constructor<PluginSettings, []>	The plugin settings class used to construct settings instances.

Methods

Method	Returns	Description
[Symbol.dispose]()	void	Disposes of the component. (Inherited from ComponentEx)
addChild(component)	TComponent	Adds a child component. Mirrors the native `Component.addChild` contract: if this component is already loaded, the child is loaded immediately, so `child._loaded` is set before this method returns even when this component has async load logic. The child's async tail (if any) is sequenced into the load promise so a later `loadWithPromises` call awaits it. Adding a child BEFORE the first load is legitimate: the child is queued and loaded when this component loads. Adding one AFTER this component has been unloaded is not — the child would never be loaded and never unloaded (a leak), so it is refused with a SilentError. The typical source of such a call is an `async` method that was suspended on an `await` when the component got unloaded and then resumed on the dead component; the SilentError unwinds it quietly (see `isUnloaded`). (Inherited from ComponentEx)
editAndSave(settingsEditor, context?)	Promise<void>	Edits the plugin settings and saves them.
ensureLoaded()	void	Ensures the component is loaded, throwing if it is not. Use this to guard public methods that register teardown-bearing resources (via `Component.register`, `Component.registerEvent`, `Component.registerDomEvent`, etc.). Registering before load is unsafe: `Component.unload` is a no-op while the component is not loaded, so any teardown registered beforehand would never run if the component is unloaded without first being loaded. The two not-loaded cases are deliberately distinguished. A component that was NEVER loaded is a genuine programming error, so it throws a loud `Error`. A component that has ALREADY been unloaded is not — it is the expected outcome of work that outlived its component (e.g. an `async` method suspended on an `await` while the component was unloaded, then resumed) — so it throws a SilentError, which `handleSilentError` suppresses, letting such work unwind quietly instead of reporting an async error. (Inherited from ComponentEx)
ensureSafe(settings)	Promise<void>	Ensures the settings are safe. It runs validation for each property and sets the default value if the validation fails.
getInFlightLoadPromise()	null \| Promise<void>	Returns the component's in-flight load `Promise` (its `onloadAsync` plus children), or `null` when nothing is loading — either the component loaded fully synchronously or its async load has already settled. Lets a caller scheduled while the component is still loading await the async load tail before acting, instead of racing it. The motivating case is a layout-ready handler (see `LayoutReadyComponent`) that fires because the component was loaded after the workspace layout was already ready: `Component.onload` has run (so `_loaded` is set) but `onloadAsync` may not have finished. (Inherited from ComponentEx)
getSafeCopy(settings)	Promise<PluginSettings>	Gets a safe copy of the settings.
getTransformer()	Transformer	Gets the transformer.
hasLoadErrors()	boolean	Returns whether the most recent load recorded any failure. Reflects the outcome of the last `load` / `loadWithPromises`: `true` when `onloadAsync` or any child's load threw (synchronously or asynchronously). Unlike `loadWithPromises`, reading this does NOT re-raise the collected errors — it lets a bystander (e.g. a layout-ready handler awaiting the in-flight load) tell whether the load succeeded without adopting a failure that the load's owner is already responsible for. (Inherited from ComponentEx)
isUnloaded()	boolean	Returns whether the component has already been unloaded, as opposed to simply not having been loaded yet. Both states leave `_loaded` false, but they mean opposite things: a component that was never loaded is still ahead of its lifecycle (queueing children before load is legitimate), while an unloaded one is behind it and must not be used any further. The distinction is tracked by a flag set in `load`, NOT by an `Component.onunload` override, because subclasses override `onunload` and may not call `super`. Use it in a long-running `async` method to abandon work whose component was unloaded mid-flight, when unwinding via the SilentError thrown by ensureLoaded / `addChild` is not desired. (Inherited from ComponentEx)
load()	void	Loads the component. (Inherited from ComponentEx)
loadFromFile(isInitialLoad)	Promise<void>	Loads the plugin settings from the file.
loadWithPromises()	null \| Promise<void>	Loads the component with promises. Unlike `load`, this method never rejects with an individual error: every failure raised by `onloadAsync` or a child's load is collected, and once everything settles the returned `Promise` rejects with a single `AggregateError` holding all of them. Non-`Error` throwables are normalized via ErrorWrapper.create. (Inherited from ComponentEx)
off(name, callback)	void	Remove an event listener.
offref(eventRef)	void	Remove an event listener by reference.
on(name, callback, thisArgument?)	AsyncEventRef	Add an event listener.
once(name, callback, thisArgument?)	AsyncEventRef	Trigger an event, executing all the listeners in order even if some of them throw an error. Add an event listener that will be called only once.
onExternalSettingsChange()	Promise<void>	Called when the external settings change.
onloadAsync()	Promise<void>	Loads settings from file and registers event handlers.
onLoadRecord(record)	Promise<void>	Called when the plugin settings record is loaded from disk.
onLoadSettings(_loadedState, _isInitialLoad)	Promise<void>	Called when settings are loaded or reloaded.
onSaveSettings(params)	Promise<void>	Called when settings are saved.
onSavingRecord(_record)	Promise<void>	Called when the plugin settings record is about to be saved to disk.
registerDisposable(disposable)	TDisposable	Registers a `Disposable` so it is disposed when this component unloads, and returns it unchanged. The recurring "tie a disposable to the component's lifecycle, then keep using it" idiom: the disposable is disposed on `Component.unload` (or earlier, if the caller disposes it directly — dispose is expected to be idempotent). Guard with ensureLoaded at the call site when registering before load would be unsafe. (Inherited from ComponentEx)
registerLegacySettingsConverter(legacySettingsClass, converter)	void	Registers a legacy settings converter.
registerLegacySettingsConverters()	void	Registers the legacy settings converters. Override to register legacy settings converters.
registerValidator(propertyName, validator)	void	Registers a validator for a property.
registerValidators()	void	Registers the validators. Override to register validators for properties.
removeChild(component)	TComponent	Removes a child component. (Inherited from ComponentEx)
revalidate()	Promise<Record<PropertyNames<PluginSettings>, string>>	Revalidates the settings.
saveToFile(context?)	Promise<void>	Saves the new plugin settings.
setProperty(propertyName, value)	Promise<string>	Sets the value of a property.
validate(settings)	Promise<ValidationResult<PluginSettings>>	Validates the settings.
whenLoadedFromFile()	Promise<void>	Waits until the settings have been read from `data.json` at least once. Anything that reads a setting from outside this component has to wait for this, because until the first `loadFromFile` completes `settings` still holds the DEFAULTS — reading it earlier answers with a default rather than with what the user actually stored. That window is easy to miss, since it is empty on a cold start (the workspace layout is not ready yet, so nothing has run) but wide open on a runtime enable from the Community Plugins tab or a re-enable after an update, where a layout-ready handler fires immediately while this component's own async load is still in flight. Resolves immediately once the settings have loaded, so a caller that arrives late is not stranded waiting for an event that has already been raised. Later reloads (an external `data.json` change) do not reset it — the question it answers is whether the settings have EVER been read, not whether the most recent read has finished.

Links to this page: