Skip to content
Obsidian Lib
v11.0.0
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Guides
Bases Formula Functions
Broken-link candidates
Bulk operation commits
CodeMirror helpers
Community Commands
Cross-plugin APIs
Custom subpaths for non-Markdown files
Debugging
Embeddable Markdown editor
Fresh data reads
Helper Functions
HTTP requests
Incremental file indexes
Modals
Plugin API protocol
Plugin data stores
Plugin Helpers
Popovers
Release assets
Rendered Markdown
Rerendering Reading views
Self-editing code blocks
Setting Components
Shared Component Pools
Styling
Translations
Virtual files
Windows and Popouts
Workers and WebAssembly
Workspace Layout State
API reference
active-file-provider
Overview
ActiveFileProvider
AppActiveFileProvider
anchored-suggest
Overview
AnchoredSuggest
AnchoredSuggestOpenAtParams
app
Overview
getApp
async-with-notice
Overview
retryWithTimeoutNotice
RetryWithTimeoutNoticeParams
runWithTimeoutNotice
RunWithTimeoutNoticeParams
attachment-path
Overview
AttachmentPathContext
CUSTOM_ATTACHMENT_LOCATION_PLUGIN_ID
DUMMY_PATH
getAttachmentFilePath
GetAttachmentFilePathParams
getAttachmentFolderPath
getAttachmentFolderPathForAttachment
GetAttachmentFolderPathForAttachmentParams
GetAttachmentFolderPathParams
getAttachmentFolderPathSyncOrNull
GetAttachmentFolderPathSyncOrNullParams
getAvailablePathForAttachments
GetAvailablePathForAttachmentsExtendedFunctionParams
GetAvailablePathForAttachmentsParams
getCheckIsAttachmentUnitFolderFunction
hasOwnAttachmentFolder
HasOwnAttachmentFolderParams
isAtProperAttachmentPath
IsAtProperAttachmentPathParams
attachment-unit-folder
Overview
findAttachmentUnitFolderPath
FindAttachmentUnitFolderPathFromAppParams
FindAttachmentUnitFolderPathParams
FindAttachmentUnitFolderPathWithPredicateParams
rebasePathOntoFolder
RebasePathOntoFolderParams
backlink
Overview
renderBacklinksTable
renderDelayedBacklinks
renderDelayedBacklinksForFolder
RenderDelayedBacklinksForFolderParams
RenderDelayedBacklinksParams
backlink-index
Overview
getIndexedBacklinksForFile
iterateReferencesAffectedByRename
IterateReferencesCallback
bases-view-registrar
Overview
BasesViewRegistrar
BasesViewRegistrarRegisterBasesViewParams
PluginBasesViewRegistrar
broken-link-candidates
Overview
BrokenLinkCandidate
BrokenLinkCandidateFinder
BrokenLinkCandidateFinderConstructorParams
BrokenLinkEvidence
BrokenLinkEvidenceKind
getParentPath
getPathMapping
GitRename
PathMapping
bug-report
Overview
BUG_REPORT_ISSUE_FORM_TEMPLATE
BUG_REPORT_PASTE_INSTRUCTIONS
BugReportEnvironment
BugReportIssueFormFieldId
BugReportIssueFormLink
BugReportPluginInfo
buildBugReportIssueFormLink
BuildBugReportIssueFormLinkParams
DEFAULT_BUG_REPORT_MAX_URL_LENGTH
formatBugReportEnvironment
getBugReportEnvironment
GetBugReportEnvironmentParams
getBugReportIssueFormUrl
GetBugReportIssueFormUrlParams
getGitHubIssueFormUrl
GetGitHubIssueFormUrlParams
bug-report-diagnostics
Overview
BugReportDiagnosticSection
BugReportLogBuffer
BugReportLogBufferConstructorOptions
BugReportLogBufferToSectionOptions
createSettingsDiagnosticSection
CreateSettingsDiagnosticSectionParams
DEFAULT_BUG_REPORT_LOG_MAX_ENTRIES
DEFAULT_BUG_REPORT_LOG_MAX_ENTRY_LENGTH
formatBugReportDiagnostics
getMarkdownFence
REDACTED_VALUE
redactSettings
bulk-operation
Overview
buildBeforeOperationCommitSubject
buildOperationCommitMessage
BuildOperationCommitMessageParams
BULK_OPERATION_LOCK_FILE_NAME
BULK_OPERATION_LOCK_STALE_AFTER_IN_MILLISECONDS
BulkOperationCommit
BulkOperationLock
BulkOperationLockStalenessContext
formatOperationId
getNextOperationId
isBulkOperationLock
isBulkOperationLockStale
OPERATION_TRAILER_KEY
OperationCommitMessage
parseBulkOperationCommit
ParseBulkOperationCommitParams
parseOperationNumber
PLUGIN_TRAILER_KEY
bulk-operation-progress
Overview
BULK_OPERATION_HOLD_INTERVAL_IN_MILLISECONDS
BulkOperationProgressListener
holdBulkOperationWhile
registerBulkOperationProgressListener
reportBulkOperationProgress
callout
Overview
CalloutMode
renderCallout
RenderCalloutParams
wrapForCallout
canvas
Overview
getCanvasReferences
getCanvasReferencesFromContent
case-insensitive-file-index
Overview
CaseInsensitiveFileIndex
getCaseInsensitiveFileIndex
setCaseInsensitiveFileIndex
unsetCaseInsensitiveFileIndex
code-block-markdown-information
Overview
CodeBlockMarkdownInformation
code-block-reg-exp
Overview
createCodeBlockRegExp
code-block-render-handoff
Overview
captureCodeBlockFocus
claimCodeBlockRenderHandoff
ClaimCodeBlockRenderHandoffParams
CODE_BLOCK_RENDER_HANDOFF_LIFETIME_IN_MILLISECONDS
CodeBlockFocusSnapshot
CodeBlockRenderHandoff
recordCodeBlockRenderHandoff
RecordCodeBlockRenderHandoffParams
restoreCodeBlockFocus
codemirror
editor-mode-extension
Overview
createLivePreviewOnlyExtension
createSourceModeOnlyExtension
isLivePreview
incremental-parse-state-field
Overview
createIncrementalParseStateField
IncrementalParse
inline-token-widgets
Overview
createInlineTokenWidgetsExtension
CreateInlineTokenWidgetsExtensionParams
execAll
InlineTokenRenderFunction
InlineTokenRenderParams
InlineTokenShouldDecorateParams
toGlobalRegExp
markdown-editor-views
Overview
dispatchToAllMarkdownEditorViews
getAllMarkdownEditorViews
range-set
Overview
RangeSetEntry
rangeSetToArray
settings-facet
Overview
createSettingsFacet
state-field-spec
Overview
StateFieldSpec
command-handlers
abstract-file-command-handler
Overview
AbstractFileCommandHandler
AbstractFileCommandHandlerConstructorParams
AbstractFileCommandHandlerHandleAbstractFileMenuParams
AbstractFileCommandHandlerHandleAbstractFilesMenuParams
AbstractFileCommandHandlerShouldAddToAbstractFileMenuParams
AbstractFileCommandHandlerShouldAddToAbstractFilesMenuParams
command-handler
Overview
CommandHandler
CommandHandlerConstructorParams
CommandHandlerRegistrationContext
command-handler-component
Overview
CommandHandlerComponent
CommandHandlerFactory
editor-command-handler
Overview
EditorCommandHandler
EditorCommandHandlerConstructorParams
EditorCommandHandlerEditorCheckCallbackParams
EditorCommandHandlerHandleEditorMenuParams
EditorCommandHandlerHandleViewportMenuParams
file-command-handler
Overview
FileCommandHandler
FileCommandHandlerShouldAddToFileMenuParams
FileCommandHandlerShouldAddToFilesMenuParams
folder-command-handler
Overview
FolderCommandHandler
FolderCommandHandlerShouldAddToFolderMenuParams
FolderCommandHandlerShouldAddToFoldersMenuParams
global-command-handler
Overview
GlobalCommandHandler
open-bug-report-command-handler
Overview
OpenBugReportCommandHandler
OpenBugReportCommandHandlerConstructorParams
open-demo-vault-command-handler
Overview
OpenDemoVaultCommandHandler
OpenDemoVaultCommandHandlerConstructorParams
open-discussion-command-handler
Overview
OpenDiscussionCommandHandler
OpenDiscussionCommandHandlerConstructorParams
open-feature-request-command-handler
Overview
OpenFeatureRequestCommandHandler
OpenFeatureRequestCommandHandlerConstructorParams
open-git-hub-command-handler
Overview
OpenGitHubCommandHandler
OpenGitHubCommandHandlerConstructorParams
open-settings-command-handler
Overview
OpenSettingsCommandHandler
OpenSettingsCommandHandlerConstructorParams
undo-bulk-operation-command-handler
Overview
UndoBulkOperationCommandHandler
UndoBulkOperationCommandHandlerConstructorParams
unlock-active-note-command-handler
Overview
UnlockActiveNoteCommandHandler
UnlockActiveNoteCommandHandlerConstructorParams
command-registrar
Overview
CommandRegistrar
PluginCommandRegistrar
community-plugins
Overview
CommunityPluginRef
CommunityPluginSearchResult
configureCommunityPlugin
ConfigureCommunityPluginParams
ConfigureCommunityPluginResult
disableCommunityPlugin
DisableCommunityPluginParams
enableCommunityPlugin
EnableCommunityPluginParams
getCommunityPluginRepo
getLatestReleaseVersion
installCommunityPlugin
InstallCommunityPluginParams
installConfigureEnableCommunityPlugin
InstallConfigureEnableCommunityPluginParams
PluginEnableRefusedError
searchCommunityPlugins
toggleEnableCommunityPlugin
ToggleEnableCommunityPluginParams
toggleInstallCommunityPlugin
ToggleInstallCommunityPluginParams
uninstallCommunityPlugin
UninstallCommunityPluginParams
updateCommunityPlugin
UpdateCommunityPluginParams
UpdateCommunityPluginResult
components
abort-signal-component
Overview
AbortSignalComponent
all-windows-event-component
Overview
AllWindowsEventComponent
AllWindowsEventComponentRegisterAllDocumentsDomEventParams
AllWindowsEventComponentRegisterAllWindowsDomEventParams
forEachWindow
ForEachWindowParams
registerBodyClass
RegisterBodyClassParams
all-windows-status-bar-item-component
Overview
AllWindowsStatusBarItemComponent
AllWindowsStatusBarItemComponentConstructorParams
AllWindowsStatusBarItemRenderParams
getPluginStatusBarItemCssClass
registerAllWindowsStatusBarItem
RegisterAllWindowsStatusBarItemParams
WINDOW_STATUS_BAR_CSS_CLASS
async-error-handler-component
Overview
AsyncErrorHandlerComponent
async-events-component
Overview
registerAsyncEvent
bulk-operation-commit-component
Overview
BulkOperationCommitComponent
BulkOperationCommitComponentConstructorParams
BulkOperationCommitComponentRunBulkOperationParams
case-insensitive-file-index-component
Overview
CaseInsensitiveFileIndexComponent
component-ex
Overview
ComponentEx
console-debug-component
Overview
ConsoleDebugComponent
core-plugin-toggle-component
Overview
CorePluginToggleComponent
CorePluginToggleComponentConstructorParams
disposable-component
Overview
asDisposableComponent
embed-extensions-component
Overview
EmbedExtensionsComponent
embeddable-markdown-editor-component
Overview
EmbeddableMarkdownEditorComponent
EmbeddableMarkdownEditorComponentConstructorParams
EmbeddableMarkdownEditorComponentEnterParams
EmbeddableMarkdownEditorComponentSelection
file-explorer-root-menu-component
Overview
FileExplorerRootMenuComponent
FileExplorerRootMenuComponentConstructorParams
FileExplorerRootMenuHandler
FileExplorerRootMenuHandlerParams
FileExplorerRootMenuSpot
VAULT_NAME_SELECTORS
generate-markdown-link-default-params-component
Overview
GenerateMarkdownLinkDefaultParamsComponent
GenerateMarkdownLinkDefaultParamsComponentConstructorParams
incremental-file-index-component
Overview
IncrementalFileIndexComponent
IncrementalFileIndexComponentConstructorParams
IndexedFileRecord
IndexFileParams
layout-ready-component
Overview
CallbackLayoutReadyComponent
LayoutReadyComponent
menu-event-registrar-component
Overview
MenuEventRegistrarComponent
monkey-around-component
Overview
around
Factories
FunctionKeys
hasPatchToken
MethodKeys
MonkeyAroundComponent
MonkeyAroundComponentRegisterFunctionPatchParams
MonkeyAroundComponentRegisterMethodPatchParams
PatchHandlerFunction
PatchHandlerParams
PostPatchHandlerFunction
PostPatchHandlerParams
notebook-navigator-menu-event-registrar-component
Overview
NotebookNavigatorMenuEventRegistrarComponent
NotebookNavigatorMenuEventRegistrarComponentConstructorParams
plugin-context-component
Overview
PluginContextComponent
plugin-gate-component
Overview
DeclaredPluginDependency
PluginConflict
PluginConflictSeverity
PluginDependency
PluginDependencyBase
PluginGateComponent
PluginGateComponentConstructorParams
plugin-notice-component
Overview
PluginNoticeCloseClickEvent
PluginNoticeComponent
PluginNoticeComponentDelayedNotice
PluginNoticeComponentShowNoticeAfterDelayParams
PluginNoticeComponentShowNoticeOptions
PluginNoticeHideInfo
PluginNoticeMode
plugin-settings-component
Overview
PluginSettingsComponentBase
PluginSettingsComponentBaseConstructorParams
PluginSettingsComponentBaseOnSaveSettingsParams
PluginSettingsState
ReadonlyPluginSettings
ReadonlyPluginSettingsState
SettingsValidator
plugin-settings-tab-component
Overview
PluginSettingsTabComponent
plugin-suggestion-component
Overview
PluginSuggestionComponent
PluginSuggestionComponentConstructorParams
SuggestedPluginState
pointer-position-component
Overview
PointerPositionComponent
reconfigurable-editor-extension-component
Overview
ReconfigurableEditorExtensionComponent
ReconfigurableEditorExtensionComponentConstructorParams
registry-component
Overview
RegistryComponent
release-notes-component
Overview
ReleaseNotes
ReleaseNotesComponent
ReleaseNotesComponentConstructorParams
rename-delete-handler-component
Overview
GetRescuePathParams
RenameDeleteHandlerComponent
RenameDeleteHandlerSettings
rmdir-guard-component
Overview
NOT_EMPTY_DIRECTORY_ERROR_CODE
RmdirGuardComponent
settings-facet-component
Overview
SettingsFacetComponent
SettingsFacetComponentConstructorParams
settings-migration-component
Overview
SettingsMigrationComponent
SettingsMigrationComponentConstructorParams
shared-component-pool-component
Overview
SharedComponentAcquisition
SharedComponentPoolComponent
SharedComponentPoolComponentAcquireOptions
SharedComponentPoolComponentConstructorParams
style-sheet-component
Overview
registerStyle
RegisterStyleParams
StyleSheetComponent
StyleSheetComponentConstructorParams
syntax-highlighting-component
Overview
SyntaxHighlightingComponent
SyntaxHighlightingComponentGrammarFactoryParams
SyntaxHighlightingComponentGrammarSource
SyntaxHighlightingComponentRegisterCodeBlockLanguageParams
SyntaxHighlightingComponentRegisterPrismLanguageParams
templates-language-component
Overview
TemplatesLanguageComponent
TemplatesLanguageComponentConstructorParams
TemplatesLanguageComponentFormatSource
worker-component
Overview
WorkerCallError
WorkerComponent
WorkerComponentCallOptions
WorkerComponentConstructorParams
WorkerMethod
WorkerMethodResult
worker-pool-component
Overview
getDefaultWorkerPoolSize
MAX_DEFAULT_WORKER_POOL_SIZE
WorkerPoolComponent
WorkerPoolComponentCallOptions
WorkerPoolComponentConstructorParams
workspace-layout-state-component
Overview
parseWorkspaceLayoutStateRecord
serializeWorkspaceLayoutStateRecord
WORKSPACE_LAYOUT_STATE_LAYOUT_KEY
WorkspaceLayoutStateChange
WorkspaceLayoutStateComponent
WorkspaceLayoutStateComponentConstructorParams
WorkspaceLayoutStateKey
WorkspaceLayoutStateKeyDefinition
WorkspaceLayoutStatePluginRecord
WorkspaceLayoutStateRecord
constructors
get-dom-events-handlers-constructor
Overview
getDomEventsHandlersConstructor
css-class
Overview
CssClass
data-handler
Overview
DataHandler
DEFAULT_PLUGIN_DATA_MAX_SIZE_IN_BYTES
PluginDataHandler
PluginDataHandlerConstructorOptions
PluginDataOperation
PluginDataParseError
PluginDataParseErrorConstructorParams
PluginDataSizeLimitExceededError
PluginDataSizeLimitExceededErrorConstructorParams
data-stores
data-store-locations
Overview
DataStoreLocation
DataStoreLocations
data-store-replica
Overview
DataStoreMergeKind
DataStoreOperation
DataStoreReplica
isDataStoreJsonValue
isDataStoreOperation
data-store-seeds
Overview
DataStoreSeedEntry
DataStoreSeedFile
DataStoreSeeds
DataStoreSeedsConstructorParams
DataStoreSeedValidation
validateDataStoreSeed
ValidateDataStoreSeedParams
data-store-transport
Overview
DataStoreTransport
DataStoreTransportConstructorParams
DataStoreTransportWriteSnapshotParams
local-data-store
Overview
LocalDataStore
LocalDataStoreClosedError
LocalDataStoreClosedErrorConstructorOptions
LocalDataStoreCloseReason
LocalDataStoreCommitParams
LocalDataStoreOpenParams
shared-data-store
Overview
SharedDataStore
SharedDataStoreOpenParams
dataview
Overview
ArrayOrDataArray
CombinedPage
DATAVIEW_PLUGIN_ADAPTER
DATAVIEW_PLUGIN_ID
DataviewInlineApi
DomElementInfoWithContainer
getRenderedContainer
insertCodeBlock
InsertCodeBlockParams
PageFile
PageFiles
reloadCurrentFileCache
renderIframe
RenderIframeParams
renderPaginatedList
RenderPaginatedListParams
RenderPaginatedParams
renderPaginatedTable
RenderPaginatedTableParams
dataview-link
Overview
fixTitle
FixTitleParams
makeLinkWithPath
debug
Overview
getObsidianLibDebugger
showInitialDebugMessage
demo-vault-helper
Overview
bootstrapDemoVault
BootstrapDemoVaultParams
demo-vault-helper-settings
Overview
DemoVaultHelperSettings
demo-vault-naming
Overview
getDemoVaultArchiveFileName
getDemoVaultFolderName
GetDemoVaultFolderNameParams
desktop-bulk-operation-git
Overview
BulkOperationGitRepo
BulkOperationGitRepoConstructorParams
BulkOperationGitRepoRunBulkOperationParams
GitBulkOperationResult
GitCommandError
GitRevertResult
desktop-demo-vault-opener
Overview
openDemoVault
OpenDemoVaultParams
desktop-git-runner
Overview
createDesktopGitRunner
desktop-operating-system
Overview
getDesktopOperatingSystem
desktop-request-url-stream
Overview
openDesktopRequestUrlStream
desktop-trusted-input
Overview
clickElement
ClickElementParams
clickMouse
ClickMouseParams
hoverElement
HoverElementParams
MouseButton
moveMouse
MoveMouseParams
pressKey
PressKeyParams
typeIntoEditor
TypeIntoEditorParams
unhoverElement
UnhoverElementParams
disposable
Overview
registerAsyncDisposable
registerDisposable
editor
Overview
syncOpenEditorBuffersForPath
toggleEditorReadOnly
editor-extension-registrar
Overview
EditorExtensionRegistrar
PluginEditorExtensionRegistrar
editor-suggest
Overview
CommandEditorSuggest
CommandEditorSuggestOpenFromCommandParams
prioritizeEditorSuggest
PrioritizeEditorSuggestParams
editor-suggest-registrar
Overview
EditorSuggestRegistrar
PluginEditorSuggestRegistrar
RegisterEditorSuggestOptions
events
Overview
EventRefDisposable
subscribeDisposableEvent
SubscribeDisposableEventParams
subscribeEvent
SubscribeEventParams
extensions-registrar
Overview
ExtensionsRegistrar
ExtensionsRegistrarRegisterExtensionsParams
PluginExtensionsRegistrar
feature-request
Overview
FEATURE_REQUEST_ISSUE_FORM_TEMPLATE
FeatureRequestIssueFormFieldId
getFeatureRequestIssueFormUrl
GetFeatureRequestIssueFormUrlParams
file-change
Overview
applyContentChanges
ApplyContentChangesParams
applyFileChanges
ApplyFileChangesOptions
ApplyFileChangesParams
FileChange
isCanvasChange
isCanvasFileNodeChange
isCanvasTextNodeChange
isContentChange
isFrontmatterChange
isFrontmatterChangeWithOffsets
toFrontmatterChangeWithOffsets
file-explorer
Overview
revealInFileExplorer
RevealInFileExplorerParams
file-manager
Overview
addAlias
AddAliasParams
deleteAlias
DeleteAliasParams
processFrontmatter
ProcessFrontmatterOptions
ProcessFrontmatterParams
waitForPendingLinkUpdates
file-system
Overview
asArrayOfFiles
asArrayOfFolders
asFile
asFileOrNull
asFolder
asFolderOrNull
BASE_FILE_EXTENSION
CANVAS_FILE_EXTENSION
checkExtension
doesExist
DoesExistParams
FileSystemType
getAbstractFile
getAbstractFileOrNull
GetAbstractFileOrNullParams
GetAbstractFileParams
getBasename
GetBasenameParams
getExtension
GetExtensionParams
getFile
getFileOrNull
GetFileOrNullParams
GetFileParams
getFileSystemType
getFolder
getFolderOrNull
GetFolderOrNullParams
GetFolderParams
getMarkdownFiles
GetMarkdownFilesParams
getOrCreateFile
getOrCreateFolder
getPath
isAbstractFile
isBaseFile
isCanvasFile
isFile
isFolder
isMarkdownFile
isNote
isPathOrFile
isTreatedAsAttachment
IsTreatedAsAttachmentParams
MARKDOWN_FILE_EXTENSION
MissingPathTreatment
PathOrAbstractFile
PathOrFile
PathOrFolder
trimMarkdownExtension
folder-note
Overview
FOLDER_NOTES_PLUGIN_ID
FolderNoteConfig
FolderNoteLocation
getFolderNoteFolder
GetFolderNoteFolderParams
resolveFolderNote
resolveFolderNoteConfig
ResolveFolderNoteConfigParams
ResolveFolderNoteParams
formula-function
Overview
createFormulaFunction
createFormulaFunctionParameter
CreateFormulaFunctionParameterParams
CreateFormulaFunctionParams
registerFormulaFunction
RegisterFormulaFunctionParams
frontmatter
Overview
checkIsPlainObject
CombinedFrontmatter
FrontmatterFormattingPreserver
ObsidianFrontmatter
ObsidianPublishFrontmatter
parseFrontmatter
registerFrontmatterFormattingPreserver
removeEmptyFrontmatterValues
RemoveEmptyFrontmatterValuesParams
setFrontmatter
frontmatter-formatting
Overview
enableFrontmatterFormattingPreservation
preserveFrontmatterFormatting
frontmatter-link-cache-with-offsets
Overview
FrontmatterLinkCacheWithOffsets
isFrontmatterLinkCacheWithOffsets
toFrontmatterLinkCacheWithOffsets
generated-during-build
Overview
LIBRARY_STYLES
LIBRARY_VERSION
git-hub-discussion
Overview
getGitHubDiscussionUrl
GetGitHubDiscussionUrlParams
git-rename-history
Overview
GitRunner
loadGitRenames
LoadGitRenamesParams
parseGitRenameLog
hotkey
Overview
formatHotkey
FormatHotkeyParams
getHotkeyFromKeyboardEvent
GetHotkeyFromKeyboardEventParams
isSameHotkey
hover-link-source-registrar
Overview
HoverLinkSourceRegistrar
HoverLinkSourceRegistrarRegisterHoverLinkSourceParams
PluginHoverLinkSourceRegistrar
html-element
Overview
appendCodeBlock
appendTextOrFragmentClone
applySpellcheckMode
ApplySpellcheckModeParams
asCodeBlock
createFragmentWithCodeBlocks
i18n
custom-type-options
Overview
CustomTypeOptionsBase
CustomTypeOptionsResources
default-translations
Overview
DefaultTranslationsBase
i18n
Overview
DEFAULT_NS
getLanguagesToLoad
initI18N
LocaleLoader
t
Translations
TranslationsMap
locales
en
Overview
en
translations-map
Overview
DEFAULT_LANGUAGE
defaultTranslationsMap
inline-token-renderer
Overview
createInlineTokenPostProcessor
CreateInlineTokenPostProcessorParams
DEFAULT_INLINE_TOKEN_SKIP_SELECTOR
registerInlineTokenRenderer
RegisterInlineTokenRendererParams
is-in-obsidian
Overview
isInObsidian
library
Overview
OBSIDIAN_LIBRARY_NAME
ObsidianLibrary
ObsidianLibraryInitParams
library-styles
Overview
injectLibraryStyles
InjectLibraryStylesParams
LAST_LIBRARY_VERSION_KEY
LIBRARY_STYLES_ELEMENT_ID
link
Overview
BacklinkConversionParams
BacklinksLike
BacklinksSnapshot
buildBacklinksSnapshot
BuildBacklinksSnapshotParams
convertLink
ConvertLinkParams
editBacklinks
EditBacklinksOptions
EditBacklinksParams
editBacklinksSnapshot
EditBacklinksSnapshotOptions
EditBacklinksSnapshotParams
editReferences
editReferencesInContent
EditReferencesInContentParams
EditReferencesOptions
EditReferencesParams
extractReferenceFile
ExtractReferenceFileParams
generateMarkdownLink
GenerateMarkdownLinkParams
generateRawMarkdownLink
GenerateRawMarkdownLinkParams
getGenerateMarkdownLinkDefaultParamsFns
hasAngleBrackets
hasEmbedSyntax
hasLeadingDot
hasLeadingSlash
hasWikilinkSyntax
LinkPathStyle
LinkStyle
MutableBacklinksSnapshot
shouldResetAlias
ShouldResetAliasParams
splitSubpath
SplitSubpathResult
updateFileUrlLinksInContent
UpdateFileUrlLinksInContentParams
updateFileUrlLinksInFile
UpdateFileUrlLinksInFileParams
updateLink
UpdateLinkParams
updateReferencesInContent
updateReferencesInFile
UpdateReferencesInFileParams
link-and-tag-input-suggest
Overview
getLinkAndTagCompletionTrigger
getVaultTagSuggestions
GetVaultTagSuggestionsParams
LinkAndTagCompletionKind
LinkAndTagCompletionTrigger
LinkAndTagInputSuggest
LinkAndTagInputSuggestConstructorParams
LinkAndTagSuggestion
LinkSuggestion
TagSuggestion
link-name
Overview
normalizeLinkName
link-update-progress
Overview
LinkUpdateProgress
LinkUpdateProgressReporter
logger
Overview
invokeAsyncAndLog
InvokeAsyncAndLogParams
loop
Overview
loop
LoopBuildNoticeMessageParams
LoopParams
markdown
Overview
fullRender
FullRenderParams
markdownToHtml
MarkdownToHtmlParams
registerLinkHandlers
RegisterLinkHandlersParams
renderExternalLink
RenderExternalLinkParams
renderInternalLink
RenderInternalLinkFolderNoteOptions
RenderInternalLinkParams
markdown-code-block-processor
Overview
getCodeBlockMarkdownInfo
GetCodeBlockMarkdownInfoParams
insertAfterCodeBlock
insertBeforeCodeBlock
InsertCodeBlockParams
removeCodeBlock
RemoveCodeBlockParams
replaceCodeBlock
ReplaceCodeBlockParams
markdown-code-block-processor-registrar
Overview
MarkdownCodeBlockProcessorRegistrar
PluginMarkdownCodeBlockProcessorRegistrar
markdown-post-processor-registrar
Overview
MarkdownPostProcessorRegistrar
MarkdownPostProcessorRegistrarRegisterMarkdownPostProcessorParams
PluginMarkdownPostProcessorRegistrar
markdown-view
Overview
getFullContentHtml
rerenderPreviews
RerenderPreviewsParams
menu
Overview
addSingleChoiceMenuItems
AddSingleChoiceMenuItemsParams
SingleChoiceMenuOption
menu-event-registrar
Overview
EditorMenuEventHandler
FileMenuEventHandler
FilesMenuEventHandler
MarkdownViewportMenuEventHandler
MenuEventRegistrar
metadata-cache
Overview
ADVANCED_METADATA_CACHE_PLUGIN_ID
BACKLINK_CACHE_PLUGIN_ID
CachedMetadataEx
CachedMetadataExFeature
ensureMetadataCacheReady
getBacklinksForFileOrPath
getBacklinksForFileSafe
GetBacklinksForFileSafeOptions
GetBacklinksForFileSafeParams
getCacheSafe
GetCacheSafeOptions
getFrontmatterSafe
getReferences
GetReferencesParams
hasBacklinkCachePlugin
isCachedMetadataEx
ParseCacheOptions
parseMetadata
ParseMetadataOptions
registerFileCacheForNonExistingFile
RegisterFileCacheForNonExistingFileParams
registerFiles
unregisterFileCacheForNonExistingFile
unregisterFiles
misplaced-attachment
Overview
AttachmentPlacement
ExternalAttachmentLinkMode
getAttachmentPlacement
GetAttachmentPlacementParams
MisplacedAttachmentEntry
MisplacedAttachmentIndex
recordAttachmentPlacement
RecordAttachmentPlacementParams
mobile-app-info
Overview
getMobileAppInfo
MobileAppInfo
mobile-trusted-input
Overview
clickElement
clickMouse
hoverElement
moveMouse
pressKey
typeIntoEditor
unhoverElement
modals
alert
Overview
alert
AlertParams
code-block-builder
Overview
CodeBlockBuilderBooleanField
CodeBlockBuilderColorField
CodeBlockBuilderConditionalDropdownField
CodeBlockBuilderDropdownField
CodeBlockBuilderField
CodeBlockBuilderFieldBase
CodeBlockBuilderFolderField
CodeBlockBuilderGroup
CodeBlockBuilderInput
CodeBlockBuilderMultipleDropdownField
CodeBlockBuilderOptionGroup
CodeBlockBuilderOptions
CodeBlockBuilderPreviewParams
CodeBlockBuilderSliderField
CodeBlockBuilderTextField
CodeBlockBuilderValue
formatCodeBlock
FormatCodeBlockParams
showCodeBlockBuilder
ShowCodeBlockBuilderParams
confirm
Overview
confirm
ConfirmParams
copy-text-manually
Overview
copyTextManually
CopyTextManuallyParams
minimizable-modal
Overview
MinimizableModal
MinimizableModalConstructorOptions
modal
Overview
ModalBase
ModalBaseConstructorParams
ModalParamsBase
showModal
modal-command-builder
Overview
CheckboxCommand
CommandBase
DropDownCommand
KeyboardCommand
ModalCommandBuilder
ModalCommandBuilderBuildOptions
ModalCommands
ModalCommandsHost
ModalCommandsRenderMode
ModalCommandsTarget
prompt
Overview
prompt
PromptParams
review-bug-report-diagnostics
Overview
reviewBugReportDiagnostics
ReviewBugReportDiagnosticsParams
select-item
Overview
selectItem
SelectItemParams
select-option
Overview
selectOption
SelectOptionItem
SelectOptionParams
suggest-modal-command-builder
Overview
SuggestModalCommandBuilder
SuggestModalCommandBuilderBuildOptions
note-priority
Overview
filterHighestPriorityNotePaths
FilterHighestPriorityNotePathsParams
findNoPriorityWinnerReason
FindNoPriorityWinnerReasonParams
findNotePriorityRank
FindNotePriorityRankParams
NO_PRIORITY_MATCH
NoPriorityWinnerReason
pickHighestPriorityNotePath
PickHighestPriorityNotePathParams
notebook-navigator
Overview
NOTEBOOK_NAVIGATOR_MENU_SOURCE
NOTEBOOK_NAVIGATOR_PLUGIN_ADAPTER
NOTEBOOK_NAVIGATOR_PLUGIN_ID
NotebookNavigatorApi
NotebookNavigatorFileMenuContext
NotebookNavigatorFileMenuSelection
NotebookNavigatorFileMenuSelectionMode
NotebookNavigatorFolderMenuContext
NotebookNavigatorMenuContext
NotebookNavigatorMenuDispose
NotebookNavigatorMenus
resolveNotebookNavigatorApi
obsidian-lib-state
Overview
getObsidianLibState
resetObsidianLibState
obsidian-protocol-handler-registrar
Overview
ObsidianProtocolHandlerRegistrar
PluginObsidianProtocolHandlerRegistrar
obsidian-settings
Overview
getNewLinkFormat
isSpellcheckEnabled
isSpellcheckEnabledForMode
NewLinkFormat
shouldUseWikilinks
SpellcheckMode
obsidian-word-characters
Overview
canonicalizeObsidianText
createObsidianMentionRegExp
getObsidianNameTokens
isObsidianWordCharacter
tokenizeObsidianWords
parse-link
Overview
escapeAlias
isParseLinkFrontmatterReference
isParseLinkReference
parseFrontmatterLinks
ParseFrontmatterLinksResult
parseLink
ParseLinkFrontmatterReference
ParseLinkFrontmatterReferenceWithOffsets
ParseLinkOptions
ParseLinkReference
ParseLinkResult
parseLinks
ParseLinksOptions
toParseLinkReference
ToParseLinkReferenceParams
unescapeAlias
path-compatibility
Overview
findPathCompatibilityViolations
FindPathCompatibilityViolationsParams
getCurrentPathCompatibilityPlatform
getForbiddenCharacterReplacementValidationMessage
isUnicodeNormalized
measure
PATH_COMPATIBILITY_PLATFORM_LABELS
PATH_COMPATIBILITY_PLATFORMS
PathCompatibilityMeasurement
PathCompatibilityPlatform
PathCompatibilityProfile
PathCompatibilityViolation
PathCompatibilityViolationType
repairName
RepairNameParams
path-settings
Overview
PathSettings
pathsValidator
pdf
Overview
printToPdf
plugin
plugin
Overview
PluginBase
reloadPlugin
showErrorAndDisablePlugin
plugin-api
Overview
findPluginApi
FindPluginApiParams
getValidatePluginApiPayloadsDebugSwitch
PluginApiDeclaration
PluginApiPayloadKind
PluginApiRef
PluginApiRefEventMap
PluginApiRevokedError
PluginApiUnavailabilityReason
PluginApiUnavailableError
PluginApiUnavailableErrorConstructorParams
PluginApiValidationError
PluginApiValidationErrorConstructorParams
publishPluginApi
PublishPluginApiParams
watchPluginApi
WatchPluginApiParams
WhenAvailablePluginApiOptions
plugin-async-cleanup
Overview
DEFAULT_PLUGIN_ASYNC_CLEANUP_NOTICE_DELAY_IN_MILLISECONDS
DEFAULT_PLUGIN_ASYNC_CLEANUP_TIMEOUT_IN_MILLISECONDS
didPluginAsyncCleanupsSettle
DidPluginAsyncCleanupsSettleParams
hasPendingPluginAsyncCleanups
PLUGIN_ASYNC_CLEANUPS_STATE_KEY
PluginAsyncCleanup
registerPluginAsyncCleanup
RegisterPluginAsyncCleanupParams
trackPluginAsyncCleanup
TrackPluginAsyncCleanupParams
plugin-context
Overview
addPluginCssClasses
initDebugController
initPluginContext
plugin-event-source
Overview
PluginEventMap
PluginEventSource
PluginEventSourceImpl
plugin-install-state
Overview
comparePluginVersionWithMinimum
getInstalledPluginState
GetInstalledPluginStateParams
getInstalledPluginVersion
GetInstalledPluginVersionParams
installAndEnablePlugin
InstallAndEnablePluginParams
InstalledPluginState
PluginVersionComparison
updatePlugin
UpdatePluginParams
plugin-instance
Overview
getLoadedPlugin
GetLoadedPluginParams
getPluginAvailability
GetPluginAvailabilityParams
PluginAvailability
PluginInstanceUnavailableError
PluginInstanceUnavailableErrorConstructorParams
PLUGINS_CHANGED_EVENT_NAME
requirePlugin
RequirePluginParams
waitForPlugin
WaitForPluginParams
plugin-lifecycle-events
Overview
PLUGIN_LOADED_EVENT_NAME
PLUGIN_UNLOADED_EVENT_NAME
PluginLifecycleEventName
PluginLifecycleEventPayload
triggerPluginLifecycleEvent
TriggerPluginLifecycleEventParams
plugin-settings-tab
Overview
BindOptions
BindOptionsExtended
PluginSettingsTabBase
PluginSettingsTabBaseBindExtendedParams
PluginSettingsTabBaseBindParams
PluginSettingsTabBaseConstructorParams
PluginSettingsTabBaseSettingExParams
PluginSettingsTabBaseSettingGroupExParams
SAVE_TO_FILE_CONTEXT
settings-migration-api
Overview
getSettingsMigrationApiContract
MigrateSettingsParams
MigrateSettingsResult
SettingsMigrationApi
third-party-plugin
Overview
createThirdPartyPluginDependency
CreateThirdPartyPluginDependencyParams
getThirdPartyPluginApi
GetThirdPartyPluginApiParams
getThirdPartyPluginAvailability
GetThirdPartyPluginAvailabilityParams
isThirdPartyPluginDependency
requireThirdPartyPluginApi
RequireThirdPartyPluginApiParams
ThirdPartyPluginAdapter
ThirdPartyPluginApiRef
ThirdPartyPluginApiRefEventMap
ThirdPartyPluginDependency
waitForThirdPartyPluginApi
WaitForThirdPartyPluginApiParams
watchThirdPartyPluginApi
WatchThirdPartyPluginApiParams
plugin-cli-handler-registrar
Overview
CliHandlerRegistrar
CliHandlerRegistrarRegisterCliHandlerParams
PluginCliHandlerRegistrar
popovers
field-popover
Overview
editFieldsInPopover
EditFieldsInPopoverParams
PopoverField
popover
Overview
PopoverValueGetter
showPopover
ShowPopoverBuildParams
ShowPopoverParams
popover-anchor
Overview
createAnchorFromDocumentCenter
createAnchorFromElement
createAnchorFromPoint
createAnchorFromSelection
PopoverAnchor
position
Overview
isPositionInOffsetRange
isPositionInside
isPositionInsideSome
PositionContainer
Positioned
property-entry
Overview
checkPropertyEntryMatches
CheckPropertyEntryMatchesParams
isPropertyEntry
PROPERTY_ENTRY_PREFIX
queue
Overview
addToQueue
addToQueueAndWait
AddToQueueAndWaitParams
AddToQueueParams
flushQueue
react
app-context
Overview
AppContext
useApp
reference
Overview
CanvasFileNodeReference
CanvasReference
CanvasTextNodeReference
getReferenceLinkText
isCanvasFileNodeReference
isCanvasReference
isCanvasTextNodeReference
isReferenceInHeading
isReferenceInOffsetRange
OffsetRange
referenceToFileChange
sortReferences
reference-definition
Overview
referenceDefinitionToFileChange
ReferenceDefinitionToFileChangeParams
release-asset
Overview
computeSha256
ensureReleaseAsset
EnsureReleaseAssetParams
formatByteSize
getGitHubReleaseAssetUrl
GetGitHubReleaseAssetUrlParams
ReleaseAsset
ReleaseAssetChecksumError
ReleaseAssetChecksumErrorConstructorParams
ReleaseAssetConsentRequest
rendered-markdown
Overview
isOwnedByRenderedMarkdown
registerFoldHandlers
RegisterFoldHandlersParams
registerFootnoteLinkHandler
RegisterFootnoteLinkHandlerParams
request-url
Overview
createRequestUrlFetch
CreateRequestUrlFetchOptions
EncodedRequestUrlRequest
encodeRequestUrlRequest
EncodeRequestUrlRequestParams
RequestUrlError
RequestUrlErrorConstructorParams
requestUrlEx
RequestUrlExBody
RequestUrlExParams
RequestUrlFetch
requestUrlStream
RequestUrlStreamParams
RequestUrlStreamResponse
resource-lock
Overview
isResourceLockedForPath
isResourceLockedForPathByAncestor
lockResourceForPath
LockResourceForPathParams
requestResourceUnlockForPath
ResourceLockComponent
ResourceLockComponentLockForPathParams
ResourceLockedError
ResourceLockMode
unlockResourceForPath
resource-url
Overview
relativePathToResourceUrl
RelativePathToResourceUrlParams
ribbon-icon-registrar
Overview
PluginRibbonIconRegistrar
RibbonIconRegistrar
RibbonIconRegistrarAddRibbonIconParams
setting-components
checkbox-component
Overview
CheckboxComponent
code-highlighter-component
Overview
CodeHighlighterComponent
date-component
Overview
DateComponent
date-time-component
Overview
DateTimeComponent
email-component
Overview
EmailComponent
file-component
Overview
FileComponent
folder-list-component
Overview
FolderInputSuggest
FolderListComponent
hotkey-component
Overview
HotkeyComponent
list-component
Overview
ListComponent
month-component
Overview
IsoMonth
MonthComponent
multiple-dropdown-component
Overview
MultipleDropdownComponent
multiple-email-component
Overview
MultipleEmailComponent
multiple-file-component
Overview
MultipleFileComponent
multiple-text-component
Overview
MultipleTextComponent
number-component
Overview
NumberComponent
password-component
Overview
PasswordComponent
setting-component-wrapper
Overview
ensureWrapped
tag-list-component
Overview
TagInputSuggest
TagListComponent
telephone-component
Overview
TelephoneComponent
text-based-component
Overview
getTextBasedComponentValue
TextBasedComponent
time-component
Overview
TimeComponent
tri-state-checkbox-component
Overview
TriStateCheckboxComponent
typed-dropdown-component
Overview
TypedDropdownComponent
typed-multiple-dropdown-component
Overview
TypedMultipleDropdownComponent
typed-range-text-component
Overview
TypedRangeTextComponent
typed-text-component
Overview
TypedTextComponent
TypedTextComponentConstructorParams
url-component
Overview
UrlComponent
validator-component
Overview
getValidatorComponent
ValidatorComponent
value-component-with-change-tracking
Overview
ValueComponentWithChangeTracking
week-component
Overview
IsoWeek
WeekComponent
setting-ex
Overview
adoptSettingEx
SettingEx
setting-group-ex
Overview
SettingGroupEx
settings-modal
Overview
openSettingTab
OpenSettingTabParams
settings-recovery
Overview
DEFAULT_MAX_SETTINGS_RECOVERY_COPIES
isSettingsRecoveryCopy
LocalSettingsRecoveryStore
LocalSettingsRecoveryStoreConstructorParams
SETTINGS_RECOVERY_STORE_ID
SettingsRecoveryCopy
SettingsRecoveryReason
SettingsRecoveryStore
SettingsRecoveryStoreKeepParams
settings-tabs
Overview
SettingsTab
SettingsTabs
status-bar-item-registrar
Overview
PluginStatusBarItemRegistrar
StatusBarItemRegistrar
templater
Overview
getTemplaterFunctions
GetTemplaterFunctionsParams
getTemplaterRenderTargetFile
parseTemplate
ParseTemplateParams
requireTemplaterApi
resolveTemplaterApi
TEMPLATER_PLUGIN_ADAPTER
TEMPLATER_PLUGIN_ID
TemplaterActiveFileProvider
TemplaterApi
TemplaterFunctionsGenerator
TemplaterRunMode
TemplaterRunningConfig
TemplaterUnavailabilityReason
TemplaterUnavailableError
transformers
duration-transformer
Overview
DurationTransformer
trusted-input
Overview
clickElement
clickMouse
hoverElement
moveMouse
pressKey
typeIntoEditor
unhoverElement
validation
Overview
ANDROID_UNSAFE_PATH_CHARS
getFileNameValidationMessage
getOsAndObsidianUnsafePathCharsRegExp
getOsUnsafePathCharsRegExp
getPathValidationMessage
hasWindowsTrailingChars
isValidationMessageHolder
isWindowsReservedName
OBSIDIAN_UNSAFE_FILENAME_CHARS
trimWindowsTrailingChars
UNIX_UNSAFE_PATH_CHARS
ValidationMessageHolder
WINDOWS_UNSAFE_PATH_CHARS
vault
Overview
cleanupEmptyFolders
CleanupEmptyFoldersParams
ContentArguments
copySafe
CopySafeParams
createFolderSafe
CreateFolderSafeResult
createTemporaryFile
createTemporaryFolder
deleteEmptyFolder
deleteEmptyFolderHierarchy
EmptyFolderBehavior
getAbstractFilePathSafe
GetAbstractFilePathSafeParams
getAvailablePath
getFilePathSafe
getFolderPathSafe
getMarkdownFilesSorted
getNoteFilesSorted
getOrCreateAbstractFileSafe
GetOrCreateAbstractFileSafeParams
getOrCreateFileSafe
getOrCreateFolderSafe
getSafeRenamePath
GetSafeRenamePathParams
InvokeFileActionSafeResult
invokeWithFileSystemLock
InvokeWithFileSystemLockParams
isChild
isChildOrSelf
IsChildOrSelfParams
IsChildParams
isEmptyFolder
listSafe
process
ProcessOptions
ProcessParams
readSafe
renameSafe
RenameSafeParams
saveNote
trashSafe
vault-delete
Overview
deleteIfNotUsed
DeleteIfNotUsedResult
RescueStillUsedFileParams
vault-transaction
Overview
VaultTransaction
VaultTransactionConstructorParams
view-registrar
Overview
PluginViewRegistrar
ViewRegistrar
virtual-file
Overview
registerVirtualFile
RegisterVirtualFileParams
VirtualFile
wasm
Overview
compileWasmModule
instantiateWasmModule
WasmInstance
worker-protocol
Overview
exposeWorkerApi
invokeWorkerHandler
isTransferredValue
isWorkerRequestMessage
isWorkerResponseMessage
SerializedWorkerError
serializeWorkerError
TransferredValue
UnwrappedTransferredValue
unwrapTransferredValue
withTransfer
WORKER_PROTOCOL
WorkerApi
WorkerApiHandlers
WorkerCallContext
WorkerCallMessage
WorkerCancelMessage
WorkerErrorMessage
WorkerHandlerResult
WorkerMessagePort
WorkerRequestMessage
WorkerResponseMessage
WorkerResultMessage
workspace
Overview
ensureLayoutReady
getAllContainers
getAllDomWindows
getMainWindow
switchToMainWindow
switchToWindow
GitHub
Select theme
Dark
Light
Auto
VirtualFile.file
VirtualFile
› file
Type:
TFile
The file accepted by Obsidian's link resolver and file views.