Se usó la API de Cloud Translation para traducir esta página.

chrome.windows

Descripción

Usa la API de chrome.windows para interactuar con las ventanas del navegador. Puedes usar esta API para crear, modificar y reorganizar ventanas en el navegador.

Permisos

Cuando se solicita, un windows.Window contiene un array de objetos tabs.Tab. Debes declarar el permiso "tabs" en tu manifiesto si necesitas acceder a las propiedades url, pendingUrl, title o favIconUrl de tabs.Tab. Por ejemplo:

{
  "name": "My extension",
  ...
  "permissions": ["tabs"],
  ...
}

Conceptos y uso

La ventana actual

Muchas funciones del sistema de extensiones toman un argumento windowId opcional, que, de forma predeterminada, se establece en la ventana actual.

La ventana actual es la que contiene el código que se está ejecutando. Es importante tener en cuenta que puede ser diferente de la ventana enfocada o superior.

Por ejemplo, supongamos que una extensión crea algunas pestañas o ventanas a partir de un solo archivo HTML, y que ese archivo contiene una llamada a tabs.query(). La ventana actual es la que contiene la página que realizó la llamada, sin importar cuál sea la ventana superior.

En el caso de los service workers, el valor de la ventana actual se revierte a la última ventana activa. En algunas circunstancias, es posible que no haya una ventana actual para las páginas en segundo plano.

Ejemplos

Para probar esta API, instala el ejemplo de la API de Windows desde el repositorio de chrome-extension-samples.

Tipos

CreateType

Chrome 44 y versiones posteriores

Especifica qué tipo de ventana del navegador se debe crear. "panel" dejó de estar disponible y solo se puede usar en las extensiones existentes incluidas en la lista de entidades permitidas en ChromeOS.

Enum

"normal"
Especifica la ventana como una ventana estándar.

"popup"
Especifica la ventana como una ventana emergente.

"panel"
Especifica la ventana como un panel.

QueryOptions

Chrome 88 y versiones posteriores

Propiedades

propagar

booleano opcional

Si es verdadero, el objeto windows.Window tiene una propiedad tabs que contiene una lista de los objetos tabs.Tab. Los objetos Tab solo contienen las propiedades url, pendingUrl, title y favIconUrl si el archivo de manifiesto de la extensión incluye el permiso "tabs".
windowTypes

WindowType[] opcional

Si se configura, el windows.Window que se devuelve se filtra según su tipo. Si no se configura, el filtro predeterminado se establece en ['normal', 'popup'].

Window

Propiedades

alwaysOnTop

booleano

Indica si la ventana está configurada para estar siempre en primer plano.
enfocados

booleano

Indica si la ventana es la ventana enfocada actualmente.
alto

número opcional

Es la altura de la ventana, incluido el marco, en píxeles. En algunas circunstancias, es posible que no se asigne una propiedad height a una ventana, por ejemplo, cuando se consultan ventanas cerradas desde la API de sessions.
id

número opcional

ID de la ventana Los IDs de ventana son únicos dentro de una sesión del navegador. En algunas circunstancias, es posible que no se asigne una propiedad ID a una ventana, por ejemplo, cuando se consultan ventanas con la API de sessions, en cuyo caso puede haber un ID de sesión.
Incógnito

booleano

Indica si la ventana es de incógnito.
izquierda

número opcional

Es el desplazamiento de la ventana desde el borde izquierdo de la pantalla en píxeles. En algunas circunstancias, es posible que no se asigne una propiedad left a una ventana, por ejemplo, cuando se consultan ventanas cerradas desde la API de sessions.
sessionId

cadena opcional

Es el ID de sesión que se usa para identificar de forma única una ventana, que se obtiene de la API de sessions.
state

WindowState opcional

Es el estado de esta ventana del navegador.
pestañas

Tab[] opcional

Es un array de objetos tabs.Tab que representan las pestañas actuales de la ventana.
superior

número opcional

Es el desplazamiento de la ventana desde el borde superior de la pantalla en píxeles. En algunas circunstancias, es posible que no se asigne una propiedad top a una ventana, por ejemplo, cuando se consultan ventanas cerradas desde la API de sessions.
tipo

WindowType opcional

Es el tipo de ventana del navegador.
ancho

número opcional

Ancho de la ventana, incluido el marco, en píxeles. En algunas circunstancias, es posible que no se asigne una propiedad width a una ventana, por ejemplo, cuando se consultan ventanas cerradas desde la API de sessions.

WindowState

Chrome 44 y versiones posteriores

Es el estado de esta ventana del navegador. En algunas circunstancias, es posible que no se asigne una propiedad state a una ventana, por ejemplo, cuando se consultan ventanas cerradas desde la API de sessions.

Enum

"normal"
Estado normal de la ventana (no minimizada, maximizada ni en pantalla completa).

"minimized"
Estado de ventana minimizada.

"maximized"
Estado de ventana maximizada.

"fullscreen"
Estado de ventana en pantalla completa.

"locked-fullscreen"
Estado de ventana de pantalla completa bloqueada. El usuario no puede salir de este estado de pantalla completa, y solo está disponible para las extensiones incluidas en la lista de entidades permitidas en ChromeOS.

