obsidian-typings 4.82.0 → 4.84.0

package/dist/cjs/implementations.d.cts

@@ -8,7 +8,7 @@ import type { Tree as LezerTree } from '@lezer/common';
 import type { App as App$1, BrowserWindow } from 'electron';
 import type { Mermaid } from 'mermaid';
 import type { FSWatcher } from 'node:fs';
-import type { App, BasesConfigFileFilter, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1 } from 'obsidian';
+import type { App, BasesConfigFileFilter, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverParent, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1 } from 'obsidian';
 import type { default as pdfjsLib } from 'pdfjs-dist';
 import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle } from 'pixi.js';
 import type { default as Prism$1 } from 'prismjs';
@@ -7354,24 +7354,39 @@ export interface HotkeysSettingTab extends SettingTab {
 export interface HourFunction extends BasesFunction, HasExtract {
 }
 /**
- * @todo Documentation incomplete.
+ * Event triggered when a link is hovered.
+ *
  * @public
  * @unofficial
  */
 export interface HoverLinkEvent {
-	/** @todo Documentation incomplete. */
+	/**
+	 * The mouse event.
+	 */
 	event: MouseEvent;
-	/** @todo Documentation incomplete. */
-	hoverParent: WorkspaceLeaf;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The hover parent.
+	 */
+	hoverParent: HoverParent;
+	/**
+	 * The link text.
+	 */
 	linktext: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The source of the event.
+	 */
 	source: "search" | "editor" | "preview" | "properties" | "graph" | "file-explorer" | "hover-link";
-	/** @todo Documentation incomplete. */
+	/**
+	 * The source path.
+	 */
 	sourcePath?: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The state of the event.
+	 */
 	state?: HoverLinkEventState;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The target element.
+	 */
 	targetEl: HTMLElement | null;
 }
 /**
@@ -10370,6 +10385,97 @@ export interface RecentFileTracker {
 	 */
 	serialize(): string[];
 }
+/**
+ * The handlers for the DOM events.
+ *
+ * @public
+ * @unofficial
+ */
+export interface RegisterDomEventsHandlers {
+	/**
+	 * Handles the external link click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onExternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the external link right click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onExternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the internal link click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onInternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the internal link drag event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 * @param title - The title.
+	 */
+	onInternalLinkDrag(evt: MouseEvent, targetEl: HTMLElement, linkText: string, title?: string): unknown;
+	/**
+	 * Handles the internal link mouseover event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onInternalLinkMouseover(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the internal link right click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onInternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the tag click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onTagClick(evt: MouseEvent, targetEl: HTMLElement, tag: string): unknown;
+}
+/**
+ * The RegisterDomEventsHandlers constructor.
+ *
+ * @public
+ * @unofficial
+ */
+export interface RegisterDomEventsHandlersConstructor extends ConstructorBase<[
+	info: RegisterDomEventsHandlersInfo
+], RegisterDomEventsHandlers> {
+}
+/**
+ * Information about the register dom events handlers.
+ *
+ * @public
+ * @unofficial
+ */
+export interface RegisterDomEventsHandlersInfo extends HoverParent {
+	/**
+	 * Obsidian app instance.
+	 */
+	app: App;
+	/**
+	 * The path to calculate relative links from.
+	 */
+	path: string;
+}
 /**
  * @todo Documentation incomplete.
  * @public

package/dist/cjs/types.d.cts

@@ -16,7 +16,7 @@ import * as fs from 'node:fs';
 import type { FSWatcher, Stats } from 'node:fs';
 import * as fsPromises from 'node:fs/promises';
 import * as path from 'node:path';
-import type { App, BasesConfigFileFilter, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, Constructor, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, Notice, ObsidianProtocolHandler, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1, request, requestUrl } from 'obsidian';
+import type { App, BasesConfigFileFilter, BlockCache, CacheItem, CachedMetadata, CloseableComponent, ColorComponent, Command, Component, Constructor, DataAdapter, Debouncer, EditableFileView, Editor, EditorPosition, EditorRange, EditorRangeOrCaret, EditorSuggest, EmbedCache, EventRef, Events, FileStats, FileView, FrontmatterLinkCache, FuzzySuggestModal, HoverLinkSource, HoverParent, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, Notice, ObsidianProtocolHandler, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, RenderContext, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs, moment as moment$1, request, requestUrl } from 'obsidian';
 import type { default as pdfjsLib } from 'pdfjs-dist';
 import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle, default as PIXI } from 'pixi.js';
 import type { default as Prism$1 } from 'prismjs';
@@ -15381,6 +15381,16 @@ declare module "obsidian" {
 		 * @since 0.12.11
 		 */
 		function createCodeBlockPostProcessor__(language: string, handler: (source: string, el: HTMLElement, ctx: MarkdownPostProcessorContext) => Promise<any> | void): (el: HTMLElement, ctx: MarkdownPostProcessorContext) => void;
+		/**
+		 * Registers the DOM events.
+		 *
+		 * @param el - The element to register the events on.
+		 * @param handlers - The handlers to register.
+		 * @param childElFn - The function to determine if `childEl` belongs to the `el`.
+		 *
+		 * @unofficial
+		 */
+		function registerDomEvents(el: HTMLElement, handlers: RegisterDomEventsHandlers, childElFn?: (childEl: HTMLElement) => boolean): void;
 		/**
 		 * Register a post processor.
 		 *
@@ -25765,24 +25775,39 @@ export interface HotkeysSettingTab extends SettingTab {
 export interface HourFunction extends BasesFunction, HasExtract {
 }
 /**
- * @todo Documentation incomplete.
+ * Event triggered when a link is hovered.
+ *
  * @public
  * @unofficial
  */
 export interface HoverLinkEvent {
-	/** @todo Documentation incomplete. */
+	/**
+	 * The mouse event.
+	 */
 	event: MouseEvent;
-	/** @todo Documentation incomplete. */
-	hoverParent: WorkspaceLeaf;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The hover parent.
+	 */
+	hoverParent: HoverParent;
+	/**
+	 * The link text.
+	 */
 	linktext: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The source of the event.
+	 */
 	source: "search" | "editor" | "preview" | "properties" | "graph" | "file-explorer" | "hover-link";
-	/** @todo Documentation incomplete. */
+	/**
+	 * The source path.
+	 */
 	sourcePath?: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The state of the event.
+	 */
 	state?: HoverLinkEventState;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The target element.
+	 */
 	targetEl: HTMLElement | null;
 }
 /**
@@ -28781,6 +28806,97 @@ export interface RecentFileTracker {
 	 */
 	serialize(): string[];
 }
