obsidian-typings 2.9.0 → 2.10.0

package/dist/types.d.ts

@@ -5702,6 +5702,13 @@ declare module "obsidian" {
 		 * Triggers when context menu action is executed on the leaf
 		 */
 		on(name: "leaf-menu", callback: (menu: Menu, leaf: WorkspaceLeaf) => void, ctx?: unknown): EventRef;
+		/**
+		 * Open a link in the current leaf
+		 * @param linktext - The link text to open
+		 * @param sourcePath - The path of the source file
+		 * @param openViewState - The view state to open the link in
+		 */
+		openLinkText(linktext: string, sourcePath: string, openViewState?: OpenViewState): Promise<void>;
 		/**
 		 * Set the vertical height a leaf may occupy if it is in a split. The height is not set directly, but
 		 * by setting the flex-grow (css) of the element. This means to predictably affect the height, you
@@ -7854,152 +7861,6 @@ export interface Account {
 	seats: number;
 	token: string;
 }
-declare module "obsidian" {
-	interface CloseableComponent {
-	}
-}
-declare module "obsidian" {
-	interface ProgressBarComponent extends ValueComponent<number> {
-		/**
-		 * Access the "line" element which is a child of the progressBar element
-		 */
-		lineEl: HTMLDivElement;
-		/**
-		 * Access the "bar" element
-		 */
-		progressBar: HTMLDivElement;
-		/**
-		 * Shows/hides the component
-		 *
-		 * @param visible Whether the setting should be visible
-		 * @returns The component
-		 */
-		setVisibility(visible: boolean): this;
-	}
-}
-declare module "obsidian" {
-	interface DropdownComponent extends ValueComponent<string> {
-		/**
-		 * The function that's called after changing the value of the component.
-		 * @remark Using `DropdownComponent.onChange(callback)` assigns the callback to this method
-		 */
-		changeCallback?: (value: string) => void;
-	}
-}
-declare module "obsidian" {
-	interface SliderComponent extends ValueComponent<number> {
-		/**
-		 * The function that's called after changing the value of the component.
-		 * @remark Using `SliderComponent.onChange(callback)` assigns the callback to this method
-		 */
-		changeCallback?: (value: number) => void;
-	}
-}
-declare module "obsidian" {
-	interface AbstractTextComponent<T extends HTMLInputElement | HTMLTextAreaElement> extends ValueComponent<string> {
-		/**
-		 * The function that's called after changing the value of the component.
-		 * @remark Using `AbstractTextComponent.onChange(callback)` assigns the callback to this method
-		 */
-		changeCallback?: (value: string) => void;
-	}
-}
-declare module "obsidian" {
-	interface TextAreaComponent extends AbstractTextComponent<HTMLTextAreaElement> {
-	}
-}
-declare module "obsidian" {
-	interface ExtraButtonComponent extends BaseComponent {
-		/**
-		 * The function that's called after clicking the button.
-		 * @remark Using `ExtraButtonComponent.onClick(callback)` assigns the callback to this method
-		 */
-		changeCallback?: () => void;
-	}
-}
-declare module "obsidian" {
-	interface ToggleComponent extends ValueComponent<boolean> {
-		/**
-		 * The function that's called after changing the value of the component.
-		 * @remark Using `ToggleComponent.onChange(callback)` assigns the callback to this method
-		 */
-		changeCallback?: (value: boolean) => void;
-	}
-}
-declare module "obsidian" {
-	/** @todo Documentation incomplete */
-	interface Component {
-		/**
-		 * Child Components attached to current component, will be unloaded on unloading parent component
-		 */
-		_children: Component[];
-		/**
-		 * Events that are attached to the current component, will be detached on unloading parent component
-		 */
-		_events: EventRef[];
-		/**
-		 * Whether the component and its children are loaded
-		 */
-		_loaded: boolean;
-		registerScopeEvent(keymapEventHandler: KeymapEventHandler): void;
-	}
-}
-declare module "obsidian" {
-	interface ValueComponent<T> extends BaseComponent {
-	}
-}
-declare module "obsidian" {
-	interface TextComponent extends AbstractTextComponent<HTMLInputElement> {
-	}
-}
-declare module "obsidian" {
-	interface ColorComponent extends ValueComponent<string> {
-		/**
-		 * The function that's called after changing the value of the component.
-		 * @remark Using `ColorComponent.onChange(callback)` assigns the callback to this method
-		 */
-		changeCallback?: (value: HexString) => void;
-		/**
-		 * Access the underlying input element of type "color"
-		 */
-		colorPickerEl: HTMLInputElement;
-		getValueInt(): number;
-		setValueInt(value: number): this;
-	}
-}
-declare module "obsidian" {
-	interface MomentFormatComponent extends TextComponent {
-	}
-}
-declare module "obsidian" {
-	interface BaseComponent {
-	}
-}
-declare module "obsidian" {
-	interface ButtonComponent extends BaseComponent {
-		/**
-		 * The function that's called after clicking the button.
-		 * @remark Using `ButtonComponent.onClick(callback)` assigns the callback to this method
-		 */
-		clickCallback?: () => void;
-	}
-}
-declare module "obsidian" {
-	interface SearchComponent extends AbstractTextComponent<HTMLInputElement> {
-		/**
-		 * The containing element for the component's `clearButtonEl` and `inputEl`
-		 */
-		containerEl: HTMLElement;
-		/**
-		 * Adds a decorator to the right side of the search component
-		 */
-		addRightDecorator(decoratorFn: (containerEl: HTMLElement) => void): this;
-		/**
-		 * Adds a class to the search component
-		 */
-		setClass(cls: string): this;
-	}
-}
 /**
  * The TFile constructor.
  *
@@ -8150,12 +8011,78 @@ export declare class CustomArrayDictImpl<T> implements CustomArrayDict<T> {
 	contains(key: string, value: T): boolean;
 	count(): number;
 }
+/** @public */
+export type PlatformType = typeof Platform;
+/**
+ * @public
+ *
+ * Due to limitations of TypeScript, we cannot extend the Platform constant directly.
+ * @example
+ * ```ts
+ * import { Platform } from 'obsidian';
+ * import type { PlatformEx } from 'obsidian-typings';
+ * const platformEx = Platform as PlatformEx;
+ * console.log(platformEx.canDisplayRibbon);
+ * ```
+ */
+export interface PlatformEx extends PlatformType {
+	canDisplayRibbon: boolean;
+	canExportPdf: boolean;
+	canPopoutWindow: boolean;
+	canSplit: boolean;
+	canStackTabs: boolean;
+	mobileDeviceHeight: number;
+	mobileKeyboardHeight: number;
+	mobileSoftKeyboardVisible: boolean;
+}
+/**
+ * A constructor for a browser history view.
+ *
+ * @public
+ */
+export type BrowserHistoryViewConstructor = new (leaf: WorkspaceLeaf, browserPluginInstance: BrowserPluginInstance) => BrowserHistoryView;
+/**
+ * A constructor for a canvas view.
+ *
+ * @public
+ */
+export type CanvasViewConstructor = new (leaf: WorkspaceLeaf, canvasPluginInstance: CanvasPluginInstance) => CanvasView;
+/**
+ * A constructor for an outline view.
+ *
+ * @public
+ */
+export type OutlineViewConstructor = new (leaf: WorkspaceLeaf, outlinePluginInstance: OutlinePluginInstance) => OutlineView;
 /**
  * A constructor for a view that is typed to a specific view type.
  *
  * @public
  */
 export type TypedViewConstructor<TView extends View> = new (leaf: WorkspaceLeaf) => TView;
