obsidian-typings 4.27.0 → 4.28.0

package/dist/cjs/implementations.d.cts

@@ -6,9 +6,10 @@ import type { ChangeDesc, Extension, Transaction } from '@codemirror/state';
 import type { EditorView, ViewUpdate } from '@codemirror/view';
 import type { Tree as LezerTree } from '@lezer/common';
 import type { App as App$1, BrowserWindow } from 'electron';
+import moment$1 from 'moment';
 import type { default as moment$1 } from 'moment';
 import type { FSWatcher } from 'node:fs';
-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';
+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';
 import type { Application, Container, Graphics, ICanvas, Sprite, Text as Text$1, TextStyle } from 'pixi.js';
 
 /**
@@ -572,21 +573,20 @@ export interface AddOverlayOptions {
 	query: RegExp;
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget component for aliases.
+ *
  * @public
  * @unofficial
  */
-export interface AliasesPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface AliasesPropertyWidgetComponent extends PropertyWidgetComponentBase<string | string[]> {
+	/** The render context for the property widget. */
 	ctx: PropertyRenderContext;
-	/** @todo Documentation incomplete. */
+	/** The hover popover for the property widget. */
 	hoverPopover: HoverPopover | null;
-	/** @todo Documentation incomplete. */
+	/** The multiselect component for the property widget. */
 	multiselect: Multiselect;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: "aliases";
-	/** @todo Documentation incomplete. */
-	setValue(value: string | string[]): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -1322,101 +1322,6 @@ export interface BacklinkView extends InfoFileView {
  */
 export interface BacklinkViewConstructor extends TypedViewConstructor<BacklinkView> {
 }
-/**
- * @remark `BaseEditor` is never used in the Obsidian codebase, but is exposed in the Obsidian module as `Editor`.
- *       However, most editor components actually make use of the extended `Editor`, so this interface is purposely.
- *       named to `BaseEditor` to not require any casting for most purposes (or overriding the `editor` property type.
- *       for all components).
- * @todo Potential risk of confusion when `Editor` is constructed from the Obsidian module, as it only has the.
- *       methods from `BaseEditor`, *not* `Editor`.
- */
-/**
- * @todo Documentation incomplete.
- * @public
- * @unofficial
- */
-export interface BaseEditor {
-	/**
-	 * CodeMirror editor instance.
-	 */
-	cm: EditorView;
-	/**
-	 * HTML instance the CM editor is attached to.
-	 */
-	containerEl: HTMLElement;
-	/**
-	 * Clean-up function executed after indenting lists.
-	 */
-	afterIndent(): void;
-	/**
-	 * Expand text.
-	 */
-	expandText(): void;
-	/**
-	 * Indents a list by one level.
-	 */
-	indentList(): void;
-	/**
-	 * Insert a template callout at the current cursor position.
-	 */
-	insertCallout(): void;
-	/**
-	 * Insert a template code block at the current cursor position.
-	 */
-	insertCodeblock(): void;
-	/**
-	 * Insert a markdown link at the current cursor position.
-	 */
-	insertLink(): void;
-	/**
-	 * Insert a mathjax equation block at the current cursor position.
-	 */
-	insertMathJax(): void;
-	/**
-	 * Insert specified text at the current cursor position.
-	 *
-	 * @remark Might be broken, inserts at the end of the document.
-	 */
-	insertText(text: string): void;
-	/**
-	 * Inserts a new line and continues a markdown bullet point list at the same level.
-	 */
-	newlineAndIndentContinueMarkdownList(): void;
-	/**
-	 * Inserts a new line at the same indent level.
-	 */
-	newlineAndIndentOnly(): void;
-	/**
-	 * Get the character position at a mouse event.
-	 */
-	posAtMouse(e: MouseEvent): EditorPosition;
-	/**
-	 * Toggles blockquote syntax on paragraph under cursor.
-	 */
-	toggleBlockquote(): void;
-	/**
-	 * Toggle bullet point list syntax on paragraph under cursor.
-	 */
-	toggleBulletList(): void;
-	/**
-	 * Toggle checkbox syntax on paragraph under cursor.
-	 */
-	toggleCheckList(): void;
-	/**
-	 * Toggle numbered list syntax on paragraph under cursor.
-	 */
-	toggleNumberList(): void;
-	/**
-	 * Convert word under cursor into a wikilink.
-	 *
-	 * @param embed - Whether to embed the link or not.
-	 */
-	triggerWikiLink(embed: boolean): void;
-	/**
-	 * Unindents a list by one level.
-	 */
-	unindentList(): void;
-}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -2986,17 +2891,16 @@ export interface CapacitorFileEntry extends Partial<FileStats> {
 export interface CeilFunction extends BasesFunction, HasGetDisplayName {
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget component for checkboxes.
+ *
  * @public
  * @unofficial
  */
-export interface CheckboxPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface CheckboxPropertyWidgetComponent extends PropertyWidgetComponentBase<boolean> {
+	/** The checkbox element for the property widget. */
 	checkboxEl: HTMLInputElement;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: "checkbox";
-	/** @todo Documentation incomplete. */
-	setValue(value: boolean | null): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -3878,34 +3782,65 @@ export interface DateOnOrAfterFunction extends BasesFunction, HasGetDisplayName,
 export interface DateOnOrBeforeFunction extends BasesFunction, HasGetDisplayName, HasCompare, HasGetRHSWidgetType {
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget component for dates.
+ *
  * @public
  * @unofficial
  */
-export interface DatePropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
-	inputEl: HTMLInputElement;
-	/** @todo Documentation incomplete. */
+export interface DatePropertyWidgetComponent extends DatePropertyWidgetComponentBase {
+	/** The button element for the property widget. */
+	buttonEl: HTMLDivElement | null;
+	/** The type of the property widget. */
 	type: "date";
-	/** @todo Documentation incomplete. */
-	parseDate(input: moment$1.MomentInput): string;
-	/** @todo Documentation incomplete. */
-	setValue(value: string | null): void;
 }
 /**
- * @todo Documentation incomplete.
+ * Base interface for date property widget components.
+ *
  * @public
  * @unofficial
  */
-export interface DatetimePropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface DatePropertyWidgetComponentBase extends PropertyWidgetComponentBase<moment$1.MomentInput> {
+	/** The date of the property widget. */
+	date?: moment$1.Moment;
+	/** Whether the property widget is dirty. */
+	dirty: boolean;
+	/** The hover popup for the property widget. */
+	hoverPopup: HoverPopover | null;
+	/** The input element for the property widget. */
 	inputEl: HTMLInputElement;
-	/** @todo Documentation incomplete. */
+	/** The value of the property widget. */
+	value: string;
+	/**
+	 * Build the input element for the property widget.
+	 *
+	 * @param parentEl - The parent element.
+	 * @returns The input element.
+	 */
+	buildInput(parentEl: HTMLElement): HTMLInputElement;
+	/**
+	 * Format the date input.
+	 *
+	 * @param input - The input to format.
+	 * @returns The formatted date.
+	 */
+	format(input: moment$1.Moment): string;
+	/**
+	 * Parse the date input.
+	 *
+	 * @param input - The input to parse.
+	 * @returns The parsed date.
+	 */
+	parse(input: moment$1.MomentInput): void;
+}
+/**
+ * Property widget component for datetimes.
+ *
+ * @public
+ * @unofficial
+ */
+export interface DatetimePropertyWidgetComponent extends DatePropertyWidgetComponentBase {
+	/** The type of the property widget. */
 	type: "datetime";
-	/** @todo Documentation incomplete. */
-	parseDateTime(input: moment$1.MomentInput): string;
-	/** @todo Documentation incomplete. */
-	setValue(value: string | null): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -5185,17 +5120,16 @@ export interface FilePropertiesViewConstructor extends TypedViewConstructor<File
 ]> {
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget component for files.
+ *
  * @public
  * @unofficial
  */
-export interface FilePropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface FilePropertyWidgetComponent extends PropertyWidgetComponentBase<string | null> {
+	/** The input element for the property widget. */
 	inputEl: HTMLInputElement;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: "file";
-	/** @todo Documentation incomplete. */
-	setValue(value: string | null): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -5412,17 +5346,16 @@ export interface FolderBookmarkItem extends BookmarkItem {
 	type: "folder";
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget component for folders.
+ *
  * @public
  * @unofficial
  */
-export interface FolderPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface FolderPropertyWidgetComponent extends PropertyWidgetComponentBase<string> {
+	/** The input element for the property widget. */
 	inputEl: HTMLInputElement;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: "folder";
-	/** @todo Documentation incomplete. */
-	setValue(value: string | null): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -6534,9 +6467,11 @@ export interface InfinityScroll {
 	/** @todo Documentation incomplete. */
 	updateVirtualDisplay(x: unknown): unknown;
 }
-/** @todo This is probably not the right term */
 /**
- * @todo Documentation incomplete.
+ * Info file view.
+ *
+ * @remark This is probably not the right term.
+ *
  * @public
  * @unofficial
  */
@@ -7837,6 +7772,10 @@ export interface MetadataTypeManager extends Events {
 	 * Get expected widget type for property and the one inferred from the property value.
 	 */
 	getTypeInfo(options: GetTypeInfoOptions): TypeInfo;
+	/**
+	 * Get property widget.
+	 */
+	getWidget(type: string): PropertyWidget<unknown>;
 	/**
 	 * Load property types from config.
 	 */
@@ -7870,33 +7809,34 @@ export interface MetadataTypeManager extends Events {
 export interface MetadataTypeManagerPropertiesRecord extends Record<string, PropertyInfo> {
 }
 /**
- * @todo Documentation incomplete.
+ * Registered type widgets.
+ *
  * @public
  * @unofficial
  */
 export interface MetadataTypeManagerRegisteredTypeWidgetsRecord extends Record<PropertyWidgetType, PropertyWidget<unknown>> {
-	/** @todo Documentation incomplete. */
+	/** Property widget for aliases. */
 	aliases: PropertyWidget<string | string[], AliasesPropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
-	checkbox: PropertyWidget<boolean | null, CheckboxPropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
+	/** Property widget for checkboxes. */
+	checkbox: PropertyWidget<boolean, CheckboxPropertyWidgetComponent>;
+	/** Property widget for dates. */
 	date: PropertyWidget<moment$1.MomentInput, DatePropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
+	/** Property widget for datetimes. */
 	datetime: PropertyWidget<moment$1.MomentInput, DatetimePropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
+	/** Property widget for files. */
 	file: PropertyWidget<string, FilePropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
+	/** Property widget for folders. */
 	folder: PropertyWidget<string, FolderPropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
-	multitext: PropertyWidget<string[], MultitextPropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
+	/** Property widget for multitexts. */
+	multitext: PropertyWidget<string[] | string, MultitextPropertyWidgetComponent>;
+	/** Property widget for numbers. */
 	number: PropertyWidget<number, NumberPropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
+	/** Property widget for properties. */
 	property: PropertyWidget<string, PropertyPropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
-	tags: PropertyWidget<string[], TagsPropertyWidgetComponent>;
-	/** @todo Documentation incomplete. */
-	text: PropertyWidget<null | string, TextPropertyWidgetComponent>;
+	/** Property widget for tags. */
+	tags: PropertyWidget<string[] | string, TagsPropertyWidgetComponent>;
+	/** Property widget for text. */
+	text: PropertyWidget<string, TextPropertyWidgetComponent>;
 }
 /**
  * @todo Documentation incomplete.
@@ -7995,82 +7935,178 @@ export interface MobileToolbar {
 export interface MonthFunction extends BasesFunction, HasExtract {
 }
 /**
- * @todo Documentation incomplete.
+ * Multiselect component.
+ *
  * @public
  * @unofficial
  */
 export interface Multiselect {
-	/** @todo Documentation incomplete. */
-	changeCallback?: (values: string[]) => void;
-	/** @todo Documentation incomplete. */
+	/** The elements of the multiselect. */
 	elements: HTMLDivElement[];
-	/** @todo Documentation incomplete. */
+	/** The input element of the multiselect. */
 	inputEl: HTMLDivElement;
-	/** @todo Documentation incomplete. */
+	/** The text of the input element of the multiselect. */
 	readonly inputText: string;
-	/** @todo Documentation incomplete. */
-	optionRenderer?: (value: string, ctx: OptionContext) => void;
-	/** @todo Documentation incomplete. */
+	/** The root element of the multiselect. */
 	rootEl: HTMLDivElement;
-	/** @todo Documentation incomplete. */
-	setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void;
-	/** @todo Documentation incomplete. */
+	/** The values of the multiselect. */
 	values: string[];
-	/** @todo Documentation incomplete. */
+	/**
+	 * Create a new element for the multiselect.
+	 *
+	 * @param value - the value of the element.
+	 * @returns the created element or `null` if the value is not valid.
+	 */
 	_createElement(value: string): string | null;
-	/** @todo Documentation incomplete. */
+	/** Create a new input element for the multiselect. */
 	_createInputEl(): HTMLDivElement;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Add a new element to the multiselect.
+	 *
+	 * @param value - the value of the element.
+	 * @returns `true` if the element was added, `false` otherwise.
+	 */
 	addElement(value: string): boolean;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Allow creating options for the multiselect.
+	 *
+	 * @param createOption - the function to create an option.
+	 * @returns the multiselect.
+	 */
 	allowCreatingOptions(createOption: (this: Multiselect, value: string) => string | undefined): this;
-	/** @todo Documentation incomplete. */
+	/**
+	 * The callback for the change event.
+	 *
+	 * @param values - the values of the multiselect.
+	 */
+	changeCallback?(values: string[]): void;
+	/**
+	 * Create a new option for the multiselect.
+	 *
+	 * @param value - the value of the option.
+	 * @returns the created option or `undefined` if the value is not valid.
+	 */
 	createOption?(this: Multiselect, value: string): string | undefined;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Edit an element of the multiselect.
+	 *
+	 * @param index - the index of the element.
+	 */
 	editElement(index: number): void;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Find a duplicate in the multiselect.
+	 *
+	 * @param values - the values to find a duplicate in.
+	 * @returns `true` if a duplicate was found, `false` otherwise.
+	 */
 	findDuplicate?(this: Multiselect, values: string[]): boolean;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Focus an element of the multiselect.
+	 *
+	 * @param index - the index of the element.
+	 */
 	focusElement(index: number): void;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Handle the change event of the multiselect.
+	 *
+	 * @param changeCallback - the callback to handle the change event.
+	 */
 	onChange(changeCallback: (values: string[]) => void): void;
-	/** @todo Documentation incomplete. */
-	onOptionContextmenu?(this: Multiselect, menu: Menu, value: string, ctx: OptionContext): void;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Handle the context menu event of the multiselect.
+	 *
+	 * @param menu - the menu to handle the context menu event.
+	 * @param value - the value of the element.
+	 */
+	onOptionContextmenu?(this: Multiselect, menu: Menu, value: string, ctx: MultiselectOptionContextMenuContext): void;
+	/** The renderer for the options of the multiselect. */
+	optionRenderer?(value: string, ctx: MultiselectOptionContextMenuContext): void;
+	/**
+	 * Prevent duplicates in the multiselect.
+	 *
+	 * @param findDuplicate - the function to find a duplicate.
+	 * @returns the multiselect.
+	 */
 	preventDuplicates(findDuplicate: (this: Multiselect, values: string[]) => number): this;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Remove an element of the multiselect.
+	 *
+	 * @param index - the index of the element.
+	 */
 	removeElement(index: number, shouldFocus?: boolean): void;
-	/** @todo Documentation incomplete. */
+	/** Render the values of the multiselect. */
 	renderValues(): void;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Set the text of the input element of the multiselect.
+	 *
+	 * @param text - the text to set.
+	 */
 	setInputText(text: string): void;
-	/** @todo Documentation incomplete. */
-	setOptionContextmenuHandler(onOptionContextmenu: (this: Multiselect, menu: Menu, value: string, ctx: OptionContext) => void): this;
-	/** @todo Documentation incomplete. */
-	setOptionRenderer(optionRenderer: (value: string, ctx: OptionContext) => void): this;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Set the context menu handler of the multiselect.
+	 *
+	 * @param onOptionContextmenu - the function to handle the context menu event.
+	 * @returns the multiselect.
+	 */
+	setOptionContextmenuHandler(onOptionContextmenu: (this: Multiselect, menu: Menu, value: string, ctx: MultiselectOptionContextMenuContext) => void): this;
+	/**
+	 * Set the option renderer of the multiselect.
+	 *
+	 * @param optionRenderer - the function to render the options.
+	 * @returns the multiselect.
+	 */
+	setOptionRenderer(optionRenderer: (value: string, ctx: MultiselectOptionContextMenuContext) => void): this;
+	/**
+	 * The setup function for the input element of the multiselect.
+	 *
+	 * @param inputEl - the input element.
+	 * @param initializer - the initializer function.
+	 */
+	setupInput?(this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown): void;
+	/**
+	 * Set the setup function for the input element of the multiselect.
+	 *
+	 * @param setupInput - the function to setup the input element.
+	 * @returns the multiselect.
+	 */
 	setupInputEl(setupInput: (this: Multiselect, inputEl: HTMLDivElement, initializer: (value: string, shouldFocus?: boolean) => unknown) => void): this;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Set the values of the multiselect.
+	 *
+	 * @param values - the values to set.
+	 * @returns the multiselect.
+	 */
 	setValues(values: string[] | null): this;
-	/** @todo Documentation incomplete. */
+	/** Trigger the change event of the multiselect. */
 	triggerChange(): void;
 }
 /**
- * @todo Documentation incomplete.
+ * Multiselect option context menu context.
+ *
  * @public
  * @unofficial
  */
-export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface MultiselectOptionContextMenuContext {
+	/** The element of the option context. */
+	el: HTMLDivElement;
+	/** The pill element of the option context. */
+	pillEl: HTMLDivElement;
+}
+/**
+ * Property widget component for multiple texts.
+ *
+ * @public
+ * @unofficial
+ */
+export interface MultitextPropertyWidgetComponent extends PropertyWidgetComponentBase<string[] | string> {
+	/** The hover popover for the property widget. */
 	hoverPopover: HoverPopover | null;
-	/** @todo Documentation incomplete. */
+	/** The multiselect component for the property widget. */
 	multiselect: Multiselect;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: "multitext";
-	/** @todo Documentation incomplete. */
+	/** The values of the property widget. */
 	valueSet: Set<string>;
-	/** @todo Documentation incomplete. */
-	setValue(value: string[] | string): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -8174,17 +8210,18 @@ export interface NoteComposerPluginOptions {
 export interface NowFunction extends BasesFunction {
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget component for numbers.
+ *
  * @public
  * @unofficial
  */
-export interface NumberPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface NumberPropertyWidgetComponent extends PropertyWidgetComponentBase<number> {
+	/** The input element for the property widget. */
 	inputEl: HTMLInputElement;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: "number";
-	/** @todo Documentation incomplete. */
-	setValue(value: number | null): void;
+	/** Show the error message. */
+	showError(): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -8285,17 +8322,6 @@ export interface OpenNotificationOptions {
 	/** @todo Documentation incomplete. */
 	duration?: number;
 }
-/**
- * @todo Documentation incomplete.
- * @public
- * @unofficial
- */
-export interface OptionContext {
-	/** @todo Documentation incomplete. */
-	el: HTMLDivElement;
-	/** @todo Documentation incomplete. */
-	pillEl: HTMLDivElement;
-}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -8505,7 +8531,6 @@ export interface PdfViewConstructor extends TypedViewConstructor<PdfView> {
  * @unofficial
  *
  * Due to limitations of TypeScript, we cannot extend the `Platform` constant directly.
- *
  * @example
  *
  * ```ts
@@ -8860,31 +8885,164 @@ export interface PropertyEntryData<T> {
  * @unofficial
  */
 export interface PropertyInfo {
-	/**
-	 * Usage count of property.
-	 */
-	occurrences: number;
 	/**
 	 * Name of property.
 	 */
 	name: string;
+	/**
+	 * Usage count of property.
+	 */
+	occurrences: number;
 	/**
 	 * Type of property.
 	 */
 	widget: string;
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget component for properties.
+ *
  * @public
  * @unofficial
  */
-export interface PropertyPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface PropertyPropertyWidgetComponent extends PropertyWidgetComponentBase<string> {
+	/** The combobox component for the property widget. */
+	combobox: PropertyPropertyWidgetComponentComboBox;
+	/** The input element for the property widget. */
 	inputEl: HTMLInputElement;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: "property";
-	/** @todo Documentation incomplete. */
-	setValue(value: string | null): void;
+}
+/**
+ * Combobox component for {@link PropertyPropertyWidgetComponent}.
+ *
+ * @public
+ * @unofficial
+ */
+export interface PropertyPropertyWidgetComponentComboBox extends PopoverSuggest<PropertyPropertyWidgetComponentComboBoxItem> {
+	/** The items of the combobox. */
+	_items: PropertyPropertyWidgetComponentComboBoxItem[];
+	/** The background element of the combobox. */
+	bgEl: HTMLDivElement;
+	/** The button element of the combobox. */
+	buttonEl: HTMLDivElement;
+	/** Whether the combobox is clearable. */
+	clearable: boolean;
+	/** The icon element of the combobox. */
+	iconEl: HTMLDivElement;
+	/** The label element of the combobox. */
+	labelEl: HTMLDivElement;
+	/** The search component of the combobox. */
+	searchComponent: SearchComponent;
+	/** The current value of the combobox. */
+	value: PropertyPropertyWidgetComponentComboBoxItem | null;
+	/**
+	 * Callback for `onClose`.
+	 */
+	_onClose?(): void;
+	/**
+	 * Callback for `onOpen`.
+	 */
+	_onOpen?(): void;
+	/** Attach the DOM of the combobox. */
+	attachDom(): void;
+	/** Detach the DOM of the combobox. */
+	detachDom(): Promise<void>;
+	/** Focus the combobox. */
+	focus(): void;
+	/** Get the items of the combobox. */
+	getItems(): PropertyPropertyWidgetComponentComboBoxItem[];
+	/**
+	 * Callback for `getSuggestions`.
+	 */
+	getSuggestions(query: string): SearchResult[];
+	/**
+	 * Register a callback for `close` event.
+	 *
+	 * @param callback - the callback to register.
+	 */
+	onClose(callback: () => void): this;
+	/**
+	 * Handle the input change event of the combobox.
+	 *
+	 * @param query - the query to handle.
+	 */
+	onInputChange(query: string): void;
+	/**
+	 * Register a callback for `open` event.
+	 *
+	 * @param callback - the callback to register.
+	 */
+	onOpen(callback: () => void): this;
+	/**
+	 * Register a callback for `select` event.
+	 *
+	 * @param callback - the callback to register.
+	 */
+	onSelect(callback: (item: PropertyPropertyWidgetComponentComboBoxItem) => void): this;
+	/** Render the label of the combobox. */
+	renderLabel(): void;
+	/**
+	 * Callback for `onSelect`.
+	 *
+	 * @param item - the item that was selected.
+	 */
+	selectCb?(item: PropertyPropertyWidgetComponentComboBoxItem): void;
+	/**
+	 * Set the clearable state of the combobox.
+	 *
+	 * @param clearable - whether the combobox should be clearable.
+	 * @returns the combobox.
+	 */
+	setClearable(clearable: boolean): this;
+	/**
+	 * Set the items of the combobox.
+	 *
+	 * @param items - the items to set.
+	 * @returns the combobox.
+	 */
+	setItems(items: PropertyPropertyWidgetComponentComboBoxItem[]): this;
+	/**
+	 * Set the placeholder of the combobox.
+	 *
+	 * @param placeholder - the placeholder to set.
+	 * @returns the combobox.
+	 */
+	setPlaceholder(placeholder: string): this;
+	/**
+	 * Set the value of the combobox.
+	 *
+	 * @param value - the value to set.
+	 * @returns the combobox.
+	 */
+	setValue(value: PropertyPropertyWidgetComponentComboBoxItem): this;
+	/**
+	 * Set the value of the combobox by its id.
+	 *
+	 * @param id - the id of the value to set.
+	 * @returns the combobox.
+	 */
+	setValueById(id: string): this;
+	/** Toggle the combobox. */
+	toggle(): unknown;
+	/**
+	 * Update the value of the combobox.
+	 *
+	 * @param value - the value to update.
+	 * @returns the combobox.
+	 */
+	updateValue(value: PropertyPropertyWidgetComponentComboBoxItem): this;
+}
+/**
+ * Combo box item for {@link PropertyPropertyWidgetComponentComboBox}.
+ *
+ * @public
+ * @unofficial
+ */
+export interface PropertyPropertyWidgetComponentComboBoxItem {
+	/** The icon of the item. */
+	icon: string;
+	/** The value of the item. */
+	value: string;
 }
 /**
  * @todo Documentation incomplete.
@@ -8914,11 +9072,12 @@ export interface PropertyRenderContext {
 	onChange(value: unknown): void;
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget.
+ *
  * @public
  * @unofficial
  */
-export interface PropertyWidget<Value = unknown, ComponentType extends PropertyWidgetComponentBase = PropertyWidgetComponentBase> {
+export interface PropertyWidget<Value = unknown, ComponentType extends PropertyWidgetComponentBase<Value> = PropertyWidgetComponentBase<Value>> {
 	/**
 	 * Lucide-dev icon associated with the widget.
 	 */
@@ -8945,19 +9104,34 @@ export interface PropertyWidget<Value = unknown, ComponentType extends PropertyW
 	validate(value: unknown): boolean;
 }
 /**
- * @todo Documentation incomplete.
+ * Base class for property widget components.
+ *
  * @public
  * @unofficial
  */
-export interface PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface PropertyWidgetComponentBase<Value = unknown> {
+	/** The container element for the property widget. */
 	containerEl: HTMLElement;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Focus the property widget.
+	 *
+	 * @param mode - The focus mode.
+	 */
 	focus(mode?: FocusMode): void;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Handle focus event.
+	 *
+	 * @param mode - The focus mode.
+	 */
 	onFocus(mode: FocusMode): void;
+	/**
+	 * Set the value of the property widget.
+	 *
+	 * @param value - The value to set.
+	 */
+	setValue(value: Value | null): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -8988,6 +9162,27 @@ export interface PublishPluginInstance extends InternalPluginInstance<PublishPlu
 	/** @todo Documentation incomplete. */
 	plugin: PublishPlugin;
 }
+/**
+ * Query for fuzzy search.
+ *
+ * @public
+ * @unofficial
+ */
+export interface QueryForFuzzySearch {
+	/** */
+	/**
+	 * The fuzzy tokens of the query.
+	 */
+	fuzzy: string[];
+	/**
+	 * The query string.
+	 */
+	query: string;
+	/**
+	 * The tokens of the query.
+	 */
+	tokens: string[];
+}
 /**
  * @todo Documentation incomplete.
  * @public
@@ -10197,17 +10392,16 @@ export interface TagViewConstructor extends TypedViewConstructor<TagView> {
 export interface TaggedWithFunction extends BasesFunction, HasGetDisplayName, HasGetRHSWidgetType {
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget component for tags.
+ *
  * @public
  * @unofficial
  */
-export interface TagsPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface TagsPropertyWidgetComponent extends PropertyWidgetComponentBase<string[] | string> {
+	/** The multiselect component for the property widget. */
 	multiselect: Multiselect;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: "tags";
-	/** @todo Documentation incomplete. */
-	setValue(value: string[] | string): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -10230,37 +10424,52 @@ export interface TemplatesPluginInstance extends InternalPluginInstance<Template
 	plugin: TemplatesPlugin;
 }
 /**
- * @todo Documentation incomplete.
+ * Property widget component for text.
+ *
  * @public
  * @unofficial
  */
-export interface TextPropertyWidgetComponent extends PropertyWidgetComponentBase {
-	/** @todo Documentation incomplete. */
+export interface TextPropertyWidgetComponent extends PropertyWidgetComponentBase<string> {
+	/** The render context for the property widget. */
 	ctx: PropertyRenderContext;
-	/** @todo Documentation incomplete. */
+	/** The input element for the property widget. */
 	inputEl: HTMLInputElement;
-	/** @todo Documentation incomplete. */
+	/** The link element for the property widget. */
 	linkEl: HTMLDivElement;
-	/** @todo Documentation incomplete. */
+	/** The link text element for the property widget. */
 	linkTextEl: HTMLDivElement;
-	/** @todo Documentation incomplete. */
+	/** The type of the property widget. */
 	type: "text";
-	/** @todo Documentation incomplete. */
+	/** The value of the property widget. */
 	value: string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Get the display text of the link from the property widget.
+	 *
+	 * @returns The display text.
+	 */
 	getDisplayText(): string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Get the link text of the property widget.
+	 *
+	 * @returns The link text.
+	 */
 	getLinkText(): string;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Check if the property widget link has an alias.
+	 *
+	 * @returns Whether the property widget link has an alias.
+	 */
 	isAlias(): boolean;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Check if the property widget link is a wikilink.
+	 *
+	 * @returns Whether the property widget link is a wikilink.
+	 */
 	isWikilink(): boolean;
-	/** @todo Documentation incomplete. */
+	/**
+	 * Render the property widget.
+	 */
 	render(): void;
-	/** @todo Documentation incomplete. */
-	setValue(value: string | null): void;
-	/** @todo Documentation incomplete. */
-	setValue(value: string | null): void;
 }
 /**
  * @todo Documentation incomplete.
@@ -10535,14 +10744,16 @@ export interface TreeItem extends TreeNode {
 	 */
 	setClickable(value: boolean): void;
 }
-/** @todo Documentation incomplete. */
 /**
- * @todo Documentation incomplete.
+ * Tree node.
+ *
  * @public
  * @unofficial
  */
 export interface TreeNode {
-	/** @todo Documentation incomplete. */
+	/**
+	 * The element of the tree node.
+	 */
 	el: HTMLElement;
 }
 /**
@@ -10663,11 +10874,22 @@ export interface TypedWorkspaceLeaf<TView extends View> extends WorkspaceLeaf {
 export interface UniqueFunction extends BasesFunction {
 }
 /**
- * Views of plugins that have been deactivated become an UnknownView.
- * @todo This is probably not the right term.
+ * Property widget component for unknown types.
+ *
+ * @public
+ * @unofficial
  */
+export interface UnknownPropertyWidgetComponent extends PropertyWidgetComponentBase<unknown> {
+	/** The element of the property widget. */
+	el: HTMLSpanElement;
+	/** The type of the property widget. */
+	type: "unknown";
+}
 /**
- * @todo Documentation incomplete.
+ * Views of plugins that have been deactivated become an UnknownView.
+ *
+ * @remark This is probably not the right term.
+ *
  * @public
  * @unofficial
  */
@@ -11714,10 +11936,7 @@ export type Mapping = {
  */
 export type MaybeDeferredView<TView extends View> = TView | DeferredView;
 /**
- * @todo Documentation incomplete.
- */
-/**
- * @todo Documentation incomplete.
+ * Property widget type.
  *
  * @public
  * @unofficial