+/**
+ * The handlers for the DOM events.
+ *
+ * @public
+ * @unofficial
+ */
+export interface RegisterDomEventsHandlers {
+	/**
+	 * Handles the external link click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onExternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the external link right click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onExternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the internal link click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onInternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the internal link drag event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 * @param title - The title.
+	 */
+	onInternalLinkDrag(evt: MouseEvent, targetEl: HTMLElement, linkText: string, title?: string): unknown;
+	/**
+	 * Handles the internal link mouseover event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onInternalLinkMouseover(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the internal link right click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onInternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
+	/**
+	 * Handles the tag click event.
+	 *
+	 * @param evt - The mouse event.
+	 * @param targetEl - The target element.
+	 * @param linkText - The link text.
+	 */
+	onTagClick(evt: MouseEvent, targetEl: HTMLElement, tag: string): unknown;
+}
+/**
+ * The RegisterDomEventsHandlers constructor.
+ *
+ * @public
+ * @unofficial
+ */
+export interface RegisterDomEventsHandlersConstructor extends ConstructorBase<[
+	info: RegisterDomEventsHandlersInfo
+], RegisterDomEventsHandlers> {
+}
+/**
+ * Information about the register dom events handlers.
+ *
+ * @public
+ * @unofficial
+ */
+export interface RegisterDomEventsHandlersInfo extends HoverParent {
+	/**
+	 * Obsidian app instance.
+	 */
+	app: App;
+	/**
+	 * The path to calculate relative links from.
+	 */
+	path: string;
+}
 /**
  * @todo Documentation incomplete.
  * @public

package/dist/obsidian-typings.api.json

@@ -75921,7 +75921,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "obsidian-typings!HoverLinkEvent:interface",
-          "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "docComment": "/**\n * Event triggered when a link is hovered.\n *\n * @unofficial\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -75936,7 +75936,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "obsidian-typings!HoverLinkEvent#event:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "docComment": "/**\n * The mouse event.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -75964,7 +75964,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "obsidian-typings!HoverLinkEvent#hoverParent:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "docComment": "/**\n * The hover parent.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -75972,8 +75972,8 @@
                 },
                 {
                   "kind": "Reference",
-                  "text": "WorkspaceLeaf",
-                  "canonicalReference": "obsidian!WorkspaceLeaf:class"
+                  "text": "HoverParent",
+                  "canonicalReference": "obsidian!HoverParent:interface"
                 },
                 {
                   "kind": "Content",
@@ -75992,7 +75992,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "obsidian-typings!HoverLinkEvent#linktext:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "docComment": "/**\n * The link text.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -76019,7 +76019,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "obsidian-typings!HoverLinkEvent#source:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "docComment": "/**\n * The source of the event.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -76046,7 +76046,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "obsidian-typings!HoverLinkEvent#sourcePath:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "docComment": "/**\n * The source path.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -76073,7 +76073,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "obsidian-typings!HoverLinkEvent#state:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "docComment": "/**\n * The state of the event.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -76101,7 +76101,7 @@
             {
               "kind": "PropertySignature",
               "canonicalReference": "obsidian-typings!HoverLinkEvent#targetEl:member",
-              "docComment": "/**\n * @todo\n *\n * Documentation incomplete.\n */\n",
+              "docComment": "/**\n * The target element.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -106145,6 +106145,733 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!RegisterDomEventsHandlers:interface",
+          "docComment": "/**\n * The handlers for the DOM events.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface RegisterDomEventsHandlers "
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/RegisterDomEventsHandlers.d.ts",
+          "releaseTag": "Public",
+          "name": "RegisterDomEventsHandlers",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlers#onExternalLinkClick:member(1)",
+              "docComment": "/**\n * Handles the external link click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onExternalLinkClick(evt: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MouseEvent",
+                  "canonicalReference": "!MouseEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", targetEl: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", linkText: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "unknown"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "evt",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "targetEl",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "linkText",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onExternalLinkClick"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlers#onExternalLinkRightClick:member(1)",
+              "docComment": "/**\n * Handles the external link right click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onExternalLinkRightClick(evt: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MouseEvent",
+                  "canonicalReference": "!MouseEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", targetEl: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", linkText: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "unknown"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "evt",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "targetEl",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "linkText",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onExternalLinkRightClick"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlers#onInternalLinkClick:member(1)",
+              "docComment": "/**\n * Handles the internal link click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onInternalLinkClick(evt: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MouseEvent",
+                  "canonicalReference": "!MouseEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", targetEl: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", linkText: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "unknown"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "evt",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "targetEl",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "linkText",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onInternalLinkClick"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlers#onInternalLinkDrag:member(1)",
+              "docComment": "/**\n * Handles the internal link drag event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n *\n * @param title - The title.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onInternalLinkDrag(evt: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MouseEvent",
+                  "canonicalReference": "!MouseEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", targetEl: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", linkText: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", title?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "unknown"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 10
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "evt",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "targetEl",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "linkText",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "title",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
+                }
+              ],
+              "name": "onInternalLinkDrag"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlers#onInternalLinkMouseover:member(1)",
+              "docComment": "/**\n * Handles the internal link mouseover event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onInternalLinkMouseover(evt: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MouseEvent",
+                  "canonicalReference": "!MouseEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", targetEl: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", linkText: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "unknown"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "evt",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "targetEl",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "linkText",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onInternalLinkMouseover"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlers#onInternalLinkRightClick:member(1)",
+              "docComment": "/**\n * Handles the internal link right click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onInternalLinkRightClick(evt: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MouseEvent",
+                  "canonicalReference": "!MouseEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", targetEl: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", linkText: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "unknown"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "evt",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "targetEl",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "linkText",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onInternalLinkRightClick"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlers#onTagClick:member(1)",
+              "docComment": "/**\n * Handles the tag click event.\n *\n * @param evt - The mouse event.\n *\n * @param targetEl - The target element.\n *\n * @param linkText - The link text.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onTagClick(evt: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MouseEvent",
+                  "canonicalReference": "!MouseEvent:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", targetEl: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HTMLElement",
+                  "canonicalReference": "!HTMLElement:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", tag: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "unknown"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "evt",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "targetEl",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "tag",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onTagClick"
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!RegisterDomEventsHandlersConstructor:interface",
+          "docComment": "/**\n * The RegisterDomEventsHandlers constructor.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface RegisterDomEventsHandlersConstructor\n    extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "ConstructorBase",
+              "canonicalReference": "obsidian-typings!ConstructorBase:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<[info: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RegisterDomEventsHandlersInfo",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlersInfo:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "], "
+            },
+            {
+              "kind": "Reference",
+              "text": "RegisterDomEventsHandlers",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlers:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": "\n"
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/Constructors/RegisterDomEventsHandlersConstructor.d.ts",
+          "releaseTag": "Public",
+          "name": "RegisterDomEventsHandlersConstructor",
+          "preserveMemberOrder": false,
+          "members": [],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 7
+            }
+          ]
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "obsidian-typings!RegisterDomEventsHandlersInfo:interface",
+          "docComment": "/**\n * Information about the register dom events handlers.\n *\n * @unofficial\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface RegisterDomEventsHandlersInfo extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "HoverParent",
+              "canonicalReference": "obsidian!HoverParent:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/obsidian/internals/RegisterDomEventsHandlersInfo.d.ts",
+          "releaseTag": "Public",
+          "name": "RegisterDomEventsHandlersInfo",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlersInfo#app:member",
+              "docComment": "/**\n * Obsidian app instance.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "app: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "App",
+                  "canonicalReference": "!Electron.CrossProcessExports.App:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "app",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "obsidian-typings!RegisterDomEventsHandlersInfo#path:member",
+              "docComment": "/**\n * The path to calculate relative links from.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "path: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "path",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
+        },
         {
           "kind": "Interface",
           "canonicalReference": "obsidian-typings!ReleaseNotesView:interface",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-typings",
-  "version": "4.82.0",
+  "version": "4.84.0",
   "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
   "main": "",
   "module": "",