Class MarkdownEvent

An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.

See

Hierarchy

Event
- MarkdownEvent

Index

Constructors

Properties

originalText parsedText

Events

Accessors

isDefaultPrevented isPropagationStopped name

Methods

preventDefault stopPropagation

Constructors

constructor

new MarkdownEvent(name: string, originalText: string, parsedText: string): MarkdownEvent
Parameters
- name: string
- originalText: string
- parsedText: string
Returns MarkdownEvent
Overrides Event.constructor
- Defined in src/lib/output/events.ts:150

Properties

`Readonly` originalText

originalText: string

The unparsed original text.

parsedText

parsedText: string

The parsed output.

Events

`Static` `Readonly` PARSE

PARSE: "parseMarkdown" = "parseMarkdown"

Triggered on the renderer when this plugin parses a markdown string.

Accessors

isDefaultPrevented

get isDefaultPrevented(): boolean
Has preventDefault been called?

Returns boolean
Inherited from Event.isDefaultPrevented
- Defined in src/lib/utils/events.ts:390

isPropagationStopped

get isPropagationStopped(): boolean
Has stopPropagation been called?

Returns boolean
Inherited from Event.isPropagationStopped
- Defined in src/lib/utils/events.ts:383

name

get name(): string
Return the event name.

Returns string
Inherited from Event.name
- Defined in src/lib/utils/events.ts:376

Methods

preventDefault

preventDefault(): void
Prevent the default action associated with this event from being executed.

Returns void
Inherited from Event.preventDefault
- Defined in src/lib/utils/events.ts:369

stopPropagation

stopPropagation(): void
Stop the propagation of this event. Remaining event handlers will not be executed.

Returns void
Inherited from Event.stopPropagation
- Defined in src/lib/utils/events.ts:362

Generated using TypeDoc