Always on top extension chrome

CreateType

Specifies what type of browser window to create. 'panel' is deprecated and is available only to existing whitelisted extensions on Chrome OS.

Type

QueryOptions

Properties

• populate

  booleanoptional

  If true, the windows.Window object has a tabs property that contains a list of the tabs.Tab objects. The Tab objects only contain the url, pendingUrl, title, and favIconUrl properties if the extension's manifest file includes the "tabs" permission.

• windowTypes

  WindowType[]optional

  If set, the windows.Window returned is filtered based on its type. If unset, the default filter is set to ['normal', 'popup'].

Window

Properties

• alwaysOnTop

  boolean

  Whether the window is set to be always on top.

• focused

  boolean

  Whether the window is currently the focused window.

• height

  numberoptional

  The height of the window, including the frame, in pixels. In some circumstances a window may not be assigned a height property; for example, when querying closed windows from the sessions API.

• id

  numberoptional

  The ID of the window. Window IDs are unique within a browser session. In some circumstances a window may not be assigned an ID property; for example, when querying windows using the sessions API, in which case a session ID may be present.

• incognito

  boolean

  Whether the window is incognito.

• left

  numberoptional

  The offset of the window from the left edge of the screen in pixels. In some circumstances a window may not be assigned a left property; for example, when querying closed windows from the sessions API.

• sessionId

  stringoptional

  The session ID used to uniquely identify a window, obtained from the sessions API.

• state

  WindowStateoptional

  The state of this browser window.

• tabs

  Tab[]optional

  Array of tabs.Tab objects representing the current tabs in the window.

• top

  numberoptional

  The offset of the window from the top edge of the screen in pixels. In some circumstances a window may not be assigned a top property; for example, when querying closed windows from the sessions API.

• type

  WindowTypeoptional

  The type of browser window this is.

• width

  numberoptional

  The width of the window, including the frame, in pixels. In some circumstances a window may not be assigned a width property; for example, when querying closed windows from the sessions API.

WindowState

The state of this browser window. In some circumstances a window may not be assigned a state property; for example, when querying closed windows from the sessions API.

Type

WindowType

The type of browser window this is. In some circumstances a window may not be assigned a type property; for example, when querying closed windows from the sessions API.

Type

WINDOW_ID_CURRENT

The windowId value that represents the current window.

Value

WINDOW_ID_NONE

The windowId value that represents the absence of a Chrome browser window.

Value

create

Creates [opens] a new browser window with any optional sizing, position, or default URL provided.

Parameters

• createData

  objectoptional
  • focused

    booleanoptional

    If true, opens an active window. If false, opens an inactive window.

  • height

    numberoptional

    The height in pixels of the new window, including the frame. If not specified, defaults to a natural height.

  • incognito

    booleanoptional

    Whether the new window should be an incognito window.

  • left

    numberoptional

    The number of pixels to position the new window from the left edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels.

  • setSelfAsOpener

    booleanoptional
    Chrome 64+

    If true, the newly-created window's 'window.opener' is set to the caller and is in the same unit of related browsing contexts as the caller.

  • state

    WindowStateoptional
    Chrome 44+

    The initial state of the window. The minimized, maximized, and fullscreen states cannot be combined with left, top, width, or height.

  • tabId

    numberoptional

    The ID of the tab to add to the new window.

  • top

    numberoptional

    The number of pixels to position the new window from the top edge of the screen. If not specified, the new window is offset naturally from the last focused window. This value is ignored for panels.

  • type

    CreateTypeoptional

    Specifies what type of browser window to create.

  • url

    string | string[]optional

    A URL or array of URLs to open as tabs in the window. Fully-qualified URLs must include a scheme, e.g., '//www.google.com', not 'www.google.com'. Non-fully-qualified URLs are considered relative within the extension. Defaults to the New Tab Page.

  • width

    numberoptional

    The width in pixels of the new window, including the frame. If not specified, defaults to a natural width.

• callback

  functionoptional

  The callback parameter looks like: [window?: Window] => void

  • window

    Windowoptional

    Contains details about the created window.

Returns

• Promise
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

get

