obsidian-typings 4.90.0 → 4.91.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.
@@ -8,7 +8,7 @@ import type { Tree as LezerTree } from '@lezer/common';
8
8
  import type { App as App$1, BrowserWindow } from 'electron';
9
9
  import type { Mermaid } from 'mermaid';
10
10
  import type { FSWatcher } from 'node:fs';
11
- import type { App, 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';
11
+ 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';
12
12
  import type { default as pdfjsLib } from 'pdfjs-dist';
13
13
  import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle } from 'pixi.js';
14
14
  import type { default as Prism$1 } from 'prismjs';
@@ -614,14 +614,28 @@ export interface AddOverlayOptions {
614
614
  * @unofficial
615
615
  */
616
616
  export interface AliasesPropertyWidgetComponent extends PropertyWidgetComponentBase {
617
+ /** The container element for the property widget. */
618
+ containerEl: HTMLElement;
617
619
  /** The render context for the property widget. */
618
620
  ctx: PropertyRenderContext;
619
621
  /** The hover popover for the property widget. */
620
- hoverPopover: HoverPopover | null;
622
+ hoverPopover: null;
621
623
  /** The multiselect component for the property widget. */
622
624
  multiselect: Multiselect;
623
625
  /** The type of the property widget. */
624
626
  type: "aliases";
627
+ /**
628
+ * Handle focus event.
629
+ *
630
+ * @param mode - The focus mode.
631
+ */
632
+ onFocus(): void;
633
+ /**
634
+ * Set the value of the property widget.
635
+ *
636
+ * @param value - The value to set.
637
+ */
638
+ setValue(value: unknown): void;
625
639
  }
626
640
  /**
627
641
  * @todo Documentation incomplete.
@@ -1357,6 +1371,78 @@ export interface BacklinkView extends InfoFileView {
1357
1371
  */
1358
1372
  export interface BacklinkViewConstructor extends TypedViewConstructor<BacklinkView> {
1359
1373
  }
1374
+ /**
1375
+ * BasesConfigFileFilter `and` clause.
1376
+ *
1377
+ * @public
1378
+ * @unofficial
1379
+ */
1380
+ export interface BasesConfigFileFilterAndClause {
1381
+ /**
1382
+ * All of the following filters must match.
1383
+ *
1384
+ * @public
1385
+ * @since 1.10.0
1386
+ * @example
1387
+ * ```ts
1388
+ * {
1389
+ * and: [
1390
+ * '*.md',
1391
+ * '*.txt',
1392
+ * ],
1393
+ * }
1394
+ * ```
1395
+ */
1396
+ and: BasesConfigFileFilter[];
1397
+ }
1398
+ /**
1399
+ * BasesConfigFileFilter `not` clause.
1400
+ *
1401
+ * @public
1402
+ * @unofficial
1403
+ */
1404
+ export interface BasesConfigFileFilterNotClause {
1405
+ /**
1406
+ * None of the following filters should match.
1407
+ *
1408
+ * @public
1409
+ * @since 1.10.0
1410
+ * @example
1411
+ * ```ts
1412
+ * {
1413
+ * not: [
1414
+ * '*.md',
1415
+ * '*.txt',
1416
+ * ],
1417
+ * }
1418
+ * ```
1419
+ */
1420
+ not: BasesConfigFileFilter[];
1421
+ }
1422
+ /**
1423
+ * BasesConfigFileFilter `or` clause.
1424
+ *
1425
+ * @public
1426
+ * @unofficial
1427
+ */
1428
+ export interface BasesConfigFileFilterOrClause {
1429
+ /**
1430
+ * Some of the following filters should match.
1431
+ *
1432
+ * @public
1433
+ * @since 1.10.0
1434
+ * @example
1435
+ * ```ts
1436
+ * {
1437
+ * or: [
1438
+ * '*.md',
1439
+ * '*.txt',
1440
+ * ],
1441
+ * }
1442
+ * ```
1443
+ */
1444
+ or: BasesConfigFileFilter[];
1445
+ }
1360
1446
  /**
1361
1447
  * Bases context
1362
1448
  *
@@ -3808,6 +3894,18 @@ export interface CheckboxPropertyWidgetComponent extends PropertyWidgetComponent
3808
3894
  checkboxEl: HTMLInputElement;
3809
3895
  /** The type of the property widget. */
3810
3896
  type: "checkbox";
3897
+ /**
3898
+ * Handle focus event.
3899
+ *
3900
+ * @param mode - The focus mode.
3901
+ */
3902
+ onFocus(): void;
3903
+ /**
3904
+ * Set the value of the property widget.
3905
+ *
3906
+ * @param value - The value to set.
3907
+ */
3908
+ setValue(value: unknown): void;
3811
3909
  }
