obsidian-typings 4.26.0 → 4.27.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.
@@ -6,10 +6,9 @@ import type { ChangeDesc, Extension, Transaction } from '@codemirror/state';
6
6
  import type { EditorView, ViewUpdate } from '@codemirror/view';
7
7
  import type { Tree as LezerTree } from '@lezer/common';
8
8
  import type { App as App$1, BrowserWindow } from 'electron';
9
- import moment$1 from 'moment';
10
9
  import type { default as moment$1 } from 'moment';
11
10
  import type { FSWatcher } from 'node:fs';
12
- 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, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, PopoverSuggest, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs } from 'obsidian';
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, HoverPopover, IconName, ItemView, KeymapInfo, LinkCache, MarkdownEditView, MarkdownFileInfo, MarkdownPostProcessorContext, MarkdownPreviewView, MarkdownView, Menu, Modal, PaneType, Plugin as Plugin, PluginManifest, PluginSettingTab, Reference, ReferenceCache, Scope, SearchComponent, SearchResult, Setting, SettingTab, SplitDirection, TAbstractFile, TFile, TFolder, TextComponent, TextFileView, Vault, View, ViewCreator, ViewState, Workspace, WorkspaceLeaf, WorkspaceTabs } from 'obsidian';
13
12
  import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle } from 'pixi.js';
14
13
 
15
14
  /**
@@ -573,20 +572,21 @@ export interface AddOverlayOptions {
573
572
  query: RegExp;
574
573
  }
575
574
  /**
576
- * Property widget component for aliases.
577
- *
575
+ * @todo Documentation incomplete.
578
576
  * @public
579
577
  * @unofficial
580
578
  */
