Modal

Defined in: obsidian.d.ts:2806

Extends

• CloseableComponent

Extended by

• SuggestModal
• AppSetting

Implements

• CloseableComponent

Constructors

new Modal()

new Modal(app): Modal

Defined in: obsidian.d.ts:2841

Parameters

app

App

Returns

Modal

Properties

app

app: App

Defined in: obsidian.d.ts:2810

---

containerEl

containerEl: HTMLElement

Defined in: obsidian.d.ts:2818

---

contentEl

contentEl: HTMLElement

Defined in: obsidian.d.ts:2831

---

modalEl

modalEl: HTMLElement

Defined in: obsidian.d.ts:2822

---

scope

scope: Scope

Defined in: obsidian.d.ts:2814

---

shouldAnimate

shouldAnimate: boolean

Defined in: src/obsidian/augmentations/Modal.d.ts:18

Whether the modal should animate

---

shouldRestoreSelection

shouldRestoreSelection: boolean

Defined in: obsidian.d.ts:2836

---

titleEl

titleEl: HTMLElement

Defined in: obsidian.d.ts:2827

---

win

win: null | Window

Defined in: src/obsidian/augmentations/Modal.d.ts:22

Reference to the global Window object

Methods

close()

close(): void

Defined in: obsidian.d.ts:2850

Returns

void

Implementation of

CloseableComponent.close

Inherited from

CloseableComponent.close

---

onClose()

onClose(): void

Defined in: obsidian.d.ts:2858

Returns

void

---

onOpen()

onOpen(): void

Defined in: obsidian.d.ts:2854

Returns

void

---

open()

open(): void

Defined in: obsidian.d.ts:2845

Returns

void

---

setContent()

setContent(content): this

Defined in: obsidian.d.ts:2867

Parameters

content

string | DocumentFragment

Returns

this

---

setTitle()

setTitle(title): this

Defined in: obsidian.d.ts:2863

Parameters

title

string

Returns

this