Gets details about a window.

Parameters

• windowId

  number
• queryOptions

  QueryOptionsoptional
  Chrome 88+
• callback

  functionoptional

  The callback parameter looks like: [window: Window] => void

  • window

    Window

Returns

• Promise
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getAll

Gets all windows.

Parameters

• queryOptions

  QueryOptionsoptional
  Chrome 88+
• callback

  functionoptional

  The callback parameter looks like: [windows: Window[]] => void

  • windows

    Window[]

Returns

• Promise
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getCurrent

Gets the current window.

Parameters

• queryOptions

  QueryOptionsoptional
  Chrome 88+
• callback

  functionoptional

  The callback parameter looks like: [window: Window] => void

  • window

    Window

Returns

• Promise
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

getLastFocused

Gets the window that was most recently focused typically the window 'on top'.

Parameters

• queryOptions

  QueryOptionsoptional
  Chrome 88+
• callback

  functionoptional

  The callback parameter looks like: [window: Window] => void

  • window

    Window

Returns

• Promise
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

remove

Removes [closes] a window and all the tabs inside it.

Parameters

• windowId

  number
• callback

  functionoptional

  The callback parameter looks like: [] => void

Returns

• Promise
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

update

Updates the properties of a window. Specify only the properties that to be changed; unspecified properties are unchanged.

Parameters

• windowId

  number
• updateInfo

  object
  • drawAttention

    booleanoptional

    If true, causes the window to be displayed in a manner that draws the user's attention to the window, without changing the focused window. The effect lasts until the user changes focus to the window. This option has no effect if the window already has focus. Set to false to cancel a previous drawAttention request.

  • focused

    booleanoptional

    If true, brings the window to the front; cannot be combined with the state 'minimized'. If false, brings the next window in the z-order to the front; cannot be combined with the state 'fullscreen' or 'maximized'.

  • height

    numberoptional

    The height to resize the window to in pixels. This value is ignored for panels.

  • left

    numberoptional

    The offset from the left edge of the screen to move the window to in pixels. This value is ignored for panels.

  • state

    WindowStateoptional

    The new state of the window. The 'minimized', 'maximized', and 'fullscreen' states cannot be combined with 'left', 'top', 'width', or 'height'.

  • top

    numberoptional

    The offset from the top edge of the screen to move the window to in pixels. This value is ignored for panels.

  • width

    numberoptional

    The width to resize the window to in pixels. This value is ignored for panels.

• callback

  functionoptional

  The callback parameter looks like: [window: Window] => void

  • window

    Window

Returns

• Promise
  Pending

  This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to callback.

onBoundsChanged

Fired when a window has been resized; this event is only dispatched when the new bounds are committed, and not for in-progress changes.

Parameters

• callback

  function

  The callback parameter looks like: [window: Window] => void

  • window

    Window

onCreated

Fired when a window is created.

Parameters

• callback

  function
  Chrome 46+

  The callback parameter looks like: [window: Window] => void

  • window

    Window

    Details of the created window.

• filters

  objectoptional
  • windowTypes

    WindowType[]

    Conditions that the window's type being created must satisfy. By default it satisfies ['normal', 'popup'].

onFocusChanged

Fired when the currently focused window changes. Returns chrome.windows.WINDOW_ID_NONE if all Chrome windows have lost focus. Note: On some Linux window managers, WINDOW_ID_NONE is always sent immediately preceding a switch from one Chrome window to another.

Parameters

• callback

  function
  Chrome 46+

  The callback parameter looks like: [windowId: number] => void

  • windowId

    number

    ID of the newly-focused window.

• filters

  objectoptional
  • windowTypes

    WindowType[]

    Conditions that the window's type being removed must satisfy. By default it satisfies ['normal', 'popup'].

onRemoved

Fired when a window is removed [closed].

Parameters

• callback

  function
  Chrome 46+

  The callback parameter looks like: [windowId: number] => void

  • windowId

    number

    ID of the removed window.

• filters

  objectoptional
  • windowTypes

    WindowType[]

    Conditions that the window's type being removed must satisfy. By default it satisfies ['normal', 'popup'].