obsidian-typings 3.14.0 → 3.15.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
  /**
@@ -5161,17 +5129,11 @@ export interface FilePropertiesViewConstructor extends TypedViewConstructor<File
5161
5129
  * @unofficial
5162
5130
  */
5163
5131
  export interface FilePropertyWidgetComponent extends PropertyWidgetComponentBase {
5164
- /**
5165
- * @todo Documentation incomplete.
5166
- */
5132
+ /** @todo Documentation incomplete. */
5167
5133
  inputEl: HTMLInputElement;
5168
- /**
5169
- * @todo Documentation incomplete.
5170
- */
5134
+ /** @todo Documentation incomplete. */
5171
5135
  type: "file";
5172
- /**
5173
- * @todo Documentation incomplete.
5174
- */
5136
+ /** @todo Documentation incomplete. */
5175
5137
  setValue(value: string | null): void;
5176
5138
  }
5177
5139
  /**
@@ -5394,17 +5356,11 @@ export interface FolderBookmarkItem extends BookmarkItem {
5394
5356
  * @unofficial
5395
5357
  */
5396
5358
  export interface FolderPropertyWidgetComponent extends PropertyWidgetComponentBase {
5397
- /**
5398
- * @todo Documentation incomplete.
5399
- */
5359
+ /** @todo Documentation incomplete. */
5400
5360
  inputEl: HTMLInputElement;
5401
- /**
5402
- * @todo Documentation incomplete.
5403
- */
5361
+ /** @todo Documentation incomplete. */
5404
5362
  type: "folder";
5405
- /**
5406
- * @todo Documentation incomplete.
5407
- */
5363
+ /** @todo Documentation incomplete. */
5408
5364
  setValue(value: string | null): void;
5409
5365
  }
5410
5366
  /**
@@ -7858,46 +7814,26 @@ export interface MetadataTypeManagerPropertiesRecord extends Record<string, Prop
7858
7814
  * @unofficial
7859
7815
  */
7860
7816
  export interface MetadataTypeManagerRegisteredTypeWidgetsRecord extends Record<PropertyWidgetType, PropertyWidget<unknown>> {
7861
- /**
7862
- * @todo Documentation incomplete.
7863
- */
7817
+ /** @todo Documentation incomplete. */
7864
7818
  aliases: PropertyWidget<string | string[], AliasesPropertyWidgetComponent>;
7865
- /**
7866
- * @todo Documentation incomplete.
7867
- */
7819
+ /** @todo Documentation incomplete. */
7868
7820
  checkbox: PropertyWidget<boolean | null, CheckboxPropertyWidgetComponent>;
7869
- /**
7870
- * @todo Documentation incomplete.
7871
- */
7821
+ /** @todo Documentation incomplete. */
7872
7822
  date: PropertyWidget<moment$1.MomentInput, DatePropertyWidgetComponent>;
7873
- /**
7874
- * @todo Documentation incomplete.
7875
- */
7823
+ /** @todo Documentation incomplete. */
7876
7824
  datetime: PropertyWidget<moment$1.MomentInput, DatetimePropertyWidgetComponent>;
7877
- /**
7878
- * @todo Documentation incomplete.
7879
- */
7825
+ /** @todo Documentation incomplete. */
7880
7826
  file: PropertyWidget<string, FilePropertyWidgetComponent>;
7881
- /**
7882
- * @todo Documentation incomplete.
7883
- */
7827
+ /** @todo Documentation incomplete. */
7884
7828
  folder: PropertyWidget<string, FolderPropertyWidgetComponent>;
7885
- /**
7886
- * @todo Documentation incomplete.
7887
- */
7829
+ /** @todo Documentation incomplete. */
7888
7830
  multitext: PropertyWidget<string[], MultitextPropertyWidgetComponent>;
7889
- /**
7890
- * @todo Documentation incomplete.
7891
- */
7831
+ /** @todo Documentation incomplete. */
7892
7832
  number: PropertyWidget<number, NumberPropertyWidgetComponent>;
7893
- /**
7894
- * @todo Documentation incomplete.
7895
- */
7833
+ /** @todo Documentation incomplete. */
7896
7834
  tags: PropertyWidget<string[], TagsPropertyWidgetComponent>;
7897
- /**
7898
- * @todo Documentation incomplete.
7899
- */
7900
- text: PropertyWidget<string, TextPropertyWidgetComponent>;
7835
+ /** @todo Documentation incomplete. */
7836
+ text: PropertyWidget<null | string, TextPropertyWidgetComponent>;
7901
7837
  }