3812
3910
  /**
3813
3911
  * @todo Documentation incomplete.
@@ -6146,6 +6244,18 @@ export interface FilePropertyWidgetComponent extends PropertyWidgetComponentBase
6146
6244
  inputEl: HTMLInputElement;
6147
6245
  /** The type of the property widget. */
6148
6246
  type: "file";
6247
+ /**
6248
+ * Handle focus event.
6249
+ *
6250
+ * @param mode - The focus mode.
6251
+ */
6252
+ onFocus(): void;
6253
+ /**
6254
+ * Set the value of the property widget.
6255
+ *
6256
+ * @param value - The value to set.
6257
+ */
6258
+ setValue(value: unknown): void;
6149
6259
  }
6150
6260
  /**
6151
6261
  * @todo Documentation incomplete.
@@ -6372,6 +6482,18 @@ export interface FolderPropertyWidgetComponent extends PropertyWidgetComponentBa
6372
6482
  inputEl: HTMLInputElement;
6373
6483
  /** The type of the property widget. */
6374
6484
  type: "folder";
6485
+ /**
6486
+ * Handle focus event.
6487
+ *
6488
+ * @param mode - The focus mode.
6489
+ */
6490
+ onFocus(): void;
6491
+ /**
6492
+ * Set the value of the property widget.
6493
+ *
6494
+ * @param value - The value to set.
6495
+ */
6496
+ setValue(value: unknown): void;
6375
6497
  }
6376
6498
  /**
6377
6499
  * @todo Documentation incomplete.
@@ -9145,13 +9267,25 @@ export interface MultiselectOptionContextMenuContext {
9145
9267
  */
9146
9268
  export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase {
9147
9269
  /** The hover popover for the property widget. */
9148
- hoverPopover: HoverPopover | null;
9270
+ hoverPopover: null;
9149
9271
  /** The multiselect component for the property widget. */
9150
9272
  multiselect: Multiselect;
9151
9273
  /** The type of the property widget. */
9152
9274
  type: "multitext";
9153
9275
  /** The values of the property widget. */
9154
9276
  valueSet: Set<string>;
9277
+ /**
9278
+ * Handle focus event.
9279
+ *
9280
+ * @param mode - The focus mode.
9281
+ */
9282
+ onFocus(): void;
9283
+ /**
9284
+ * Set the value of the property widget.
9285
+ *
9286
+ * @param value - The value to set.
9287
+ */
9288
+ setValue(value: unknown): void;
9155
9289
  }
9156
9290
  /**
9157
9291
  * @todo Documentation incomplete.
@@ -9267,6 +9401,18 @@ export interface NumberPropertyWidgetComponent extends PropertyWidgetComponentBa
9267
9401
  type: "number";
9268
9402
  /** Show the error message. */
9269
9403
  showError(): void;
9404
+ /**
9405
+ * Handle focus event.
9406
+ *
9407
+ * @param mode - The focus mode.
9408
+ */
9409
+ onFocus(): void;
9410
+ /**
9411
+ * Set the value of the property widget.
9412
+ *
9413
+ * @param value - The value to set.
9414
+ */
9415
+ setValue(value: unknown): void;
9270
9416
  }
9271
9417
  /**
9272
9418
  * @todo Documentation incomplete.
@@ -9956,6 +10102,18 @@ export interface PropertyPropertyWidgetComponent extends PropertyWidgetComponent
9956
10102
  inputEl: HTMLInputElement;
9957
10103
  /** The type of the property widget. */
9958
10104
  type: "property";
10105
+ /**
10106
+ * Handle focus event.
10107
+ *
10108
+ * @param mode - The focus mode.
10109
+ */
10110
+ onFocus(): void;
10111
+ /**
10112
+ * Set the value of the property widget.
10113
+ *
10114
+ * @param value - The value to set.
10115
+ */
10116
+ setValue(value: unknown): void;
9959
10117
  }
