chrome.app.window

Descripción

Usa la API de chrome.app.window para crear ventanas. Las ventanas tienen un marco opcional con barra de título y controles de tamaño. No están asociadas con ninguna ventana del navegador Chrome. Consulta el ejemplo de estado de la ventana para ver una demostración de estas opciones.

Tipos

AppWindow

Propiedades

  • contentWindow

    Ventana

    El objeto "window" de JavaScript para el campo secundario creado.

  • id

    cadena

    El ID con el que se creó la ventana.

  • innerBounds

    Límites

    La posición, el tamaño y las restricciones del contenido de la ventana, que no incluye las decoraciones de la ventana. Esta propiedad es nueva en Chrome 36.

  • outerBounds

    Límites

    La posición, el tamaño y las restricciones de la ventana, que incluye decoraciones, como la barra de título y el marco. Esta propiedad es nueva en Chrome 36.

  • clearAttention

    void

    Dirigir la atención a la ventana.

    La función clearAttention se ve de la siguiente manera: 

    ()=> {...}

  • cerrar

    void

    Cierra la ventana.

    La función close se ve de la siguiente manera: 

    ()=> {...}

  • drawAttention

    void

    Destaca la ventana.

    La función drawAttention se ve de la siguiente manera: 

    ()=> {...}

  • enfoque

    void

    Enfocar la ventana

    La función focus se ve de la siguiente manera: 

    ()=> {...}

  • pantalla completa

    void

    Pantalla completa de la ventana.

    El usuario podrá presionar ESC para restablecer la ventana. Una aplicación puede evitar que se mantenga el estado de pantalla completa cuando se presiona ESC si solicita el permiso app.window.fullscreen.overrideEsc y cancela el evento llamando a .preventDefault(), en los controladores keydown y keyup, de la siguiente manera:

    window.onkeydown = window.onkeyup = function(e) { if (e.keyCode == 27 /* ESC *\/) { e.preventDefault(); } };

    Ten en cuenta que window.fullscreen() hará que toda la ventana aparezca en pantalla completa y no requerirá un gesto del usuario. También se puede usar la API de pantalla completa de HTML5 para ingresar al modo de pantalla completa (consulta APIs web para obtener más información).

    La función fullscreen se ve de la siguiente manera: 

    ()=> {...}

  • getBounds

    void

    Obsoleto

    Usa internalBounds o outerBounds.

    Obtén los límites internos de la ventana como un objeto ContentBounds.

    La función getBounds se ve de la siguiente manera: 

    ()=> {...}

  • ocultar

    void

    Ocultar la ventana. No hace nada si la ventana ya está oculta.

    La función hide se ve de la siguiente manera: 

    ()=> {...}

  • isAlwaysOnTop

    void

    ¿La ventana siempre está arriba?

    La función isAlwaysOnTop se ve de la siguiente manera: 

    ()=> {...}

    • resultados

      boolean

  • isFullscreen

    void

    ¿La ventana está en pantalla completa? Esto será así si la ventana se creó en pantalla completa o en pantalla completa a través de las APIs de pantalla completa de AppWindow o HTML5.

    La función isFullscreen se ve de la siguiente manera: 

    ()=> {...}

    • resultados

      boolean

  • isMaximized

    void

    ¿La ventana está maximizada?

    La función isMaximized se ve de la siguiente manera: 

    ()=> {...}

    • resultados

      boolean

  • isMinimized

    void

    ¿La ventana está minimizada?

    La función isMinimized se ve de la siguiente manera: 

    ()=> {...}

    • resultados

      boolean

  • maximizar

    void

    Maximiza la ventana.

    La función maximize se ve de la siguiente manera: 

    ()=> {...}

  • minimizar

    void

    Minimizar la ventana.

    La función minimize se ve de la siguiente manera: 

    ()=> {...}

  • moveTo

    void

    Obsoleta a partir de Chrome 43

    Usa outerBounds.

    Mueve la ventana a la posición (left, top).

    La función moveTo se ve de la siguiente manera: 

    (left: number,top: number)=> {...}

    • izquierda

      número

    • superior

      número

  • resizeTo

    void

    Obsoleta a partir de Chrome 43

    Usa outerBounds.

    Cambia el tamaño de la ventana a width x height píxeles.

    La función resizeTo se ve de la siguiente manera: 

    (width: number,height: number)=> {...}

    • ancho

      número

    • alto

      número

  • restablecer

    void

    Restablece la ventana saliendo del estado maximizado, minimizado o de pantalla completa.

    La función restore se ve de la siguiente manera: 

    ()=> {...}

  • setAlwaysOnTop

    void

    Establece si la ventana debe permanecer encima de la mayoría de las demás ventanas. Requiere el permiso alwaysOnTopWindows.

    La función setAlwaysOnTop se ve de la siguiente manera: 

    (alwaysOnTop: boolean)=> {...}

    • alwaysOnTop

      boolean

  • setBounds

    void

    Obsoleto

    Usa internalBounds o outerBounds.

    Configura los límites internos de la ventana.

    La función setBounds se ve de la siguiente manera: 

    (bounds: ContentBounds)=> {...}

  • setVisibleOnAllWorkspaces

    void

    Establece si la ventana es visible en todos los lugares de trabajo. (Solo para plataformas que lo admiten).

    La función setVisibleOnAllWorkspaces se ve de la siguiente manera: 

    (alwaysVisible: boolean)=> {...}

    • alwaysVisible

      boolean

  • mostrar

    void

    Muestra la ventana. No hace nada si la ventana ya es visible. Enfoca la ventana si focused se establece en verdadero o se omite.

    La función show se ve de la siguiente manera: 

    (focused?: boolean)=> {...}

    • enfocados

      booleano opcional

Bounds

Propiedades

  • alto

    número

    Esta propiedad se puede usar para leer o escribir la altura actual del contenido o la ventana.

  • izquierda

    número

    Esta propiedad se puede usar para leer o escribir la coordenada X actual del contenido o la ventana.

  • maxHeight

    número opcional

    Esta propiedad se puede usar para leer o escribir la altura máxima actual del contenido o la ventana. Un valor de null indica “sin especificar”.

  • maxWidth

    número opcional

    Esta propiedad se puede usar para leer o escribir el ancho máximo actual del contenido o la ventana. Un valor de null indica “sin especificar”.

  • minHeight

    número opcional

    Esta propiedad se puede usar para leer o escribir la altura mínima actual del contenido o la ventana. Un valor de null indica “sin especificar”.

  • minWidth

    número opcional

    Esta propiedad se puede usar para leer o escribir el ancho mínimo actual del contenido o la ventana. Un valor de null indica “sin especificar”.

  • superior

    número

    Esta propiedad se puede usar para leer o escribir la coordenada Y actual del contenido o la ventana.

  • ancho

    número

    Esta propiedad se puede usar para leer o escribir el ancho actual del contenido o la ventana.

  • setMaximumSize

    void

    Establece las restricciones de tamaño máximo del contenido o la ventana. Se puede establecer el ancho o la altura máximos en null para quitar la restricción. Un valor de undefined no modificará la restricción.

    La función setMaximumSize se ve de la siguiente manera: 

    (maxWidth: number,maxHeight: number)=> {...}

    • maxWidth

      número

    • maxHeight

      número

  • setMinimumSize

    void

    Establece las restricciones de tamaño mínimo del contenido o la ventana. Se puede establecer el ancho o la altura mínimos en null para quitar la restricción. Un valor de undefined no modificará la restricción.

    La función setMinimumSize se ve de la siguiente manera: 

    (minWidth: number,minHeight: number)=> {...}

    • minWidth

      número

    • minHeight

      número

  • setPosition

    void

    Establece la posición izquierda y superior del contenido o la ventana.

    La función setPosition se ve de la siguiente manera: 

    (left: number,top: number)=> {...}

    • izquierda

      número

    • superior

      número

  • setSize

    void

    Establezca el ancho y la altura del contenido o la ventana.

    La función setSize se ve de la siguiente manera: 

    (width: number,height: number)=> {...}

    • ancho

      número

    • alto

      número

BoundsSpecification

Propiedades

  • alto

    número opcional

    La altura del contenido o la ventana.

  • izquierda

    número opcional

    La coordenada X del contenido o la ventana.

  • maxHeight

    número opcional

    La altura máxima del contenido o la ventana.

  • maxWidth

    número opcional

    Es el ancho máximo del contenido o la ventana.

  • minHeight

    número opcional

    Es la altura mínima del contenido o la ventana.

  • minWidth

    número opcional

    Es el ancho mínimo del contenido o la ventana.

  • superior

    número opcional

    Es la coordenada Y del contenido o la ventana.

  • ancho

    número opcional

    Es el ancho del contenido o la ventana.

ContentBounds

Propiedades

  • alto

    número opcional

  • izquierda

    número opcional

  • superior

    número opcional

  • ancho

    número opcional

CreateWindowOptions

Propiedades

  • alwaysOnTop

    booleano opcional

    Si es verdadero, la ventana permanecerá encima de la mayoría de las demás ventanas. Si hay varias ventanas de este tipo, la ventana enfocada en ese momento aparecerá en primer plano. Requiere el permiso alwaysOnTopWindows. La configuración predeterminada es "false".

    Llama a setAlwaysOnTop() en la ventana para cambiar esta propiedad después de la creación.

  • límites

    ContentBounds opcional

    Obsoleto

    Usa internalBounds o outerBounds.

    Es el tamaño y la posición del contenido en la ventana (excepto la barra de título). Si también se especifica un ID y se mostró antes una ventana con un ID coincidente, se usarán los límites recordados de la ventana en su lugar.

  • enfocados

    booleano opcional

    Si es verdadero, la ventana se enfocará cuando se cree. El valor predeterminado es verdadero.

  • marco

    string|FrameOptions opcional

    Tipo de marco: none o chrome (el valor predeterminado es chrome). En none, se puede usar la propiedad de CSS -webkit-app-region para aplicar la función de arrastre a la ventana de la app. Se puede usar -webkit-app-region: drag para marcar regiones arrastrables. Se puede usar no-drag para inhabilitar este estilo en elementos anidados.

    El uso de FrameOptions es nuevo en M36.

  • de pesos

    booleano opcional

    Si es verdadero, la ventana se creará en un estado oculto. Llama a show() en la ventana para mostrarlo una vez que se haya creado. La configuración predeterminada es "false".

  • ícono

    cadena opcional

    Chrome 54 y versiones posteriores

    URL del ícono de ventana. Una ventana puede tener su propio ícono cuando showInShelf se establece en verdadero. La URL debe ser global o local de extensión.

  • id

    cadena opcional

    El ID para identificar la ventana. Se usará para recordar el tamaño y la posición de la ventana, y restablecer esa geometría cuando se abra más tarde una ventana con el mismo ID. Si se crea una ventana con un ID determinado mientras ya existe otra con el mismo ID, la ventana abierta actualmente se enfocará en lugar de crear una nueva.

  • innerBounds

    BoundsSpecification opcional

    Se usa para especificar la posición inicial, el tamaño inicial y las restricciones del contenido de la ventana (sin incluir las decoraciones de la ventana). Si también se especifica un id y se mostró antes una ventana con un id coincidente, se usarán los límites recordados en su lugar.

    Ten en cuenta que el SO determina el padding entre los límites interno y externo. Por lo tanto, configurar la misma propiedad de límites para innerBounds y outerBounds generará un error.

    Esta propiedad es nueva en Chrome 36.

  • maxHeight

    número opcional

    Obsoleto

    Usa internalBounds o outerBounds.

    Altura máxima de la ventana.

  • maxWidth

    número opcional

    Obsoleto

    Usa internalBounds o outerBounds.

    Ancho máximo de la ventana.

  • minHeight

    número opcional

    Obsoleto

    Usa internalBounds o outerBounds.

    Altura mínima de la ventana.

  • minWidth

    número opcional

    Obsoleto

    Usa internalBounds o outerBounds.

    Ancho mínimo de la ventana.

  • outerBounds

    BoundsSpecification opcional

    Se usa para especificar la posición inicial, el tamaño inicial y las restricciones de la ventana (incluidas las decoraciones de la ventana, como la barra de título y el marco). Si también se especifica un id y se mostró antes una ventana con un id coincidente, se usarán los límites recordados en su lugar.

    Ten en cuenta que el SO determina el padding entre los límites interno y externo. Por lo tanto, configurar la misma propiedad de límites para innerBounds y outerBounds generará un error.

    Esta propiedad es nueva en Chrome 36.

  • resizable

    booleano opcional

    Si es verdadero, el usuario podrá cambiar el tamaño de la ventana. El valor predeterminado es verdadero.

  • showInShelf

    booleano opcional

    Chrome 54 y versiones posteriores

    Si es verdadero, la ventana tendrá su propio ícono de biblioteca. De lo contrario, la ventana se agrupará en la barra con otras ventanas asociadas con la app. El valor predeterminado es falso. Si showInShelf se establece en true, debes especificar un ID para la ventana.

  • singleton

    booleano opcional

    Obsoleto

    Ya no se admiten varias ventanas con el mismo ID.

    De forma predeterminada, si especificas un ID para la ventana, esta solo se creará si no existe otra con el mismo ID. Si ya existe una ventana con el mismo ID, esa ventana se activa en su lugar. Si deseas crear varias ventanas con el mismo ID, puedes configurar esta propiedad como falsa.

  • state

    Estado opcional

    Es el estado inicial de la ventana, que permite crearla en pantalla completa, maximizada o minimizada. La configuración predeterminada es “normal”.

  • tipo

    WindowType opcional

    Chrome 45 y versiones posteriores Obsoleta desde Chrome 69

    Todas las ventanas de apps usan el tipo de ventana “shell”.

    El tipo de ventana que se creará.

  • visibleOnAllWorkspaces

    booleano opcional

    Si es verdadero y es compatible con la plataforma, la ventana será visible en todos los lugares de trabajo.

FrameOptions

Propiedades

  • activeColor

    cadena opcional

    Permite configurar el color del marco de la ventana cuando está activa. La coloración de marcos solo está disponible si el tipo de marco es chrome.

    La coloración de marcos solo está disponible si el tipo de marco es chrome.

    La coloración de marcos es nueva en Chrome 36.

  • color [color]

    cadena opcional

    Permite establecer el color del marco. La coloración de marcos solo está disponible si el tipo de marco es chrome.

    La coloración de marcos es nueva en Chrome 36.

  • inactiveColor

    cadena opcional

    Permite que el color del marco de la ventana cuando está inactiva se configura de manera diferente al color activo. La coloración de marcos solo está disponible si el tipo de marco es chrome.

    inactiveColor debe usarse junto con color.

    La coloración de marcos es nueva en Chrome 36.

  • tipo

    cadena opcional

    Tipo de marco: none o chrome (el valor predeterminado es chrome).

    En none, se puede usar la propiedad -webkit-app-region de CSS para aplicar la función de arrastre a la ventana de la app.

    Se puede usar -webkit-app-region: drag para marcar regiones arrastrables. Se puede usar no-drag para inhabilitar este estilo en elementos anidados.

State

Estado de una ventana: normal, pantalla completa, maximizada, minimizada

Enum

WindowType

Chrome 45 y versiones posteriores

Especifica el tipo de ventana que se creará.

Enum

"shell"
Tipo de ventana predeterminado.

"panel"
Ventana administrada por el SO (obsoleta).

Métodos

canSetVisibleOnAllWorkspaces()

chrome.app.window.canSetVisibleOnAllWorkspaces()

Si la plataforma actual admite que las ventanas sean visibles en todos los lugares de trabajo

Devuelve

  • boolean

create()

Promesa 
chrome.app.window.create(
  url: string,
  options?: CreateWindowOptions,
  callback?: function,
)

El tamaño y la posición de una ventana se pueden especificar de varias maneras. La opción más simple es no especificar nada, en cuyo caso se usarán un tamaño predeterminado y una posición dependiente de la plataforma.

Para establecer la posición, el tamaño y las restricciones de la ventana, usa las propiedades innerBounds o outerBounds. Los límites internos no incluyen decoraciones de ventanas. Los límites externos incluyen la barra de título y el marco de la ventana. Ten en cuenta que el SO determina el padding entre los límites interno y externo. Por lo tanto, configurar la misma propiedad para los límites internos y externos se considera un error (por ejemplo, configurar innerBounds.left y outerBounds.left).

Para recordar automáticamente las posiciones de las ventanas, puedes proporcionarles IDs. Si una ventana tiene un ID, este ID se utiliza para recordar el tamaño y la posición de la ventana cada vez que se mueve o cambia su tamaño. Luego, se usan este tamaño y esta posición en lugar de los límites especificados en la siguiente apertura de una ventana con el mismo ID. Si necesitas abrir una ventana con un ID en una ubicación que no sea la predeterminada recordada, puedes ocultarla, moverla a la ubicación deseada y mostrarla.

Parámetros

  • url

    cadena

  • Opciones

    CreateWindowOptions opcional

  • callback

    Función opcional

    El parámetro callback se ve de la siguiente manera: 

    (createdWindow: AppWindow)=>void

Devuelve

  • Promise<AppWindow>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

current()

chrome.app.window.current()

Muestra un objeto AppWindow para el contexto actual de la secuencia de comandos (es decir, el objeto "window" de JavaScript). También se puede llamar a esta función en un controlador para un contexto de secuencia de comandos de otra página, por ejemplo: otherWindow.chrome.app.window.current().

Devuelve

get()

chrome.app.window.get(
  id: string,
)

Obtiene un objeto AppWindow con el ID dado. Si no existe ninguna ventana con el ID especificado, se muestra un valor nulo. Este método es nuevo en Chrome 33.

Parámetros

  • id

    cadena

Devuelve

getAll()

chrome.app.window.getAll()

Obtiene un array de todas las ventanas de la app creadas actualmente. Este método es nuevo en Chrome 33.

Devuelve

Eventos

onBoundsChanged

chrome.app.window.onBoundsChanged.addListener(
  callback: function,
)

Se activa cuando se cambia el tamaño de la ventana.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

onClosed

chrome.app.window.onClosed.addListener(
  callback: function,
)

Se activa cuando se cierra la ventana. Ten en cuenta que esto se debe escuchar desde una ventana que no sea la que se cierra, por ejemplo, desde la página en segundo plano. Esto se debe a que la ventana que se cierra estará en proceso de eliminación cuando se active el evento, lo que significa que no funcionarán todas las APIs en el contexto de la secuencia de comandos de la ventana.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

onFullscreened

chrome.app.window.onFullscreened.addListener(
  callback: function,
)

Se activa cuando la ventana está en pantalla completa (ya sea a través de las APIs de AppWindow o HTML5).

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

onMaximized

chrome.app.window.onMaximized.addListener(
  callback: function,
)

Se activa cuando el período se maximiza.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

onMinimized

chrome.app.window.onMinimized.addListener(
  callback: function,
)

Se activa cuando se minimiza la ventana.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    ()=>void

onRestored

chrome.app.window.onRestored.addListener(
  callback: function,
)

Se activa cuando la ventana se restaura y deja de minimizarse o maximizarse.

Parámetros

  • callback

    la función

    El parámetro callback se ve de la siguiente manera: 

    ()=>void