WindowType

Chrome 44 y versiones posteriores

Es el tipo de ventana del navegador. En algunas circunstancias, es posible que no se asigne una propiedad type a una ventana, por ejemplo, cuando se consultan ventanas cerradas desde la API de sessions.

Enum

"normal"
Una ventana del navegador normal.

"popup"
Es una ventana emergente del navegador.

"panel"
Obsoleto en esta API. Una ventana de panel de la app de Chrome. Las extensiones solo pueden ver sus propias ventanas de paneles.

"app"
Obsoleto en esta API. Es una ventana de la app de Chrome. Las extensiones solo pueden ver las ventanas de su propia app.

"devtools"
Una ventana de Herramientas para desarrolladores.

Propiedades

WINDOW_ID_CURRENT

Es el valor de windowId que representa la ventana actual.

Valor

-2

WINDOW_ID_NONE

Es el valor de windowId que representa la ausencia de una ventana del navegador Chrome.

Valor

-1

Métodos

create()

chrome.windows.create(
  createData?: object,
): Promise<Window | undefined>

Crea (abre) una nueva ventana del navegador con cualquier tamaño, posición o URL predeterminada opcional proporcionada.

Parámetros

createData

objeto opcional
- enfocados
  
  booleano opcional
  
  Si es true, se abre una ventana activa. Si es false, se abre una ventana inactiva.
- alto
  
  número opcional
  
  Altura en píxeles de la ventana nueva, incluido el marco. Si no se especifica, se establece de forma predeterminada una altura natural.
- Incógnito
  
  booleano opcional
  
  Indica si la ventana nueva debe ser de incógnito.
- izquierda
  
  número opcional
  
  Cantidad de píxeles para posicionar la ventana nueva desde el borde izquierdo de la pantalla. Si no se especifica, la nueva ventana se desplaza de forma natural desde la última ventana enfocada. Este valor se ignora para los paneles.
- setSelfAsOpener
  
  booleano opcional
  
  Chrome 64 y versiones posteriores
  
  Si es true, el "window.opener" de la ventana recién creada se establece en el llamador y se encuentra en la misma unidad de contextos de navegación relacionados que el llamador.
- state
  
  WindowState opcional
  
  Chrome 44 y versiones posteriores
  
  Es el estado inicial de la ventana. Los estados minimized, maximized y fullscreen no se pueden combinar con left, top, width o height.
- tabId
  
  número opcional
  
  ID de la pestaña que se agregará a la ventana nueva.
- superior
  
  número opcional
  
  Es la cantidad de píxeles para posicionar la ventana nueva desde el borde superior de la pantalla. Si no se especifica, la nueva ventana se desplaza de forma natural desde la última ventana enfocada. Este valor se ignora para los paneles.
- tipo
  
  CreateType opcional
  
  Especifica qué tipo de ventana del navegador se debe crear.
- url
  
  cadena | cadena[] opcional
  
  Es una URL o un array de URLs que se abrirán como pestañas en la ventana. Las URLs completamente calificadas deben incluir un esquema, p.ej., "http://www.google.com", no "www.google.com". Las URLs no completamente calificadas se consideran relativas dentro de la extensión. La configuración predeterminada es la página Nueva pestaña.
- ancho
  
  número opcional
  
  Ancho en píxeles de la ventana nueva, incluido el marco. Si no se especifica, el valor predeterminado es un ancho natural.

Muestra

Promise<Window | undefined>

Chrome 88 y versiones posteriores

get()

chrome.windows.get(
  windowId: number,
  queryOptions?: QueryOptions,
): Promise<Window>

Obtiene detalles sobre una ventana.

Parámetros

windowId

número
queryOptions

QueryOptions opcional

Chrome 88 y versiones posteriores

Muestra

Promise<Window>

Chrome 88 y versiones posteriores

getAll()

chrome.windows.getAll(
  queryOptions?: QueryOptions,
): Promise<Window[]>

Obtiene todas las ventanas.

Parámetros

queryOptions

QueryOptions opcional

Chrome 88 y versiones posteriores

Muestra

Promise<Window[]>

Chrome 88 y versiones posteriores

getCurrent()

chrome.windows.getCurrent(
  queryOptions?: QueryOptions,
): Promise<Window>

Obtiene la ventana actual.

Parámetros

queryOptions

QueryOptions opcional

Chrome 88 y versiones posteriores

Muestra

Promise<Window>

Chrome 88 y versiones posteriores

getLastFocused()

chrome.windows.getLastFocused(
  queryOptions?: QueryOptions,
): Promise<Window>

Obtiene la ventana que se enfocó más recientemente, por lo general, la ventana "en primer plano".

Parámetros

queryOptions

QueryOptions opcional

Chrome 88 y versiones posteriores

Muestra

Promise<Window>

Chrome 88 y versiones posteriores

remove()

chrome.windows.remove(
  windowId: number,
): Promise<void>

Quita (cierra) una ventana y todas las pestañas que contiene.

Parámetros

windowId

número

Muestra

Promise<void>

Chrome 88 y versiones posteriores

update()

chrome.windows.update(
  windowId: number,
  updateInfo: object,
): Promise<Window>

Actualiza las propiedades de una ventana. Especifica solo las propiedades que se cambiarán. Las propiedades no especificadas no se modificarán.

Parámetros

windowId

número
updateInfo

objeto
- drawAttention
  
  booleano opcional
  
  Si es true, hace que la ventana se muestre de una manera que atrae la atención del usuario hacia ella, sin cambiar la ventana enfocada. El efecto dura hasta que el usuario cambia el enfoque a la ventana. Esta opción no tiene efecto si la ventana ya tiene el enfoque. Se establece en false para cancelar una solicitud drawAttention anterior.
- enfocados
  
  booleano opcional
  
  Si es true, lleva la ventana al frente; no se puede combinar con el estado "minimizada". Si es false, trae al frente la siguiente ventana en el orden Z; no se puede combinar con el estado "pantalla completa" o "maximizado".
- alto
  
  número opcional
  
  Altura a la que se cambiará el tamaño de la ventana, en píxeles. Este valor se ignora para los paneles.
- izquierda
  
  número opcional
  
  Es el desplazamiento desde el borde izquierdo de la pantalla al que se moverá la ventana, en píxeles. Este valor se ignora para los paneles.
- state
  
  WindowState opcional
  
  Es el estado nuevo de la ventana. Los estados "minimized", "maximized" y "fullscreen" no se pueden combinar con "left", "top", "width" o "height".
- superior
  
  número opcional
  
  Es el desplazamiento desde el borde superior de la pantalla al que se moverá la ventana, expresado en píxeles. Este valor se ignora para los paneles.
- ancho
  
  número opcional
  
  Ancho al que se cambiará el tamaño de la ventana en píxeles. Este valor se ignora para los paneles.

Muestra

Promise<Window>

Chrome 88 y versiones posteriores

Eventos

onBoundsChanged

Chrome 86 y versiones posteriores

chrome.windows.onBoundsChanged.addListener(
  callback: function,
)

Se activa cuando se cambia el tamaño de una ventana. Este evento solo se envía cuando se confirman los nuevos límites y no para los cambios en curso.

Parámetros

callback

función

El parámetro callback se ve de la siguiente manera:
```
(window: Window) => void
```
- ventana
  
  Window

onCreated

chrome.windows.onCreated.addListener(
  callback: function,
  filters?: object,
)

Se activa cuando se crea una ventana.

Parámetros

callback

función

Chrome 46 y versiones posteriores

El parámetro callback se ve de la siguiente manera:
```
(window: Window) => void
```
- ventana
  
  Window
  
  Son los detalles de la ventana creada.
filtros

objeto opcional
- windowTypes
  
  WindowType[]
  
  Condiciones que debe satisfacer el tipo de ventana que se crea. De forma predeterminada, satisface ['normal', 'popup'].

onFocusChanged

chrome.windows.onFocusChanged.addListener(
  callback: function,
  filters?: object,
)

Se activa cuando cambia la ventana que tiene el foco. Devuelve chrome.windows.WINDOW_ID_NONE si todas las ventanas de Chrome perdieron el enfoque. Nota: En algunos administradores de ventanas de Linux, WINDOW_ID_NONE siempre se envía inmediatamente antes de cambiar de una ventana de Chrome a otra.

Parámetros

callback

función

Chrome 46 y versiones posteriores

El parámetro callback se ve de la siguiente manera:
```
(windowId: number) => void
```
- windowId
  
  número
  
  ID de la ventana a la que se le asignó el enfoque.
filtros

objeto opcional
- windowTypes
  
  WindowType[]
  
  Condiciones que debe satisfacer el tipo de ventana que se quita. De forma predeterminada, satisface ['normal', 'popup'].

onRemoved

chrome.windows.onRemoved.addListener(
  callback: function,
  filters?: object,
)

Se activa cuando se quita (cierra) una ventana.

Parámetros

callback

función

Chrome 46 y versiones posteriores

El parámetro callback se ve de la siguiente manera:
```
(windowId: number) => void
```
- windowId
  
  número
  
  ID de la ventana quitada.
filtros

objeto opcional
- windowTypes
  
  WindowType[]
  
  Condiciones que debe satisfacer el tipo de ventana que se quita. De forma predeterminada, satisface ['normal', 'popup'].

chrome.windows Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Descripción

Permisos

Conceptos y uso

La ventana actual

Ejemplos

Tipos

CreateType

Enum

QueryOptions

Propiedades

Window

Propiedades

WindowState

Enum

WindowType

Enum

Propiedades

WINDOW_ID_CURRENT

Valor

WINDOW_ID_NONE

Valor

Métodos

create()

Parámetros

Muestra

get()

Parámetros

Muestra

getAll()

Parámetros

Muestra

getCurrent()

Parámetros

Muestra

getLastFocused()

Parámetros

Muestra

remove()

Parámetros

Muestra

update()

Parámetros

Muestra

Eventos

onBoundsChanged

Parámetros

onCreated

Parámetros

onFocusChanged

Parámetros

onRemoved

Parámetros

chrome.windows