9960
10118
  /**
9961
10119
  * Combobox component for {@link PropertyPropertyWidgetComponent}.
@@ -10155,8 +10313,6 @@ export interface PropertyWidget<ComponentType extends PropertyWidgetComponentBas
10155
10313
  * @unofficial
10156
10314
  */
10157
10315
  export interface PropertyWidgetComponentBase {
10158
- /** The container element for the property widget. */
10159
- containerEl: HTMLElement;
10160
10316
  /** The type of the property widget. */
10161
10317
  type: string;
10162
10318
  /**
@@ -10165,18 +10321,6 @@ export interface PropertyWidgetComponentBase {
10165
10321
  * @param mode - The focus mode.
10166
10322
  */
10167
10323
  focus(mode?: FocusMode): void;
10168
- /**
10169
- * Handle focus event.
10170
- *
10171
- * @param mode - The focus mode.
10172
- */
10173
- onFocus(mode: FocusMode): void;
10174
- /**
10175
- * Set the value of the property widget.
10176
- *
10177
- * @param value - The value to set.
10178
- */
10179
- setValue(value: unknown): void;
10180
10324
  }
10181
10325
  /**
10182
10326
  * @todo Documentation incomplete.
@@ -11467,6 +11611,18 @@ export interface TagsPropertyWidgetComponent extends PropertyWidgetComponentBase
11467
11611
  multiselect: Multiselect;
11468
11612
  /** The type of the property widget. */
11469
11613
  type: "tags";
11614
+ /**
11615
+ * Handle focus event.
11616
+ *
11617
+ * @param mode - The focus mode.
11618
+ */
11619
+ onFocus(): void;
11620
+ /**
11621
+ * Set the value of the property widget.
11622
+ *
11623
+ * @param value - The value to set.
11624
+ */
11625
+ setValue(value: unknown): void;
11470
11626
  }
11471
11627
  /**
11472
11628
  * @todo Documentation incomplete.
@@ -11495,46 +11651,34 @@ export interface TemplatesPluginInstance extends InternalPluginInstance<Template
11495
11651
  * @unofficial
11496
11652
  */
11497
11653
  export interface TextPropertyWidgetComponent extends PropertyWidgetComponentBase {
11654
+ /** The container element for the property widget. */
11655
+ containerEl: HTMLElement;
11498
11656
  /** The render context for the property widget. */
11499
11657
  ctx: PropertyRenderContext;
11500
11658
  /** The input element for the property widget. */
11501
11659
  inputEl: HTMLInputElement;
11502
- /** The link element for the property widget. */
11503
- linkEl: HTMLDivElement;
11504
- /** The link text element for the property widget. */
11505
- linkTextEl: HTMLDivElement;
11660
+ /** The hover popover for the property widget. */
11661
+ hoverPopover: null;
11506
11662
  /** The type of the property widget. */
11507
11663
  type: "text";
11508
11664
  /** The value of the property widget. */
11509
11665
  value: string;
11510
11666
  /**
11511
- * Get the display text of the link from the property widget.
11512
- *
11513
- * @returns The display text.
11514
- */
11515
- getDisplayText(): string;
11516
- /**
11517
- * Get the link text of the property widget.
11518
- *
11519
- * @returns The link text.
11667
+ * Render the property widget.
11520
11668
  */
11521
- getLinkText(): string;
11669
+ render(): void;
11522
11670
  /**
11523
- * Check if the property widget link has an alias.
11671
+ * Handle focus event.
11524
11672
  *
11525
- * @returns Whether the property widget link has an alias.
11673
+ * @param mode - The focus mode.
11526
11674
  */
11527
- isAlias(): boolean;
11675
+ onFocus(): void;
11528
11676
  /**
11529
- * Check if the property widget link is a wikilink.
11677
+ * Set the value of the property widget.
11530
11678
  *
11531
- * @returns Whether the property widget link is a wikilink.
11532
- */
11533
- isWikilink(): boolean;
11534
- /**
11535
- * Render the property widget.
11679
+ * @param value - The value to set.
11536
11680
  */
11537
- render(): void;
11681
+ setValue(value: unknown): void;
11538
11682
  }
11539
11683
  /**
11540
11684
  * @todo Documentation incomplete.