EmbedMarkdownComponent

Unofficial

Both Official Unofficial

Both Own Inherited

A component that renders an embedded markdown file.

Import:

import type { EmbedMarkdownComponent } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface EmbedMarkdownComponent extends EmbedComponent

Extends: EmbedComponent

Constructor

new EmbedMarkdownComponent()

Constructor.

To extract the constructor type, use ExtractConstructor<Component>.

Properties

	Property	Type	Description
	_children	Component[]	Child Components attached to current component, will be unloaded on unloading parent component. (Inherited from EmbedComponent)
	_events	EventRef[]	Events that are attached to the current component, will be detached on unloading parent component. (Inherited from EmbedComponent)
	_loaded	boolean	Whether the component and its children are loaded. (Inherited from EmbedComponent)

Methods

	Method	Returns	Description
	addChild(component)	T	Adds a child component, loading it if this component is loaded. (Inherited from EmbedComponent)
	load()	void	Load this component and its children. (Inherited from EmbedComponent)
	loadFile()	void	Load the file into the component. (Inherited from EmbedComponent)
	onload()	void	Override this to load your component. (Inherited from EmbedComponent)
	onunload()	void	Override this to unload your component (Inherited from EmbedComponent)
	register(cb)	void	Registers a callback to be called when unloading. (Inherited from EmbedComponent)
	registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading. (Inherited from EmbedComponent)
	registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading (Inherited from EmbedComponent)
	registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading (Inherited from EmbedComponent)
	registerEvent(eventRef)	void	Registers an event to be detached when unloading. (Inherited from EmbedComponent)
	registerInterval(id)	number	Registers an interval (from setInterval) to be cancelled when unloading. Use window.setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API (Inherited from EmbedComponent)
	registerScopeEvent(keymapEventHandler)	void	Register a scope keymap event handler to be removed on unload. (Inherited from EmbedComponent)
	removeChild(component)	T	Removes a child component, unloading it. (Inherited from EmbedComponent)
	unload()	void	Override this to unload your component. (Inherited from EmbedComponent)

---

Links to this page:

• EmbedRegistryEmbedByExtensionRecord