WebviewerView
Unofficial
obsidian#View that renders an embedded web browser for browsing web pages within Obsidian.
Import:
import type { WebviewerView } from '@obsidian-typings/obsidian-public-latest';Signature:
export interface WebviewerView extends ItemViewExtends: ItemView
Constructor
new WebviewerView(leaf: WorkspaceLeaf, browserPluginInstance: WebviewerPluginInstance)Constructor.
Properties
| Property | Type | Description | |
|---|---|---|---|
| actionsEl | HTMLElement | Container of actions for the view. (Inherited from ItemView) | |
| app | App | The Obsidian app instance. (Inherited from ItemView) | |
| backButtonEl | HTMLButtonElement | Back button element for changing view history. (Inherited from ItemView) | |
| canDropAnywhere | boolean | Whether the view may be dropped anywhere in workspace. (Inherited from ItemView) | |
| closeable | boolean | Whether the leaf may close the view. (Inherited from ItemView) | |
| containerEl | HTMLElement | The container HTML element for the component. (Inherited from ItemView) | |
| contentEl | HTMLElement | The parent element of the content. (Inherited from ItemView) | |
| forwardButtonEl | HTMLButtonElement | Forward button element for changing view history. (Inherited from ItemView) | |
| headerEl | HTMLElement | Header bar container of view. (Inherited from ItemView) | |
| icon | IconName | The icon of the view. (Inherited from ItemView) | |
| iconEl | HTMLElement | Icon element for the view (for dragging). (Inherited from ItemView) | |
| leaf | WorkspaceLeaf | The leaf of the view. (Inherited from ItemView) | |
| leftSidebarToggleEl | HTMLElement | null | Toggle button for the left sidebar, shown on mobile. null on desktop.(Inherited from ItemView) | |
| moreOptionsButtonEl | HTMLAnchorElement | Anchor button for revealing more view actions. (Inherited from ItemView) | |
| navigation | boolean | Whether or not the view is intended for navigation. If your view is a static view that is not intended to be navigated away, set this to false. (For example: File explorer, calendar, etc.) If your view opens a file or can be otherwise navigated, set this to true. (For example: Markdown editor view, Kanban view, PDF view, etc.)(Inherited from ItemView) | |
| scope | null | Scope | Assign an optional scope to your view to register hotkeys for when the view is in focus. (Inherited from ItemView) | |
| titleContainerEl | HTMLElement | Container for the title of the view. (Inherited from ItemView) | |
| titleEl | HTMLElement | Title element for the view. (Inherited from ItemView) | |
| titleParentEl | HTMLElement | Title of the parent. (Inherited from ItemView) |
Methods
| Method | Returns | Description | |
|---|---|---|---|
| addAction(icon, title, callback) | HTMLElement | Add an action to the item view. (Inherited from ItemView) | |
| close() | Promise<void> | Closes the view. (Inherited from ItemView) | |
| closeSearch() | void | Close the in-page search bar. | |
| commitPageLoad() | unknown | Finalize and commit the current page load. | |
| configureWebContents() | void | Configure the web contents settings for the webview. | |
| contextMenuItemsForImg(e) | unknown | Build context menu items for an image element. | |
| contextMenuItemsForLink(e, t) | unknown | Build context menu items for a link element. | |
| contextMenuItemsForSelection(e, t) | unknown | Build context menu items for selected text. | |
| displayBlank() | void | Display a blank page in the webview. | |
| displayContextMenu(e) | void | Display a context menu at the given position. | |
| displayErrorView() | void | Shows the error view. | |
| displayReaderView() | Promise<unknown> | Display the page content in reader mode. | |
| displayWebView() | void | Shows the webview. | |
| getDisplayText() | string | Get the display text of the view. (Inherited from ItemView) | |
| getEphemeralState() | Record<string, unknown> | Get the ephemeral state of the view. (Inherited from ItemView) | |
| getIcon() | IconName | Get the icon of the view. (Inherited from ItemView) | |
| getReaderModeContent() | Promise<unknown> | Get the parsed content for reader mode. | |
| getSideTooltipPlacement() | 'left' | 'right' | undefined | Returns the placement of the tooltip. (Inherited from ItemView) | |
| getState() | Record<string, unknown> | Get the state of the view. (Inherited from ItemView) | |
| getViewType() | typeof ViewType.Webviewer | Get the current view type. | |
| handleCopy(event) | void | Handle copy event on metadata editor and serialize properties. (Inherited from ItemView) | |
| handleCut(event) | void | Handle cut event on metadata editor and serialize and remove properties. (Inherited from ItemView) | |
| handleDrop(event, draggable, isOver) | DropResult | null | Handle a drop event on this view. (Inherited from ItemView) | |
| handlePaste(event) | void | Handle paste event of properties on metadata editor. (Inherited from ItemView) | |
| hideAll() | void | Hide all view content (webview, reader, error). | |
| instantiateWebView() | void | Setup the webview. | |
| navigate(e, t) | unknown | Navigate the webview to a URL. | |
| onCheckboxClick(e, t, n) | void | Handle a checkbox click in reader mode. | |
| onClose() | Promise<void> | Called when the view is closed. (Inherited from ItemView) | |
| onExternalLinkClick(e, t, n) | void | Handle a click on an external link. | |
| onExternalLinkRightClick(e, t, n) | void | Handle a right-click on an external link. | |
| onFoldChange() | void | Handle a fold/collapse state change in reader mode. | |
| onGroupChange() | void | Handle a linked group change event. (Inherited from ItemView) | |
| onHeaderMenu(e) | void | Called when the header context menu is triggered. (Inherited from ItemView) | |
| onInternalLinkClick(e, t, n) | void | Handle a click on an internal (vault) link. | |
| onInternalLinkDrag(e, t, n) | void | Handle dragging an internal link. | |
| onInternalLinkMouseover(e, t, n) | void | Handle mouseover on an internal link for preview. | |
| onInternalLinkRightClick(e, t, n) | void | Handle a right-click on an internal link. | |
| onMoreOptions(event) | void | Handle the 'more options' button click event. (Inherited from ItemView) | |
| onMoreOptionsMenu(e) | void | Handle the 'more options' context menu event. (Inherited from ItemView) | |
| onOpen() | Promise<void> | Called when the view is opened. (Inherited from ItemView) | |
| onPaneMenu(menu, source) | void | Populates the pane menu. (Replaces the previously removed onHeaderMenu and onMoreOptionsMenu)(Inherited from ItemView) | |
| onReaderModeContextMenu(e) | void | Handle a context menu event in reader mode. | |
| onRenderComplete() | void | Called when the reader mode rendering is complete. | |
| onResize() | void | Called when the size of this view is changed. (Inherited from ItemView) | |
| onScroll() | void | Handle scroll events in the webview. | |
| onTabMenu(menu) | void | Adds the menu items to the menu. (Inherited from ItemView) | |
| onTagClick(e, t, n) | void | Handle a click on a tag in reader mode. | |
| open(parentEl) | Promise<void> | Opens the view. (Inherited from ItemView) | |
| postProcess(e, t, n) | void | Post-process rendered content in reader mode. | |
| pushViewStackHistory(e) | void | Push the current page to the view navigation history stack. | |
| reportPageLoad(url, title, navigate) | void | Report a page load event to the history database. | |
| saveAsMarkdown() | Promise<unknown> | Save the current page content as a Markdown file. | |
| selectFavicon(e) | unknown | Select the appropriate favicon for the current page. | |
| setEphemeralState(state) | void | Set the ephemeral state of the view. (Inherited from ItemView) | |
| setFavicon(e) | unknown | Set the favicon for the current page. | |
| setState(state, result) | Promise<void> | Set the state of the view. (Inherited from ItemView) | |
| showSearch() | void | Show the in-page search bar. | |
| storeCurrentPageTitle() | Promise<unknown> | Stores the title of the current webview. | |
| toggleReaderMode() | void | Toggles the reader mode. | |
| updateNavButtons() | void | Update the state of the back/forward navigation buttons. (Inherited from ItemView) | |
| zoomIn() | void | Zoom in the webview. | |
| zoomOut() | void | Zoom out the webview. | |
| zoomReset() | void | Resets the zoom factor of the webview. |
Links to this page: