Skip to content

PluginNoticeHideInfo

Describes why a notice was hidden, passed to PluginNoticeComponentShowNoticeOptions.onHide.

Import:

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

Signature:

export interface PluginNoticeHideInfo

Properties

PropertyTypeDescription
isCloseButtonClickedbooleanWhether the notice was hidden by the user clicking its close (X) button specifically. Always implies PluginNoticeHideInfo.isUserAction.
isUserActionbooleanWhether the notice was hidden by a user action — clicking the close (X) button, or clicking a dismissible notice to dismiss it — as opposed to programmatically (a later reusable notice replacing it, an explicit hide(), the duration elapsing, or component unload).

Links to this page: