PluginNoticeComponentShowNoticeAfterDelayParams

Parameters for PluginNoticeComponent.showNoticeAfterDelay.

Import:

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

Signature:

export interface PluginNoticeComponentShowNoticeAfterDelayParams

Properties

Property	Type	Description
abortController?	AbortController	When provided, a Cancel button is appended to the notice; clicking it aborts this controller. When omitted, no Cancel button is shown.
cancelButtonText?	string	The text of the Cancel button shown when PluginNoticeComponentShowNoticeAfterDelayParams.abortController is provided. When omitted, the localized Cancel label is used.
content	ValueProvider<DocumentFragment | string>	The notice content, resolved lazily only if the delay elapses — so an operation that finishes sooner never builds it.
delayInMilliseconds?	number	How long the operation must run before the notice is shown. Operations that finish sooner never show a notice, avoiding a distracting flash.