CallbackLayoutReadyComponent

A LayoutReadyComponent subclass that invokes a provided callback function when the layout becomes ready.

Import:

import { CallbackLayoutReadyComponent } from 'obsidian-dev-utils/obsidian/components/layout-ready-component';

Signature:

export class CallbackLayoutReadyComponent extends LayoutReadyComponent

Extends: LayoutReadyComponent

Constructor

new CallbackLayoutReadyComponent(app: App, callback: () => Promisable<void>)

Creates a new CallbackLayoutReadyComponent instance.

Methods

Method	Returns	Description
[Symbol.dispose]()	void	Disposes of the component. (Inherited from LayoutReadyComponent)
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. (Inherited from LayoutReadyComponent)
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. (Inherited from LayoutReadyComponent)
load()	void	Loads the component. (Inherited from LayoutReadyComponent)
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 LayoutReadyComponent)
onLayoutReady()	Promisable<void>	Executes when the Obsidian layout becomes ready.
onload()	void	Loads the component and registers the layout ready handler. (Inherited from LayoutReadyComponent)
onloadAsync()	Promise<void>	Asynchronously loads the component. Override to add async load logic, which is executed after Component.onload. (Inherited from LayoutReadyComponent)
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 LayoutReadyComponent)
removeChild(component)	TComponent	Removes a child component. (Inherited from LayoutReadyComponent)