581
- export interface AliasesPropertyWidgetComponent extends PropertyWidgetComponentBase<string | string[]> {
582
- /** The render context for the property widget. */
579
+ export interface AliasesPropertyWidgetComponent extends PropertyWidgetComponentBase {
580
+ /** @todo Documentation incomplete. */
583
581
  ctx: PropertyRenderContext;
584
- /** The hover popover for the property widget. */
582
+ /** @todo Documentation incomplete. */
585
583
  hoverPopover: HoverPopover | null;
586
- /** The multiselect component for the property widget. */
584
+ /** @todo Documentation incomplete. */
587
585
  multiselect: Multiselect;
588
- /** The type of the property widget. */
586
+ /** @todo Documentation incomplete. */
589
587
  type: "aliases";
588
+ /** @todo Documentation incomplete. */
589
+ setValue(value: string | string[]): void;
590
590
  }
591
591
  /**
592
592
  * @todo Documentation incomplete.
@@ -2986,16 +2986,17 @@ export interface CapacitorFileEntry extends Partial<FileStats> {
2986
2986
  export interface CeilFunction extends BasesFunction, HasGetDisplayName {
2987
2987
  }
2988
2988
  /**
2989
- * Property widget component for checkboxes.
2990
- *
2989
+ * @todo Documentation incomplete.
2991
2990
  * @public
2992
2991
  * @unofficial
2993
2992
  */
2994
- export interface CheckboxPropertyWidgetComponent extends PropertyWidgetComponentBase<boolean> {
2995
- /** The checkbox element for the property widget. */
2993
+ export interface CheckboxPropertyWidgetComponent extends PropertyWidgetComponentBase {
2994
+ /** @todo Documentation incomplete. */
2996
2995
  checkboxEl: HTMLInputElement;
2997
- /** The type of the property widget. */
2996
+ /** @todo Documentation incomplete. */
2998
2997
  type: "checkbox";
2998
+ /** @todo Documentation incomplete. */
2999
+ setValue(value: boolean | null): void;
2999
3000
  }
3000
3001
  /**
3001
3002
  * @todo Documentation incomplete.
@@ -3877,65 +3878,34 @@ export interface DateOnOrAfterFunction extends BasesFunction, HasGetDisplayName,
3877
3878
  export interface DateOnOrBeforeFunction extends BasesFunction, HasGetDisplayName, HasCompare, HasGetRHSWidgetType {
3878
3879
  }
3879
3880
  /**
3880
- * Property widget component for dates.
3881
- *
3881
+ * @todo Documentation incomplete.
3882
3882
  * @public
3883
3883
  * @unofficial
3884
3884
  */
3885
- export interface DatePropertyWidgetComponent extends DatePropertyWidgetComponentBase {
3886
- /** The button element for the property widget. */
3887
- buttonEl: HTMLDivElement | null;
3888
- /** The type of the property widget. */
3885
+ export interface DatePropertyWidgetComponent extends PropertyWidgetComponentBase {
3886
+ /** @todo Documentation incomplete. */
3887
+ inputEl: HTMLInputElement;
3888
+ /** @todo Documentation incomplete. */
3889
3889
  type: "date";
3890
+ /** @todo Documentation incomplete. */
3891
+ parseDate(input: moment$1.MomentInput): string;
3892
+ /** @todo Documentation incomplete. */
3893
+ setValue(value: string | null): void;
3890
3894
  }
3891
3895
  /**
3892
- * Base interface for date property widget components.
3893
- *
3896
+ * @todo Documentation incomplete.
3894
3897
  * @public
3895
3898
  * @unofficial
3896
3899
  */
3897
- export interface DatePropertyWidgetComponentBase extends PropertyWidgetComponentBase<moment$1.MomentInput> {
3898
- /** The date of the property widget. */
3899
- date?: moment$1.Moment;
3900
- /** Whether the property widget is dirty. */
3901
- dirty: boolean;
3902
- /** The hover popup for the property widget. */
3903
- hoverPopup: HoverPopover | null;
3904
- /** The input element for the property widget. */
3900
+ export interface DatetimePropertyWidgetComponent extends PropertyWidgetComponentBase {
3901
+ /** @todo Documentation incomplete. */
3905
3902
  inputEl: HTMLInputElement;
3906
- /** The value of the property widget. */
3907
- value: string;
3908
- /**
3909
- * Build the input element for the property widget.
3910
- *
3911
- * @param parentEl - The parent element.
3912
- * @returns The input element.
3913
- */
3914
- buildInput(parentEl: HTMLElement): HTMLInputElement;
3915
- /**
3916
- * Format the date input.
3917
- *
3918
- * @param input - The input to format.
3919
- * @returns The formatted date.
3920
- */
3921
- format(input: moment$1.Moment): string;
3922
- /**
3923
- * Parse the date input.
3924
- *
3925
- * @param input - The input to parse.
3926
- * @returns The parsed date.
3927
- */
3928
- parse(input: moment$1.MomentInput): void;
3929
- }
3930
- /**
3931
- * Property widget component for datetimes.
3932
- *
3933
- * @public
3934
- * @unofficial
3935
- */
3936
- export interface DatetimePropertyWidgetComponent extends DatePropertyWidgetComponentBase {
3937
- /** The type of the property widget. */
3903
+ /** @todo Documentation incomplete. */
3938
3904
  type: "datetime";
3905
+ /** @todo Documentation incomplete. */
3906
+ parseDateTime(input: moment$1.MomentInput): string;
3907
+ /** @todo Documentation incomplete. */
3908
+ setValue(value: string | null): void;
3939
3909
  }
3940
3910
  /**
3941
3911
  * @todo Documentation incomplete.
@@ -5215,16 +5185,17 @@ export interface FilePropertiesViewConstructor extends TypedViewConstructor<File
5215
5185
  ]> {
5216
5186
  }
5217
5187
  /**
5218
- * Property widget component for files.
5219
- *
5188
+ * @todo Documentation incomplete.
5220
5189
  * @public
5221
5190
  * @unofficial
5222
5191
  */
5223
- export interface FilePropertyWidgetComponent extends PropertyWidgetComponentBase<string | null> {
5224
- /** The input element for the property widget. */
5192
+ export interface FilePropertyWidgetComponent extends PropertyWidgetComponentBase {
5193
+ /** @todo Documentation incomplete. */
5225
5194
  inputEl: HTMLInputElement;
5226
- /** The type of the property widget. */
5195
+ /** @todo Documentation incomplete. */
5227
5196
  type: "file";
5197
+ /** @todo Documentation incomplete. */
5198
+ setValue(value: string | null): void;
5228
5199
  }
5229
5200
  /**
5230
5201
  * @todo Documentation incomplete.
@@ -5441,16 +5412,17 @@ export interface FolderBookmarkItem extends BookmarkItem {
5441
5412
  type: "folder";
5442
5413
  }
5443
5414
  /**
5444
- * Property widget component for folders.
5445
- *
5415
+ * @todo Documentation incomplete.
5446
5416
  * @public
5447
5417
  * @unofficial
5448
5418
  */
5449
- export interface FolderPropertyWidgetComponent extends PropertyWidgetComponentBase<string> {
5450
- /** The input element for the property widget. */
5419
+ export interface FolderPropertyWidgetComponent extends PropertyWidgetComponentBase {
5420
+ /** @todo Documentation incomplete. */
5451
5421
  inputEl: HTMLInputElement;
5452
- /** The type of the property widget. */
5422
+ /** @todo Documentation incomplete. */
5453
5423
  type: "folder";
5424
+ /** @todo Documentation incomplete. */
5425
+ setValue(value: string | null): void;
5454
5426
  }
5455
5427
  /**
5456
5428
  * @todo Documentation incomplete.
@@ -7865,10 +7837,6 @@ export interface MetadataTypeManager extends Events {
7865
7837
  * Get expected widget type for property and the one inferred from the property value.
7866
7838
  */
7867
7839
  getTypeInfo(options: GetTypeInfoOptions): TypeInfo;
7868
- /**
7869
- * Get property widget.
7870
- */
7871
- getWidget(type: string): PropertyWidget<unknown>;
7872
7840
  /**
7873
7841
  * Load property types from config.
7874
7842
  */
@@ -7902,34 +7870,33 @@ export interface MetadataTypeManager extends Events {
7902
7870
  export interface MetadataTypeManagerPropertiesRecord extends Record<string, PropertyInfo> {
7903
7871
  }
7904
7872
  /**
7905
- * Registered type widgets.
7906
- *
7873
+ * @todo Documentation incomplete.
7907
7874
  * @public
7908
7875
  * @unofficial
7909
7876
  */
7910
7877
  export interface MetadataTypeManagerRegisteredTypeWidgetsRecord extends Record<PropertyWidgetType, PropertyWidget<unknown>> {
7911
- /** Property widget for aliases. */
7878
+ /** @todo Documentation incomplete. */
7912
7879
  aliases: PropertyWidget<string | string[], AliasesPropertyWidgetComponent>;
7913
- /** Property widget for checkboxes. */
7914
- checkbox: PropertyWidget<boolean, CheckboxPropertyWidgetComponent>;
7915
- /** Property widget for dates. */
7880
+ /** @todo Documentation incomplete. */
7881
+ checkbox: PropertyWidget<boolean | null, CheckboxPropertyWidgetComponent>;
7882
+ /** @todo Documentation incomplete. */
7916
7883
  date: PropertyWidget<moment$1.MomentInput, DatePropertyWidgetComponent>;
7917
- /** Property widget for datetimes. */
7884
+ /** @todo Documentation incomplete. */
7918
7885
  datetime: PropertyWidget<moment$1.MomentInput, DatetimePropertyWidgetComponent>;
7919
- /** Property widget for files. */
7886
+ /** @todo Documentation incomplete. */
7920
7887
  file: PropertyWidget<string, FilePropertyWidgetComponent>;
7921
- /** Property widget for folders. */
7888
+ /** @todo Documentation incomplete. */
7922
7889
  folder: PropertyWidget<string, FolderPropertyWidgetComponent>;
7923
- /** Property widget for multitexts. */
7924
- multitext: PropertyWidget<string[] | string, MultitextPropertyWidgetComponent>;
7925
- /** Property widget for numbers. */
7890
+ /** @todo Documentation incomplete. */
7891
+ multitext: PropertyWidget<string[], MultitextPropertyWidgetComponent>;
7892
+ /** @todo Documentation incomplete. */
7926
7893
  number: PropertyWidget<number, NumberPropertyWidgetComponent>;
7927
- /** Property widget for properties. */
7894
+ /** @todo Documentation incomplete. */
7928
7895
  property: PropertyWidget<string, PropertyPropertyWidgetComponent>;
7929
- /** Property widget for tags. */
7930
- tags: PropertyWidget<string[] | string, TagsPropertyWidgetComponent>;
7931
- /** Property widget for text. */
7932
- text: PropertyWidget<string, TextPropertyWidgetComponent>;
7896
+ /** @todo Documentation incomplete. */
7897
+ tags: PropertyWidget<string[], TagsPropertyWidgetComponent>;
7898
+ /** @todo Documentation incomplete. */
7899
+ text: PropertyWidget<null | string, TextPropertyWidgetComponent>;
7933
7900
  }
7934
7901
  /**
7935
7902
  * @todo Documentation incomplete.
@@ -8028,178 +7995,82 @@ export interface MobileToolbar {
8028
7995
  export interface MonthFunction extends BasesFunction, HasExtract {
8029
7996
  }
8030
7997
  /**
8031
- * Multiselect component.
8032
- *
7998
+ * @todo Documentation incomplete.
8033
7999
  * @public
8034
8000
  * @unofficial
8035
8001
  */
8036
8002
  export interface Multiselect {
8037
- /** The elements of the multiselect. */
8003
+ /** @todo Documentation incomplete. */
8004
+ changeCallback?: (values: string[]) => void;
8005
+ /** @todo Documentation incomplete. */
8038
8006
  elements: HTMLDivElement[];
8039
- /** The input element of the multiselect. */
8007
+ /** @todo Documentation incomplete. */
8040
8008
  inputEl: HTMLDivElement;
8041
- /** The text of the input element of the multiselect. */
8009
+ /** @todo Documentation incomplete. */
8042
8010
  readonly inputText: string;
8043
- /** The root element of the multiselect. */
8011
+ /** @todo Documentation incomplete. */
8012
+ optionRenderer?: (value: string, ctx: OptionContext) => void;
8013
+ /** @todo Documentation incomplete. */
8044
8014
  rootEl: HTMLDivElement;
8045
- /** The values of the multiselect. */
8015
+ /** @todo Documentation incomplete. */
8016
+ setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void;
8017
+ /** @todo Documentation incomplete. */
8046
8018
  values: string[];
8047
- /**
8048
- * Create a new element for the multiselect.
8049
- *
8050
- * @param value - the value of the element.
8051
- * @returns the created element or `null` if the value is not valid.
8052
- */
8019
+ /** @todo Documentation incomplete. */
8053
8020
  _createElement(value: string): string | null;
8054
- /** Create a new input element for the multiselect. */
8021
+ /** @todo Documentation incomplete. */
8055
8022
  _createInputEl(): HTMLDivElement;
8056
- /**
8057
- * Add a new element to the multiselect.
8058
- *
8059
- * @param value - the value of the element.
8060
- * @returns `true` if the element was added, `false` otherwise.
8061
- */
8023
+ /** @todo Documentation incomplete. */
8062
8024
  addElement(value: string): boolean;
8063
- /**
8064
- * Allow creating options for the multiselect.
8065
- *
8066
- * @param createOption - the function to create an option.
8067
- * @returns the multiselect.
8068
- */
8025
+ /** @todo Documentation incomplete. */
8069
8026
  allowCreatingOptions(createOption: (this: Multiselect, value: string) => string | undefined): this;
8070
- /**
8071
- * The callback for the change event.
8072
- *
8073
- * @param values - the values of the multiselect.
8074
- */
8075
- changeCallback?(values: string[]): void;
8076
- /**
8077
- * Create a new option for the multiselect.
8078
- *
8079
- * @param value - the value of the option.
8080
- * @returns the created option or `undefined` if the value is not valid.
8081
- */
8027
+ /** @todo Documentation incomplete. */
8082
8028
  createOption?(this: Multiselect, value: string): string | undefined;
8083
- /**
8084
- * Edit an element of the multiselect.
8085
- *
8086
- * @param index - the index of the element.
8087
- */
8029
+ /** @todo Documentation incomplete. */
8088
8030
  editElement(index: number): void;
8089
- /**
8090
- * Find a duplicate in the multiselect.
8091
- *
8092
- * @param values - the values to find a duplicate in.
8093
- * @returns `true` if a duplicate was found, `false` otherwise.
8094
- */
8031
+ /** @todo Documentation incomplete. */
8095
8032
  findDuplicate?(this: Multiselect, values: string[]): boolean;
8096
- /**
8097
- * Focus an element of the multiselect.
8098
- *
8099
- * @param index - the index of the element.
8100
- */
8033
+ /** @todo Documentation incomplete. */
8101
8034
  focusElement(index: number): void;
8102
- /**
8103
- * Handle the change event of the multiselect.
8104
- *
8105
- * @param changeCallback - the callback to handle the change event.
8106
- */
8035
+ /** @todo Documentation incomplete. */
8107
8036
  onChange(changeCallback: (values: string[]) => void): void;
8108
- /**
8109
- * Handle the context menu event of the multiselect.
8110
- *
8111
- * @param menu - the menu to handle the context menu event.
8112
- * @param value - the value of the element.
8113
- */
8114
- onOptionContextmenu?(this: Multiselect, menu: Menu, value: string, ctx: MultiselectOptionContextMenuContext): void;
8115
- /** The renderer for the options of the multiselect. */
8116
- optionRenderer?(value: string, ctx: MultiselectOptionContextMenuContext): void;
8117
- /**
8118
- * Prevent duplicates in the multiselect.
8119
- *
8120
- * @param findDuplicate - the function to find a duplicate.
8121
- * @returns the multiselect.
8122
- */
8037
+ /** @todo Documentation incomplete. */
8038
+ onOptionContextmenu?(this: Multiselect, menu: Menu, value: string, ctx: OptionContext): void;
8039
+ /** @todo Documentation incomplete. */
8123
8040
  preventDuplicates(findDuplicate: (this: Multiselect, values: string[]) => number): this;
8124
- /**
8125
- * Remove an element of the multiselect.
8126
- *
8127
- * @param index - the index of the element.
8128
- */
8041
+ /** @todo Documentation incomplete. */
8129
8042
  removeElement(index: number, shouldFocus?: boolean): void;
8130
- /** Render the values of the multiselect. */
8043
+ /** @todo Documentation incomplete. */
8131
8044
  renderValues(): void;
8132
- /**
8133
- * Set the text of the input element of the multiselect.
8134
- *
8135
- * @param text - the text to set.
8136
- */
8045
+ /** @todo Documentation incomplete. */
8137
8046
  setInputText(text: string): void;
8138
- /**
8139
- * Set the context menu handler of the multiselect.
8140
- *
8141
- * @param onOptionContextmenu - the function to handle the context menu event.
8142
- * @returns the multiselect.
8143
- */
8144
- setOptionContextmenuHandler(onOptionContextmenu: (this: Multiselect, menu: Menu, value: string, ctx: MultiselectOptionContextMenuContext) => void): this;
8145
- /**
8146
- * Set the option renderer of the multiselect.
8147
- *
8148
- * @param optionRenderer - the function to render the options.
8149
- * @returns the multiselect.
8150
- */
8151
- setOptionRenderer(optionRenderer: (value: string, ctx: MultiselectOptionContextMenuContext) => void): this;
8152
- /**
8153
- * The setup function for the input element of the multiselect.
8154
- *
8155
- * @param inputEl - the input element.
8156
- * @param initializer - the initializer function.
8157
- */
8158
- setupInput?(this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown): void;
8159
- /**
8160
- * Set the setup function for the input element of the multiselect.
8161
- *
8162
- * @param setupInput - the function to setup the input element.
8163
- * @returns the multiselect.
8164
- */
8047
+ /** @todo Documentation incomplete. */
8048
+ setOptionContextmenuHandler(onOptionContextmenu: (this: Multiselect, menu: Menu, value: string, ctx: OptionContext) => void): this;
8049
+ /** @todo Documentation incomplete. */
8050
+ setOptionRenderer(optionRenderer: (value: string, ctx: OptionContext) => void): this;
8051
+ /** @todo Documentation incomplete. */
8165
8052
  setupInputEl(setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void): this;
8166
- /**
8167
- * Set the values of the multiselect.
8168
- *
8169
- * @param values - the values to set.
8170
- * @returns the multiselect.
8171
- */
8053
+ /** @todo Documentation incomplete. */
8172
8054
  setValues(values: string[] | null): this;
8173
- /** Trigger the change event of the multiselect. */
8055
+ /** @todo Documentation incomplete. */
8174
8056
  triggerChange(): void;
8175
8057
  }
8176
8058
  /**
8177
- * Multiselect option context menu context.
8178
- *
8179
- * @public
8180
- * @unofficial
8181
- */
8182
- export interface MultiselectOptionContextMenuContext {
8183
- /** The element of the option context. */
8184
- el: HTMLDivElement;
8185
- /** The pill element of the option context. */
8186
- pillEl: HTMLDivElement;
8187
- }
8188
- /**
8189
- * Property widget component for multiple texts.
8190
- *
8059
+ * @todo Documentation incomplete.
8191
8060
  * @public
8192
8061
  * @unofficial
8193
8062
  */
8194
- export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase<string[] | string> {
8195
- /** The hover popover for the property widget. */
8063
+ export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase {
8064
+ /** @todo Documentation incomplete. */
8196
8065
  hoverPopover: HoverPopover | null;
8197
- /** The multiselect component for the property widget. */
8066
+ /** @todo Documentation incomplete. */
8198
8067
  multiselect: Multiselect;
8199
- /** The type of the property widget. */
8068
+ /** @todo Documentation incomplete. */
8200
8069
  type: "multitext";
8201
- /** The values of the property widget. */
8070
+ /** @todo Documentation incomplete. */
8202
8071
  valueSet: Set<string>;
8072
+ /** @todo Documentation incomplete. */
8073
+ setValue(value: string[] | string): void;
8203
8074
  }
8204
8075
  /**
8205
8076
  * @todo Documentation incomplete.
@@ -8303,18 +8174,17 @@ export interface NoteComposerPluginOptions {
8303
8174
  export interface NowFunction extends BasesFunction {
8304
8175
  }
8305
8176
  /**
8306
- * Property widget component for numbers.
8307
- *
8177
+ * @todo Documentation incomplete.
8308
8178
  * @public
8309
8179
  * @unofficial
8310
8180
  */
8311
- export interface NumberPropertyWidgetComponent extends PropertyWidgetComponentBase<number> {
8312
- /** The input element for the property widget. */
8181
+ export interface NumberPropertyWidgetComponent extends PropertyWidgetComponentBase {
8182
+ /** @todo Documentation incomplete. */
8313
8183
  inputEl: HTMLInputElement;
8314
- /** The type of the property widget. */
8184
+ /** @todo Documentation incomplete. */
8315
8185
  type: "number";
8316
- /** Show the error message. */
8317
- showError(): void;
8186
+ /** @todo Documentation incomplete. */
8187
+ setValue(value: number | null): void;
8318
8188
  }
8319
8189
  /**
8320
8190
  * @todo Documentation incomplete.
@@ -8415,6 +8285,17 @@ export interface OpenNotificationOptions {
8415
8285
  /** @todo Documentation incomplete. */
8416
8286
  duration?: number;
8417
8287
  }
8288
+ /**
8289
+ * @todo Documentation incomplete.
8290
+ * @public
8291
+ * @unofficial
8292
+ */
8293
+ export interface OptionContext {
8294
+ /** @todo Documentation incomplete. */
8295
+ el: HTMLDivElement;
8296
+ /** @todo Documentation incomplete. */
8297
+ pillEl: HTMLDivElement;
8298
+ }
8418
8299
  /**
8419
8300
  * @todo Documentation incomplete.
8420
8301
  * @public
@@ -8624,6 +8505,7 @@ export interface PdfViewConstructor extends TypedViewConstructor<PdfView> {
8624
8505
  * @unofficial
8625
8506
  *
8626
8507
  * Due to limitations of TypeScript, we cannot extend the `Platform` constant directly.
8508
+ *
8627
8509
  * @example
8628
8510
  *
8629
8511
  * ```ts
@@ -8978,164 +8860,31 @@ export interface PropertyEntryData<T> {
8978
8860
  * @unofficial
8979
8861
  */
8980
8862
  export interface PropertyInfo {
8981
- /**
8982
- * Name of property.
8983
- */
8984
- name: string;
8985
8863
  /**
8986
8864
  * Usage count of property.
8987
8865
  */
8988
8866
  occurrences: number;
8867
+ /**
8868
+ * Name of property.
8869
+ */
8870
+ name: string;
8989
8871
  /**
8990
8872
  * Type of property.
8991
8873
  */
8992
8874
  widget: string;
8993
8875
  }
8994
8876
  /**
8995
- * Property widget component for properties.
8996
- *
8877
+ * @todo Documentation incomplete.
8997
8878
  * @public
8998
8879
  * @unofficial
8999
8880
  */
9000
- export interface PropertyPropertyWidgetComponent extends PropertyWidgetComponentBase<string> {
9001
- /** The combobox component for the property widget. */
9002
- combobox: PropertyPropertyWidgetComponentComboBox;
9003
- /** The input element for the property widget. */
8881
+ export interface PropertyPropertyWidgetComponent extends PropertyWidgetComponentBase {
8882
+ /** @todo Documentation incomplete. */
9004
8883
  inputEl: HTMLInputElement;
9005
- /** The type of the property widget. */
8884
+ /** @todo Documentation incomplete. */
9006
8885
  type: "property";
9007
- }
9008
- /**
9009
- * Combobox component for {@link PropertyPropertyWidgetComponent}.
9010
- *
9011
- * @public
9012
- * @unofficial
9013
- */
9014
- export interface PropertyPropertyWidgetComponentComboBox extends PopoverSuggest<PropertyPropertyWidgetComponentComboBoxItem> {
9015
- /** The items of the combobox. */
9016
- _items: PropertyPropertyWidgetComponentComboBoxItem[];
9017
- /** The background element of the combobox. */
9018
- bgEl: HTMLDivElement;
9019
- /** The button element of the combobox. */
9020
- buttonEl: HTMLDivElement;
9021
- /** Whether the combobox is clearable. */
9022
- clearable: boolean;
9023
- /** The icon element of the combobox. */
9024
- iconEl: HTMLDivElement;
9025
- /** The label element of the combobox. */
9026
- labelEl: HTMLDivElement;
9027
- /** The search component of the combobox. */
9028
- searchComponent: SearchComponent;
9029
- /** The current value of the combobox. */
9030
- value: PropertyPropertyWidgetComponentComboBoxItem | null;
9031
- /**
9032
- * Callback for `onClose`.
9033
- */
9034
- _onClose?(): void;
9035
- /**
9036
- * Callback for `onOpen`.
9037
- */
9038
- _onOpen?(): void;
9039
- /** Attach the DOM of the combobox. */
9040
- attachDom(): void;
9041
- /** Detach the DOM of the combobox. */
9042
- detachDom(): Promise<void>;
9043
- /** Focus the combobox. */
9044
- focus(): void;
9045
- /** Get the items of the combobox. */
9046
- getItems(): PropertyPropertyWidgetComponentComboBoxItem[];
9047
- /**
9048
- * Callback for `getSuggestions`.
9049
- */
9050
- getSuggestions(query: string): SearchResult[];
9051
- /**
9052
- * Register a callback for `close` event.
9053
- *
9054
- * @param callback - the callback to register.
9055
- */
9056
- onClose(callback: () => void): this;
9057
- /**
9058
- * Handle the input change event of the combobox.
9059
- *
9060
- * @param query - the query to handle.
9061
- */
9062
- onInputChange(query: string): void;
9063
- /**
9064
- * Register a callback for `open` event.
9065
- *
9066
- * @param callback - the callback to register.
9067
- */
9068
- onOpen(callback: () => void): this;
9069
- /**
9070
- * Register a callback for `select` event.
9071
- *
9072
- * @param callback - the callback to register.
9073
- */
9074
- onSelect(callback: (item: PropertyPropertyWidgetComponentComboBoxItem) => void): this;
9075
- /** Render the label of the combobox. */
9076
- renderLabel(): void;
9077
- /**
9078
- * Callback for `onSelect`.
9079
- *
9080
- * @param item - the item that was selected.
9081
- */
9082
- selectCb?(item: PropertyPropertyWidgetComponentComboBoxItem): void;
9083
- /**
9084
- * Set the clearable state of the combobox.
9085
- *
9086
- * @param clearable - whether the combobox should be clearable.
9087
- * @returns the combobox.
9088
- */
9089
- setClearable(clearable: boolean): this;
9090
- /**
9091
- * Set the items of the combobox.
9092
- *
9093
- * @param items - the items to set.
9094
- * @returns the combobox.
9095
- */
9096
- setItems(items: PropertyPropertyWidgetComponentComboBoxItem[]): this;
9097
- /**
9098
- * Set the placeholder of the combobox.
9099
- *
9100
- * @param placeholder - the placeholder to set.
9101
- * @returns the combobox.
9102
- */
9103
- setPlaceholder(placeholder: string): this;
9104
- /**
9105
- * Set the value of the combobox.
9106
- *
9107
- * @param value - the value to set.
9108
- * @returns the combobox.
9109
- */
9110
- setValue(value: PropertyPropertyWidgetComponentComboBoxItem): this;
9111
- /**
9112
- * Set the value of the combobox by its id.
9113
- *
9114
- * @param id - the id of the value to set.
9115
- * @returns the combobox.
9116
- */
9117
- setValueById(id: string): this;
9118
- /** Toggle the combobox. */
9119
- toggle(): unknown;
9120
- /**
9121
- * Update the value of the combobox.
9122
- *
9123
- * @param value - the value to update.
9124
- * @returns the combobox.
9125
- */
9126
- updateValue(value: PropertyPropertyWidgetComponentComboBoxItem): this;
9127
- }
9128
- /**
9129
- * Combo box item for {@link PropertyPropertyWidgetComponentComboBox}.
9130
- *
9131
- * @public
9132
- * @unofficial
9133
- */
9134
- export interface PropertyPropertyWidgetComponentComboBoxItem {
9135
- /** The icon of the item. */
9136
- icon: string;
9137
- /** The value of the item. */
9138
- value: string;
8886
+ /** @todo Documentation incomplete. */
8887
+ setValue(value: string | null): void;
9139
8888
  }
9140
8889
  /**
9141
8890
  * @todo Documentation incomplete.
@@ -9165,12 +8914,11 @@ export interface PropertyRenderContext {
9165
8914
  onChange(value: unknown): void;
9166
8915
  }
9167
8916
  /**
9168
- * Property widget.
9169
- *
8917
+ * @todo Documentation incomplete.
9170
8918
  * @public
9171
8919
  * @unofficial
9172
8920
  */
9173
- export interface PropertyWidget<Value = unknown, ComponentType extends PropertyWidgetComponentBase<Value> = PropertyWidgetComponentBase<Value>> {
8921
+ export interface PropertyWidget<Value = unknown, ComponentType extends PropertyWidgetComponentBase = PropertyWidgetComponentBase> {
9174
8922
  /**
9175
8923
  * Lucide-dev icon associated with the widget.
9176
8924
  */
@@ -9197,34 +8945,19 @@ export interface PropertyWidget<Value = unknown, ComponentType extends PropertyW
9197
8945
  validate(value: unknown): boolean;
9198
8946
  }
9199
8947
  /**
9200
- * Base class for property widget components.
9201
- *
8948
+ * @todo Documentation incomplete.
9202
8949
  * @public
9203
8950
  * @unofficial
9204
8951
  */
9205
- export interface PropertyWidgetComponentBase<Value = unknown> {
9206
- /** The container element for the property widget. */
8952
+ export interface PropertyWidgetComponentBase {
8953
+ /** @todo Documentation incomplete. */
9207
8954
  containerEl: HTMLElement;
9208
- /** The type of the property widget. */
8955
+ /** @todo Documentation incomplete. */
9209
8956
  type: string;
9210
- /**
9211
- * Focus the property widget.
9212
- *
9213
- * @param mode - The focus mode.
9214
- */
8957
+ /** @todo Documentation incomplete. */
9215
8958
  focus(mode?: FocusMode): void;
9216
- /**
9217
- * Handle focus event.
9218
- *
9219
- * @param mode - The focus mode.
9220
- */
8959
+ /** @todo Documentation incomplete. */
9221
8960
  onFocus(mode: FocusMode): void;
9222
- /**
9223
- * Set the value of the property widget.
9224
- *
9225
- * @param value - The value to set.
9226
- */
9227
- setValue(value: Value | null): void;
9228
8961
  }
9229
8962
  /**
9230
8963
  * @todo Documentation incomplete.
@@ -9255,27 +8988,6 @@ export interface PublishPluginInstance extends InternalPluginInstance<PublishPlu
9255
8988
  /** @todo Documentation incomplete. */
9256
8989
  plugin: PublishPlugin;
9257
8990
  }
9258
- /**
9259
- * Query for fuzzy search.
9260
- *
9261
- * @public
9262
- * @unofficial
9263
- */
9264
- export interface QueryForFuzzySearch {
9265
- /** */
9266
- /**
9267
- * The fuzzy tokens of the query.
9268
- */
9269
- fuzzy: string[];
9270
- /**
9271
- * The query string.
9272
- */
9273
- query: string;
9274
- /**
9275
- * The tokens of the query.
9276
- */
9277
- tokens: string[];
9278
- }
9279
8991
  /**
9280
8992
  * @todo Documentation incomplete.
9281
8993
  * @public
@@ -10485,16 +10197,17 @@ export interface TagViewConstructor extends TypedViewConstructor<TagView> {
10485
10197
  export interface TaggedWithFunction extends BasesFunction, HasGetDisplayName, HasGetRHSWidgetType {
10486
10198
  }
10487
10199
  /**
10488
- * Property widget component for tags.
10489
- *
10200
+ * @todo Documentation incomplete.
10490
10201
  * @public
10491
10202
  * @unofficial
10492
10203
  */
10493
- export interface TagsPropertyWidgetComponent extends PropertyWidgetComponentBase<string[] | string> {
10494
- /** The multiselect component for the property widget. */
10204
+ export interface TagsPropertyWidgetComponent extends PropertyWidgetComponentBase {
10205
+ /** @todo Documentation incomplete. */
10495
10206
  multiselect: Multiselect;
10496
- /** The type of the property widget. */
10207
+ /** @todo Documentation incomplete. */
10497
10208
  type: "tags";
10209
+ /** @todo Documentation incomplete. */
10210
+ setValue(value: string[] | string): void;
10498
10211
  }
10499
10212
  /**
10500
10213
  * @todo Documentation incomplete.
@@ -10517,52 +10230,37 @@ export interface TemplatesPluginInstance extends InternalPluginInstance<Template
10517
10230
  plugin: TemplatesPlugin;
10518
10231
  }
10519
10232
  /**
10520
- * Property widget component for text.
10521
- *
10233
+ * @todo Documentation incomplete.
10522
10234
  * @public
10523
10235
  * @unofficial
10524
10236
  */
10525
- export interface TextPropertyWidgetComponent extends PropertyWidgetComponentBase<string> {
10526
- /** The render context for the property widget. */
10237
+ export interface TextPropertyWidgetComponent extends PropertyWidgetComponentBase {
10238
+ /** @todo Documentation incomplete. */
10527
10239
  ctx: PropertyRenderContext;
10528
- /** The input element for the property widget. */
10240
+ /** @todo Documentation incomplete. */
10529
10241
  inputEl: HTMLInputElement;
10530
- /** The link element for the property widget. */
10242
+ /** @todo Documentation incomplete. */
10531
10243
  linkEl: HTMLDivElement;
10532
- /** The link text element for the property widget. */
10244
+ /** @todo Documentation incomplete. */
10533
10245
  linkTextEl: HTMLDivElement;
10534
- /** The type of the property widget. */
10246
+ /** @todo Documentation incomplete. */
10535
10247
  type: "text";
10536
- /** The value of the property widget. */
10248
+ /** @todo Documentation incomplete. */
10537
10249
  value: string;
10538
- /**
10539
- * Get the display text of the link from the property widget.
10540
- *
10541
- * @returns The display text.
10542
- */
10250
+ /** @todo Documentation incomplete. */
10543
10251
  getDisplayText(): string;
10544
- /**
10545
- * Get the link text of the property widget.
10546
- *
10547
- * @returns The link text.
10548
- */
10252
+ /** @todo Documentation incomplete. */
10549
10253
  getLinkText(): string;
10550
- /**
10551
- * Check if the property widget link has an alias.
10552
- *
10553
- * @returns Whether the property widget link has an alias.
10554
- */
10254
+ /** @todo Documentation incomplete. */
10555
10255
  isAlias(): boolean;
10556
- /**
10557
- * Check if the property widget link is a wikilink.
10558
- *
10559
- * @returns Whether the property widget link is a wikilink.
10560
- */
10256
+ /** @todo Documentation incomplete. */
10561
10257
  isWikilink(): boolean;
10562
- /**
10563
- * Render the property widget.
10564
- */
10258
+ /** @todo Documentation incomplete. */
10565
10259
  render(): void;
10260
+ /** @todo Documentation incomplete. */
10261
+ setValue(value: string | null): void;
10262
+ /** @todo Documentation incomplete. */
10263
+ setValue(value: string | null): void;
10566
10264
  }
10567
10265
  /**
10568
10266
  * @todo Documentation incomplete.
@@ -10964,18 +10662,6 @@ export interface TypedWorkspaceLeaf<TView extends View> extends WorkspaceLeaf {
10964
10662
  */
10965
10663
  export interface UniqueFunction extends BasesFunction {
10966
10664
  }
10967
- /**
10968
- * Property widget component for unknown types.
10969
- *
10970
- * @public
10971
- * @unofficial
10972
- */
10973
- export interface UnknownPropertyWidgetComponent extends PropertyWidgetComponentBase<unknown> {
10974
- /** The element of the property widget. */
10975
- el: HTMLSpanElement;
10976
- /** The type of the property widget. */
10977
- type: "unknown";
10978
- }
10979
10665
  /**
10980
10666
  * Views of plugins that have been deactivated become an UnknownView.
10981
10667
  * @todo This is probably not the right term.