obsidian/augmentations

Classes

Class	Description
AbstractInputSuggest	Attach to an <input> element or a <div contentEditable> to add type-ahead support.
App	The main app object.
CapacitorAdapter	Implementation of the vault adapter for mobile devices. app.vault.adapter returns an instance of obsidian#CapacitorAdapter on mobile devices.
ConfirmationButton	A button inside a ConfirmationModal’s button row. Clicking the button closes the modal after the click handler resolves; return a truthy value from the handler to keep the modal open (for example, to surface a validation error).
ConfirmationModal	A modal that asks the user to confirm an action. Use ConfirmationModal.addButton to add each option to the button row, and ConfirmationModal.addCancelButton for the dismissal button. Buttons auto-close the modal on click unless the handler returns truthy.
DisplayValueComponent	A read-only display value for a setting row: a value label and an optional status indicator. On a navigable row, it surfaces the value edited on the page the row opens, so the user can see it without opening that page.
Editor	A common interface that bridges the gap between CodeMirror 5 and CodeMirror 6.
EditorSuggest	Represents a autocomplete suggestion in the editor
Events	Event emitter implementation
FileManager	Manage the creation, deletion and renaming of files from the UI.
FileSystemAdapter	Implementation of the vault adapter for desktop. app.vault.adapter returns an instance of obsidian#FileSystemAdapter on desktop devices.
FuzzySuggestModal	Suggest modal for fuzzy search.
HoverPopover	A hover popover.
Keymap	Manages keymap lifecycle for different obsidian#Scopes.
MarkdownEditView	This is the editor for Obsidian Mobile as well as the upcoming WYSIWYG editor.
MarkdownPreviewRenderer	The renderer of the markdown preview.
MarkdownPreviewView	The markdown preview view.
MarkdownRenderChild	A component to register as a child component for the markdown preview.
MarkdownRenderer	A renderer for markdown.
Menu	A component for context menus.
MenuItem	A menu item.
MenuSeparator	A separator for the menu.
MetadataCache	A cached metadata for a note. Linktext is any internal link that is composed of a path and a subpath, such as ‘My note#Heading’ Linkpath (or path) is the path part of a linktext Subpath is the heading/block ID part of a linktext.
Modal	Modal dialog component.
Notice	Notification component. Use to present timely, high-value information.
Plugin	Base class for all plugins.
PluginSettingTab	Provides a unified interface for users to configure the plugin.
PopoverSuggest	Base class for adding a type-ahead popover.
RenderContext	Utility functions for rendering Values within the app.
Scope	A scope receives keyboard events and binds callbacks to given hotkeys. Only one scope is active at a time, but scopes may define parent scopes (in the constructor) and inherit their hotkeys.
SecretStorage	A secret storage.
Setting	A setting.
SettingGroup	Setting group.
SettingPage	Base class for a sub-page within a SettingTab. Use with the page factory on SettingDefinitionPage to render a sub-page imperatively — useful when the page’s content is dynamic or doesn’t fit cleanly into a list of definitions. For declarative sub-pages, use the items field on SettingDefinitionPage instead.
SettingTab	A setting tab.
SuggestModal	A suggest modal.
TAbstractFile	This can be either a obsidian#TFile or a obsidian#TFolder.
Tasks	A task manager.
TFile	A file.
TFolder	A folder.
Vault	Work with files and folders stored inside a vault.
Workspace	A workspace.
WorkspaceContainer	Workspace container.
WorkspaceFloating	Workspace floating.
WorkspaceItem	Workspace item.
WorkspaceLeaf	Workspace leaf.
WorkspaceMobileDrawer	Workspace mobile drawer.
WorkspaceParent	Workspace parent.
WorkspaceRibbon	Workspace ribbon.
WorkspaceRoot	Workspace root.
WorkspaceSidedock	Workspace sidedock.
WorkspaceSplit	Workspace split.
WorkspaceTabs	Workspace tabs.
WorkspaceWindow	Workspace window.

Interfaces

