obsidian/internals

Interfaces

Interface	Description
Account	Represents the user’s Obsidian account information and license details.
AppMenuBarManager	Manager for the application menu bar (native desktop menu).
AppSetting	The settings modal for the application, managing core and plugin setting tabs.
Btime	Interface for setting the birth time (creation time) of a file.
CanvasConnection	Represents a connection (edge) between two nodes on a canvas.
CanvasNode	Represents a node (card) on a canvas.
CapacitorAdapterFs	File system adapter for Capacitor (mobile) platform.
CapacitorFileEntry	File or directory entry from the Capacitor (mobile) file system.
ClickableToken	Represents a clickable token in the editor (e.g. link, tag).
ClipboardManager	Manager for clipboard operations in the markdown editor, handling paste, drag, and drop.
CloseableComponent	A closeable component that can get dismissed via the Android ‘back’ button.
CodeBlockPostProcessorHandler	Handler function for post processing a code block.
ConfigItem	Union type of all valid configuration item keys in the vault config.
CoordsLeftTop	Left and top coordinates.
DataAdapterEx	Common members for obsidian#CapacitorAdapter and obsidian#FileSystemAdapter.
Dimensions	Width and height dimensions.
DomEventsHandlers	The handlers for the DOM events.
DomEventsHandlersInfo	Information about the DOM events handlers.
EditorSuggestEx	Extended editor suggest interface for managing editor suggestion providers.
EditorSuggests	Manager for editor suggestion popups providing autocompletion in the editor.
ElectronWindow	Extended Electron BrowserWindow with internal properties.
EmbeddedEditorView	View for an embedded markdown editor, supporting preview and edit modes.
EnsureSideLeafOptions	Options for ensuring a side leaf exists in the workspace.
EventsEntry	An entry representing a registered event handler.
FileCacheEntry	Cache entry storing file hash, modification time, and size.
FileEntry	Represents a file or folder entry in the data adapter’s file listing.
FileSuggest	Editor suggestion provider for file and link autocompletion.
FileSuggestion	File suggestion.
FileSuggestManager	File suggest manager.
FileSystemWatchHandler	Callback interface for handling file system watch events.
FocusMetadataOptions	Options for focusing a specific property or heading in the metadata editor.
FocusMode	Specifies which part of an input to focus: start, end, or select both.
Fold	Represents a folded range in the editor.
FoldInfo	Information about all folds in a document.
FoldManager	Manager for persisting and restoring editor fold states.
FrameDom	DOM elements for the custom window frame (title bar) on desktop.
GetRecentFilesOptions	Options for getting recent files.
HotkeysSettingTab	Setting tab for viewing and editing keyboard hotkeys.
HoverLinkEvent	Event triggered when a link is hovered.
HoverLinkEventState	State passed with hover link events.
IFramedMarkdownEditor	A markdown editor that runs inside an iframe, used for embedded editable views.
ImportedAttachment	Imported attachment.
KeyScope	A registered keyboard shortcut interceptor within a scope.
LeafEntry	Serialized representation of a workspace leaf or split for layout persistence.
LinkSuggestion
LoadProgress	Represents a loading progress indicator.
Localization	Nested dictionary of localization strings for internationalization.
MarkdownBaseView	Base interface for markdown editor views, providing CodeMirror integration and editing capabilities.
MarkdownEditViewEphemeralState	Ephemeral state for the markdown edit view, storing cursor position.
MarkdownScrollableEditView	Extended markdown editor view with scrolling, search, and CSS class management.
MarkdownViewEphemeralState	Ephemeral state for a markdown view, storing scroll position.
MarkdownViewModes	Available view modes for a markdown view.
MarkdownViewSourceMode	Source mode configuration for a markdown view.
MenuSubmenuConfigRecord	obsidian#Menu submenu configuration record.
MetadataCacheWorkerMessage	Message received from the metadata cache web worker.
MetadataEditor	Editor component for managing frontmatter property fields in a markdown view.
MetadataEditorProperty	Component representing a single property field in the metadata editor.
MetadataWidget	Base interface for metadata property widgets that render value inputs.
MobileFileInfo	Interface for rendering file information on mobile.
MobileNavbar	Navigation bar component for the mobile interface.
MobileTabSwitcher	Tab switcher component for navigating between open tabs on mobile.
MobileToolbar	Toolbar component displayed above the keyboard on mobile.
ObsidianDOM	Core DOM elements of the Obsidian application layout.
ObsidianTouchEvent	Represents a touch event processed by Obsidian’s gesture system.
ObsidianTouchEventRegisterCallback	Callbacks for controlling a touch gesture’s lifecycle.
ParsedLinktext	Parsed link text result.
PlatformEx	Due to limitations of TypeScript, we cannot extend the obsidian#Platform constant directly.
PluginUpdateManifest	Information about an available plugin update.
PositionedReference	A reference with position information in the source file.
PromisedQueue	A sequential promise queue that ensures functions execute one at a time.
PropertyEntryData	Data for a single frontmatter property entry.
PropertyInfo	Information about a frontmatter property across the vault.
PropertyRenderContext	Context provided to property widgets for rendering and interaction.
PropertyWidget	Property widget.
PropertyWidgetEntry	Entry associating a display name with a property widget type.
PropertyWidgetType	Property widget type.
QueryForFuzzySearch	Query for fuzzy search.
ReadViewRenderer	Renderer for the reading/preview view, managing section-based markdown rendering.
RecentFileTracker	Tracks recently opened files for quick access and navigation.
RendererSection	A section of the read view renderer representing a block of rendered content.
Runnable	A controllable task with start, stop, and cancel lifecycle.
SearchCursor	Cursor for navigating through search results in the editor.
SetHighlightMatch	Parameters for setting a highlight match in the editor.
SharedFile	Represents a file shared to Obsidian from another app on mobile.
ShareReceiver	Handler for receiving shared files and text from other apps on mobile.
StateHistory	Captured state of a workspace leaf for history navigation.
StateHistoryEphemeralState	Ephemeral editor state stored in the state history (cursor and scroll position).
StateHistoryLeafHistory	Back and forward history stacks for a workspace leaf.
StatusBar	The status bar displayed at the bottom of the application window.
Submenu	Represents a submenu entry in a context menu.
SuggestionContainer	Container for displaying and navigating editor suggestion items.
SuggestModalChooser	Chooser component for a suggest modal, managing suggestion selection and navigation.
TableCell	Represents a single cell in a markdown table.
TableCellEditor	obsidian#Editor for a single table cell, combining markdown editing with cell properties.
TableEditor	obsidian#Editor for managing markdown tables.
TextDirection	The direction of the text.
ThemeManifest	Manifest metadata for an installed theme.
Token	A clickable token in the editor with position, text, and type information.
TypedWorkspaceLeaf	A workspace leaf with a strongly typed view.
VaultFileMapRecord	Record mapping file paths to their obsidian#TAbstractFile instances in the vault.
ViewEphemeralState	Ephemeral state for a view, storing cursor position and focus information.
WatchAndStatAllResult	Result from watching and stating all files in a directory on Capacitor.
WeakMapWrapper	Wrapper around a WeakMap providing the same interface with an inner map reference.
WidgetEditorView	Editable widget view for embedded file sections (headings, blocks) within the editor.
WindowSelection	Represents a captured text selection within a window.