Skip to content

Notice

Defined in: obsidian.d.ts:2924

Notification component. Use to present timely, high-value information.

Constructors

new Notice()

new Notice(message, duration?): Notice

Defined in: obsidian.d.ts:2935

Parameters

message

The message to be displayed, can either be a simple string or a DocumentFragment

string | DocumentFragment

duration?

number

Time in milliseconds to show the notice for. If this is 0, the Notice will stay visible until the user manually dismisses it.

Returns

Notice

Properties

noticeEl

noticeEl: HTMLElement

Defined in: obsidian.d.ts:2928

Methods

hide()

hide(): void

Defined in: obsidian.d.ts:2944

Returns

void


setMessage()

setMessage(message): this

Defined in: obsidian.d.ts:2940

Change the message of this notice.

Parameters

message

string | DocumentFragment

Returns

this