WebviewTag

external interface WebviewTag(source)

Properties

Link copied to clipboard
abstract var allowpopups: Boolean

A boolean. When this attribute is present the guest page will be allowed to open new windows. Popups are disabled by default.

Link copied to clipboard
abstract val closeEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val consoleMessageEvent: <Error class: unknown class><ConsoleMessageEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val destroyedEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val devtoolsClosedEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val devtoolsFocusedEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val devtoolsOpenedEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val devtoolsOpenUrlEvent: <Error class: unknown class><DevtoolsOpenUrlEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val devtoolsSearchQueryEvent: <Error class: unknown class><DevtoolsSearchQueryEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didAttachEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didChangeThemeColorEvent: <Error class: unknown class><DidChangeThemeColorEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didFailLoadEvent: <Error class: unknown class><DidFailLoadEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didFinishLoadEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didFrameFinishLoadEvent: <Error class: unknown class><DidFrameFinishLoadEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didFrameNavigateEvent: <Error class: unknown class><DidFrameNavigateEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didNavigateEvent: <Error class: unknown class><DidNavigateEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didNavigateInPageEvent: <Error class: unknown class><DidNavigateInPageEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didRedirectNavigationEvent: <Error class: unknown class><DidRedirectNavigationEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didStartLoadingEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didStartNavigationEvent: <Error class: unknown class><DidStartNavigationEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val didStopLoadingEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard

A string which is a list of strings which specifies the blink features to be disabled separated by ,. The full list of supported feature strings can be found in the RuntimeEnabledFeatures.json5 file.

Link copied to clipboard

A boolean. When this attribute is present the guest page will have web security disabled. Web security is enabled by default.

Link copied to clipboard
abstract val domReadyEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard

A string which is a list of strings which specifies the blink features to be enabled separated by ,. The full list of supported feature strings can be found in the RuntimeEnabledFeatures.json5 file.

Link copied to clipboard
abstract val enterHtmlFullScreenEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val foundInPageEvent: <Error class: unknown class><FoundInPageEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract var httpreferrer: String

A string that sets the referrer URL for the guest page.

Link copied to clipboard
abstract val ipcMessageEvent: <Error class: unknown class><IpcMessageEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val leaveHtmlFullScreenEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val loadCommitEvent: <Error class: unknown class><LoadCommitEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val mediaPausedEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val mediaStartedPlayingEvent: <Error class: unknown class><<Error class: unknown class>, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract var nodeintegration: Boolean

A boolean. When this attribute is present the guest page in webview will have node integration and can use node APIs like require and process to access low level system resources. Node integration is disabled by default in the guest page.

Link copied to clipboard

A boolean for the experimental option for enabling NodeJS support in sub-frames such as iframes inside the webview. All your preloads will load for every iframe, you can use process.isMainFrame to determine if you are in the main frame or not. This option is disabled by default in the guest page.

Link copied to clipboard
abstract val pageFaviconUpdatedEvent: <Error class: unknown class><PageFaviconUpdatedEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val pageTitleUpdatedEvent: <Error class: unknown class><PageTitleUpdatedEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract var partition: String

A string that sets the session used by the page. If partition starts with persist:, the page will use a persistent session available to all pages in the app with the same partition. if there is no persist: prefix, the page will use an in-memory session. By assigning the same partition, multiple pages can share the same session. If the partition is unset then default session of the app will be used.

Link copied to clipboard
abstract val pluginCrashedEvent: <Error class: unknown class><PluginCrashedEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract var plugins: Boolean

A boolean. When this attribute is present the guest page in webview will be able to use browser plugins. Plugins are disabled by default.

Link copied to clipboard
abstract var preload: String

A string that specifies a script that will be loaded before other scripts run in the guest page. The protocol of script's URL must be file: (even when using asar: archives) because it will be loaded by Node's require under the hood, which treats asar: archives as virtual directories.

Link copied to clipboard
abstract val renderProcessGoneEvent: <Error class: unknown class><RenderProcessGoneEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract var src: String

A string representing the visible URL. Writing to this attribute initiates top-level navigation.

Link copied to clipboard
abstract val updateTargetUrlEvent: <Error class: unknown class><UpdateTargetUrlEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract var useragent: String

A string that sets the user agent for the guest page before the page is navigated to. Once the page is loaded, use the setUserAgent method to change the user agent.

Link copied to clipboard
abstract var webpreferences: String

A string which is a comma separated list of strings which specifies the web preferences to be set on the webview. The full list of supported preference strings can be found in BrowserWindow.

Link copied to clipboard
abstract val willFrameNavigateEvent: <Error class: unknown class><WillFrameNavigateEvent, WebviewTag, <Error class: unknown class>>
Link copied to clipboard
abstract val willNavigateEvent: <Error class: unknown class><WillNavigateEvent, WebviewTag, <Error class: unknown class>>

Functions

Link copied to clipboard

Adjusts the current text selection starting and ending points in the focused frame by the given amounts. A negative amount moves the selection towards the beginning of the document, and a positive amount moves the selection towards the end of the document.

Link copied to clipboard
abstract fun canGoBack(): Boolean

Whether the guest page can go back.

Link copied to clipboard
abstract fun canGoForward(): Boolean

Whether the guest page can go forward.

Link copied to clipboard
abstract fun canGoToOffset(offset: Double): Boolean

Whether the guest page can go to offset.

Link copied to clipboard
abstract fun capturePage(rect: Rectangle = definedExternally): <Error class: unknown class><NativeImage>

Resolves with a NativeImage

Link copied to clipboard
abstract fun centerSelection()

Centers the current text selection in page.

Link copied to clipboard
abstract fun clearHistory()

Clears the navigation history.

Link copied to clipboard
abstract fun closeDevTools()

Closes the DevTools window of guest page.

Link copied to clipboard
abstract fun copy()

Executes editing command copy in page.

Link copied to clipboard
abstract fun cut()

Executes editing command cut in page.

Link copied to clipboard
abstract fun delete()

Executes editing command delete in page.

Link copied to clipboard
abstract fun downloadURL(url: String, options: DownloadURLOptions = definedExternally)

Initiates a download of the resource at url without navigating.

Link copied to clipboard
abstract fun executeJavaScript(code: String, userGesture: Boolean = definedExternally): <Error class: unknown class><Any?>

A promise that resolves with the result of the executed code or is rejected if the result of the code is a rejected promise.

Link copied to clipboard
abstract fun findInPage(text: String, options: FindInPageOptions = definedExternally): Double

The request id used for the request.

Link copied to clipboard
abstract fun getTitle(): String

The title of guest page.

Link copied to clipboard
abstract fun getURL(): String

The URL of guest page.

Link copied to clipboard
abstract fun getUserAgent(): String

The user agent for guest page.

Link copied to clipboard
abstract fun getWebContentsId(): Double

The WebContents ID of this webview.

Link copied to clipboard
abstract fun getZoomFactor(): Double

the current zoom factor.

Link copied to clipboard
abstract fun getZoomLevel(): Double

the current zoom level.

Link copied to clipboard
abstract fun goBack()

Makes the guest page go back.

Link copied to clipboard
abstract fun goForward()

Makes the guest page go forward.

Link copied to clipboard
abstract fun goToIndex(index: Double)

Navigates to the specified absolute index.

Link copied to clipboard
abstract fun goToOffset(offset: Double)

Navigates to the specified offset from the "current entry".

Link copied to clipboard
abstract fun insertCSS(css: String): <Error class: unknown class><String>

A promise that resolves with a key for the inserted CSS that can later be used to remove the CSS via <webview>.removeInsertedCSS(key).

Link copied to clipboard
abstract fun insertText(text: String): <Error class: unknown class><<Error class: unknown class>>

Inserts text to the focused element.

Link copied to clipboard
abstract fun inspectElement(x: Double, y: Double)

Starts inspecting element at position (x, y) of guest page.

Link copied to clipboard
abstract fun inspectServiceWorker()

Opens the DevTools for the service worker context present in the guest page.

Link copied to clipboard
abstract fun inspectSharedWorker()

Opens the DevTools for the shared worker context present in the guest page.

Link copied to clipboard
abstract fun isAudioMuted(): Boolean

Whether guest page has been muted.

Link copied to clipboard
abstract fun isCrashed(): Boolean

Whether the renderer process has crashed.

Link copied to clipboard
abstract fun isCurrentlyAudible(): Boolean

Whether audio is currently playing.

Link copied to clipboard
abstract fun isDevToolsFocused(): Boolean

Whether DevTools window of guest page is focused.

Link copied to clipboard
abstract fun isDevToolsOpened(): Boolean

Whether guest page has a DevTools window attached.

Link copied to clipboard
abstract fun isLoading(): Boolean

Whether guest page is still loading resources.

Link copied to clipboard
abstract fun isLoadingMainFrame(): Boolean

Whether the main frame (and not just iframes or frames within it) is still loading.

Link copied to clipboard

Whether the guest page is waiting for a first-response for the main resource of the page.

Link copied to clipboard
abstract fun loadURL(url: String, options: LoadURLOptions = definedExternally): <Error class: unknown class><<Error class: unknown class>>

The promise will resolve when the page has finished loading (see did-finish-load), and rejects if the page fails to load (see did-fail-load).

Link copied to clipboard
abstract fun openDevTools()

Opens a DevTools window for guest page.

Link copied to clipboard
abstract fun paste()

Executes editing command paste in page.

Link copied to clipboard
abstract fun pasteAndMatchStyle()

Executes editing command pasteAndMatchStyle in page.

Link copied to clipboard
abstract fun print(options: WebviewTagPrintOptions = definedExternally): <Error class: unknown class><<Error class: unknown class>>

Prints webview's web page. Same as webContents.print([options]).

Link copied to clipboard
abstract fun printToPDF(    options: PrintToPDFOptions): <Error class: unknown class><<Error class: unknown class><out <Error class: unknown class>>>

Resolves with the generated PDF data.

Link copied to clipboard
abstract fun redo()

Executes editing command redo in page.

Link copied to clipboard
abstract fun reload()

Reloads the guest page.

Link copied to clipboard
abstract fun reloadIgnoringCache()

Reloads the guest page and ignores cache.

Link copied to clipboard
abstract fun removeInsertedCSS(key: String): <Error class: unknown class><<Error class: unknown class>>

Resolves if the removal was successful.

Link copied to clipboard
abstract fun replace(text: String)

Executes editing command replace in page.

Link copied to clipboard
abstract fun replaceMisspelling(text: String)

Executes editing command replaceMisspelling in page.

Link copied to clipboard
abstract fun scrollToBottom()

Scrolls to the bottom of the current <webview>.

Link copied to clipboard
abstract fun scrollToTop()

Scrolls to the top of the current <webview>.

Link copied to clipboard
abstract fun selectAll()

Executes editing command selectAll in page.

Link copied to clipboard
abstract fun send(channel: String, vararg args: Any?): <Error class: unknown class><<Error class: unknown class>>

Send an asynchronous message to renderer process via channel, you can also send arbitrary arguments. The renderer process can handle the message by listening to the channel event with the ipcRenderer module.

Link copied to clipboard
abstract fun sendInputEvent(event: KeyboardInputEvent): <Error class: unknown class><<Error class: unknown class>>
abstract fun sendInputEvent(event: MouseInputEvent): <Error class: unknown class><<Error class: unknown class>>
abstract fun sendInputEvent(event: MouseWheelInputEvent): <Error class: unknown class><<Error class: unknown class>>

Sends an input event to the page.

Link copied to clipboard
abstract fun sendToFrame(    frameId: <Error class: unknown class><Double, Double>,     channel: String,     vararg args: Any?): <Error class: unknown class><<Error class: unknown class>>

Send an asynchronous message to renderer process via channel, you can also send arbitrary arguments. The renderer process can handle the message by listening to the channel event with the ipcRenderer module.

Link copied to clipboard
abstract fun setAudioMuted(muted: Boolean)

Set guest page muted.

Link copied to clipboard
abstract fun setUserAgent(userAgent: String)

Overrides the user agent for the guest page.

Link copied to clipboard
abstract fun setVisualZoomLevelLimits(    minimumLevel: Double,     maximumLevel: Double): <Error class: unknown class><<Error class: unknown class>>

Sets the maximum and minimum pinch-to-zoom level.

Link copied to clipboard
abstract fun setZoomFactor(factor: Double)

Changes the zoom factor to the specified factor. Zoom factor is zoom percent divided by 100, so 300% = 3.0.

Link copied to clipboard
abstract fun setZoomLevel(level: Double)

Changes the zoom level to the specified level. The original size is 0 and each increment above or below represents zooming 20% larger or smaller to default limits of 300% and 50% of original size, respectively. The formula for this is scale := 1.2 ^ level.

Link copied to clipboard

Shows pop-up dictionary that searches the selected word on the page.

Link copied to clipboard
abstract fun stop()

Stops any pending navigation.

Link copied to clipboard

Stops any findInPage request for the webview with the provided action.

Link copied to clipboard
abstract fun undo()

Executes editing command undo in page.

Link copied to clipboard
abstract fun unselect()

Executes editing command unselect in page.