WebviewerPluginInstance
Unofficial
Plugin instance for the web viewer, providing an embedded web browser within Obsidian.
Import:
import type { WebviewerPluginInstance } from '@obsidian-typings/obsidian-public-latest';Signature:
export interface WebviewerPluginInstance extends InternalPluginInstance<WebviewerPlugin>Extends: InternalPluginInstance<WebviewerPlugin>
Properties
| Property | Type | Description | |
|---|---|---|---|
| db | WebviewerDBStore | Stored history items and cached fav icons. | |
| defaultOn | false | Whether this plugin is enabled by default. | |
| description | string | Human-readable description of this plugin. (Inherited from InternalPluginInstance) | |
| id | string | Unique identifier for this plugin. (Inherited from InternalPluginInstance) | |
| name | string | Human-readable display name of this plugin. (Inherited from InternalPluginInstance) | |
| pendingIgnoredURLs | string[] | URLs that are pending to be added to the ignore list. |
Methods
| Method | Returns | Description | |
|---|---|---|---|
| getSearchEngineUrl(searchQuery) | string | Build a search engine URL for the given search query. | |
| handleOpenUrl(event) | void | Handle a custom open URL event from the webview. | |
| init(app, plugin) | void | Initialize the plugin instance with app and plugin references. (Inherited from InternalPluginInstance) | |
| onDisable(app, plugin) | void | Called when the plugin is disabled. (Inherited from InternalPluginInstance) | |
| onEnable(app, plugin) | Promise<void> | Called when the plugin is enabled. (Inherited from InternalPluginInstance) | |
| onUserDisable(app) | void | Called when the user manually disables the plugin. (Inherited from InternalPluginInstance) | |
| onUserEnable(app) | void | Called when the user manually enables the plugin. (Inherited from InternalPluginInstance) | |
| openUrl(url, newLeaf?, active?) | void | Open a URL in the web viewer. | |
| openUrlExternally(url) | void | Open a URL in the system default browser. | |
| updateSession() | void | Update the current browsing session state. |
Links to this page: