Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RenderedMarkdownModal<YourPlugin>

A Modal used in addRenderedMarkdownButton to display rendered markdown from a raw string, or fetched from a provided url.

param plugin
param source

Raw markdown content or url to find raw markdown.

param fetch

True → fetch markdown from source as url. False → source is already a markdown string.

Type parameters

  • YourPlugin: Plugin

Hierarchy

  • Modal
    • RenderedMarkdownModal

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RenderedMarkdownModal<YourPlugin>(plugin: YourPlugin, source: string, fetch: boolean): RenderedMarkdownModal<YourPlugin>

  • Type parameters

    • YourPlugin: Plugin_2<YourPlugin>

    Parameters

    • plugin: YourPlugin
    • source: string
    • fetch: boolean

    Returns RenderedMarkdownModal<YourPlugin>

Properties

app

app: App

containerEl

containerEl: HTMLElement

contentEl

contentEl: HTMLElement

fetch

fetch: boolean

modalEl

modalEl: HTMLElement

plugin

plugin: YourPlugin

scope

scope: Scope

shouldRestoreSelection

shouldRestoreSelection: boolean

source

source: string

titleEl

titleEl: HTMLElement

Methods

close

  • close(): void

  • Returns void

onClose

  • onClose(): void

onOpen

  • onOpen(): Promise<void>

open

  • open(): void

  • Returns void

Generated using TypeDoc