obsidian-typings 3.14.1 → 3.16.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.
@@ -577,25 +577,15 @@ export interface AddOverlayOptions {
577
577
  * @unofficial
578
578
  */
579
579
  export interface AliasesPropertyWidgetComponent extends PropertyWidgetComponentBase {
580
- /**
581
- * @todo Documentation incomplete.
582
- */
580
+ /** @todo Documentation incomplete. */
583
581
  ctx: PropertyRenderContext;
584
- /**
585
- * @todo Documentation incomplete.
586
- */
582
+ /** @todo Documentation incomplete. */
587
583
  hoverPopover: HoverPopover | null;
588
- /**
589
- * @todo Documentation incomplete.
590
- */
584
+ /** @todo Documentation incomplete. */
591
585
  multiselect: Multiselect;
592
- /**
593
- * @todo Documentation incomplete.
594
- */
586
+ /** @todo Documentation incomplete. */
595
587
  type: "aliases";
596
- /**
597
- * @todo Documentation incomplete.
598
- */
588
+ /** @todo Documentation incomplete. */
599
589
  setValue(value: string | string[]): void;
600
590
  }
601
591
  /**
@@ -3009,17 +2999,11 @@ export interface CeilFunction extends BasesFunction, HasGetDisplayName {
3009
2999
  * @unofficial
3010
3000
  */
3011
3001
  export interface CheckboxPropertyWidgetComponent extends PropertyWidgetComponentBase {
3012
- /**
3013
- * @todo Documentation incomplete.
3014
- */
3002
+ /** @todo Documentation incomplete. */
3015
3003
  checkboxEl: HTMLInputElement;
3016
- /**
3017
- * @todo Documentation incomplete.
3018
- */
3004
+ /** @todo Documentation incomplete. */
3019
3005
  type: "checkbox";
3020
- /**
3021
- * @todo Documentation incomplete.
3022
- */
3006
+ /** @todo Documentation incomplete. */
3023
3007
  setValue(value: boolean | null): void;
3024
3008
  }
3025
3009
  /**
@@ -3907,21 +3891,13 @@ export interface DateOnOrBeforeFunction extends BasesFunction, HasGetDisplayName
3907
3891
  * @unofficial
3908
3892
  */
3909
3893
  export interface DatePropertyWidgetComponent extends PropertyWidgetComponentBase {
3910
- /**
3911
- * @todo Documentation incomplete.
3912
- */
3894
+ /** @todo Documentation incomplete. */
3913
3895
  inputEl: HTMLInputElement;
3914
- /**
3915
- * @todo Documentation incomplete.
3916
- */
3896
+ /** @todo Documentation incomplete. */
3917
3897
  type: "date";
3918
- /**
3919
- * @todo Documentation incomplete.
3920
- */
3898
+ /** @todo Documentation incomplete. */
3921
3899
  parseDate(input: moment$1.MomentInput): string;
3922
- /**
3923
- * @todo Documentation incomplete.
3924
- */
3900
+ /** @todo Documentation incomplete. */
3925
3901
  setValue(value: string | null): void;
3926
3902
  }
3927
3903
  /**
@@ -3930,21 +3906,13 @@ export interface DatePropertyWidgetComponent extends PropertyWidgetComponentBase
3930
3906
  * @unofficial
3931
3907
  */
3932
3908
  export interface DatetimePropertyWidgetComponent extends PropertyWidgetComponentBase {
3933
- /**
3934
- * @todo Documentation incomplete.
3935
- */
3909
+ /** @todo Documentation incomplete. */
3936
3910
  inputEl: HTMLInputElement;
3937
- /**
3938
- * @todo Documentation incomplete.
3939
- */
3911
+ /** @todo Documentation incomplete. */
3940
3912
  type: "datetime";
3941
- /**
3942
- * @todo Documentation incomplete.
3943
- */
3913
+ /** @todo Documentation incomplete. */
3944
3914
  parseDateTime(input: moment$1.MomentInput): string;
3945
- /**
3946
- * @todo Documentation incomplete.
3947
- */
3915
+ /** @todo Documentation incomplete. */
3948
3916
  setValue(value: string | null): void;
3949
3917
  }
3950
3918
  /**
@@ -4406,21 +4374,36 @@ export interface ElectronWindow extends BrowserWindow {
4406
4374
  devToolsWebContents: unknown;
4407
4375
  }
4408
4376
  /**
4409
- * @todo Documentation incomplete.
4377
+ * A component that renders an embedded audio file.
4378
+ *
4410
4379
  * @public
4411
4380
  * @unofficial
4412
4381
  */
4413
- export interface EmbedAudioComponent extends Component {
4382
+ export interface EmbedAudioComponent extends EmbedComponent {
4414
4383
  }
4415
4384
  /**
4416
- * @todo Documentation incomplete.
4385
+ * A component that renders an embedded canvas file.
4386
+ *
4417
4387
  * @public
4418
4388
  * @unofficial
4419
4389
  */
4420
- export interface EmbedCanvasComponent extends Component {
4390
+ export interface EmbedCanvasComponent extends EmbedComponent {
4421
4391
  }
4422
4392
  /**
4423
- * @todo Documentation incomplete.
4393
+ * The component that renders the embedded file.
4394
+ *
4395
+ * @public
4396
+ * @unofficial
4397
+ */
4398
+ export interface EmbedComponent extends Component {
4399
+ /**
4400
+ * Load the file into the component.
4401
+ */
4402
+ loadFile(): void;
4403
+ }
4404
+ /**
4405
+ * A context to configure embedding of a file.
4406
+ *
4424
4407
  * @public
4425
4408
  * @unofficial
4426
4409
  */
@@ -4457,28 +4440,32 @@ export interface EmbedContext {
4457
4440
  state?: unknown;
4458
4441
  }
4459
4442
  /**
4460
- * @todo Documentation incomplete.
4443
+ * A component that renders an embedded image file.
4444
+ *
4461
4445
  * @public
4462
4446
  * @unofficial
4463
4447
  */
4464
- export interface EmbedImageComponent extends Component {
4448
+ export interface EmbedImageComponent extends EmbedComponent {
4465
4449
  }
4466
4450
  /**
4467
- * @todo Documentation incomplete.
4451
+ * A component that renders an embedded markdown file.
4452
+ *
4468
4453
  * @public
4469
4454
  * @unofficial
4470
4455
  */
4471
- export interface EmbedMarkdownComponent extends Component {
4456
+ export interface EmbedMarkdownComponent extends EmbedComponent {
4472
4457
  }
4473
4458
  /**
4474
- * @todo Documentation incomplete.
4459
+ * A component that renders an embedded PDF file.
4460
+ *
4475
4461
  * @public
4476
4462
  * @unofficial
4477
4463
  */
4478
- export interface EmbedPdfComponent extends Component {
4464
+ export interface EmbedPdfComponent extends EmbedComponent {
4479
4465
  }
4480
4466
  /**
4481
- * @todo Documentation incomplete.
4467
+ * A registry for embeddable files components.
4468
+ *
4482
4469
  * @public
4483
4470
  * @unofficial
4484
4471
  */
@@ -4490,7 +4477,7 @@ export interface EmbedRegistry extends Events {
4490
4477
  /**
4491
4478
  * Get the embed constructor for a specific file type.
4492
4479
  */
4493
- getEmbedCreator(file: TFile): EmbeddableConstructor | null;
4480
+ getEmbedCreator(file: TFile): EmbedCreator | null;
4494
4481
  /**
4495
4482
  * Check whether a file extension has a registered embed constructor.
4496
4483
  */
@@ -4498,11 +4485,11 @@ export interface EmbedRegistry extends Events {
4498
4485
  /**
4499
4486
  * Register an embed constructor for a specific file extension.
4500
4487
  */
4501
- registerExtension(extension: string, embedCreator: EmbeddableConstructor): void;
4488
+ registerExtension(extension: string, embedCreator: EmbedCreator): void;
4502
4489
  /**
4503
4490
  * Register an embed constructor for a list of file extensions.
4504
4491
  */
4505
- registerExtensions(extensions: string[], embedCreator: EmbeddableConstructor): void;
4492
+ registerExtensions(extensions: string[], embedCreator: EmbedCreator): void;
4506
4493
  /**
4507
4494
  * Unregister an embed constructor for a specific file extension.
4508
4495
  */
@@ -4513,66 +4500,116 @@ export interface EmbedRegistry extends Events {
4513
4500
  unregisterExtensions(extensions: string[]): void;
4514
4501
  }
4515
4502
  /**
4516
- * @todo Documentation incomplete.
4503
+ * A record of embeddable file extensions and their creators.
4504
+ *
4517
4505
  * @public
4518
4506
  * @unofficial
4519
4507
  */
4520
- export interface EmbedRegistryEmbedByExtensionRecord extends Record<string, EmbeddableConstructor> {
4521
- /** @todo Documentation incomplete. */
4508
+ export interface EmbedRegistryEmbedByExtensionRecord extends Record<string, EmbedCreator> {
4509
+ /**
4510
+ * Creates an embed component for a 3GP file.
4511
+ */
4522
4512
  [FileExtension._3gp]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
4523
- /** @todo Documentation incomplete. */
4513
+ /**
4514
+ * Creates an embed component for an AVIF file.
4515
+ */
4524
4516
  [FileExtension.avif]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
4525
- /** @todo Documentation incomplete. */
4517
+ /**
4518
+ * Creates an embed component for a BMP file.
4519
+ */
4526
4520
  [FileExtension.bmp]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
4527
- /** @todo Documentation incomplete. */
4521
+ /**
4522
+ * Creates an embed component for a canvas file.
4523
+ */
4528
4524
  [FileExtension.canvas]: (context: EmbedContext, file: TFile, subpath?: string) => EmbedCanvasComponent;
4529
- /** @todo Documentation incomplete. */
4525
+ /**
4526
+ * Creates an embed component for a FLAC file.
4527
+ */
4530
4528
  [FileExtension.flac]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
4531
- /** @todo Documentation incomplete. */
4529
+ /**
4530
+ * Creates an embed component for a GIF file.
4531
+ */
4532
4532
  [FileExtension.gif]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
4533
- /** @todo Documentation incomplete. */
4533
+ /**
4534
+ * Creates an embed component for a JPEG file.
4535
+ */
4534
4536
  [FileExtension.jpeg]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
4535
- /** @todo Documentation incomplete. */
4537
+ /**
4538
+ * Creates an embed component for a JPG file.
4539
+ */
4536
4540
  [FileExtension.jpg]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
4537
- /** @todo Documentation incomplete. */
4541
+ /**
4542
+ * Creates an embed component for an M4A file.
4543
+ */
4538
4544
  [FileExtension.m4a]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
4539
- /** @todo Documentation incomplete. */
4545
+ /**
4546
+ * Creates an embed component for a markdown file.
4547
+ */
4540
4548
  [FileExtension.md]: (context: EmbedContext, file: TFile, subpath?: string) => EmbedMarkdownComponent;
4541
- /** @todo Documentation incomplete. */
4549
+ /**
4550
+ * Creates an embed component for a MKV file.
4551
+ */
4542
4552
  [FileExtension.mkv]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
4543
- /** @todo Documentation incomplete. */
4553
+ /**
4554
+ * Creates an embed component for a MOV file.
4555
+ */
4544
4556
  [FileExtension.mov]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
4545
- /** @todo Documentation incomplete. */
4557
+ /**
4558
+ * Creates an embed component for an MP3 file.
4559
+ */
4546
4560
  [FileExtension.mp3]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
4547
- /** @todo Documentation incomplete. */
4561
+ /**
4562
+ * Creates an embed component for an MP4 file.
4563
+ */
4548
4564
  [FileExtension.mp4]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
4549
- /** @todo Documentation incomplete. */
4565
+ /**
4566
+ * Creates an embed component for an OGA file.
4567
+ */
4550
4568
  [FileExtension.oga]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
4551
- /** @todo Documentation incomplete. */
4569
+ /**
4570
+ * Creates an embed component for an OGG file.
4571
+ */
4552
4572
  [FileExtension.ogg]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
4553
- /** @todo Documentation incomplete. */
4573
+ /**
4574
+ * Creates an embed component for an OGV file.
4575
+ */
4554
4576
  [FileExtension.ogv]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
4555
- /** @todo Documentation incomplete. */
4577
+ /**
4578
+ * Creates an embed component for an OPUS file.
4579
+ */
4556
4580
  [FileExtension.opus]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
4557
- /** @todo Documentation incomplete. */
4581
+ /**
4582
+ * Creates an embed component for a PDF file.
4583
+ */
4558
4584
  [FileExtension.pdf]: (context: EmbedContext, file: TFile, subpath?: string) => EmbedPdfComponent;
4559
- /** @todo Documentation incomplete. */
4585
+ /**
4586
+ * Creates an embed component for a PNG file.
4587
+ */
4560
4588
  [FileExtension.png]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
4561
- /** @todo Documentation incomplete. */
4589
+ /**
4590
+ * Creates an embed component for an SVG file.
4591
+ */
4562
4592
  [FileExtension.svg]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
4563
- /** @todo Documentation incomplete. */
4593
+ /**
4594
+ * Creates an embed component for a WAV file.
4595
+ */
4564
4596
  [FileExtension.wav]: (context: EmbedContext, file: TFile) => EmbedAudioComponent;
4565
- /** @todo Documentation incomplete. */
4597
+ /**
4598
+ * Creates an embed component for a WEBM file.
4599
+ */
4566
4600
  [FileExtension.webm]: (context: EmbedContext, file: TFile) => EmbedVideoComponent;
4567
- /** @todo Documentation incomplete. */
4601
+ /**
4602
+ * Creates an embed component for a WEBP file.
4603
+ */
4568
4604
  [FileExtension.webp]: (context: EmbedContext, file: TFile) => EmbedImageComponent;
4569
4605
  }
4570
4606
  /**
4571
- * @todo Documentation incomplete.
4607
+ * A component that renders an embedded video file.
4608
+ *
4572
4609
  * @public
4573
4610
  * @unofficial
4574
4611
  */
4575
- export interface EmbedVideoComponent extends Component {
4612
+ export interface EmbedVideoComponent extends EmbedComponent {
4576
4613
  }
4577
4614
  /**
4578
4615
  * @todo Documentation incomplete.
@@ -5161,17 +5198,11 @@ export interface FilePropertiesViewConstructor extends TypedViewConstructor<File
5161
5198
  * @unofficial
5162
5199
  */
5163
5200
  export interface FilePropertyWidgetComponent extends PropertyWidgetComponentBase {
5164
- /**
5165
- * @todo Documentation incomplete.
5166
- */
5201
+ /** @todo Documentation incomplete. */
5167
5202
  inputEl: HTMLInputElement;
5168
- /**
5169
- * @todo Documentation incomplete.
5170
- */
5203
+ /** @todo Documentation incomplete. */
5171
5204
  type: "file";
5172
- /**
5173
- * @todo Documentation incomplete.
5174
- */
5205
+ /** @todo Documentation incomplete. */
5175
5206
  setValue(value: string | null): void;
5176
5207
  }
5177
5208
  /**
@@ -5394,17 +5425,11 @@ export interface FolderBookmarkItem extends BookmarkItem {
5394
5425
  * @unofficial
5395
5426
  */
5396
5427
  export interface FolderPropertyWidgetComponent extends PropertyWidgetComponentBase {
5397
- /**
5398
- * @todo Documentation incomplete.
5399
- */
5428
+ /** @todo Documentation incomplete. */
5400
5429
  inputEl: HTMLInputElement;
5401
- /**
5402
- * @todo Documentation incomplete.
5403
- */
5430
+ /** @todo Documentation incomplete. */
5404
5431
  type: "folder";
5405
- /**
5406
- * @todo Documentation incomplete.
5407
- */
5432
+ /** @todo Documentation incomplete. */
5408
5433
  setValue(value: string | null): void;
5409
5434
  }
5410
5435
  /**
@@ -7858,45 +7883,25 @@ export interface MetadataTypeManagerPropertiesRecord extends Record<string, Prop
7858
7883
  * @unofficial
7859
7884
  */
7860
7885
  export interface MetadataTypeManagerRegisteredTypeWidgetsRecord extends Record<PropertyWidgetType, PropertyWidget<unknown>> {
7861
- /**
7862
- * @todo Documentation incomplete.
7863
- */
7886
+ /** @todo Documentation incomplete. */
7864
7887
  aliases: PropertyWidget<string | string[], AliasesPropertyWidgetComponent>;
7865
- /**
7866
- * @todo Documentation incomplete.
7867
- */
7888
+ /** @todo Documentation incomplete. */
7868
7889
  checkbox: PropertyWidget<boolean | null, CheckboxPropertyWidgetComponent>;
7869
- /**
7870
- * @todo Documentation incomplete.
7871
- */
7890
+ /** @todo Documentation incomplete. */
7872
7891
  date: PropertyWidget<moment$1.MomentInput, DatePropertyWidgetComponent>;
7873
- /**
7874
- * @todo Documentation incomplete.
7875
- */
7892
+ /** @todo Documentation incomplete. */
7876
7893
  datetime: PropertyWidget<moment$1.MomentInput, DatetimePropertyWidgetComponent>;
7877
- /**
7878
- * @todo Documentation incomplete.
7879
- */
7894
+ /** @todo Documentation incomplete. */
7880
7895
  file: PropertyWidget<string, FilePropertyWidgetComponent>;
7881
- /**
7882
- * @todo Documentation incomplete.
7883
- */
7896
+ /** @todo Documentation incomplete. */
7884
7897
  folder: PropertyWidget<string, FolderPropertyWidgetComponent>;
7885
- /**
7886
- * @todo Documentation incomplete.
7887
- */
7898
+ /** @todo Documentation incomplete. */
7888
7899
  multitext: PropertyWidget<string[], MultitextPropertyWidgetComponent>;
7889
- /**
7890
- * @todo Documentation incomplete.
7891
- */
7900
+ /** @todo Documentation incomplete. */
7892
7901
  number: PropertyWidget<number, NumberPropertyWidgetComponent>;
7893
- /**
7894
- * @todo Documentation incomplete.
7895
- */
7902
+ /** @todo Documentation incomplete. */
7896
7903
  tags: PropertyWidget<string[], TagsPropertyWidgetComponent>;
7897
- /**
7898
- * @todo Documentation incomplete.
7899
- */
7904
+ /** @todo Documentation incomplete. */
7900
7905
  text: PropertyWidget<null | string, TextPropertyWidgetComponent>;
7901
7906
  }
7902
7907
  /**
@@ -8001,113 +8006,59 @@ export interface MonthFunction extends BasesFunction, HasExtract {
8001
8006
  * @unofficial
8002
8007
  */
8003
8008
  export interface Multiselect {
8004
- /**
8005
- * @todo Documentation incomplete.
8006
- */
8009
+ /** @todo Documentation incomplete. */
8007
8010
  changeCallback?: (values: string[]) => void;
8008
- /**
8009
- * @todo Documentation incomplete.
8010
- */
8011
+ /** @todo Documentation incomplete. */
8011
8012
  elements: HTMLDivElement[];
8012
- /**
8013
- * @todo Documentation incomplete.
8014
- */
8013
+ /** @todo Documentation incomplete. */
8015
8014
  inputEl: HTMLDivElement;
8016
- /**
8017
- * @todo Documentation incomplete.
8018
- */
8015
+ /** @todo Documentation incomplete. */
8019
8016
  readonly inputText: string;
8020
- /**
8021
- * @todo Documentation incomplete.
8022
- */
8017
+ /** @todo Documentation incomplete. */
8023
8018
  optionRenderer?: (value: string, ctx: OptionContext) => void;
8024
- /**
8025
- * @todo Documentation incomplete.
8026
- */
8019
+ /** @todo Documentation incomplete. */
8027
8020
  rootEl: HTMLDivElement;
8028
- /**
8029
- * @todo Documentation incomplete.
8030
- */
8021
+ /** @todo Documentation incomplete. */
8031
8022
  setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void;
8032
- /**
8033
- * @todo Documentation incomplete.
8034
- */
8023
+ /** @todo Documentation incomplete. */
8035
8024
  values: string[];
8036
- /**
8037
- * @todo Documentation incomplete.
8038
- */
8025
+ /** @todo Documentation incomplete. */
8039
8026
  _createElement(value: string): string | null;
8040
- /**
8041
- * @todo Documentation incomplete.
8042
- */
8027
+ /** @todo Documentation incomplete. */
8043
8028
  _createInputEl(): HTMLDivElement;
8044
- /**
8045
- * @todo Documentation incomplete.
8046
- */
8029
+ /** @todo Documentation incomplete. */
8047
8030
  addElement(value: string): boolean;
8048
- /**
8049
- * @todo Documentation incomplete.
8050
- */
8031
+ /** @todo Documentation incomplete. */
8051
8032
  allowCreatingOptions(createOption: (this: Multiselect, value: string) => string | undefined): this;
8052
- /**
8053
- * @todo Documentation incomplete.
8054
- */
8033
+ /** @todo Documentation incomplete. */
8055
8034
  createOption?(this: Multiselect, value: string): string | undefined;
8056
- /**
8057
- * @todo Documentation incomplete.
8058
- */
8035
+ /** @todo Documentation incomplete. */
8059
8036
  editElement(index: number): void;
8060
- /**
8061
- * @todo Documentation incomplete.
8062
- */
8037
+ /** @todo Documentation incomplete. */
8063
8038
  findDuplicate?(this: Multiselect, values: string[]): boolean;
8064
- /**
8065
- * @todo Documentation incomplete.
8066
- */
8039
+ /** @todo Documentation incomplete. */
8067
8040
  focusElement(index: number): void;
8068
- /**
8069
- * @todo Documentation incomplete.
8070
- */
8041
+ /** @todo Documentation incomplete. */
8071
8042
  onChange(changeCallback: (values: string[]) => void): void;
8072
- /**
8073
- * @todo Documentation incomplete.
8074
- */
8043
+ /** @todo Documentation incomplete. */
8075
8044
  onOptionContextmenu?(this: Multiselect, menu: Menu, value: string, ctx: OptionContext): void;
8076
- /**
8077
- * @todo Documentation incomplete.
8078
- */
8045
+ /** @todo Documentation incomplete. */
8079
8046
  preventDuplicates(findDuplicate: (this: Multiselect, values: string[]) => number): this;
8080
- /**
8081
- * @todo Documentation incomplete.
8082
- */
8047
+ /** @todo Documentation incomplete. */
8083
8048
  removeElement(index: number, shouldFocus?: boolean): void;
8084
- /**
8085
- * @todo Documentation incomplete.
8086
- */
8049
+ /** @todo Documentation incomplete. */
8087
8050
  renderValues(): void;
8088
- /**
8089
- * @todo Documentation incomplete.
8090
- */
8051
+ /** @todo Documentation incomplete. */
8091
8052
  setInputText(text: string): void;
8092
- /**
8093
- * @todo Documentation incomplete.
8094
- */
8053
+ /** @todo Documentation incomplete. */
8095
8054
  setOptionContextmenuHandler(onOptionContextmenu: (this: Multiselect, menu: Menu, value: string, ctx: OptionContext) => void): this;
8096
- /**
8097
- * @todo Documentation incomplete.
8098
- */
8055
+ /** @todo Documentation incomplete. */
8099
8056
  setOptionRenderer(optionRenderer: (value: string, ctx: OptionContext) => void): this;
8100
- /**
8101
- * @todo Documentation incomplete.
8102
- */
8057
+ /** @todo Documentation incomplete. */
8103
8058
  setupInputEl(setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void): this;
8104
- /**
8105
- * @todo Documentation incomplete.
8106
- */
8059
+ /** @todo Documentation incomplete. */
8107
8060
  setValues(values: string[] | null): this;
8108
- /**
8109
- * @todo Documentation incomplete.
8110
- */
8061
+ /** @todo Documentation incomplete. */
8111
8062
  triggerChange(): void;
8112
8063
  }
8113
8064
  /**
@@ -8116,25 +8067,15 @@ export interface Multiselect {
8116
8067
  * @unofficial
8117
8068
  */
8118
8069
  export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase {
8119
- /**
8120
- * @todo Documentation incomplete.
8121
- */
8070
+ /** @todo Documentation incomplete. */
8122
8071
  hoverPopover: HoverPopover | null;
8123
- /**
8124
- * @todo Documentation incomplete.
8125
- */
8072
+ /** @todo Documentation incomplete. */
8126
8073
  multiselect: Multiselect;
8127
- /**
8128
- * @todo Documentation incomplete.
8129
- */
8074
+ /** @todo Documentation incomplete. */
8130
8075
  type: "multitext";
8131
- /**
8132
- * @todo Documentation incomplete.
8133
- */
8076
+ /** @todo Documentation incomplete. */
8134
8077
  valueSet: Set<string>;
8135
- /**
8136
- * @todo Documentation incomplete.
8137
- */
8078
+ /** @todo Documentation incomplete. */
8138
8079
  setValue(value: string[] | string): void;
8139
8080
  }
8140
8081
  /**
@@ -8244,17 +8185,11 @@ export interface NowFunction extends BasesFunction {
8244
8185
  * @unofficial
8245
8186
  */
8246
8187
  export interface NumberPropertyWidgetComponent extends PropertyWidgetComponentBase {
8247
- /**
8248
- * @todo Documentation incomplete.
8249
- */
8188
+ /** @todo Documentation incomplete. */
8250
8189
  inputEl: HTMLInputElement;
8251
- /**
8252
- * @todo Documentation incomplete.
8253
- */
8190
+ /** @todo Documentation incomplete. */
8254
8191
  type: "number";
8255
- /**
8256
- * @todo Documentation incomplete.
8257
- */
8192
+ /** @todo Documentation incomplete. */
8258
8193
  setValue(value: number | null): void;
8259
8194
  }
8260
8195
  /**
@@ -8362,13 +8297,9 @@ export interface OpenNotificationOptions {
8362
8297
  * @unofficial
8363
8298
  */
8364
8299
  export interface OptionContext {
8365
- /**
8366
- * @todo Documentation incomplete.
8367
- */
8300
+ /** @todo Documentation incomplete. */
8368
8301
  el: HTMLDivElement;
8369
- /**
8370
- * @todo Documentation incomplete.
8371
- */
8302
+ /** @todo Documentation incomplete. */
8372
8303
  pillEl: HTMLDivElement;
8373
8304
  }
8374
8305
  /**
@@ -8944,21 +8875,13 @@ export interface PropertyWidget<Value = unknown, ComponentType extends Component
8944
8875
  * @unofficial
8945
8876
  */
8946
8877
  export interface PropertyWidgetComponentBase extends Component {
8947
- /**
8948
- * @todo Documentation incomplete.
8949
- */
8878
+ /** @todo Documentation incomplete. */
8950
8879
  containerEl: HTMLElement;
8951
- /**
8952
- * @todo Documentation incomplete.
8953
- */
8880
+ /** @todo Documentation incomplete. */
8954
8881
  type: string;
8955
- /**
8956
- * @todo Documentation incomplete.
8957
- */
8882
+ /** @todo Documentation incomplete. */
8958
8883
  focus(mode?: FocusMode): void;
8959
- /**
8960
- * @todo Documentation incomplete.
8961
- */
8884
+ /** @todo Documentation incomplete. */
8962
8885
  onFocus(mode: FocusMode): void;
8963
8886
  }
8964
8887
  /**
@@ -9958,6 +9881,10 @@ export interface SuggestionContainer<T> {
9958
9881
  * @remark Prefer setSelectedItem, which clamps the index to within suggestions array.
9959
9882
  */
9960
9883
  forceSetSelectedItem(index: number, event: Event): void;
9884
+ /** @todo Documentation incomplete. */
9885
+ getSelectedElement(): HTMLElement | null;
9886
+ /** @todo Documentation incomplete. */
9887
+ getSelectedValue(): SearchResult | null;
9961
9888
  /**
9962
9889
  * Move selected item to next suggestion.
9963
9890
  */
@@ -10200,17 +10127,11 @@ export interface TaggedWithFunction extends BasesFunction, HasGetDisplayName, Ha
10200
10127
  * @unofficial
10201
10128
  */
10202
10129
  export interface TagsPropertyWidgetComponent extends PropertyWidgetComponentBase {
10203
- /**
10204
- * @todo Documentation incomplete.
10205
- */
10130
+ /** @todo Documentation incomplete. */
10206
10131
  multiselect: Multiselect;
10207
- /**
10208
- * @todo Documentation incomplete.
10209
- */
10132
+ /** @todo Documentation incomplete. */
10210
10133
  type: "tags";
10211
- /**
10212
- * @todo Documentation incomplete.
10213
- */
10134
+ /** @todo Documentation incomplete. */
10214
10135
  setValue(value: string[] | string): void;
10215
10136
  }
10216
10137
  /**
@@ -10239,57 +10160,31 @@ export interface TemplatesPluginInstance extends InternalPluginInstance<Template
10239
10160
  * @unofficial
10240
10161
  */
10241
10162
  export interface TextPropertyWidgetComponent extends PropertyWidgetComponentBase {
10242
- /**
10243
- * @todo Documentation incomplete.
10244
- */
10163
+ /** @todo Documentation incomplete. */
10245
10164
  ctx: PropertyRenderContext;
10246
- /**
10247
- * @todo Documentation incomplete.
10248
- */
10165
+ /** @todo Documentation incomplete. */
10249
10166
  inputEl: HTMLInputElement;
10250
- /**
10251
- * @todo Documentation incomplete.
10252
- */
10167
+ /** @todo Documentation incomplete. */
10253
10168
  linkEl: HTMLDivElement;
10254
- /**
10255
- * @todo Documentation incomplete.
10256
- */
10169
+ /** @todo Documentation incomplete. */
10257
10170
  linkTextEl: HTMLDivElement;
10258
- /**
10259
- * @todo Documentation incomplete.
10260
- */
10171
+ /** @todo Documentation incomplete. */
10261
10172
  type: "text";
10262
- /**
10263
- * @todo Documentation incomplete.
10264
- */
10173
+ /** @todo Documentation incomplete. */
10265
10174
  value: string;
10266
- /**
10267
- * @todo Documentation incomplete.
10268
- */
10175
+ /** @todo Documentation incomplete. */
10269
10176
  getDisplayText(): string;
10270
- /**
10271
- * @todo Documentation incomplete.
10272
- */
10177
+ /** @todo Documentation incomplete. */
10273
10178
  getLinkText(): string;
10274
- /**
10275
- * @todo Documentation incomplete.
10276
- */
10179
+ /** @todo Documentation incomplete. */
10277
10180
  isAlias(): boolean;
10278
- /**
10279
- * @todo Documentation incomplete.
10280
- */
10181
+ /** @todo Documentation incomplete. */
10281
10182
  isWikilink(): boolean;
10282
- /**
10283
- * @todo Documentation incomplete.
10284
- */
10183
+ /** @todo Documentation incomplete. */
10285
10184
  render(): void;
10286
- /**
10287
- * @todo Documentation incomplete.
10288
- */
10185
+ /** @todo Documentation incomplete. */
10289
10186
  setValue(value: string | null): void;
10290
- /**
10291
- * @todo Documentation incomplete.
10292
- */
10187
+ /** @todo Documentation incomplete. */
10293
10188
  setValue(value: string | null): void;
10294
10189
  }
10295
10190
  /**
@@ -11597,12 +11492,17 @@ export type ContentPosition = [
11597
11492
  endOffset: number
11598
11493
  ];
11599
11494
  /**
11600
- * @todo Documentation incomplete.
11495
+ * Creates an embed component for a given file.
11496
+ *
11497
+ * @param context - Context used to embed the file.
11498
+ * @param file - File to embed.
11499
+ * @param subpath - Optional subpath within the file.
11500
+ * @returns An embed component.
11601
11501
  *
11602
11502
  * @public
11603
11503
  * @unofficial
11604
11504
  */
11605
- export type EmbeddableConstructor = (context: EmbedContext, file: TFile, subpath?: string) => Component;
11505
+ export type EmbedCreator = (context: EmbedContext, file: TFile, subpath?: string) => EmbedComponent;
11606
11506
  /**
11607
11507
  * @todo Documentation incomplete.
11608
11508
  *
@@ -11755,6 +11655,12 @@ export type PlatformType = typeof Platform;
11755
11655
  * @unofficial
11756
11656
  */
11757
11657
  export type PropertyWidgetType = "aliases" | "checkbox" | "date" | "datetime" | "multitext" | "number" | "tags" | "text" | string;
11658
+ /**
11659
+ * The direction of the text.
11660
+ * @public
11661
+ * @unofficial
11662
+ */
11663
+ export type TextDirection = "auto" | "ltr" | "rtl";
11758
11664
  /**
11759
11665
  * @todo Documentation incomplete.
11760
11666
  *