7902
7838
  /**
7903
7839
  * @todo Documentation incomplete.
@@ -8001,113 +7937,59 @@ export interface MonthFunction extends BasesFunction, HasExtract {
8001
7937
  * @unofficial
8002
7938
  */
8003
7939
  export interface Multiselect {
8004
- /**
8005
- * @todo Documentation incomplete.
8006
- */
7940
+ /** @todo Documentation incomplete. */
8007
7941
  changeCallback?: (values: string[]) => void;
8008
- /**
8009
- * @todo Documentation incomplete.
8010
- */
7942
+ /** @todo Documentation incomplete. */
8011
7943
  elements: HTMLDivElement[];
8012
- /**
8013
- * @todo Documentation incomplete.
8014
- */
7944
+ /** @todo Documentation incomplete. */
8015
7945
  inputEl: HTMLDivElement;
8016
- /**
8017
- * @todo Documentation incomplete.
8018
- */
7946
+ /** @todo Documentation incomplete. */
8019
7947
  readonly inputText: string;
8020
- /**
8021
- * @todo Documentation incomplete.
8022
- */
7948
+ /** @todo Documentation incomplete. */
8023
7949
  optionRenderer?: (value: string, ctx: OptionContext) => void;
8024
- /**
8025
- * @todo Documentation incomplete.
8026
- */
7950
+ /** @todo Documentation incomplete. */
8027
7951
  rootEl: HTMLDivElement;
8028
- /**
8029
- * @todo Documentation incomplete.
8030
- */
7952
+ /** @todo Documentation incomplete. */
8031
7953
  setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void;
8032
- /**
8033
- * @todo Documentation incomplete.
8034
- */
7954
+ /** @todo Documentation incomplete. */
8035
7955
  values: string[];
8036
- /**
8037
- * @todo Documentation incomplete.
8038
- */
7956
+ /** @todo Documentation incomplete. */
8039
7957
  _createElement(value: string): string | null;
8040
- /**
8041
- * @todo Documentation incomplete.
8042
- */
7958
+ /** @todo Documentation incomplete. */
8043
7959
  _createInputEl(): HTMLDivElement;
8044
- /**
8045
- * @todo Documentation incomplete.
8046
- */
7960
+ /** @todo Documentation incomplete. */
8047
7961
  addElement(value: string): boolean;
8048
- /**
8049
- * @todo Documentation incomplete.
8050
- */
7962
+ /** @todo Documentation incomplete. */
8051
7963
  allowCreatingOptions(createOption: (this: Multiselect, value: string) => string | undefined): this;
8052
- /**
8053
- * @todo Documentation incomplete.
8054
- */
7964
+ /** @todo Documentation incomplete. */
8055
7965
  createOption?(this: Multiselect, value: string): string | undefined;
8056
- /**
8057
- * @todo Documentation incomplete.
8058
- */
7966
+ /** @todo Documentation incomplete. */
8059
7967
  editElement(index: number): void;
8060
- /**
8061
- * @todo Documentation incomplete.
8062
- */
7968
+ /** @todo Documentation incomplete. */
8063
7969
  findDuplicate?(this: Multiselect, values: string[]): boolean;
8064
- /**
8065
- * @todo Documentation incomplete.
8066
- */
7970
+ /** @todo Documentation incomplete. */
8067
7971
  focusElement(index: number): void;
8068
- /**
8069
- * @todo Documentation incomplete.
8070
- */
7972
+ /** @todo Documentation incomplete. */
8071
7973
  onChange(changeCallback: (values: string[]) => void): void;
8072
- /**
8073
- * @todo Documentation incomplete.
8074
- */
7974
+ /** @todo Documentation incomplete. */
8075
7975
  onOptionContextmenu?(this: Multiselect, menu: Menu, value: string, ctx: OptionContext): void;
8076
- /**
8077
- * @todo Documentation incomplete.
8078
- */
7976
+ /** @todo Documentation incomplete. */
8079
7977
  preventDuplicates(findDuplicate: (this: Multiselect, values: string[]) => number): this;
8080
- /**
8081
- * @todo Documentation incomplete.
8082
- */
7978
+ /** @todo Documentation incomplete. */
8083
7979
  removeElement(index: number, shouldFocus?: boolean): void;
8084
- /**
8085
- * @todo Documentation incomplete.
8086
- */
7980
+ /** @todo Documentation incomplete. */
8087
7981
  renderValues(): void;
8088
- /**
8089
- * @todo Documentation incomplete.
8090
- */
7982
+ /** @todo Documentation incomplete. */
8091
7983
  setInputText(text: string): void;
8092
- /**
8093
- * @todo Documentation incomplete.
8094
- */
7984
+ /** @todo Documentation incomplete. */
8095
7985
  setOptionContextmenuHandler(onOptionContextmenu: (this: Multiselect, menu: Menu, value: string, ctx: OptionContext) => void): this;
8096
- /**
8097
- * @todo Documentation incomplete.
8098
- */
7986
+ /** @todo Documentation incomplete. */
8099
7987
  setOptionRenderer(optionRenderer: (value: string, ctx: OptionContext) => void): this;
8100
- /**
8101
- * @todo Documentation incomplete.
8102
- */
7988
+ /** @todo Documentation incomplete. */
8103
7989
  setupInputEl(setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void): this;
8104
- /**
8105
- * @todo Documentation incomplete.
8106
- */
7990
+ /** @todo Documentation incomplete. */
8107
7991
  setValues(values: string[] | null): this;
8108
- /**
8109
- * @todo Documentation incomplete.
8110
- */
7992
+ /** @todo Documentation incomplete. */
8111
7993
  triggerChange(): void;
8112
7994
  }
