obsidian-typings 4.84.0 → 4.86.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/implementations.d.cts +91 -91
- package/dist/cjs/types.d.cts +92 -92
- package/dist/obsidian-typings.api.json +867 -867
- package/package.json +4 -4
|
@@ -4882,6 +4882,97 @@ export interface Dimensions {
|
|
|
4882
4882
|
/** @todo Documentation incomplete. */
|
|
4883
4883
|
width: number;
|
|
4884
4884
|
}
|
|
4885
|
+
/**
|
|
4886
|
+
* The handlers for the DOM events.
|
|
4887
|
+
*
|
|
4888
|
+
* @public
|
|
4889
|
+
* @unofficial
|
|
4890
|
+
*/
|
|
4891
|
+
export interface DomEventsHandlers {
|
|
4892
|
+
/**
|
|
4893
|
+
* Handles the external link click event.
|
|
4894
|
+
*
|
|
4895
|
+
* @param evt - The mouse event.
|
|
4896
|
+
* @param targetEl - The target element.
|
|
4897
|
+
* @param linkText - The link text.
|
|
4898
|
+
*/
|
|
4899
|
+
onExternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
4900
|
+
/**
|
|
4901
|
+
* Handles the external link right click event.
|
|
4902
|
+
*
|
|
4903
|
+
* @param evt - The mouse event.
|
|
4904
|
+
* @param targetEl - The target element.
|
|
4905
|
+
* @param linkText - The link text.
|
|
4906
|
+
*/
|
|
4907
|
+
onExternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
4908
|
+
/**
|
|
4909
|
+
* Handles the internal link click event.
|
|
4910
|
+
*
|
|
4911
|
+
* @param evt - The mouse event.
|
|
4912
|
+
* @param targetEl - The target element.
|
|
4913
|
+
* @param linkText - The link text.
|
|
4914
|
+
*/
|
|
4915
|
+
onInternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
4916
|
+
/**
|
|
4917
|
+
* Handles the internal link drag event.
|
|
4918
|
+
*
|
|
4919
|
+
* @param evt - The mouse event.
|
|
4920
|
+
* @param targetEl - The target element.
|
|
4921
|
+
* @param linkText - The link text.
|
|
4922
|
+
* @param title - The title.
|
|
4923
|
+
*/
|
|
4924
|
+
onInternalLinkDrag(evt: MouseEvent, targetEl: HTMLElement, linkText: string, title?: string): unknown;
|
|
4925
|
+
/**
|
|
4926
|
+
* Handles the internal link mouseover event.
|
|
4927
|
+
*
|
|
4928
|
+
* @param evt - The mouse event.
|
|
4929
|
+
* @param targetEl - The target element.
|
|
4930
|
+
* @param linkText - The link text.
|
|
4931
|
+
*/
|
|
4932
|
+
onInternalLinkMouseover(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
4933
|
+
/**
|
|
4934
|
+
* Handles the internal link right click event.
|
|
4935
|
+
*
|
|
4936
|
+
* @param evt - The mouse event.
|
|
4937
|
+
* @param targetEl - The target element.
|
|
4938
|
+
* @param linkText - The link text.
|
|
4939
|
+
*/
|
|
4940
|
+
onInternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
4941
|
+
/**
|
|
4942
|
+
* Handles the tag click event.
|
|
4943
|
+
*
|
|
4944
|
+
* @param evt - The mouse event.
|
|
4945
|
+
* @param targetEl - The target element.
|
|
4946
|
+
* @param linkText - The link text.
|
|
4947
|
+
*/
|
|
4948
|
+
onTagClick(evt: MouseEvent, targetEl: HTMLElement, tag: string): unknown;
|
|
4949
|
+
}
|
|
4950
|
+
/**
|
|
4951
|
+
* The DomEventsHandlers constructor.
|
|
4952
|
+
*
|
|
4953
|
+
* @public
|
|
4954
|
+
* @unofficial
|
|
4955
|
+
*/
|
|
4956
|
+
export interface DomEventsHandlersConstructor extends ConstructorBase<[
|
|
4957
|
+
info: DomEventsHandlersInfo
|
|
4958
|
+
], DomEventsHandlers> {
|
|
4959
|
+
}
|
|
4960
|
+
/**
|
|
4961
|
+
* Information about the DOM events handlers.
|
|
4962
|
+
*
|
|
4963
|
+
* @public
|
|
4964
|
+
* @unofficial
|
|
4965
|
+
*/
|
|
4966
|
+
export interface DomEventsHandlersInfo extends HoverParent {
|
|
4967
|
+
/**
|
|
4968
|
+
* Obsidian app instance.
|
|
4969
|
+
*/
|
|
4970
|
+
app: App;
|
|
4971
|
+
/**
|
|
4972
|
+
* The path to calculate relative links from.
|
|
4973
|
+
*/
|
|
4974
|
+
path: string;
|
|
4975
|
+
}
|
|
4885
4976
|
/**
|
|
4886
4977
|
* @todo Documentation incomplete.
|
|
4887
4978
|
* @public
|
|
@@ -10385,97 +10476,6 @@ export interface RecentFileTracker {
|
|
|
10385
10476
|
*/
|
|
10386
10477
|
serialize(): string[];
|
|
10387
10478
|
}
|
|
10388
|
-
/**
|
|
10389
|
-
* The handlers for the DOM events.
|
|
10390
|
-
*
|
|
10391
|
-
* @public
|
|
10392
|
-
* @unofficial
|
|
10393
|
-
*/
|
|
10394
|
-
export interface RegisterDomEventsHandlers {
|
|
10395
|
-
/**
|
|
10396
|
-
* Handles the external link click event.
|
|
10397
|
-
*
|
|
10398
|
-
* @param evt - The mouse event.
|
|
10399
|
-
* @param targetEl - The target element.
|
|
10400
|
-
* @param linkText - The link text.
|
|
10401
|
-
*/
|
|
10402
|
-
onExternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
10403
|
-
/**
|
|
10404
|
-
* Handles the external link right click event.
|
|
10405
|
-
*
|
|
10406
|
-
* @param evt - The mouse event.
|
|
10407
|
-
* @param targetEl - The target element.
|
|
10408
|
-
* @param linkText - The link text.
|
|
10409
|
-
*/
|
|
10410
|
-
onExternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
10411
|
-
/**
|
|
10412
|
-
* Handles the internal link click event.
|
|
10413
|
-
*
|
|
10414
|
-
* @param evt - The mouse event.
|
|
10415
|
-
* @param targetEl - The target element.
|
|
10416
|
-
* @param linkText - The link text.
|
|
10417
|
-
*/
|
|
10418
|
-
onInternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
10419
|
-
/**
|
|
10420
|
-
* Handles the internal link drag event.
|
|
10421
|
-
*
|
|
10422
|
-
* @param evt - The mouse event.
|
|
10423
|
-
* @param targetEl - The target element.
|
|
10424
|
-
* @param linkText - The link text.
|
|
10425
|
-
* @param title - The title.
|
|
10426
|
-
*/
|
|
10427
|
-
onInternalLinkDrag(evt: MouseEvent, targetEl: HTMLElement, linkText: string, title?: string): unknown;
|
|
10428
|
-
/**
|
|
10429
|
-
* Handles the internal link mouseover event.
|
|
10430
|
-
*
|
|
10431
|
-
* @param evt - The mouse event.
|
|
10432
|
-
* @param targetEl - The target element.
|
|
10433
|
-
* @param linkText - The link text.
|
|
10434
|
-
*/
|
|
10435
|
-
onInternalLinkMouseover(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
10436
|
-
/**
|
|
10437
|
-
* Handles the internal link right click event.
|
|
10438
|
-
*
|
|
10439
|
-
* @param evt - The mouse event.
|
|
10440
|
-
* @param targetEl - The target element.
|
|
10441
|
-
* @param linkText - The link text.
|
|
10442
|
-
*/
|
|
10443
|
-
onInternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
10444
|
-
/**
|
|
10445
|
-
* Handles the tag click event.
|
|
10446
|
-
*
|
|
10447
|
-
* @param evt - The mouse event.
|
|
10448
|
-
* @param targetEl - The target element.
|
|
10449
|
-
* @param linkText - The link text.
|
|
10450
|
-
*/
|
|
10451
|
-
onTagClick(evt: MouseEvent, targetEl: HTMLElement, tag: string): unknown;
|
|
10452
|
-
}
|
|
10453
|
-
/**
|
|
10454
|
-
* The RegisterDomEventsHandlers constructor.
|
|
10455
|
-
*
|
|
10456
|
-
* @public
|
|
10457
|
-
* @unofficial
|
|
10458
|
-
*/
|
|
10459
|
-
export interface RegisterDomEventsHandlersConstructor extends ConstructorBase<[
|
|
10460
|
-
info: RegisterDomEventsHandlersInfo
|
|
10461
|
-
], RegisterDomEventsHandlers> {
|
|
10462
|
-
}
|
|
10463
|
-
/**
|
|
10464
|
-
* Information about the register dom events handlers.
|
|
10465
|
-
*
|
|
10466
|
-
* @public
|
|
10467
|
-
* @unofficial
|
|
10468
|
-
*/
|
|
10469
|
-
export interface RegisterDomEventsHandlersInfo extends HoverParent {
|
|
10470
|
-
/**
|
|
10471
|
-
* Obsidian app instance.
|
|
10472
|
-
*/
|
|
10473
|
-
app: App;
|
|
10474
|
-
/**
|
|
10475
|
-
* The path to calculate relative links from.
|
|
10476
|
-
*/
|
|
10477
|
-
path: string;
|
|
10478
|
-
}
|
|
10479
10479
|
/**
|
|
10480
10480
|
* @todo Documentation incomplete.
|
|
10481
10481
|
* @public
|
package/dist/cjs/types.d.cts
CHANGED
|
@@ -15390,7 +15390,7 @@ declare module "obsidian" {
|
|
|
15390
15390
|
*
|
|
15391
15391
|
* @unofficial
|
|
15392
15392
|
*/
|
|
15393
|
-
function registerDomEvents(el: HTMLElement, handlers:
|
|
15393
|
+
function registerDomEvents(el: HTMLElement, handlers: DomEventsHandlers, childElFn?: (childEl: HTMLElement) => boolean): void;
|
|
15394
15394
|
/**
|
|
15395
15395
|
* Register a post processor.
|
|
15396
15396
|
*
|
|
@@ -23303,6 +23303,97 @@ export interface Dimensions {
|
|
|
23303
23303
|
/** @todo Documentation incomplete. */
|
|
23304
23304
|
width: number;
|
|
23305
23305
|
}
|
|
23306
|
+
/**
|
|
23307
|
+
* The handlers for the DOM events.
|
|
23308
|
+
*
|
|
23309
|
+
* @public
|
|
23310
|
+
* @unofficial
|
|
23311
|
+
*/
|
|
23312
|
+
export interface DomEventsHandlers {
|
|
23313
|
+
/**
|
|
23314
|
+
* Handles the external link click event.
|
|
23315
|
+
*
|
|
23316
|
+
* @param evt - The mouse event.
|
|
23317
|
+
* @param targetEl - The target element.
|
|
23318
|
+
* @param linkText - The link text.
|
|
23319
|
+
*/
|
|
23320
|
+
onExternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
23321
|
+
/**
|
|
23322
|
+
* Handles the external link right click event.
|
|
23323
|
+
*
|
|
23324
|
+
* @param evt - The mouse event.
|
|
23325
|
+
* @param targetEl - The target element.
|
|
23326
|
+
* @param linkText - The link text.
|
|
23327
|
+
*/
|
|
23328
|
+
onExternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
23329
|
+
/**
|
|
23330
|
+
* Handles the internal link click event.
|
|
23331
|
+
*
|
|
23332
|
+
* @param evt - The mouse event.
|
|
23333
|
+
* @param targetEl - The target element.
|
|
23334
|
+
* @param linkText - The link text.
|
|
23335
|
+
*/
|
|
23336
|
+
onInternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
23337
|
+
/**
|
|
23338
|
+
* Handles the internal link drag event.
|
|
23339
|
+
*
|
|
23340
|
+
* @param evt - The mouse event.
|
|
23341
|
+
* @param targetEl - The target element.
|
|
23342
|
+
* @param linkText - The link text.
|
|
23343
|
+
* @param title - The title.
|
|
23344
|
+
*/
|
|
23345
|
+
onInternalLinkDrag(evt: MouseEvent, targetEl: HTMLElement, linkText: string, title?: string): unknown;
|
|
23346
|
+
/**
|
|
23347
|
+
* Handles the internal link mouseover event.
|
|
23348
|
+
*
|
|
23349
|
+
* @param evt - The mouse event.
|
|
23350
|
+
* @param targetEl - The target element.
|
|
23351
|
+
* @param linkText - The link text.
|
|
23352
|
+
*/
|
|
23353
|
+
onInternalLinkMouseover(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
23354
|
+
/**
|
|
23355
|
+
* Handles the internal link right click event.
|
|
23356
|
+
*
|
|
23357
|
+
* @param evt - The mouse event.
|
|
23358
|
+
* @param targetEl - The target element.
|
|
23359
|
+
* @param linkText - The link text.
|
|
23360
|
+
*/
|
|
23361
|
+
onInternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
23362
|
+
/**
|
|
23363
|
+
* Handles the tag click event.
|
|
23364
|
+
*
|
|
23365
|
+
* @param evt - The mouse event.
|
|
23366
|
+
* @param targetEl - The target element.
|
|
23367
|
+
* @param linkText - The link text.
|
|
23368
|
+
*/
|
|
23369
|
+
onTagClick(evt: MouseEvent, targetEl: HTMLElement, tag: string): unknown;
|
|
23370
|
+
}
|
|
23371
|
+
/**
|
|
23372
|
+
* The DomEventsHandlers constructor.
|
|
23373
|
+
*
|
|
23374
|
+
* @public
|
|
23375
|
+
* @unofficial
|
|
23376
|
+
*/
|
|
23377
|
+
export interface DomEventsHandlersConstructor extends ConstructorBase<[
|
|
23378
|
+
info: DomEventsHandlersInfo
|
|
23379
|
+
], DomEventsHandlers> {
|
|
23380
|
+
}
|
|
23381
|
+
/**
|
|
23382
|
+
* Information about the DOM events handlers.
|
|
23383
|
+
*
|
|
23384
|
+
* @public
|
|
23385
|
+
* @unofficial
|
|
23386
|
+
*/
|
|
23387
|
+
export interface DomEventsHandlersInfo extends HoverParent {
|
|
23388
|
+
/**
|
|
23389
|
+
* Obsidian app instance.
|
|
23390
|
+
*/
|
|
23391
|
+
app: App;
|
|
23392
|
+
/**
|
|
23393
|
+
* The path to calculate relative links from.
|
|
23394
|
+
*/
|
|
23395
|
+
path: string;
|
|
23396
|
+
}
|
|
23306
23397
|
/**
|
|
23307
23398
|
* @todo Documentation incomplete.
|
|
23308
23399
|
* @public
|
|
@@ -28806,97 +28897,6 @@ export interface RecentFileTracker {
|
|
|
28806
28897
|
*/
|
|
28807
28898
|
serialize(): string[];
|
|
28808
28899
|
}
|
|
28809
|
-
/**
|
|
28810
|
-
* The handlers for the DOM events.
|
|
28811
|
-
*
|
|
28812
|
-
* @public
|
|
28813
|
-
* @unofficial
|
|
28814
|
-
*/
|
|
28815
|
-
export interface RegisterDomEventsHandlers {
|
|
28816
|
-
/**
|
|
28817
|
-
* Handles the external link click event.
|
|
28818
|
-
*
|
|
28819
|
-
* @param evt - The mouse event.
|
|
28820
|
-
* @param targetEl - The target element.
|
|
28821
|
-
* @param linkText - The link text.
|
|
28822
|
-
*/
|
|
28823
|
-
onExternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
28824
|
-
/**
|
|
28825
|
-
* Handles the external link right click event.
|
|
28826
|
-
*
|
|
28827
|
-
* @param evt - The mouse event.
|
|
28828
|
-
* @param targetEl - The target element.
|
|
28829
|
-
* @param linkText - The link text.
|
|
28830
|
-
*/
|
|
28831
|
-
onExternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
28832
|
-
/**
|
|
28833
|
-
* Handles the internal link click event.
|
|
28834
|
-
*
|
|
28835
|
-
* @param evt - The mouse event.
|
|
28836
|
-
* @param targetEl - The target element.
|
|
28837
|
-
* @param linkText - The link text.
|
|
28838
|
-
*/
|
|
28839
|
-
onInternalLinkClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
28840
|
-
/**
|
|
28841
|
-
* Handles the internal link drag event.
|
|
28842
|
-
*
|
|
28843
|
-
* @param evt - The mouse event.
|
|
28844
|
-
* @param targetEl - The target element.
|
|
28845
|
-
* @param linkText - The link text.
|
|
28846
|
-
* @param title - The title.
|
|
28847
|
-
*/
|
|
28848
|
-
onInternalLinkDrag(evt: MouseEvent, targetEl: HTMLElement, linkText: string, title?: string): unknown;
|
|
28849
|
-
/**
|
|
28850
|
-
* Handles the internal link mouseover event.
|
|
28851
|
-
*
|
|
28852
|
-
* @param evt - The mouse event.
|
|
28853
|
-
* @param targetEl - The target element.
|
|
28854
|
-
* @param linkText - The link text.
|
|
28855
|
-
*/
|
|
28856
|
-
onInternalLinkMouseover(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
28857
|
-
/**
|
|
28858
|
-
* Handles the internal link right click event.
|
|
28859
|
-
*
|
|
28860
|
-
* @param evt - The mouse event.
|
|
28861
|
-
* @param targetEl - The target element.
|
|
28862
|
-
* @param linkText - The link text.
|
|
28863
|
-
*/
|
|
28864
|
-
onInternalLinkRightClick(evt: MouseEvent, targetEl: HTMLElement, linkText: string): unknown;
|
|
28865
|
-
/**
|
|
28866
|
-
* Handles the tag click event.
|
|
28867
|
-
*
|
|
28868
|
-
* @param evt - The mouse event.
|
|
28869
|
-
* @param targetEl - The target element.
|
|
28870
|
-
* @param linkText - The link text.
|
|
28871
|
-
*/
|
|
28872
|
-
onTagClick(evt: MouseEvent, targetEl: HTMLElement, tag: string): unknown;
|
|
28873
|
-
}
|
|
28874
|
-
/**
|
|
28875
|
-
* The RegisterDomEventsHandlers constructor.
|
|
28876
|
-
*
|
|
28877
|
-
* @public
|
|
28878
|
-
* @unofficial
|
|
28879
|
-
*/
|
|
28880
|
-
export interface RegisterDomEventsHandlersConstructor extends ConstructorBase<[
|
|
28881
|
-
info: RegisterDomEventsHandlersInfo
|
|
28882
|
-
], RegisterDomEventsHandlers> {
|
|
28883
|
-
}
|
|
28884
|
-
/**
|
|
28885
|
-
* Information about the register dom events handlers.
|
|
28886
|
-
*
|
|
28887
|
-
* @public
|
|
28888
|
-
* @unofficial
|
|
28889
|
-
*/
|
|
28890
|
-
export interface RegisterDomEventsHandlersInfo extends HoverParent {
|
|
28891
|
-
/**
|
|
28892
|
-
* Obsidian app instance.
|
|
28893
|
-
*/
|
|
28894
|
-
app: App;
|
|
28895
|
-
/**
|
|
28896
|
-
* The path to calculate relative links from.
|
|
28897
|
-
*/
|
|
28898
|
-
path: string;
|
|
28899
|
-
}
|
|
28900
28900
|
/**
|
|
28901
28901
|
* @todo Documentation incomplete.
|
|
28902
28902
|
* @public
|