MarkdownRenderChild

Official

Both Official Unofficial

Both Own Inherited

A component to register as a child component for the markdown preview.

Import:

import { MarkdownRenderChild } from 'obsidian';

Signature:

export class MarkdownRenderChild extends Component

Extends: Component

Constructor

new MarkdownRenderChild(containerEl: HTMLElement)

Constructor.

To get the constructor instance, use getMarkdownRenderChildConstructor from obsidian-typings/implementations.

Properties

	Property	Type	Description
	_children	Component[]	Child Components attached to current component, will be unloaded on unloading parent component. (Inherited from Component)
	_events	EventRef[]	Events that are attached to the current component, will be detached on unloading parent component. (Inherited from Component)
	_loaded	boolean	Whether the component and its children are loaded. (Inherited from Component)
	containerEl	HTMLElement	The container element of the markdown render child.

Methods

	Method	Returns	Description
	addChild(component)	T	Adds a child component, loading it if this component is loaded. (Inherited from Component)
	load()	void	Load this component and its children. (Inherited from Component)
	onload()	void	Override this to load your component. (Inherited from Component)
	onunload()	void	Override this to unload your component (Inherited from Component)
	register(cb)	void	Registers a callback to be called when unloading. (Inherited from Component)
	registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading. (Inherited from Component)
	registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading (Inherited from Component)
	registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading (Inherited from Component)
	registerEvent(eventRef)	void	Registers an event to be detached when unloading. (Inherited from Component)
	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 Component)
	registerScopeEvent(keymapEventHandler)	void	Register a scope keymap event handler to be removed on unload. (Inherited from Component)
	removeChild(component)	T	Removes a child component, unloading it. (Inherited from Component)
	unload()	void	Override this to unload your component. (Inherited from Component)

---

Links to this page:

• getMarkdownRenderChildConstructor
• MarkdownRenderer