EmbedContext

Unofficial

Both Official Unofficial

Both Own Inherited

A context to configure embedding of a file.

Import:

import type { EmbedContext } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface EmbedContext

Properties

	Property	Type	Description
	app	App	Reference to the app.
	containerEl	HTMLElement	Element where the embed should be displayed.
	depth?	number	Depth of the embed within its container (how many levels of embeds are above it).
	displayMode?	boolean	Whether the embed should be dynamic (CM) or static (postProcessed).
	linktext?	string	Text that should be displayed in the embed.
	showInline?	boolean	Whether the embed should be an inline embed.
	sourcePath?	string	Optional path to the current open file.
	state?	unknown	Serialized state to restore for the embed.