+/**
+ * A constructor for a sync view.
+ *
+ * @public
+ */
+export type SyncViewConstructor = new (leaf: WorkspaceLeaf, syncPluginInstance: SyncPluginInstance) => SyncView;
+/**
+ * A constructor for a browser view.
+ *
+ * @public
+ */
+export type BrowserViewConstructor = new (leaf: WorkspaceLeaf, browserPluginInstance: BrowserPluginInstance) => BrowserView;
+/**
+ * A constructor for a bookmarks view.
+ *
+ * @public
+ */
+export type BookmarksViewConstructor = new (leaf: WorkspaceLeaf, bookmarksPluginInstance: BookmarksPluginInstance) => BookmarksView;
+/**
+ * A constructor for a file properties view.
+ *
+ * @public
+ */
+export type FilePropertiesViewConstructor = new (leaf: WorkspaceLeaf, propertiesPluginInstance: PropertiesPluginInstance) => FilePropertiesView;
 /**
  * Get the AllPropertiesView constructor.
  *
@@ -8170,12 +8097,6 @@ export declare function getAllPropertiesViewConstructor(app: App): TypedViewCons
  * @public
  */
 export declare function getMarkdownViewConstructor(app: App): TypedViewConstructor<MarkdownView>;
-/**
- * A constructor for a canvas view.
- *
- * @public
- */
-export type CanvasViewConstructor = new (leaf: WorkspaceLeaf, canvasPluginInstance: CanvasPluginInstance) => CanvasView;
 /**
  * Get the CanvasView constructor.
  *
@@ -8197,12 +8118,6 @@ export declare function getFileExplorerViewConstructor(app: App): TypedViewConst
  * @public
  */
 export declare function getOutgoingLinkViewConstructor(app: App): TypedViewConstructor<OutgoingLinkView>;
