chrome.windows

Descrizione

Utilizza l'API chrome.windows per interagire con le finestre del browser. Puoi utilizzare questa API per creare, modificare e riorganizzare le finestre nel browser.

Autorizzazioni

Se richiesto, un windows.Window contiene un array di oggetti tabs.Tab. Devi dichiarare l'autorizzazione "tabs" nel manifest se hai bisogno di accedere alle proprietà url, pendingUrl, title o favIconUrl di tabs.Tab. Ad esempio:

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

Concetti e utilizzo

La finestra corrente

Molte funzioni nel sistema di estensioni accettano un argomento windowId facoltativo, che per impostazione predefinita è la finestra corrente.

La finestra corrente è la finestra che contiene il codice attualmente in esecuzione. È importante tenere presente che questa finestra può essere diversa da quella in primo piano o attiva.

Ad esempio, supponiamo che un'estensione crei alcune schede o finestre da un singolo file HTML e che il file HTML contenga una chiamata a tabs.query(). La finestra corrente è quella che contiene la pagina che ha effettuato la chiamata, indipendentemente dalla finestra in primo piano.

Nel caso dei service worker, il valore della finestra corrente torna all'ultima finestra attiva. In alcune circostanze, potrebbe non essere presente alcuna finestra corrente per le pagine in background.

Esempi

Per provare questa API, installa l'esempio di API di Windows dal repository chrome-extension-samples.

Due finestre, ciascuna con una scheda
Due finestre, ognuna con una scheda.

Tipi

CreateType

Chrome 44+

Specifica il tipo di finestra del browser da creare. "panel" è deprecato ed è disponibile solo per le estensioni autorizzate esistenti su ChromeOS.

Enum

"normale"
Specifica la finestra come finestra standard.

"popup"
Specifica la finestra come finestra popup.

"panel"
Specifica la finestra come pannello.

QueryOptions

Chrome 88+

Proprietà

  • compilare

    booleano facoltativo

    Se è true, l'oggetto windows.Window ha una proprietà tabs che contiene un elenco degli oggetti tabs.Tab. Gli oggetti Tab contengono solo le proprietà url, pendingUrl, title e favIconUrl se il file manifest dell'estensione include l'autorizzazione "tabs".

  • windowTypes

    WindowType[] facoltativo

    Se impostato, il windows.Window restituito viene filtrato in base al tipo. Se non viene impostato, il filtro predefinito è ['normal', 'popup'].

Window

Proprietà

  • alwaysOnTop

    booleano

    Indica se la finestra è impostata per essere sempre in primo piano.

  • Focalizzati

    booleano

    Indica se la finestra è attualmente attiva.

  • altezza

    number (facoltativo)

    L'altezza della finestra, incluso il frame, in pixel. In alcune circostanze, a una finestra potrebbe non essere assegnata una proprietà height, ad esempio quando si esegue una query sulle finestre chiuse dall'API sessions.

  • id

    number (facoltativo)

    L'ID della finestra. Gli ID finestra sono univoci all'interno di una sessione del browser. In alcune circostanze, a una finestra potrebbe non essere assegnata una proprietà ID, ad esempio quando si esegue una query sulle finestre utilizzando l'API sessions, nel qual caso potrebbe essere presente un ID sessione.

  • in incognito

    booleano

    Indica se la finestra è in modalità di navigazione in incognito.

  • sinistra

    number (facoltativo)

    L'offset della finestra dal bordo sinistro dello schermo in pixel. In alcune circostanze, a una finestra potrebbe non essere assegnata una proprietà left, ad esempio quando si esegue una query sulle finestre chiuse dall'API sessions.

  • sessionId

    stringa facoltativa

    L'ID sessione utilizzato per identificare in modo univoco una finestra, ottenuto dall'API sessions.

  • stato

    WindowState facoltativo

    Lo stato di questa finestra del browser.

  • schede

    Tab[] facoltativo

    Array di oggetti tabs.Tab che rappresentano le schede correnti nella finestra.

  • in alto

    number (facoltativo)

    L'offset della finestra dal bordo superiore dello schermo in pixel. In alcune circostanze, a una finestra potrebbe non essere assegnata una proprietà top, ad esempio quando si esegue una query sulle finestre chiuse dall'API sessions.

  • tipo

    WindowType facoltativo

    Il tipo di finestra del browser.

  • larghezza

    number (facoltativo)

    La larghezza della finestra, incluso il frame, in pixel. In alcune circostanze, a una finestra potrebbe non essere assegnata una proprietà width, ad esempio quando si esegue una query sulle finestre chiuse dall'API sessions.

WindowState

Chrome 44+

Lo stato di questa finestra del browser. In alcune circostanze, a una finestra potrebbe non essere assegnata una proprietà state, ad esempio quando si esegue una query sulle finestre chiuse dall'API sessions.

Enum

"normale"
Stato normale della finestra (non ridotta a icona, ingrandita o a schermo intero).

"minimized"
Stato della finestra ridotta a icona.

"maximized"
Stato della finestra massimizzata.

"fullscreen"
Stato della finestra a schermo intero.

"locked-fullscreen"
Stato della finestra a schermo intero bloccata. Non è possibile uscire da questa modalità a schermo intero tramite l'azione dell'utente ed è disponibile solo per le estensioni autorizzate su Chrome OS.

WindowType

Chrome 44+

Il tipo di finestra del browser. In alcune circostanze, a una finestra potrebbe non essere assegnata una proprietà type, ad esempio quando si interrogano finestre chiuse dall'API sessions.

Enum

"normale"
Una normale finestra del browser.

"popup"
Un popup del browser.

"panel"
Obsoleto in questa API. Una finestra in stile pannello delle app Chrome. Le estensioni possono visualizzare solo le proprie finestre del riquadro.

"app"
Deprecato in questa API. Una finestra dell'app Chrome. Le estensioni possono visualizzare solo le finestre della propria app.

"devtools"
Una finestra degli strumenti per sviluppatori.

Proprietà

WINDOW_ID_CURRENT

Il valore windowId che rappresenta la finestra corrente.

Valore

-2

WINDOW_ID_NONE

Il valore windowId che rappresenta l'assenza di una finestra del browser Chrome.

Valore

-1

Metodi

create()

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

Crea (apre) una nuova finestra del browser con le dimensioni, la posizione o l'URL predefinito facoltativi forniti.

Parametri

  • createData

    oggetto facoltativo

    • Focalizzati

      booleano facoltativo

      Se true, si apre una finestra attiva. Se false, si apre una finestra non attiva.

    • altezza

      number (facoltativo)

      L'altezza in pixel della nuova finestra, incluso il frame. Se non specificato, il valore predefinito è un'altezza naturale.

    • in incognito

      booleano facoltativo

      Indica se la nuova finestra deve essere una finestra di navigazione in incognito.

    • sinistra

      number (facoltativo)

      Il numero di pixel per posizionare la nuova finestra dal bordo sinistro dello schermo. Se non viene specificato, il nuovo riquadro viene spostato naturalmente rispetto all'ultimo riquadro attivo. Questo valore viene ignorato per i riquadri.

    • setSelfAsOpener

      booleano facoltativo

      Chrome 64+

      Se true, "window.opener" della finestra appena creata è impostato sul chiamante e si trova nella stessa unità di contesti di navigazione correlati del chiamante.

    • stato

      WindowState facoltativo

      Chrome 44+

      Lo stato iniziale della finestra. Gli stati minimized, maximized e fullscreen non possono essere combinati con left, top, width o height.

    • tabId

      number (facoltativo)

      L'ID della scheda da aggiungere alla nuova finestra.

    • in alto

      number (facoltativo)

      Il numero di pixel per posizionare la nuova finestra dal bordo superiore dello schermo. Se non viene specificato, il nuovo riquadro viene spostato naturalmente rispetto all'ultimo riquadro attivo. Questo valore viene ignorato per i riquadri.

    • tipo

      CreateType facoltativo

      Specifica il tipo di finestra del browser da creare.

    • url

      stringa | stringa[] facoltativo

      Un URL o un array di URL da aprire come schede nella finestra. Gli URL completi devono includere uno schema, ad esempio "http://www.google.com", non "www.google.com". Gli URL non completi vengono considerati relativi all'interno dell'estensione. Per impostazione predefinita, viene visualizzata la pagina Nuova scheda.

    • larghezza

      number (facoltativo)

      La larghezza in pixel della nuova finestra, incluso il frame. Se non specificato, il valore predefinito è una larghezza naturale.

Resi

  • Promise<Window | undefined>

    Chrome 88+

get()

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

Recupera i dettagli di una finestra.

Parametri

  • windowId

    numero

  • queryOptions

    QueryOptions facoltativo

    Chrome 88+

Resi

getAll()

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

