Skip to content

EmbedContext

Unofficial

A context to configure embedding of a file.

Import:

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

Signature:

export interface EmbedContext

Properties

PropertyTypeDescription
appAppReference to the app.
containerElHTMLElementElement where the embed should be displayed.
depth?numberDepth of the embed within its container (how many levels of embeds are above it).
displayMode?booleanWhether the embed should be dynamic (CM) or static (postProcessed).
linktext?stringText that should be displayed in the embed.
showInline?booleanWhether the embed should be an inline embed.
sourcePath?stringOptional path to the current open file.
state?unknownSerialized state to restore for the embed.