-/**
- * A constructor for a browser view.
- *
- * @public
- */
-export type BrowserViewConstructor = new (leaf: WorkspaceLeaf, browserPluginInstance: BrowserPluginInstance) => BrowserView;
 /**
  * Get the BrowserView constructor.
  *
@@ -8233,12 +8148,6 @@ export declare function getViewConstructorByViewType<TView extends View = View>(
  * @public
  */
 export declare function getSearchViewConstructor(app: App): TypedViewConstructor<SearchView>;
-/**
- * A constructor for a file properties view.
- *
- * @public
- */
-export type FilePropertiesViewConstructor = new (leaf: WorkspaceLeaf, propertiesPluginInstance: PropertiesPluginInstance) => FilePropertiesView;
 /**
  * Get the FilePropertiesView constructor.
  *
@@ -8246,12 +8155,6 @@ export type FilePropertiesViewConstructor = new (leaf: WorkspaceLeaf, properties
  * @public
  */
 export declare function getFilePropertiesViewConstructor(app: App): FilePropertiesViewConstructor;
-/**
- * A constructor for a bookmarks view.
- *
- * @public
- */
-export type BookmarksViewConstructor = new (leaf: WorkspaceLeaf, bookmarksPluginInstance: BookmarksPluginInstance) => BookmarksView;
 /**
  * Get the BookmarksView constructor.
  *
@@ -8273,12 +8176,6 @@ export declare function getEmptyViewConstructor(app: App): TypedViewConstructor<
  * @public
  */
 export declare function getAudioViewConstructor(app: App): TypedViewConstructor<AudioView>;
-/**
- * A constructor for an outline view.
- *
- * @public
- */
-export type OutlineViewConstructor = new (leaf: WorkspaceLeaf, outlinePluginInstance: OutlinePluginInstance) => OutlineView;
 /**
  * Get the OutlineView constructor.
  *
@@ -8321,12 +8218,6 @@ export declare function getLocalGraphViewConstructor(app: App): TypedViewConstru
  * @public
  */
 export declare function getImageViewConstructor(app: App): TypedViewConstructor<ImageView>;
-/**
- * A constructor for a browser history view.
- *
- * @public
- */
-export type BrowserHistoryViewConstructor = new (leaf: WorkspaceLeaf, browserPluginInstance: BrowserPluginInstance) => BrowserHistoryView;
 /**
  * Get the BrowserHistoryView constructor.
  *
@@ -8334,12 +8225,6 @@ export type BrowserHistoryViewConstructor = new (leaf: WorkspaceLeaf, browserPlu
  * @public
  */
 export declare function getBrowserHistoryViewConstructor(app: App): BrowserHistoryViewConstructor;
-/**
- * A constructor for a sync view.
- *
- * @public
- */
-export type SyncViewConstructor = new (leaf: WorkspaceLeaf, syncPluginInstance: SyncPluginInstance) => SyncView;
 /**
  * Get the SyncView constructor.
  *
@@ -8361,6 +8246,152 @@ export declare function getReleaseNotesViewConstructor(app: App): TypedViewConst
  * @public
  */
 export declare function getBacklinkViewConstructor(app: App): TypedViewConstructor<BacklinkView>;
+declare module "obsidian" {
+	interface CloseableComponent {
+	}
+}
+declare module "obsidian" {
+	interface ProgressBarComponent extends ValueComponent<number> {
+		/**
+		 * Access the "line" element which is a child of the progressBar element
+		 */
+		lineEl: HTMLDivElement;
+		/**
+		 * Access the "bar" element
+		 */
+		progressBar: HTMLDivElement;
+		/**
+		 * Shows/hides the component
+		 *
+		 * @param visible Whether the setting should be visible
+		 * @returns The component
+		 */
+		setVisibility(visible: boolean): this;
+	}
+}
+declare module "obsidian" {
+	interface DropdownComponent extends ValueComponent<string> {
+		/**
+		 * The function that's called after changing the value of the component.
+		 * @remark Using `DropdownComponent.onChange(callback)` assigns the callback to this method
+		 */
+		changeCallback?: (value: string) => void;
+	}
+}
+declare module "obsidian" {
+	interface SliderComponent extends ValueComponent<number> {
+		/**
+		 * The function that's called after changing the value of the component.
+		 * @remark Using `SliderComponent.onChange(callback)` assigns the callback to this method
+		 */
+		changeCallback?: (value: number) => void;
+	}
+}
+declare module "obsidian" {
+	interface AbstractTextComponent<T extends HTMLInputElement | HTMLTextAreaElement> extends ValueComponent<string> {
+		/**
+		 * The function that's called after changing the value of the component.
+		 * @remark Using `AbstractTextComponent.onChange(callback)` assigns the callback to this method
+		 */
+		changeCallback?: (value: string) => void;
+	}
+}
+declare module "obsidian" {
+	interface TextAreaComponent extends AbstractTextComponent<HTMLTextAreaElement> {
+	}
+}
+declare module "obsidian" {
+	interface ExtraButtonComponent extends BaseComponent {
+		/**
+		 * The function that's called after clicking the button.
+		 * @remark Using `ExtraButtonComponent.onClick(callback)` assigns the callback to this method
+		 */
+		changeCallback?: () => void;
+	}
+}
+declare module "obsidian" {
+	interface ToggleComponent extends ValueComponent<boolean> {
+		/**
+		 * The function that's called after changing the value of the component.
+		 * @remark Using `ToggleComponent.onChange(callback)` assigns the callback to this method
+		 */
+		changeCallback?: (value: boolean) => void;
+	}
+}
+declare module "obsidian" {
+	/** @todo Documentation incomplete */
+	interface Component {
+		/**
+		 * Child Components attached to current component, will be unloaded on unloading parent component
+		 */
+		_children: Component[];
+		/**
+		 * Events that are attached to the current component, will be detached on unloading parent component
+		 */
+		_events: EventRef[];
+		/**
+		 * Whether the component and its children are loaded
+		 */
+		_loaded: boolean;
+		registerScopeEvent(keymapEventHandler: KeymapEventHandler): void;
+	}
+}
+declare module "obsidian" {
+	interface ValueComponent<T> extends BaseComponent {
+	}
+}
+declare module "obsidian" {
+	interface TextComponent extends AbstractTextComponent<HTMLInputElement> {
+	}
+}
+declare module "obsidian" {
+	interface ColorComponent extends ValueComponent<string> {
+		/**
+		 * The function that's called after changing the value of the component.
+		 * @remark Using `ColorComponent.onChange(callback)` assigns the callback to this method
+		 */
+		changeCallback?: (value: HexString) => void;
+		/**
+		 * Access the underlying input element of type "color"
+		 */
+		colorPickerEl: HTMLInputElement;
+		getValueInt(): number;
+		setValueInt(value: number): this;
+	}
+}
+declare module "obsidian" {
+	interface MomentFormatComponent extends TextComponent {
+	}
+}
+declare module "obsidian" {
+	interface BaseComponent {
+	}
+}
+declare module "obsidian" {
+	interface ButtonComponent extends BaseComponent {
+		/**
+		 * The function that's called after clicking the button.
+		 * @remark Using `ButtonComponent.onClick(callback)` assigns the callback to this method
+		 */
+		clickCallback?: () => void;
+	}
+}
+declare module "obsidian" {
+	interface SearchComponent extends AbstractTextComponent<HTMLInputElement> {
+		/**
+		 * The containing element for the component's `clearButtonEl` and `inputEl`
+		 */
+		containerEl: HTMLElement;
+		/**
+		 * Adds a decorator to the right side of the search component
+		 */
+		addRightDecorator(decoratorFn: (containerEl: HTMLElement) => void): this;
+		/**
+		 * Adds a class to the search component
+		 */
+		setClass(cls: string): this;
+	}
+}
 declare module "obsidian" {
 	/** @todo Documentation incomplete */
 	interface ItemView extends View {
@@ -8853,30 +8884,6 @@ declare module "obsidian" {
 		updateShowBacklinks(): void;
 	}
 }
-/** @public */
-export type PlatformType = typeof Platform;
-/**
- * @public
- *
- * Due to limitations of TypeScript, we cannot extend the Platform constant directly.
- * @example
- * ```ts
- * import { Platform } from 'obsidian';
- * import type { PlatformEx } from 'obsidian-typings';
- * const platformEx = Platform as PlatformEx;
- * console.log(platformEx.canDisplayRibbon);
- * ```
- */
-export interface PlatformEx extends PlatformType {
-	canDisplayRibbon: boolean;
-	canExportPdf: boolean;
-	canPopoutWindow: boolean;
-	canSplit: boolean;
-	canStackTabs: boolean;
-	mobileDeviceHeight: number;
-	mobileKeyboardHeight: number;
-	mobileSoftKeyboardVisible: boolean;
-}
 
 export {};
 import './style-mod.d.cts';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-typings",
-    "version": "2.9.0",
+    "version": "2.10.0",
     "description": "Extended type definitions for the Obsidian API (https://obsidian.md)",
     "main": "",
     "module": "",