forked from obsidianmd/obsidian-plugin-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathobsidian.d.ts
More file actions
3938 lines (3577 loc) · 84.6 KB
/
obsidian.d.ts
File metadata and controls
3938 lines (3577 loc) · 84.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { Extension, StateField } from '@codemirror/state';
import { EditorView } from '@codemirror/view';
import * as CodeMirror from 'codemirror';
import * as Moment from 'moment';
declare global {
interface ObjectConstructor {
isEmpty(object: Record<string, any>): boolean;
each<T>(object: {
[key: string]: T;
}, callback: (value: T, key?: string) => boolean | void, context?: any): boolean;
assign(target: any, ...sources: any): any;
entries(obj: any): any[];
}
}
declare global {
interface Array<T> {
first(): T | undefined;
last(): T | undefined;
contains(target: T): boolean;
remove(target: T): void;
shuffle(): this;
}
}
declare global {
interface Math {
clamp(value: number, min: number, max: number): number;
square(value: number): number;
}
}
declare global {
interface StringConstructor {
isString(obj: any): obj is string;
}
interface String {
contains(target: string): boolean;
startsWith(searchString: string, position?: number): boolean;
endsWith(target: string, length?: number): boolean;
format(...args: string[]): string;
}
}
declare global {
interface NumberConstructor {
isNumber(obj: any): obj is number;
}
}
declare global {
interface Window {
isBoolean(obj: any): obj is boolean;
}
function isBoolean(obj: any): obj is boolean;
}
declare global {
interface Element {
getText(): string;
setText(val: string | DocumentFragment): void;
}
}
declare global {
interface Element {
addClass(...classes: string[]): void;
addClasses(classes: string[]): void;
removeClass(...classes: string[]): void;
removeClasses(classes: string[]): void;
toggleClass(classes: string | string[], value: boolean): void;
hasClass(cls: string): boolean;
}
}
declare global {
interface Node {
detach(): void;
empty(): void;
insertAfter(other: Node): void;
indexOf(other: Node): number;
setChildrenInPlace(children: Node[]): void;
appendText(val: string): void;
}
}
declare global {
interface Element extends Node {
setAttr(qualifiedName: string, value: string | number | boolean | null): void;
setAttrs(obj: {
[key: string]: string | number | boolean | null;
}): void;
getAttr(qualifiedName: string): string | null;
matchParent(selector: string, lastParent?: Element): Element | null;
}
}
declare global {
interface HTMLElement extends Element {
show(): void;
hide(): void;
toggle(show: boolean): void;
toggleVisibility(visible: boolean): void;
/**
* Returns whether this element is shown, when the element is attached to the DOM and
* none of the parent and ancestor elements are hidden with `display: none`.
*
* Exception: Does not work on <body> and <html>, or on elements with `position: fixed`.
*/
isShown(): boolean;
}
}
declare global {
function fish(selector: string): HTMLElement | null;
function fishAll(selector: string): HTMLElement[];
interface Window extends EventTarget, AnimationFrameProvider, GlobalEventHandlers, WindowEventHandlers, WindowLocalStorage, WindowOrWorkerGlobalScope, WindowSessionStorage {
fish(selector: string): HTMLElement | null;
fishAll(selector: string): HTMLElement[];
ElementList: any;
}
interface Element extends Node {
find(selector: string): Element | null;
findAll(selector: string): HTMLElement[];
findAllSelf(selector: string): HTMLElement[];
}
interface HTMLElement extends Element {
find(selector: string): HTMLElement;
findAll(selector: string): HTMLElement[];
findAllSelf(selector: string): HTMLElement[];
}
}
declare global {
interface DomElementInfo {
/**
* The class to be assigned. Can be a space-separated string or an array of strings.
*/
cls?: string | string[];
/**
* The textContent to be assigned.
*/
text?: string | DocumentFragment;
/**
* HTML attributes to be added.
*/
attr?: {
[key: string]: string | number | boolean | null;
};
/**
* HTML title (for hover tooltip).
*/
title?: string;
/**
* The parent element to be assigned to.
*/
parent?: Node;
value?: string;
type?: string;
prepend?: boolean;
href?: string;
}
interface Node {
/**
* Create an element and append it to this node.
*/
createEl<K extends keyof HTMLElementTagNameMap>(tag: K, o?: DomElementInfo | string, callback?: (el: HTMLElementTagNameMap[K]) => void): HTMLElementTagNameMap[K];
createDiv(o?: DomElementInfo | string, callback?: (el: HTMLDivElement) => void): HTMLDivElement;
createSpan(o?: DomElementInfo | string, callback?: (el: HTMLSpanElement) => void): HTMLSpanElement;
}
function createEl<K extends keyof HTMLElementTagNameMap>(tag: K, o?: DomElementInfo | string, callback?: (el: HTMLElementTagNameMap[K]) => void): HTMLElementTagNameMap[K];
function createDiv(o?: DomElementInfo | string, callback?: (el: HTMLDivElement) => void): HTMLDivElement;
function createSpan(o?: DomElementInfo | string, callback?: (el: HTMLSpanElement) => void): HTMLSpanElement;
function createFragment(callback?: (el: DocumentFragment) => void): DocumentFragment;
}
interface EventListenerInfo {
selector: string;
listener: Function;
options?: boolean | AddEventListenerOptions;
callback: Function;
}
declare global {
interface HTMLElement extends Element {
_EVENTS?: {
[K in keyof HTMLElementEventMap]?: EventListenerInfo[];
};
on<K extends keyof HTMLElementEventMap>(this: HTMLElement, type: K, selector: string, listener: (this: HTMLElement, ev: HTMLElementEventMap[K], delegateTarget: HTMLElement) => any, options?: boolean | AddEventListenerOptions): void;
off<K extends keyof HTMLElementEventMap>(this: HTMLElement, type: K, selector: string, listener: (this: HTMLElement, ev: HTMLElementEventMap[K], delegateTarget: HTMLElement) => any, options?: boolean | AddEventListenerOptions): void;
onClickEvent(this: HTMLElement, listener: (this: HTMLElement, ev: MouseEvent) => any, options?: boolean | AddEventListenerOptions): void;
/**
* @param listener - the callback to call when this node is inserted into the DOM.
* @param once - if true, this will only fire once and then unhook itself.
* @returns destroy - a function to remove the event handler to avoid memory leaks.
*/
onNodeInserted(this: HTMLElement, listener: () => any, once?: boolean): () => void;
trigger(eventType: string): void;
}
interface Document {
_EVENTS?: {
[K in keyof DocumentEventMap]?: EventListenerInfo[];
};
on<K extends keyof DocumentEventMap>(this: Document, type: K, selector: string, listener: (this: Document, ev: DocumentEventMap[K], delegateTarget: HTMLElement) => any, options?: boolean | AddEventListenerOptions): void;
off<K extends keyof DocumentEventMap>(this: Document, type: K, selector: string, listener: (this: Document, ev: DocumentEventMap[K], delegateTarget: HTMLElement) => any, options?: boolean | AddEventListenerOptions): void;
}
}
export interface AjaxOptions {
method?: 'GET' | 'POST';
url: string;
success?: (response: any, req: XMLHttpRequest) => any;
error?: (error: any, req: XMLHttpRequest) => any;
data?: object | string | ArrayBuffer;
headers?: Record<string, string>;
withCredentials?: boolean;
req?: XMLHttpRequest;
}
declare global {
function ajax(options: AjaxOptions): void;
function ajaxPromise(options: AjaxOptions): Promise<any>;
function ready(fn: () => any): void;
}
/**
* @public
*/
export class AbstractTextComponent<T extends HTMLInputElement | HTMLTextAreaElement> extends ValueComponent<string> {
/**
* @public
*/
inputEl: T;
/**
* @public
*/
constructor(inputEl: T);
/**
* @public
*/
setDisabled(disabled: boolean): this;
/**
* @public
*/
getValue(): string;
/**
* @public
*/
setValue(value: string): this;
/**
* @public
*/
setPlaceholder(placeholder: string): this;
/**
* @public
*/
onChanged(): void;
/**
* @public
*/
onChange(callback: (value: string) => any): this;
}
/**
* Adds an icon to the library
* @param iconId - the icon ID
* @param svgContent - the content of the SVG, without the <svg>. Must fit viewBox="0 0 100 100".
* @public
*/
export function addIcon(iconId: string, svgContent: string): void;
/**
* This is the API version of the app, which follows the release cycle of the desktop app.
* Example: "0.13.21"
* @public
*/
export let apiVersion: string;
/**
* @public
*/
export class App {
/** @public */
keymap: Keymap;
/** @public */
scope: Scope;
/** @public */
workspace: Workspace;
/** @public */
vault: Vault;
/** @public */
metadataCache: MetadataCache;
/** @public */
fileManager: FileManager;
/**
* The last known user interaction event, to help commands find out what modifier keys are pressed.
* @public
*/
lastEvent: UserEvent | null;
}
/**
* @public
*/
export abstract class BaseComponent {
/** @public */
disabled: boolean;
/**
* Facilitates chaining
* @public
*/
then(cb: (component: this) => any): this;
/**
* @public
*/
setDisabled(disabled: boolean): this;
}
/**
* @public
*/
export interface BlockCache extends CacheItem {
/** @public */
id: string;
}
/**
* @public
*/
export interface BlockSubpathResult extends SubpathResult {
/**
* @public
*/
type: 'block';
/**
* @public
*/
block: BlockCache;
/**
* @public
*/
list?: ListItemCache;
}
/**
* @public
*/
export class ButtonComponent extends BaseComponent {
/**
* @public
*/
buttonEl: HTMLButtonElement;
/**
* @public
*/
constructor(containerEl: HTMLElement);
/**
* @public
*/
setDisabled(disabled: boolean): this;
/**
* @public
*/
setCta(): this;
/**
* @public
*/
removeCta(): this;
/**
* @public
*/
setWarning(): this;
/**
* @public
*/
setTooltip(tooltip: string): this;
/**
* @public
*/
setButtonText(name: string): this;
/**
* @public
*/
setIcon(icon: string): this;
/**
* @public
*/
setClass(cls: string): this;
/**
* @public
*/
onClick(callback: (evt: MouseEvent) => any): this;
}
/**
* @public
*/
export interface CachedMetadata {
/**
* @public
*/
links?: LinkCache[];
/**
* @public
*/
embeds?: EmbedCache[];
/**
* @public
*/
tags?: TagCache[];
/**
* @public
*/
headings?: HeadingCache[];
/**
* Sections are root level markdown blocks, which can be used to divide the document up.
* @public
*/
sections?: SectionCache[];
/**
* @public
*/
listItems?: ListItemCache[];
/**
* @public
*/
frontmatter?: FrontMatterCache;
/**
* @public
*/
blocks?: Record<string, BlockCache>;
}
/**
* @public
*/
export interface CacheItem {
/**
* @public
*/
position: Pos;
}
/** @public */
export interface CloseableComponent {
/** @public */
close(): any;
}
/**
* @public
*/
export interface Command {
/**
* Globally unique ID to identify this command.
* @public
*/
id: string;
/**
* Human friendly name for searching.
* @public
*/
name: string;
/**
* Icon ID to be used in the toolbar.
* @public
*/
icon?: string;
/** @public */
mobileOnly?: boolean;
/**
* Simple callback, triggered globally.
* @public
*/
callback?: () => any;
/**
* Complex callback, overrides the simple callback.
* Used to "check" whether your command can be performed in the current circumstances.
* For example, if your command requires the active focused pane to be a MarkdownSourceView, then
* you should only return true if the condition is satisfied. Returning false or undefined causes
* the command to be hidden from the command palette.
*
* @param checking - Whether the command palette is just "checking" if your command should show right now.
* If checking is true, then this function should not perform any action.
* If checking is false, then this function should perform the action.
* @returns Whether this command can be executed at the moment.
* @public
*/
checkCallback?: (checking: boolean) => boolean | void;
/**
* A command callback that is only triggered when the user is in an editor.
* Overrides `callback` and `checkCallback`
* @public
*/
editorCallback?: (editor: Editor, view: MarkdownView) => any;
/**
* A command callback that is only triggered when the user is in an editor.
* Overrides `editorCallback`, `callback` and `checkCallback`
* @public
*/
editorCheckCallback?: (checking: boolean, editor: Editor, view: MarkdownView) => boolean | void;
/**
* Sets the default hotkey. It is recommended for plugins to avoid setting default hotkeys if possible,
* to avoid conflicting hotkeys with one that's set by the user, even though customized hotkeys have higher priority.
* @public
*/
hotkeys?: Hotkey[];
}
/**
* @public
*/
export class Component {
/**
* Load this component and its children
* @public
*/
load(): void;
/**
* Override this to load your component
* @public
* @virtual
*/
onload(): void;
/**
* Unload this component and its children
* @public
*/
unload(): void;
/**
* Override this to unload your component
* @public
* @virtual
*/
onunload(): void;
/**
* Adds a child component, loading it if this component is loaded
* @public
*/
addChild<T extends Component>(component: T): T;
/**
* Removes a child component, unloading it
* @public
*/
removeChild<T extends Component>(component: T): T;
/**
* Registers a callback to be called when unloading
* @public
*/
register(cb: () => any): void;
/**
* Registers an event to be detached when unloading
* @public
*/
registerEvent(eventRef: EventRef): void;
/**
* Registers an DOM event to be detached when unloading
* @public
*/
registerDomEvent<K extends keyof WindowEventMap>(el: Window, type: K, callback: (this: HTMLElement, ev: WindowEventMap[K]) => any): void;
/**
* Registers an DOM event to be detached when unloading
* @public
*/
registerDomEvent<K extends keyof DocumentEventMap>(el: Document, type: K, callback: (this: HTMLElement, ev: DocumentEventMap[K]) => any): void;
/**
* Registers an DOM event to be detached when unloading
* @public
*/
registerDomEvent<K extends keyof HTMLElementEventMap>(el: HTMLElement, type: K, callback: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any): void;
/**
* Registers an key event to be detached when unloading
* @public
*/
registerScopeEvent(keyHandler: KeymapEventHandler): void;
/**
* Registers an interval (from setInterval) to be cancelled when unloading
* Use {@link window.setInterval} instead of {@link setInterval} to avoid TypeScript confusing between NodeJS vs Browser API
* @public
*/
registerInterval(id: number): number;
}
/**
* @public
*/
export interface Constructor<T> {
/**
* @public
*/
new (...args: any[]): T;
}
/**
* @public
*/
export interface DataAdapter {
/**
* @public
*/
getName(): string;
/**
* @public
*/
exists(normalizedPath: string, sensitive?: boolean): Promise<boolean>;
/**
* @public
*/
stat(normalizedPath: string): Promise<Stat | null>;
/**
* @public
*/
list(normalizedPath: string): Promise<ListedFiles>;
/**
* @public
*/
read(normalizedPath: string): Promise<string>;
/**
* @public
*/
readBinary(normalizedPath: string): Promise<ArrayBuffer>;
/**
* @public
*/
write(normalizedPath: string, data: string, options?: DataWriteOptions): Promise<void>;
/**
* @public
*/
writeBinary(normalizedPath: string, data: ArrayBuffer, options?: DataWriteOptions): Promise<void>;
/**
* @public
*/
append(normalizedPath: string, data: string, options?: DataWriteOptions): Promise<void>;
/**
* @public
*/
getResourcePath(normalizedPath: string): string;
/**
* @public
*/
mkdir(normalizedPath: string): Promise<void>;
/**
* @public
*/
trashSystem(normalizedPath: string): Promise<boolean>;
/**
* @public
*/
trashLocal(normalizedPath: string): Promise<void>;
/**
* @public
*/
rmdir(normalizedPath: string, recursive: boolean): Promise<void>;
/**
* @public
*/
remove(normalizedPath: string): Promise<void>;
/**
* @public
*/
rename(normalizedPath: string, normalizedNewPath: string): Promise<void>;
/**
* @public
*/
copy(normalizedPath: string, normalizedNewPath: string): Promise<void>;
}
/**
* @public
*/
export interface DataWriteOptions {
/** @public */
ctime?: number;
/** @public */
mtime?: number;
}
/**
* A standard debounce function.
*
* @param cb - The function to call.
* @param timeout - The timeout to wait.
* @param resetTimer - Whether to reset the timeout when the debouncer is called again.
* @returns a debounced function that takes the same parameter as the original function.
* @public
*/
export function debounce<T extends unknown[]>(cb: (...args: [...T]) => any, timeout?: number, resetTimer?: boolean): Debouncer<T>;
/** @public */
export interface Debouncer<T extends unknown[]> {
/** @public */
(...args: [...T]): void;
/** @public */
cancel(): this;
}
/**
* @public
*/
export class DropdownComponent extends ValueComponent<string> {
/**
* @public
*/
selectEl: HTMLSelectElement;
/**
* @public
*/
constructor(containerEl: HTMLElement);
/**
* @public
*/
setDisabled(disabled: boolean): this;
/**
* @public
*/
addOption(value: string, display: string): this;
/**
* @public
*/
addOptions(options: Record<string, string>): this;
/**
* @public
*/
getValue(): string;
/**
* @public
*/
setValue(value: string): this;
/**
* @public
*/
onChange(callback: (value: string) => any): this;
}
/**
* @public
*/
export abstract class EditableFileView extends FileView {
}
/**
* A common interface that bridges the gap between CodeMirror 5 and CodeMirror 6.
* @public
*/
export abstract class Editor {
/** @public */
getDoc(): this;
/** @public */
abstract refresh(): void;
/** @public */
abstract getValue(): string;
/** @public */
abstract setValue(content: string): void;
/**
* Get the text at line (0-indexed)
* @public
*/
abstract getLine(line: number): string;
/** @public */
setLine(n: number, text: string): void;
/**
* Gets the number of lines in the document
* @public
*/
abstract lineCount(): number;
/** @public */
abstract lastLine(): number;
/** @public */
abstract getSelection(): string;
/** @public */
somethingSelected(): boolean;
/** @public */
abstract getRange(from: EditorPosition, to: EditorPosition): string;
/** @public */
abstract replaceSelection(replacement: string, origin?: string): void;
/** @public */
abstract replaceRange(replacement: string, from: EditorPosition, to?: EditorPosition, origin?: string): void;
/** @public */
abstract getCursor(string?: 'from' | 'to' | 'head' | 'anchor'): EditorPosition;
/** @public */
abstract listSelections(): EditorSelection[];
/** @public */
setCursor(pos: EditorPosition | number, ch?: number): void;
/** @public */
abstract setSelection(anchor: EditorPosition, head?: EditorPosition): void;
/** @public */
abstract setSelections(ranges: EditorSelectionOrCaret[], main?: number): void;
/** @public */
abstract focus(): void;
/** @public */
abstract blur(): void;
/** @public */
abstract hasFocus(): boolean;
/** @public */
abstract getScrollInfo(): {
/** @public */
top: number;
/** @public */
left: number;
};
/** @public */
abstract scrollTo(x?: number | null, y?: number | null): void;
/** @public */
abstract scrollIntoView(range: EditorRange, center?: boolean): void;
/** @public */
abstract undo(): void;
/** @public */
abstract redo(): void;
/** @public */
abstract exec(command: EditorCommandName): void;
/** @public */
abstract transaction(tx: EditorTransaction, origin?: string): void;
/** @public */
abstract wordAt(pos: EditorPosition): EditorRange | null;
/** @public */
abstract posToOffset(pos: EditorPosition): number;
/** @public */
abstract offsetToPos(offset: number): EditorPosition;
/** @public */
processLines<T>(read: (line: number, lineText: string) => T | null, write: (line: number, lineText: string, value: T | null) => EditorChange | void, ignoreEmpty?: boolean): void;
}
/** @public */
export interface EditorChange extends EditorRangeOrCaret {
/** @public */
text: string;
}
/** @public */
export type EditorCommandName = 'goUp' | 'goDown' | 'goLeft' | 'goRight' | 'goStart' | 'goEnd' | 'indentMore' | 'indentLess' | 'newlineAndIndent' | 'swapLineUp' | 'swapLineDown' | 'deleteLine' | 'toggleFold' | 'foldAll' | 'unfoldAll';
/**
* Use this StateField to get a reference to the EditorView
* @public
*/
export const editorEditorField: StateField<EditorView>;
/**
* Use this StateField to check whether Live Preview is active
* @public
*/
export const editorLivePreviewField: StateField<boolean>;
/** @public */
export interface EditorPosition {
/** @public */
line: number;
/** @public */
ch: number;
}
/** @public */
export interface EditorRange {
/** @public */
from: EditorPosition;
/** @public */
to: EditorPosition;
}
/** @public */
export interface EditorRangeOrCaret {
/** @public */
from: EditorPosition;
/** @public */
to?: EditorPosition;
}
/** @public */
export interface EditorSelection {
/** @public */
anchor: EditorPosition;
/** @public */
head: EditorPosition;
}
/** @public */
export interface EditorSelectionOrCaret {
/** @public */
anchor: EditorPosition;
/** @public */
head?: EditorPosition;
}
/** @public */
export abstract class EditorSuggest<T> extends PopoverSuggest<T> {
/**
* Current suggestion context, containing the result of `onTrigger`.
* This will be null any time the EditorSuggest is not supposed to run.
* @public
*/
context: EditorSuggestContext | null;
/**
* Override this to use a different limit for suggestion items
* @public
*/
limit: number;
/** @public */
constructor(app: App);
/**
* @public
*/
setInstructions(instructions: Instruction[]): void;
/**
* Based on the editor line and cursor position, determine if this EditorSuggest should be triggered at this moment.
* Typically, you would run a regular expression on the current line text before the cursor.
* Return null to indicate that this editor suggest is not supposed to be triggered.
*
* Please be mindful of performance when implementing this function, as it will be triggered very often (on each keypress).
* Keep it simple, and return null as early as possible if you determine that it is not the right time.
* @public
*/
abstract onTrigger(cursor: EditorPosition, editor: Editor, file: TFile): EditorSuggestTriggerInfo | null;
/**
* Generate suggestion items based on this context. Can be async, but preferably sync.
* When generating async suggestions, you should pass the context along.
* @public
*/
abstract getSuggestions(context: EditorSuggestContext): T[] | Promise<T[]>;
}
/** @public */
export interface EditorSuggestContext extends EditorSuggestTriggerInfo {
/** @public */
editor: Editor;
/** @public */
file: TFile;
}
/** @public */
export interface EditorSuggestTriggerInfo {
/**
* The start position of the triggering text. This is used to position the popover.
* @public
*/
start: EditorPosition;
/**
* The end position of the triggering text. This is used to position the popover.
* @public
*/
end: EditorPosition;
/**
* They query string (usually the text between start and end) that will be used to generate the suggestion content.
* @public
*/
query: string;
}
/** @public */
export interface EditorTransaction {
/** @public */
replaceSelection?: string;
/** @public */
changes?: EditorChange[];
/**
* Multiple selections, overrides `selection`.
* @public
*/
selections?: EditorRangeOrCaret[];
/** @public */
selection?: EditorRangeOrCaret;
}
/**
* Use this StateField to get a reference to the MarkdownView
* @public
*/
export const editorViewField: StateField<MarkdownView>;
/**
* @public
*/
export interface EmbedCache extends ReferenceCache {
}
/**
* @public
*/
export interface EventRef {
}
/**
* @public
*/
export class Events {
/**
* @public
*/
on(name: string, callback: (...data: any) => any, ctx?: any): EventRef;
/**
* @public
*/