Interface	Description
BasesAllOptions	BasesOptions and the associated sub-types are configuration-driven settings controls which can be provided by a BasesViewRegistration to expose configuration options to users in the view config menu of the Bases toolbar.
BasesConfigFileFilter
BasesOptions
BasesPropertyId	The full ID of a property, used in the bases config file. The prefixed BasesPropertyType disambiguates properties of the same name but from different sources.
BasesPropertyType	The three valid “sources” of a property in a Base. - note: Properties from the frontmatter of markdown files in the vault. - formula: Properties calculated by evaluating a formula from the base config file. - file: Properties inherent to a file, such as the name, extension, size, etc.
BasesSortConfig
BasesViewFactory	Implement this factory function in a BasesViewRegistration to create a new instance of a custom Bases view.
BlockCache	The cache of the block in the note. markdown foo ^bar
BlockSubpathResult	Subpath result for a block from resolveSubpath
BulkUndoRecord	A captured pre-modification snapshot of a file, used to undo a bulk modification.
CachedMetadata	Cached metadata for a note.
CacheItem	A cache item with a position within a note.
CliData	The data passed to the CLI.
CliFlag	The data passed to the CLI.
CliFlags
CliFlags__	A map of CLI flags.
CliHandler
CliHandler__	A function that handles CLI commands.
Command	A command that can be executed from the command palette or toolbar buttons.
Constructor
Constructor__	Abstract constructor type.
DataAdapter	Work directly with files and folders inside a vault. If possible prefer using the obsidian#Vault API over this.
DataWriteOptions	Custom options for writing to a file.
Debouncer	A debouncer wrapper for a function.
EditorChange	Represents a change to the editor
EditorCommandName
EditorCommandName__	The name of a command you can execute with Editor.exec
EditorPosition	Represents a position in the editor
EditorRange	Represents a range in the editor
EditorRangeOrCaret	Represents a range or caret in the editor
EditorScrollInfo	Scroll info for the editor
EditorSelection	Represents a selection in the editor
EditorSelectionOrCaret	Represents a selection or caret in the editor
EditorSuggestContext	The context of the suggestion
EditorSuggestTriggerInfo	The trigger info for the suggestion
EditorTransaction	Transaction for the editor
EmbedCache	The cache of the embed in the note. markdown ![[wikilink]] ![[wikilink|alias]] 
EventRef	Event reference
FileStats	File stats
FootnoteCache	The cache of the footnote in the note. markdown foo [^1] [^1]: bar baz [^qux] [^qux]: quux
FootnoteRefCache	The cache of the footnote reference in the note. markdown foo [^1] [^1]: bar baz [^qux] [^qux]: quux
FootnoteSubpathResult	Result of resolving footnotes using resolveSubpath
FrontMatterCache	The cache of the frontmatter in the note. Frontmatter is a block of metadata that is used to store information about the note. markdown --- key1: "value1", key2: 42 ---
FrontMatterInfo	The information about the frontmatter in the note.
FrontmatterLinkCache	The cache of the links in the frontmatter. markdown --- key1: "[[wikilink]]" key2: "[[wikilink|alias]]" ---
FuzzyMatch	The result of a fuzzy search.
HeadingCache	The cache of the heading in the note. markdown # foo ## bar ### baz
HeadingSubpathResult	Subpath result for a heading from resolveSubpath
HexString	Hex strings are 6-digit hash-prefixed rgb strings in lowercase form. Example: #ffffff
HexString__	Hex strings are 6-digit hash-prefixed rgb strings in lowercase form.
HistoryHandler	A handler that responds to history navigation, e.g. the Android ‘back’ button.
Hotkey	A hotkey.
HoverLinkSource	A source for hover links.
HoverParent	A parent for hover links.
HSL	Represents an obsidian#HSL color.
IconName	Can be any Lucide icon name or an internal icon name.
IconName__	Can be any Lucide icon name or an internal icon name.
Instruction	An instruction for the modal.
ISuggestOwner	An owner that controls UI suggestions.
KeymapContext	Context of the keymap.
KeymapEventHandler	Event handler for the keymap.
KeymapEventListener	Return false to automatically preventDefault
KeymapEventListener__	The event listener for the keymap. Return false to automatically preventDefault.
KeymapInfo	Information about the key combination.
LinkCache	The cache of the link in the note. markdown [[wikilink]] [[wikilink|alias]] [alias](markdown-link)
ListedFiles	Listed content of the folder.
ListItemCache	The cache of the list item in the note. List items are markdown blocks that are used to create lists. markdown - Unordered List Item 1 - Unordered List Item 2 - Unordered List Item 3 1. Ordered List Item 1 2. Ordered List Item 2 3. Ordered List Item 3
LivePreviewStateType	The object stored in the view plugin livePreviewState
Loc	Location within a Markdown document
MarkdownFileInfo	The markdown file info.
MarkdownPostProcessor	A post processor receives an element which is a section of the preview. Post processors can mutate the DOM to render various things, such as mermaid graphs, latex equations, or custom controls. If your post processor requires lifecycle management, for example, to clear an interval, kill a subprocess, etc when this element is removed from the app, look into MarkdownPostProcessorContext.addChild
MarkdownPostProcessorContext	The context of the markdown post processor.
MarkdownPreviewEvents	The events of the markdown preview.
MarkdownPreviewScrollOptions	Options for MarkdownPreviewRenderer.applyScroll.
MarkdownSectionInformation	Markdown section information.
MarkdownSubView	A sub view of the markdown view.
MarkdownViewModeType
MarkdownViewModeType__	The mode of the markdown view.
MenuPositionDef	A definition for the position of the menu.
Modifier	Mod = Cmd on MacOS and Ctrl on other OS Ctrl = Ctrl key for every OS Meta = Cmd on MacOS and Win key on other OS
Modifier__	Mod = Cmd on MacOS and Ctrl on other OS Ctrl = Ctrl key for every OS Meta = Cmd on MacOS and Win key on other OS
ObsidianProtocolData	A data object for obsidian:// URLs.
ObsidianProtocolHandler
ObsidianProtocolHandler__	A handler for obsidian:// URLs.
OpenViewState	View state for the open action.
PaneType
PaneType__	The pane type of the leaf.
PluginManifest	Metadata about a Community plugin.
Point	Represents a point in a 2D coordinate system.
PopoverState
Pos	Describes a text range in a Markdown document.
Reference	Base interface for items that point to a different location.
ReferenceCache	A reference to a link.
ReferenceLinkCache	The cache of the reference link in the note. markdown [google] [google]: https://google.com
RequestUrlParam	The parameters for the requestUrl function.
RequestUrlResponse	The response from the requestUrl function.
RequestUrlResponsePromise	The promise of the requestUrl function.
RGB	A color in obsidian#RGB format.
RibbonItem	Represents a button item in the sidebar ribbon.
RibbonState	Serialized state of a WorkspaceRibbon.
SearchMatches
SearchMatches__	A search matches.
SearchMatchPart	Text position offsets within text file. Represents a text range [from offset, to offset].
SearchMatchPart__	Text position offsets within text file. Represents a text range [fromOffset, toOffset].
SearchResult	A search result.
SearchResultContainer	A search result container.
SecretMetadata	Access metadata for a stored secret.
SectionCache	The cache of the section in the note. Sections are root level markdown blocks, which can be used to divide the document up. markdown # Heading section Paragraph section > [!NOTE] > Callout section
SettingColorControl
SettingControl
SettingControlBase
SettingDefinition
SettingDefinitionAction
SettingDefinitionAddItem	Configuration for a SettingDefinitionList’s addItem affordance.
SettingDefinitionBase
SettingDefinitionControl
SettingDefinitionEmpty
SettingDefinitionGroup	A group of settings rendered under a shared heading. Used as an inline group in the array returned by getSettingDefinitions(). For collections of mutable data (with add/delete/reorder affordances), use SettingDefinitionList instead.
SettingDefinitionItem	A single item in the array returned by getSettingDefinitions().
SettingDefinitionList	A specialized SettingDefinitionGroup for collections of mutable data: entries the user adds, reorders, or removes. Rendered with a more compact visual style than a group, and supports emptyState, onReorder, and onDelete for the mutation affordances.
SettingDefinitionPage	A declarative page of settings rendered as a navigable entry. Used as an inline page in the array returned by getSettingDefinitions().
SettingDefinitionRender
SettingDropdownControl
SettingFileControl	File-path input with a vault file suggester. Persists the selected file’s full path including extension (e.g. folder/note.md). Resolve the saved path with Vault.getFileByPath().
SettingFolderControl	Folder-path input with a vault folder suggester. Persists the selected folder’s path (a string).
SettingGroupItem	A single item within a SettingDefinitionGroup — either a setting or a navigable page.
SettingNumberControl	Numeric text input. Persists a number; falls back to defaultValue (or 0) if the input cannot be parsed.
SettingSliderControl
SettingTextAreaControl	Multi-line text input. Persists a string.
SettingTextControl
SettingToggleControl
Side
Side__	The side of the leaf.
SplitDirection
SplitDirection__	The direction of the leaf split.
Stat	A stat for a file or folder.
SubpathResult	A result of a subpath search.
TabInsertLocation	Describes where a dragged tab would be inserted, returned by WorkspaceTabs.getTabInsertLocation.
TabInsertRect	The rectangle marking where a dragged tab would be inserted, returned within TabInsertLocation.
TagCache	The cache of the tag in the note. markdown --- tags: - foo - bar --- #baz
TooltipOptions	Options for the tooltip.
TooltipPlacement
TooltipPlacement__	The placement of the tooltip.
UserEvent
UserEvent__	The user event.
ViewCreator
ViewCreator__	A view creator.
ViewState	The state of the view.
ViewStateResult	The result of the view state.
WorkspaceWindowInitData