Skip to content

Commit

Permalink
fix: prevent errors when extensions listen for chrome.tabs events (#…
Browse files Browse the repository at this point in the history 
…39770)

* fix: prevent errors when extensions listen for chrome.tabs events

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

* chore: mark events unsupported in Electron

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

---------

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>
  • Loading branch information
@trop @codebytere
trop[bot] and codebytere authored Sep 7, 2023
1 parent 0c450f8 commit 149f314
Showing 1 changed file with 353 additions and 0 deletions.
353 changes: 353 additions & 0 deletions shell/common/extensions/api/tabs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -704,9 +704,362 @@
}
}
],
// Electron does not yet support tab events - we define them here because otherwise extensions crash when
// they try to listen for them.
"events": [
{
"name": "onCreated",
"deprecated": "chrome.tabs.onCreated is not current supported in Electron",
"type": "function",
"description": "Fired when a tab is created. Note that the tab's URL and tab group membership may not be set at the time this event is fired, but you can listen to onUpdated events so as to be notified when a URL is set or the tab is added to a tab group.",
"parameters": [
{
"$ref": "Tab",
"name": "tab",
"description": "Details of the tab that was created."
}
]
},
{
"name": "onUpdated",
"deprecated": "chrome.tabs.onUpdated is not current supported in Electron",
"type": "function",
"description": "Fired when a tab is updated.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "changeInfo",
"description": "Lists the changes to the state of the tab that was updated.",
"properties": {
"status": {
"$ref": "TabStatus",
"optional": true,
"description": "The tab's loading status."
},
"url": {
"type": "string",
"optional": true,
"description": "The tab's URL if it has changed."
},
"groupId": {
"type": "integer",
"optional": true,
"minimum": -1,
"description": "The tab's new group."
},
"pinned": {
"type": "boolean",
"optional": true,
"description": "The tab's new pinned state."
},
"audible": {
"type": "boolean",
"optional": true,
"description": "The tab's new audible state."
},
"discarded": {
"type": "boolean",
"optional": true,
"description": "The tab's new discarded state."
},
"autoDiscardable": {
"type": "boolean",
"optional": true,
"description": "The tab's new auto-discardable state."
},
"mutedInfo": {
"$ref": "MutedInfo",
"optional": true,
"description": "The tab's new muted state and the reason for the change."
},
"favIconUrl": {
"type": "string",
"optional": true,
"description": "The tab's new favicon URL."
},
"title": {
"type": "string",
"optional": true,
"description": "The tab's new title."
}
}
},
{
"$ref": "Tab",
"name": "tab",
"description": "Gives the state of the tab that was updated."
}
]
},
{
"name": "onMoved",
"deprecated": "chrome.tabs.onMoved is not current supported in Electron",
"type": "function",
"description": "Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response to the manually-moved tab. This event is not fired when a tab is moved between windows; for details, see $(ref:tabs.onDetached).",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "moveInfo",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0
},
"fromIndex": {
"type": "integer",
"minimum": 0
},
"toIndex": {
"type": "integer",
"minimum": 0
}
}
}
]
},
{
"name": "onSelectionChanged",
"deprecated": "chrome.tabs.onSelectionChanged is not current supported in Electron",
"type": "function",
"description": "Fires when the selected tab in a window changes.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"description": "The ID of the tab that has become active."
},
{
"type": "object",
"name": "selectInfo",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0,
"description": "The ID of the window the selected tab changed inside of."
}
}
}
]
},
{
"name": "onActiveChanged",
"deprecated": "chrome.tabs.onActiveChanged is not current supported in Electron",
"type": "function",
"description": "Fires when the selected tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to $(ref:tabs.onUpdated) events so as to be notified when a URL is set.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"description": "The ID of the tab that has become active."
},
{
"type": "object",
"name": "selectInfo",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0,
"description": "The ID of the window the selected tab changed inside of."
}
}
}
]
},
{
"name": "onActivated",
"deprecated": "chrome.tabs.onActivated is not current supported in Electron",
"type": "function",
"description": "Fires when the active tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to onUpdated events so as to be notified when a URL is set.",
"parameters": [
{
"type": "object",
"name": "activeInfo",
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"description": "The ID of the tab that has become active."
},
"windowId": {
"type": "integer",
"minimum": 0,
"description": "The ID of the window the active tab changed inside of."
}
}
}
]
},
{
"name": "onHighlightChanged",
"deprecated": "chrome.tabs.onHighlightChanged is not current supported in Electron",
"type": "function",
"description": "Fired when the highlighted or selected tabs in a window changes.",
"parameters": [
{
"type": "object",
"name": "selectInfo",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0,
"description": "The window whose tabs changed."
},
"tabIds": {
"type": "array",
"name": "tabIds",
"items": {
"type": "integer",
"minimum": 0
},
"description": "All highlighted tabs in the window."
}
}
}
]
},
{
"name": "onHighlighted",
"deprecated": "chrome.tabs.onHighlighted is not current supported in Electron",
"type": "function",
"description": "Fired when the highlighted or selected tabs in a window changes.",
"parameters": [
{
"type": "object",
"name": "highlightInfo",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0,
"description": "The window whose tabs changed."
},
"tabIds": {
"type": "array",
"name": "tabIds",
"items": {
"type": "integer",
"minimum": 0
},
"description": "All highlighted tabs in the window."
}
}
}
]
},
{
"name": "onDetached",
"deprecated": "chrome.tabs.onDetached is not current supported in Electron",
"type": "function",
"description": "Fired when a tab is detached from a window; for example, because it was moved between windows.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "detachInfo",
"properties": {
"oldWindowId": {
"type": "integer",
"minimum": 0
},
"oldPosition": {
"type": "integer",
"minimum": 0
}
}
}
]
},
{
"name": "onAttached",
"deprecated": "chrome.tabs.onAttached is not current supported in Electron",
"type": "function",
"description": "Fired when a tab is attached to a window; for example, because it was moved between windows.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "attachInfo",
"properties": {
"newWindowId": {
"type": "integer",
"minimum": 0
},
"newPosition": {
"type": "integer",
"minimum": 0
}
}
}
]
},
{
"name": "onRemoved",
"deprecated": "chrome.tabs.onRemoved is not current supported in Electron",
"type": "function",
"description": "Fired when a tab is closed.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "removeInfo",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0,
"description": "The window whose tab is closed."
},
"isWindowClosing": {
"type": "boolean",
"description": "True when the tab was closed because its parent window was closed."
}
}
}
]
},
{
"name": "onReplaced",
"deprecated": "chrome.tabs.onReplaced is not current supported in Electron",
"type": "function",
"description": "Fired when a tab is replaced with another tab due to prerendering or instant.",
"parameters": [
{
"type": "integer",
"name": "addedTabId",
"minimum": 0
},
{
"type": "integer",
"name": "removedTabId",
"minimum": 0
}
]
},
{
"name": "onZoomChange",
"deprecated": "chrome.tabs.onZoomChange is not current supported in Electron",
"type": "function",
"description": "Fired when a tab is zoomed.",
"parameters": [
Expand Down

0 comments on commit 149f314

Please # to comment.