Riceve tutte le finestre.

Parametri

Resi

  • Promise<Window[]>

    Chrome 88+

getCurrent()

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

Ottiene la finestra corrente.

Parametri

Resi

getLastFocused()

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

Recupera la finestra su cui è stato eseguito l'ultimo focus, in genere la finestra "in primo piano".

Parametri

Resi

remove()

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

Rimuove (chiude) una finestra e tutte le schede al suo interno.

Parametri

  • windowId

    numero

Resi

  • Promise<void>

    Chrome 88+

update()

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

Aggiorna le proprietà di una finestra. Specifica solo le proprietà da modificare; le proprietà non specificate rimangono invariate.

Parametri

  • windowId

    numero

  • updateInfo

    oggetto

    • drawAttention

      booleano facoltativo

      Se true, la finestra viene visualizzata in modo da attirare l'attenzione dell'utente, senza modificare la finestra attiva. L'effetto dura finché l'utente non sposta il focus sulla finestra. Questa opzione non ha effetto se la finestra è già attiva. Imposta false per annullare una precedente richiesta di drawAttention.

    • Focalizzati

      booleano facoltativo

      Se true, porta la finestra in primo piano; non può essere combinato con lo stato "ridotto a icona". Se false, porta in primo piano la finestra successiva nell'ordine Z; non può essere combinato con lo stato "schermo intero" o "ingrandita".

    • altezza

      number (facoltativo)

      L'altezza a cui ridimensionare la finestra in pixel. Questo valore viene ignorato per i riquadri.

    • sinistra

      number (facoltativo)

      L'offset dal bordo sinistro dello schermo a cui spostare la finestra in pixel. Questo valore viene ignorato per i riquadri.

    • stato

      WindowState facoltativo

      Il nuovo stato della finestra. Gli stati "ridotto a icona", "ingrandito" e "a schermo intero" non possono essere combinati con "sinistra", "alto", "larghezza" o "altezza".

    • in alto

      number (facoltativo)

      L'offset dal bordo superiore dello schermo a cui spostare la finestra in pixel. Questo valore viene ignorato per i riquadri.

    • larghezza

      number (facoltativo)

      La larghezza a cui ridimensionare la finestra in pixel. Questo valore viene ignorato per i riquadri.

Resi

Eventi

onBoundsChanged

Chrome 86+ 
chrome.windows.onBoundsChanged.addListener(
  callback: function,
)

Attivato quando una finestra è stata ridimensionata. Questo evento viene inviato solo quando vengono applicati i nuovi limiti e non per le modifiche in corso.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (window: Window) => void

onCreated

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

Attivato quando viene creata una finestra.

Parametri

  • callback

    funzione

    Chrome 46 o versioni successive

    Il parametro callback ha il seguente aspetto: 

    (window: Window) => void

    • finestra

      Finestra

      Dettagli della finestra creata.

  • filtri

    oggetto facoltativo

    • windowTypes

      WindowType[]

      Condizioni che il tipo di finestra in fase di creazione deve soddisfare. Per impostazione predefinita, soddisfa ['normal', 'popup'].

onFocusChanged

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

Attivato quando cambia la finestra attualmente selezionata. Restituisce chrome.windows.WINDOW_ID_NONE se tutte le finestre di Chrome hanno perso lo stato attivo. Nota:in alcuni window manager Linux, WINDOW_ID_NONE viene sempre inviato immediatamente prima di passare da una finestra di Chrome all'altra.

Parametri

  • callback

    funzione

    Chrome 46 o versioni successive

    Il parametro callback ha il seguente aspetto: 

    (windowId: number) => void

    • windowId

      numero

      ID della finestra appena messa a fuoco.

  • filtri

    oggetto facoltativo

    • windowTypes

      WindowType[]

      Condizioni che devono essere soddisfatte per la rimozione del tipo di finestra. Per impostazione predefinita, soddisfa ['normal', 'popup'].

onRemoved

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

Attivato quando una finestra viene rimossa (chiusa).

Parametri

  • callback

    funzione

    Chrome 46 o versioni successive

    Il parametro callback ha il seguente aspetto: 

    (windowId: number) => void

    • windowId

      numero

      ID della finestra rimossa.

  • filtri

    oggetto facoltativo

    • windowTypes

      WindowType[]

      Condizioni che devono essere soddisfatte per la rimozione del tipo di finestra. Per impostazione predefinita, soddisfa ['normal', 'popup'].