Skip to content

PluginNoticeComponentDelayedNotice

A handle to a delayed notice created by PluginNoticeComponent.showNoticeAfterDelay. It is a Disposable (so it can be used with using) that also lets the content be updated while the notice is shown.

Import:

import type { PluginNoticeComponentDelayedNotice } from 'obsidian-dev-utils/obsidian/components/plugin-notice-component';

Signature:

export interface PluginNoticeComponentDelayedNotice extends Disposable

Extends: Disposable

Methods

MethodReturnsDescription
setContent(content)voidReplaces this handle's message, re-applying the plugin-name prefix, the interactive-click guard, and the Cancel button. Useful for reporting progress. If the delay has not elapsed yet, the new content becomes what is shown once it does.

Only this handle's own message is rewritten: when the notice was joined rather than opened (see PluginNoticeComponentShowNoticeAfterDelayParams.mode), the messages already in it are left alone.

Links to this page: