EmbedComponent

Unofficial

The component that renders the embedded file.

Import:

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

Signature:

export interface EmbedComponent extends Component

Extends: Component

Constructor

new EmbedComponent()

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 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)

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)
loadFile()	void	Load the file into the 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: