Saltar al contenido principal

webFrame

Personalizar el renderizado de la página web actual.

Process: Renderer

webFrame export of the Electron module is an instance of the WebFrame class representing the current frame. Sub-frames can be retrieved by certain properties and methods (e.g. webFrame.firstChild).

Un ejemplo de zoom de la página actual al 200%.

const { webFrame } = require('electron')

webFrame.setZoomFactor(2)

Métodos​

La clase WebFrame tiene los siguientes métodos de instancia:

webFrame.setZoomFactor(factor)​

  • factor Double - Factor de zoom; por defecto es 1.0.

Cambia el nivel de zoom al nivel especificado. Factor de zoom es porcentaje de zoom dividido entre 100, así que 300% = 3.0.

El factor debe ser mayor que 0.0.

webFrame.getZoomFactor()​

Returns number - The current zoom factor.

webFrame.setZoomLevel(level)​

  • nivel número - Nivel de Zoom.

Cambia el nivel de zoom al nivel especificado. El tamaño original es 0 y cada incremento por encima o por debajo representa un zoom del 20% mayor o menor a los límites predeterminados de 300% y 50% del tamaño original, respectivamente.

NOTE: The zoom policy at the Chromium level is same-origin, meaning that the zoom level for a specific domain propagates across all instances of windows with the same domain. Differentiating the window URLs will make zoom work per-window.

webFrame.getZoomLevel()​

Returns number - The current zoom level.

webFrame.setVisualZoomLevelLimits(minimumLevel, maximumLevel)​

  • minimumLevel número
  • maximumLevel número

Establecer el nivel de máximo y mínimo pizca de zoom.

NOTE: Visual zoom is disabled by default in Electron. To re-enable it, call:

webFrame.setVisualZoomLevelLimits(1, 3)

NOTE: Visual zoom only applies to pinch-to-zoom behavior. Cmd+/-/0 zoom shortcuts are controlled by the 'zoomIn', 'zoomOut', and 'resetZoom' MenuItem roles in the application Menu. To disable shortcuts, manually define the Menu and omit zoom roles from the definition.

webFrame.setSpellCheckProvider(language, provider)​

  • idioma cadena
  • Objeto provider
    • spellCheck Función
      • words string[]
      • callback Function
        • misspeltWords string[]

Establece un proveedor para la corrección ortográfica en campos de entrada y áreas de texto.

Si quiere utilizar este método debe deshabilitar el corrector ortográfico incorporado cuando construya la ventana.

const mainWindow = new BrowserWindow({
  webPreferences: {
    spellcheck: false
  }
})

El provider debe ser un objeto que tiene un método spellCheck que acepte un array de palabras individuales para revisión ortográfica. La función spellCheck corre cronológicamente y llama a la función callback con un array de palabras mal escritas cuando se completa.

Un ejemplo de uso de node-spellchecker como proveedor:

const { webFrame } = require('electron')
const spellChecker = require('spellchecker')
webFrame.setSpellCheckProvider('en-US', {
  spellCheck (words, callback) {
    setTimeout(() => {
      const misspelled = words.filter(x => spellchecker.isMisspelled(x))
      callback(misspelled)
    }, 0)
  }
})

webFrame.insertCSS(css[, options])​

  • css cadena
  • options Object (opcional)
    • cssOrigin string (optional) - Can be 'user' or 'author'. Sets the cascade origin of the inserted stylesheet. Default is 'author'.

Devuelve string - Una llave para el CSS insertado que puede ser utilizado más tarde para eliminar el CSS a través de webFrame.removeInsertedCSS(key).

Inyecta CSS en la página web actual y devuelve un identificador único para la hoja de estilo insertada.

webFrame.removeInsertedCSS(key)​

  • llave cadena

Elimina el CSS insertado desde la página web actual. La hoja de estilos se identifica por su clave, el cual es devuelto desde webFrame.insertCSS(css).

webFrame.insertText(texto)​

  • texto cadena

Inserta texto en el elemento enfocado.

webFrame.executeJavaScript(code[, userGesture, callback])​

  • codigo string
  • userGesture boolean (opcional) - Predeterminado es falso.
  • callback Function (optional) - Called after script has been executed. Unless the frame is suspended (e.g. showing a modal alert), execution will be synchronous and the callback will be invoked before the method returns. For compatibility with an older version of this method, the error parameter is second.
    • resultado Cualquiera
    • error Error

Returns Promise<any> - A promise that resolves with the result of the executed code or is rejected if execution throws or results in a rejected promise.

Evalúa el código en la página.

En la ventana del navegador, algunas API HTML como requestFullScreen solo pueden invocarse con un gesto del usuario. Establecer userGesture a true eliminará esta limitación.

webFrame.executeJavaScriptInIsolatedWorld(worldId, scripts[, userGesture, callback])​

  • worldId Integer - The ID of the world to run the javascript in, 0 is the default main world (where content runs), 999 is the world used by Electron's contextIsolation feature. Accepts values in the range 1..536870911.
  • scripts WebSource[]
  • userGesture boolean (opcional) - Predeterminado es falso.
  • callback Function (optional) - Called after script has been executed. Unless the frame is suspended (e.g. showing a modal alert), execution will be synchronous and the callback will be invoked before the method returns. For compatibility with an older version of this method, the error parameter is second.
    • resultado Cualquiera
    • error Error

Returns Promise<any> - A promise that resolves with the result of the executed code or is rejected if execution could not start.

Funciona como executeJavaScript pero evaluá scripts en un contexto aislado.

Note that when the execution of script fails, the returned promise will not reject and the result would be undefined. This is because Chromium does not dispatch errors of isolated worlds to foreign worlds.

webFrame.setIsolatedWorldInfo(worldId, info)​

  • worldId Integer - El ID de la palabra para correr javascript en, 0 es el mundo por defecto, 999 es el mundo usado por la característica contextIsolation de Electron. Las extenciones de Chrome reservan el rango de IDs en [1 << 20, 1 << 29). Aquí puede suministrar cualquier entero.
  • Objeto info
    • securityOrigin string (opcional) - Origen de seguridad para el mundo aislado.
    • csp string (opcional) - Política de Seguridad de Contenido para el mundo aislado.
    • name string (optional) - Name for isolated world. Useful in devtools.

Set the security origin, content security policy and name of the isolated world. Note: If the csp is specified, then the securityOrigin also has to be specified.

webFrame.getResourceUsage()​

Devuelve Objeto:

Devuelve un objeto que describe la información de uso de las cachés de memoria interna de Blink.

const { webFrame } = require('electron')
console.log(webFrame.getResourceUsage())

Esto generará:

{
  images: {
    count: 22,
    size: 2549,
    liveSize: 2542
  },
  cssStyleSheets: { /* same with "images" */ },
  xslStyleSheets: { /* same with "images" */ },
  fonts: { /* same with "images" */ },
  other: { /* same with "images" */ }
}

webFrame.clearCache()​

Intenta liberar memoria que ya no se usa (como las imágenes de una navegación anterior).

Tenga en cuenta que llamar ciegamente este método probablemente haga que Electron sea más lento, ya que tendrá que volver a llenar estos cachés vacíos, solo debe llamarlo si ha ocurrido un evento en su aplicación que le haga pensar que su página está usando menos memoria (es decir, ha navegado desde una página muy pesada a una casi vacía, y tiene la intención de permanecer allí).

webFrame.getFrameForSelector(selector)​

  • selector string - selector CSS para un elemento frame.

Devuelve WebFrame - El elemento de frame en webFrame's documento seleccionado por selector, null sería devuelto si selector no selecciona un frame o si el frame no está en el proceso actual de renderizado.

webFrame.findFrameByName(name)​

  • name string

Deveulve WebFrame - Un hijo de webFrame con el name suministrado, null sería retornado is no hay tal frame o si el frame no está en el proceso renderer actual.

webFrame.findFrameByRoutingId(routingId)​

  • routingId Integer - Un Integer representando el id único del frame en el proceso renderer actual. Las IDs de rutas se pueden recuperar de WebFrame instancias (webFrame.routingId) y también son pasados por el frame WebContents específicos eventos de navegación (por ejemplo, did-frame-navigate)

Devuelve WebFrame - que tiene el routingId proporcionado, null si no se encuentra.

webFrame.isWordMisspelled(word)​

  • word string - The word to be spellchecked.

Returns boolean - True if the word is misspelled according to the built in spellchecker, false otherwise. If no dictionary is loaded, always return false.

webFrame.getWordSuggestions(word)​

  • word string - The misspelled word.

Returns string[] - A list of suggested words for a given word. If the word is spelled correctly, the result will be empty.

Propiedades​

webFrame.top Readonly​

Un WebFrame | null que representa el frame superior en la jerarquía de frames al cual pertenece el webFrame, la propiedad debe ser null si el frame superior no está en el renderer process actual.

webFrame.opener Readonly​

Un WebFrame representa el frame webFrame que abrió, la propiedad debería ser null si no hay abridores o si el abridor no está en el proceso renderer actual.

webFrame.parent Readonly​

Un WebFrame | null que representa el frame padre de webFrame, la propiedad debería ser null si webFrame es superior o el padre no está en renderer process actual.

webFrame.firstChild Readonly​

Un WebFrame | null que representa al primer frame hijo de webFrame, la propiedad debería ser null si webFrame no tiene hijos o el primer hijo no esta en el renderer process actual.

webFrame.nextSibling Readonly​

Un WebFrame | null que representa el siguiente frame hermano, la propiedad debería ser null si webFrame es el último frame en su padre o si el siguiente hermano no está en el renderer process actual.

webFrame.routingId Readonly​

An Integer representing the unique frame id in the current renderer process. Distinct WebFrame instances that refer to the same underlying frame will have the same routingId.