8113
7995
  /**
@@ -8116,25 +7998,15 @@ export interface Multiselect {
8116
7998
  * @unofficial
8117
7999
  */
8118
8000
  export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase {
8119
- /**
8120
- * @todo Documentation incomplete.
8121
- */
8001
+ /** @todo Documentation incomplete. */
8122
8002
  hoverPopover: HoverPopover | null;
8123
- /**
8124
- * @todo Documentation incomplete.
8125
- */
8003
+ /** @todo Documentation incomplete. */
8126
8004
  multiselect: Multiselect;
8127
- /**
8128
- * @todo Documentation incomplete.
8129
- */
8005
+ /** @todo Documentation incomplete. */
8130
8006
  type: "multitext";
8131
- /**
8132
- * @todo Documentation incomplete.
8133
- */
8007
+ /** @todo Documentation incomplete. */
8134
8008
  valueSet: Set<string>;
8135
- /**
8136
- * @todo Documentation incomplete.
8137
- */
8009
+ /** @todo Documentation incomplete. */
8138
8010
  setValue(value: string[] | string): void;
8139
8011
  }
8140
8012
  /**
@@ -8244,17 +8116,11 @@ export interface NowFunction extends BasesFunction {
8244
8116
  * @unofficial
8245
8117
  */
8246
8118
  export interface NumberPropertyWidgetComponent extends PropertyWidgetComponentBase {
8247
- /**
8248
- * @todo Documentation incomplete.
8249
- */
8119
+ /** @todo Documentation incomplete. */
8250
8120
  inputEl: HTMLInputElement;
8251
- /**
8252
- * @todo Documentation incomplete.
8253
- */
8121
+ /** @todo Documentation incomplete. */
8254
8122
  type: "number";
8255
- /**
8256
- * @todo Documentation incomplete.
8257
- */
8123
+ /** @todo Documentation incomplete. */
8258
8124
  setValue(value: number | null): void;
8259
8125
  }
8260
8126
  /**
@@ -8362,13 +8228,9 @@ export interface OpenNotificationOptions {
8362
8228
  * @unofficial
8363
8229
  */
8364
8230
  export interface OptionContext {
8365
- /**
8366
- * @todo Documentation incomplete.
8367
- */
8231
+ /** @todo Documentation incomplete. */
8368
8232
  el: HTMLDivElement;
8369
- /**
8370
- * @todo Documentation incomplete.
8371
- */
8233
+ /** @todo Documentation incomplete. */
8372
8234
  pillEl: HTMLDivElement;
8373
8235
  }
8374
8236
  /**
@@ -8944,21 +8806,13 @@ export interface PropertyWidget<Value = unknown, ComponentType extends Component
8944
8806
  * @unofficial
8945
8807
  */
8946
8808
  export interface PropertyWidgetComponentBase extends Component {
8947
- /**
8948
- * @todo Documentation incomplete.
8949
- */
8809
+ /** @todo Documentation incomplete. */
8950
8810
  containerEl: HTMLElement;
8951
- /**
8952
- * @todo Documentation incomplete.
8953
- */
8811
+ /** @todo Documentation incomplete. */
8954
8812
  type: string;
8955
- /**
8956
- * @todo Documentation incomplete.
8957
- */
8813
+ /** @todo Documentation incomplete. */
8958
8814
  focus(mode?: FocusMode): void;
8959
- /**
8960
- * @todo Documentation incomplete.
8961
- */
8815
+ /** @todo Documentation incomplete. */
8962
8816
  onFocus(mode: FocusMode): void;
8963
8817
  }
8964
8818
  /**
@@ -9958,6 +9812,14 @@ export interface SuggestionContainer<T> {
9958
9812
  * @remark Prefer setSelectedItem, which clamps the index to within suggestions array.
9959
9813
  */
9960
9814
  forceSetSelectedItem(index: number, event: Event): void;
9815
+ /**
9816
+ * @todo Documentation incomplete.
9817
+ */
9818
+ getSelectedElement(): HTMLElement | null;
9819
+ /**
9820
+ * @todo Documentation incomplete.
9821
+ */
9822
+ getSelectedValue(): SearchResult | null;
9961
9823
  /**
9962
9824
  * Move selected item to next suggestion.
9963
9825
  */
@@ -10200,17 +10062,11 @@ export interface TaggedWithFunction extends BasesFunction, HasGetDisplayName, Ha
10200
10062
  * @unofficial
10201
10063
  */
10202
10064
  export interface TagsPropertyWidgetComponent extends PropertyWidgetComponentBase {
10203
- /**
10204
- * @todo Documentation incomplete.
10205
- */
10065
+ /** @todo Documentation incomplete. */
10206
10066
  multiselect: Multiselect;
10207
- /**
10208
- * @todo Documentation incomplete.
10209
- */
10067
+ /** @todo Documentation incomplete. */
10210
10068
  type: "tags";
10211
- /**
10212
- * @todo Documentation incomplete.
10213
- */
10069
+ /** @todo Documentation incomplete. */
10214
10070
  setValue(value: string[] | string): void;
10215
10071
  }
10216
10072
  /**
@@ -10239,57 +10095,31 @@ export interface TemplatesPluginInstance extends InternalPluginInstance<Template
10239
10095
  * @unofficial
10240
10096
  */
10241
10097
  export interface TextPropertyWidgetComponent extends PropertyWidgetComponentBase {
10242
- /**
10243
- * @todo Documentation incomplete.
10244
- */
10098
+ /** @todo Documentation incomplete. */
10245
10099
  ctx: PropertyRenderContext;
10246
- /**
10247
- * @todo Documentation incomplete.
10248
- */
10100
+ /** @todo Documentation incomplete. */
10249
10101
  inputEl: HTMLInputElement;
10250
- /**
10251
- * @todo Documentation incomplete.
10252
- */
10102
+ /** @todo Documentation incomplete. */
10253
10103
  linkEl: HTMLDivElement;
10254
- /**
10255
- * @todo Documentation incomplete.
10256
- */
10104
+ /** @todo Documentation incomplete. */
10257
10105
  linkTextEl: HTMLDivElement;
10258
- /**
10259
- * @todo Documentation incomplete.
10260
- */
10106
+ /** @todo Documentation incomplete. */
10261
10107
  type: "text";
10262
- /**
10263
- * @todo Documentation incomplete.
10264
- */
10108
+ /** @todo Documentation incomplete. */
10265
10109
  value: string;
10266
- /**
10267
- * @todo Documentation incomplete.
10268
- */
10110
+ /** @todo Documentation incomplete. */
10269
10111
  getDisplayText(): string;
10270
- /**
10271
- * @todo Documentation incomplete.
10272
- */
10112
+ /** @todo Documentation incomplete. */
10273
10113
  getLinkText(): string;
10274
- /**
10275
- * @todo Documentation incomplete.
10276
- */
10114
+ /** @todo Documentation incomplete. */
10277
10115
  isAlias(): boolean;
10278
- /**
10279
- * @todo Documentation incomplete.
10280
- */
10116
+ /** @todo Documentation incomplete. */
10281
10117
  isWikilink(): boolean;
10282
- /**
10283
- * @todo Documentation incomplete.
10284
- */
10118
+ /** @todo Documentation incomplete. */
10285
10119
  render(): void;
10286
- /**
10287
- * @todo Documentation incomplete.
10288
- */
10120
+ /** @todo Documentation incomplete. */
10289
10121
  setValue(value: string | null): void;
10290
- /**
10291
- * @todo Documentation incomplete.
10292
- */
10122
+ /** @todo Documentation incomplete. */
10293
10123
  setValue(value: string | null): void;
10294
10124
  }
10295
10125
  /**
@@ -11755,6 +11585,12 @@ export type PlatformType = typeof Platform;
11755
11585
  * @unofficial
11756
11586
  */
11757
11587
  export type PropertyWidgetType = "aliases" | "checkbox" | "date" | "datetime" | "multitext" | "number" | "tags" | "text" | string;
11588
+ /**
11589
+ * The direction of the text.
11590
+ * @public
11591
+ * @unofficial
11592
+ */
11593
+ export type TextDirection = "auto" | "ltr" | "rtl";
11758
11594
  /**
11759
11595
  * @todo Documentation incomplete.
11760
11596
  *