Skip to content

PluginNoticeComponentShowNoticeOptions.shouldHideOnClick?

PluginNoticeComponentShowNoticeOptions › shouldHideOnClick?

Type: boolean

Whether clicking the notice hides it. When true (the default), the notice dismisses on click like a normal Obsidian notice. When false, the notice is hard to close: it does not dismiss on any stray click, and instead shows a close (X) button that hides it directly (see PluginNoticeComponentShowNoticeOptions.shouldShowCloseButton and PluginNoticeComponentShowNoticeOptions.onCloseClick).

A shouldHideOnClick: false notice is shown with an infinite duration and stands on its own (implies PluginNoticeMode.Separate), so a later notice never silently replaces it; passing any other PluginNoticeComponentShowNoticeOptions.mode together with shouldHideOnClick: false throws.