תיאור
שימוש ב-API של chrome.tabs
כדי לקיים אינטראקציה עם מערכת הכרטיסיות של הדפדפן. אפשר להשתמש ב-API הזה כדי ליצור, לשנות ולסדר מחדש כרטיסיות בדפדפן.
סקירה כללית
ה-Tabs API לא רק מציע תכונות לשינוי ולניהול כרטיסיות, אלא גם יכול לזהות השפה של הכרטיסייה, לצלם צילום מסך ולאחר מכן תקשורת עם סקריפטים של תוכן בכרטיסיות.
הרשאות
רוב התכונות לא דורשות הרשאות כדי להשתמש בהן. לדוגמה: יצירת כרטיסייה חדשה, טעינה מחדש של כרטיסייה, ניווט לכתובת URL אחרת וכו'
יש שלוש הרשאות שהמפתחים צריכים להכיר במהלך העבודה עם Tabs API.
- הכרטיסיות הרשאה
- ההרשאה הזו לא מעניקה גישה למרחב השמות
chrome.tabs
. במקום זאת, מעניק לתוסף את היכולת להפעילtabs.query()
מול 4 מאפיינים רגישים ב-tabs.Tab
מופעים:url
,pendingUrl
,title
וגםfavIconUrl
. - הרשאות המארח
- הרשאות מארח מאפשרות לתוסף לקרוא את ארבע הרגישות של כרטיסייה תואמת ולשלוח שאילתות
tabs.Tab
נכסים. הם יכולים גם לבצע אינטראקציה ישירות עם הכרטיסיות התואמות באמצעות שיטות כמו בתורtabs.captureVisibleTab()
,tabs.executeScript()
,tabs.insertCSS()
וגםtabs.removeCSS()
. - הכרטיסייה ActiveTab הרשאה
activeTab
מעניקה הרשאת מארח זמנית של תוסף לכרטיסייה הנוכחית ב תגובה להפעלה של משתמש. בניגוד להרשאות המארח, הפקודהactiveTab
לא מפעילה אזהרות.
מניפסט
דוגמאות להצהרה על כל הרשאה במניפסט:
{
"name": "My extension",
...
"permissions": [
"tabs"
],
...
}
{
"name": "My extension",
...
"host_permissions": [
"http://*/*",
"https://*/*"
],
...
}
{
"name": "My extension",
...
"permissions": [
"activeTab"
],
...
}
תרחישים לדוגמה
בקטעים הבאים מתוארים כמה תרחישים נפוצים לדוגמה.
פתיחה של דף תוסף בכרטיסייה חדשה
דפוס נפוץ של תוספים הוא פתיחת דף הצטרפות בכרטיסייה חדשה כשהתוסף: מותקנת. בדוגמה הבאה אפשר לראות איך לעשות את זה.
background.js:
chrome.runtime.onInstalled.addListener(({reason}) => {
if (reason === 'install') {
chrome.tabs.create({
url: "onboarding.html"
});
}
});
הצגת הכרטיסייה הנוכחית
דוגמה זו ממחישה כיצד Service Worker של תוסף יכול לאחזר את הכרטיסייה הפעילה חלון שמתמקד בו באותו רגע (או החלון האחרון שהתמקדתם בו, אם לא מתמקדים בחלונות של Chrome). הזה בדרך כלל נחשב ככרטיסייה הנוכחית של המשתמש.
async function getCurrentTab() {
let queryOptions = { active: true, lastFocusedWindow: true };
// `tab` will either be a `tabs.Tab` instance or `undefined`.
let [tab] = await chrome.tabs.query(queryOptions);
return tab;
}
function getCurrentTab(callback) {
let queryOptions = { active: true, lastFocusedWindow: true };
chrome.tabs.query(queryOptions, ([tab]) => {
if (chrome.runtime.lastError)
console.error(chrome.runtime.lastError);
// `tab` will either be a `tabs.Tab` instance or `undefined`.
callback(tab);
});
}
השתקת הכרטיסייה שצוינה
הדוגמה הזו מראה איך תוסף יכול להחליף את מצב ההשתקה של כרטיסייה נתונה.
async function toggleMuteState(tabId) {
const tab = await chrome.tabs.get(tabId);
const muted = !tab.mutedInfo.muted;
await chrome.tabs.update(tabId, {muted});
console.log(`Tab ${tab.id} is ${muted ? "muted" : "unmuted"}`);
}
function toggleMuteState(tabId) {
chrome.tabs.get(tabId, async (tab) => {
let muted = !tab.mutedInfo.muted;
await chrome.tabs.update(tabId, { muted });
console.log(`Tab ${tab.id} is ${ muted ? "muted" : "unmuted" }`);
});
}
העברת הכרטיסייה הנוכחית למיקום הראשון כשלוחצים עליה
הדוגמה הזו מראה איך להזיז כרטיסייה בזמן שגרירה מתבצעת או לא. אומנם הדוגמה הזאת
משתמש ב-chrome.tabs.move
, תוכל להשתמש באותו דפוס המתנה לשיחות אחרות שמשנות כרטיסיות בזמן
מתבצע גרירה.
chrome.tabs.onActivated.addListener(moveToFirstPosition);
async function moveToFirstPosition(activeInfo) {
try {
await chrome.tabs.move(activeInfo.tabId, {index: 0});
console.log("Success.");
} catch (error) {
if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
setTimeout(() => moveToFirstPosition(activeInfo), 50);
} else {
console.error(error);
}
}
}
chrome.tabs.onActivated.addListener(moveToFirstPositionMV2);
function moveToFirstPositionMV2(activeInfo) {
chrome.tabs.move(activeInfo.tabId, { index: 0 }, () => {
if (chrome.runtime.lastError) {
const error = chrome.runtime.lastError;
if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
setTimeout(() => moveToFirstPositionMV2(activeInfo), 50);
} else {
console.error(error);
}
} else {
console.log("Success.");
}
});
}
העברת הודעה לסקריפט התוכן של כרטיסייה שנבחרה
הדוגמה הזו ממחישה איך קובץ Service Worker של תוסף יכול לתקשר עם סקריפטים של תוכן בכרטיסיות מסוימות בדפדפן באמצעות tabs.sendMessage()
.
function sendMessageToActiveTab(message) {
const [tab] = await chrome.tabs.query({ active: true, lastFocusedWindow: true });
const response = await chrome.tabs.sendMessage(tab.id, message);
// TODO: Do something with the response.
}
דוגמאות לתוספים
להדגמות נוספות של תוספי Tabs API, נסו את הפתרונות הבאים:
סוגים
MutedInfo
מצב ההשתקה של הכרטיסייה והסיבה לשינוי המצב האחרון.
מאפיינים
-
extensionId
מחרוזת אופציונלי
המזהה של התוסף ששינה את מצב ההשתקה. המדיניות לא מוגדרת אם תוסף לא היה הסיבה לשינוי האחרון של מצב ההשתקה.
-
הושתק
בוליאני
האם הכרטיסייה מושתקת (לא ניתן להשמיע צליל). יכול להיות שהכרטיסייה תושתק גם אם היא לא הושמעה או שלא מושמעת כרגע צליל. שווה ערך לפרמטר 'מושתק' אינדיקטור האודיו מוצג.
-
סיבה
MutedInfoReason אופציונלי
הסיבה להשתקה או לביטול ההשתקה של הכרטיסייה. המדיניות לא מוגדרת אם מצב ההשתקה של הכרטיסייה לא השתנה מעולם.
MutedInfoReason
אירוע שגרם לשינוי במצב מושתק.
Enum
"משתמש"
פעולה של קלט משתמשים הגדירה את מצב ההשתקה.
"צילום"
צילום הכרטיסייה התחיל, מה שחייב שינוי של מצב מושתק.
"extension" (תוסף)
תוסף, שמזוהה באמצעות השדה extensionsId, מגדיר את מצב ההשתקה.
Tab
מאפיינים
-
פעיל
בוליאני
האם הכרטיסייה פעילה בחלון שלה. זה לא בהכרח אומר שהחלון ממוקדים.
-
audible, אודיבל
ערך בוליאני אופציונלי
Chrome 45+האם הכרטיסייה השמיעה צליל במהלך השניות האחרונות (אבל ייתכן שהוא לא יושמע אם גם הוא מושתק). שווה ערך ל'אודיו מהרמקול' סימן ויזואלי מוצג.
-
autoDiscardable
בוליאני
Chrome 54+ההגדרה קובעת אם הדפדפן יכול למחוק את הכרטיסייה באופן אוטומטי כשהמשאבים נמוכים.
-
דחית את
בוליאני
Chrome 54+האם הכרטיסייה נמחקה. כרטיסייה שנמחקה היא כרטיסייה שהתוכן שלה הוסר מהזיכרון, אבל הוא עדיין מופיע בשורת הכרטיסיות. התוכן שלו ייטען מחדש בפעם הבאה שהוא יופעל.
-
favIconUrl
מחרוזת אופציונלי
כתובת ה-URL של סמל האתר של הכרטיסייה. הנכס הזה קיים רק אם המניפסט של התוסף כולל את ההרשאה
"tabs"
. אם הכרטיסייה נטענת, יכול להיות שזו גם מחרוזת ריקה. -
groupId
number
Chrome מגרסה 88 ואילךהמזהה של הקבוצה שאליה הכרטיסייה שייכת.
-
גובה
מספר אופציונלי
גובה הכרטיסייה בפיקסלים.
-
מודגש
בוליאני
האם הכרטיסייה מודגשת.
-
id [מזהה]
מספר אופציונלי
המזהה של הכרטיסייה. מזהי הכרטיסיות הם ייחודיים בהפעלה של הדפדפן. במקרים מסוימים לא ניתן להקצות מזהה לכרטיסייה. לדוגמה, כשמריצים שאילתות על כרטיסיות זרות באמצעות API
sessions
, ובמקרה כזה יכול להיות מזהה סשן. אפשר גם להגדיר את מזהה הכרטיסייה כ-chrome.tabs.TAB_ID_NONE
עבור אפליקציות וחלונות של כלי פיתוח. -
גלישה פרטית
בוליאני
האם הכרטיסייה בחלון פרטי.
-
index
number
האינדקס מבוסס אפס של הכרטיסייה בתוך החלון שלה.
-
lastAccessed
number
Chrome 121 ואילךהפעם האחרונה שבוצעה גישה לכרטיסייה כמספר אלפיות השנייה מאז נקודת ההתחלה.
-
mutedInfo
MutedInfo אופציונלי
Chrome 46 ואילךמצב ההשתקה של הכרטיסייה והסיבה לשינוי המצב האחרון.
-
openerTabId
מספר אופציונלי
מזהה הכרטיסייה שפתחה את הכרטיסייה הזו, אם יש כזו. המאפיין הזה קיים רק אם כרטיסיית הפתיחה עדיין קיימת.
-
pendingUrl
מחרוזת אופציונלי
Chrome מגרסה 79 ואילךכתובת ה-URL שאליה הכרטיסייה עוברת, לפני שתחייב אותה. הנכס הזה מוצג רק אם המניפסט של התוסף כולל את ההרשאה
"tabs"
, וקיים ניווט בהמתנה. -
מוצמד
בוליאני
האם הכרטיסייה מוצמדת.
-
נבחר
בוליאני
הוצא משימושיש להשתמש ב-
tabs.Tab.highlighted
.האם הכרטיסייה נבחרה.
-
sessionId
מחרוזת אופציונלי
מזהה הסשן שמשמש לזיהוי ייחודי של כרטיסייה שהתקבלה מה-API של
sessions
. -
status
TabStatus אופציונלי
סטטוס הטעינה של הכרטיסייה.
-
title
מחרוזת אופציונלי
כותרת הכרטיסייה. הנכס הזה קיים רק אם המניפסט של התוסף כולל את ההרשאה
"tabs"
. -
כתובת אתר
מחרוזת אופציונלי
כתובת ה-URL האחרונה שבוצעה במסגרת ההתחייבות של המסגרת הראשית של הכרטיסייה. המאפיין הזה מוצג רק אם המניפסט של התוסף כולל את ההרשאה
"tabs"
, והוא יכול להיות מחרוזת ריקה אם הכרטיסייה עדיין לא מחויבת. למידע נוסף, ראוTab.pendingUrl
. -
רוחב
מספר אופציונלי
רוחב הכרטיסייה בפיקסלים.
-
windowId
number
מזהה החלון שמכיל את הכרטיסייה.
TabStatus
סטטוס הטעינה של הכרטיסייה.
Enum
"לא נטענו"
"בטעינה"
"complete"
WindowType
סוג החלון.
Enum
"רגיל"
"חלון קופץ"
"panel"
"אפליקציה"
"devtools"
ZoomSettings
מגדירה את אופן הטיפול בשינויי מרחק מתצוגה בכרטיסייה ובאיזה היקף.
מאפיינים
-
defaultZoomFactor
מספר אופציונלי
Chrome 43 ואילךמשמש להחזרת רמת הזום המוגדרת כברירת מחדל בכרטיסייה הנוכחית בשיחות לכרטיסיות.getZoomSettings.
-
מצב
ZoomSettingsMode optional
מגדיר את אופן הטיפול בשינויי זום, כלומר איזו יישות אחראית להתאמה לעומס (scaling) של הדף בפועל. ברירת המחדל היא
automatic
. -
היקף
ZoomSettingsScope אופציונלי
מגדיר אם השינויים מרחק התצוגה יישארו בתוקף עבור מקור הדף, או רק בכרטיסייה הזו. ברירת המחדל היא
per-origin
במצבautomatic
. אחרת, ברירת המחדל היאper-tab
.
ZoomSettingsMode
מגדיר את אופן הטיפול בשינויי זום, כלומר איזו יישות אחראית להתאמה לעומס (scaling) של הדף בפועל. ברירת המחדל היא automatic
.
Enum
'אוטומטית'
הדפדפן מטפל בשינויים בזום באופן אוטומטי.
"ידני"
ביטול הטיפול האוטומטי בשינויי זום. האירוע onZoomChange
עדיין יישלח, והתוסף אחראי להאזין לאירוע הזה ולשנות את קנה המידה של הדף באופן ידני. במצב הזה אי אפשר לשנות את מרחק התצוגה ב-per-origin
, ולכן מתעלם מהגדרת הזום של scope
ומבוסס על per-tab
.
"מושבת"
השבתת כל שינוי מרחק התצוגה בכרטיסייה. הכרטיסייה תחזור לברירת המחדל של מרחק התצוגה ותתעלם מכל השינויים שבוצעו בשינוי מרחק התצוגה.
ZoomSettingsScope
מגדיר אם השינויים מרחק התצוגה יישארו בתוקף עבור מקור הדף, או רק בכרטיסייה הזו. ברירת המחדל היא per-origin
במצב automatic
. אחרת, ברירת המחדל היא per-tab
.
Enum
"per-origin"
שינויי הזום נשארים תמיד במקור של הדף עם התצוגה המקדימה. כלומר, גם כל שאר הכרטיסיות שמנווטים לאותו מקור מוגדלות. בנוסף, per-origin
שינויים בזום נשמרים עם המקור. כלומר, כשעוברים לדפים אחרים באותו מקור, כולם מוקטנים לאותו גורם של שינוי מרחק התצוגה. ההיקף per-origin
זמין רק במצב automatic
.
'לכל כרטיסייה'
שינויים בזום נכנסים לתוקף רק בכרטיסייה הזו, ושינויים בזום בכרטיסיות אחרות לא משפיעים על ההגדלה של התצוגה בכרטיסייה הזו. בנוסף, per-tab
שינויים בזום יאופסו בניווט. כשמנווטים בכרטיסייה תמיד נטענים דפים עם per-origin
הגורמים של שינוי מרחק התצוגה.
מאפיינים
MAX_CAPTURE_VISIBLE_TAB_CALLS_PER_SECOND
מספר הפעמים המקסימלי שניתן לקרוא ל-captureVisibleTab
בשנייה. captureVisibleTab
הוא יקר ולא צריך להתקשר אליו בתדירות גבוהה מדי.
ערך
2
TAB_ID_NONE
מזהה שמייצג את היעדר כרטיסייה בדפדפן.
ערך
-1
TAB_INDEX_NONE
אינדקס שמייצג את היעדר אינדקס כרטיסיות ברצועת כרטיסיות.
ערך
-1
שיטות
captureVisibleTab()
chrome.tabs.captureVisibleTab(
windowId?: number,
options?: ImageDetails,
callback?: function,
)
תיעוד האזור הגלוי של הכרטיסייה שפעילה עכשיו בחלון שצוין. כדי להפעיל את השיטה הזו, לתוסף צריכה להיות ההרשאה <all_urls> או ההרשאה activeTab. בנוסף לאתרים שבדרך כלל יש לתוספים גישה אליהם, השיטה הזו מאפשרת לתוספים לתעד אתרים רגישים שיש עליהם הגבלות, כולל דפים מסוג chrome:scheme ותוספים אחרים. ולנתונים: כתובות URL. אפשר לצלם את האתרים הרגישים האלה רק באמצעות ההרשאה ActiveTab. ניתן לתעד כתובות URL של קבצים רק אם לתוסף ניתנה גישה לקובץ.
פרמטרים
-
windowId
מספר אופציונלי
חלון היעד. ברירת המחדל היא החלון הנוכחי.
-
אפשרויות
ImageDetails אופציונלי
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(dataUrl: string) => void
-
dataUrl
מחרוזת
כתובת URL של נתונים שמקודדת תמונה של האזור הגלוי בכרטיסייה שצולמה. ניתן להקצות ל-'src' של רכיב HTML
img
לתצוגה.
-
החזרות
-
Promise<string>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
connect()
chrome.tabs.connect(
tabId: number,
connectInfo?: object,
)
מתחבר לסקריפטים של התוכן בכרטיסייה שצוינה. האירוע runtime.onConnect
מופעל בכל סקריפט תוכן שפועל בכרטיסייה שצוינה עבור התוסף הנוכחי. לפרטים נוספים, אפשר לעיין במאמר בנושא העברת הודעות באמצעות Content Script.
פרמטרים
-
tabId
number
-
connectInfo
אובייקט אופציונלי
-
documentId
מחרוזת אופציונלי
Chrome 106+פותחים יציאה אל מסמך ספציפי שזוהה על ידי
documentId
במקום כל הפריימים בכרטיסייה. -
frameId
מספר אופציונלי
פותחים יציאה למסגרת ספציפית שזוהה על ידי
frameId
במקום לכל המסגרות בכרטיסייה. -
שם
מחרוזת אופציונלי
מועבר אל onConnect עבור סקריפטים של תוכן שמאזינים לאירוע החיבור.
-
החזרות
-
יציאה שיכולה לשמש לתקשורת עם סקריפטים של התוכן שפועלים בכרטיסייה שצוינה. האירוע
runtime.Port
של השקע מופעל אם הכרטיסייה נסגרת או לא קיימת.
create()
chrome.tabs.create(
createProperties: object,
callback?: function,
)
יצירת כרטיסייה חדשה.
פרמטרים
-
createProperties
אובייקט
-
פעיל
ערך בוליאני אופציונלי
אם הכרטיסייה צריכה להפוך לכרטיסייה הפעילה בחלון. לא תהיה לכך השפעה על התמקדות החלון (ראו
windows.update
). ברירת המחדל היאtrue
. -
index
מספר אופציונלי
המיקום שהכרטיסייה צריכה להופיע בחלון. הערך שצוין מוצמד לאפס ולמספר הכרטיסיות בחלון.
-
openerTabId
מספר אופציונלי
המזהה של הכרטיסייה שפתחה את הכרטיסייה. אם מוגדרת, לשונית הפתיחה חייבת להופיע באותו חלון שבו נמצאת הכרטיסייה החדשה שנוצרה.
-
מוצמד
ערך בוליאני אופציונלי
האם צריך להצמיד את הכרטיסייה. ברירת המחדל היא
false
. -
נבחר
ערך בוליאני אופציונלי
הוצא משימושיש להשתמש בערך פעיל.
האם הכרטיסייה צריכה להפוך לכרטיסייה שנבחרה בחלון. ברירת המחדל היא
true
. -
כתובת אתר
מחרוזת אופציונלי
כתובת ה-URL שאליה רוצים לנווט בהתחלה בכרטיסייה. כתובות URL שמוגדרות במלואן חייבות לכלול סכמה (כלומר, 'http://www.google.com' ולא 'www.google.com'). כתובות URL יחסיות הן יחסיות לדף הנוכחי שבתוך התוסף. ברירת המחדל היא דף הכרטיסייה החדשה.
-
windowId
מספר אופציונלי
החלון שבו יש ליצור את הכרטיסייה החדשה. ברירת המחדל היא החלון הנוכחי.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(tab: Tab) => void
-
כרטיסייה
הכרטיסייה שנוצרה.
-
החזרות
-
התחייבות<Tab>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
detectLanguage()
chrome.tabs.detectLanguage(
tabId?: number,
callback?: function,
)
מזהה את השפה הראשית של התוכן בכרטיסייה.
פרמטרים
-
tabId
מספר אופציונלי
ברירת המחדל היא הכרטיסייה הפעילה של החלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(language: string) => void
-
language
מחרוזת
קוד שפה לפי תקן ISO, כמו
en
אוfr
. לרשימה מלאה של השפות שנתמכות בשיטה הזו: kLanguageInfoTable. העמודות השנייה עד הרביעית מסומנת ומוחזר הערך הראשון שאינו NULL, מלבד סינית פשוטה שעבורה מוחזרzh-CN
. בשביל שפה לא ידועה או לא מוגדרת, מוחזרund
.
-
החזרות
-
Promise<string>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
discard()
chrome.tabs.discard(
tabId?: number,
callback?: function,
)
מחיקת כרטיסייה מהזיכרון. כרטיסיות שנמחקו ימשיכו להופיע בשורת הכרטיסיות והן נטענות מחדש לאחר ההפעלה.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה שרוצים למחוק. אם הכרטיסייה מוגדרת, הכרטיסייה תימחק, אלא אם היא פעילה או כבר נמחקה. אם לא מציינים את זה, הדפדפן ימחק את הכרטיסייה הכי פחות חשובה. פעולה זו עלולה להיכשל אם אין כרטיסיות שניתן למחוק.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(tab?: Tab) => void
-
כרטיסייה
Tab אופציונלי
הכרטיסייה שנמחקה, אם היא נמחקה. ולא מוגדר אחרת.
-
החזרות
-
Promise<Tab | לא מוגדר>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
duplicate()
chrome.tabs.duplicate(
tabId: number,
callback?: function,
)
משכפל כרטיסייה.
פרמטרים
-
tabId
number
מזהה הכרטיסייה שרוצים לשכפל.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(tab?: Tab) => void
החזרות
-
Promise<Tab | לא מוגדר>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
executeScript()
chrome.tabs.executeScript(
tabId?: number,
details: InjectDetails,
callback?: function,
)
הוחלף על ידי scripting.executeScript
במניפסט מגרסה V3.
מחדיר קוד JavaScript לדף. פרטים נוספים מופיעים בקטע הזרקה פרוגרמטית במסמך בנושא סקריפטים של תוכן.
פרמטרים
-
tabId
מספר אופציונלי
המזהה של הכרטיסייה שבה צריך להריץ את הסקריפט. הכרטיסייה הפעילה של החלון הנוכחי כברירת מחדל.
-
פרטים
פרטי הסקריפט להרצה. יש להגדיר את הקוד או את מאפייני הקובץ, אבל לא ניתן להגדיר את שניהם בו-זמנית.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(result?: any[]) => void
-
תוצאה
כל[] אופציונלי
התוצאה של הסקריפט בכל מסגרת שהוחדרה.
-
החזרות
-
Promise<any[] | לא מוגדר>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
get()
chrome.tabs.get(
tabId: number,
callback?: function,
)
אחזור פרטים על הכרטיסייה שצוינה.
פרמטרים
-
tabId
number
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(tab: Tab) => void
-
כרטיסייה
-
החזרות
-
התחייבות<Tab>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getAllInWindow()
chrome.tabs.getAllInWindow(
windowId?: number,
callback?: function,
)
יש להשתמש ב-tabs.query
{windowId: windowId}
.
קבלת פרטים על כל הכרטיסיות בחלון שצוין.
פרמטרים
-
windowId
מספר אופציונלי
ברירת המחדל היא החלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(tabs: Tab[]) => void
-
כרטיסיות
Tab[]
-
החזרות
-
התחייבות<Tab[]>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getCurrent()
chrome.tabs.getCurrent(
callback?: function,
)
קבלת הכרטיסייה שממנה מתבצעת הקריאה לסקריפט. הפונקציה מחזירה את הערך undefined
אם היא נקראת מהקשר שאינו כרטיסייה (לדוגמה, דף רקע או תצוגה קופצת).
פרמטרים
החזרות
-
Promise<Tab | לא מוגדר>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getSelected()
chrome.tabs.getSelected(
windowId?: number,
callback?: function,
)
יש להשתמש ב-tabs.query
{active: true}
.
הפונקציה מקבלת את הכרטיסייה שנבחרה בחלון שצוין.
פרמטרים
-
windowId
מספר אופציונלי
ברירת המחדל היא החלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(tab: Tab) => void
-
כרטיסייה
-
החזרות
-
התחייבות<Tab>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getZoom()
chrome.tabs.getZoom(
tabId?: number,
callback?: function,
)
הפונקציה מקבלת את הגורם הנוכחי לשינוי מרחק התצוגה של כרטיסייה ספציפית.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה שממנה יש לקבל את גורם הזום הנוכחי; הכרטיסייה הפעילה של החלון הנוכחי כברירת מחדל.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(zoomFactor: number) => void
-
zoomFactor
number
הגורם הנוכחי של מרחק התצוגה בכרטיסייה.
-
החזרות
-
Promise<number>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getZoomSettings()
chrome.tabs.getZoomSettings(
tabId?: number,
callback?: function,
)
קבלת ההגדרות הנוכחיות של שינוי מרחק התצוגה של כרטיסייה ספציפית.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה שממנה יתקבלו ההגדרות הנוכחיות של מרחק התצוגה; הכרטיסייה הפעילה של החלון הנוכחי כברירת מחדל.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(zoomSettings: ZoomSettings) => void
-
zoomSettings
ההגדרות הנוכחיות של שינוי מרחק התצוגה בכרטיסייה.
-
החזרות
-
Promise<ZoomSettings>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
goBack()
chrome.tabs.goBack(
tabId?: number,
callback?: function,
)
אם יש דף קיים, אפשר לחזור לדף הקודם.
פרמטרים
-
tabId
מספר אופציונלי
המזהה של הכרטיסייה שצריך לנווט חזרה. ברירת המחדל של הכרטיסייה הנבחרת של החלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
goForward()
chrome.tabs.goForward(
tabId?: number,
callback?: function,
)
המשיכו לדף הבא, אם קיים.
פרמטרים
-
tabId
מספר אופציונלי
המזהה של הכרטיסייה שצריך לנווט קדימה. ברירת המחדל של הכרטיסייה הנבחרת של החלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
group()
chrome.tabs.group(
options: object,
callback?: function,
)
הוספת כרטיסייה אחת או יותר לקבוצה מוגדרת. אם לא צוינה קבוצה, מוסיפים את הכרטיסיות הנתונות לקבוצה חדשה שנוצרה.
פרמטרים
-
אפשרויות
אובייקט
-
createProperties
אובייקט אופציונלי
הגדרות ליצירת קבוצה. לא ניתן להשתמש אם הפרמטר groupId כבר צוין.
-
windowId
מספר אופציונלי
החלון של הקבוצה החדשה. ברירת המחדל היא החלון הנוכחי.
-
-
groupId
מספר אופציונלי
מזהה הקבוצה שאליה רוצים להוסיף את הכרטיסיות. אם לא מציינים זאת, המערכת תיצור קבוצה חדשה.
-
tabIds
מספר | [מספר, ...מספר[]]
מזהה הכרטיסייה או רשימת מזהי הכרטיסיות שצריך להוסיף לקבוצה שצוינה.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(groupId: number) => void
-
groupId
number
מזהה הקבוצה שאליה נוספו הכרטיסיות.
-
החזרות
-
Promise<number>
הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
highlight()
chrome.tabs.highlight(
highlightInfo: object,
callback?: function,
)
מדגישה את הכרטיסיות הנתונות ומתמקדת בקבוצה הראשונה. נראה שלא תתבצע שום פעולה אם הכרטיסייה שצוינה פעילה כרגע.
פרמטרים
-
highlightInfo
אובייקט
-
כרטיסיות
מספר | מספר[]
אינדקס כרטיסייה אחד או יותר להדגשה.
-
windowId
מספר אופציונלי
החלון שמכיל את הכרטיסיות.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(window: Window) => void
-
חלון
מכיל פרטים על החלון שהכרטיסיות שלו הודגשו.
-
החזרות
-
Promise<windows.Window>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
insertCSS()
chrome.tabs.insertCSS(
tabId?: number,
details: InjectDetails,
callback?: function,
)
הוחלף על ידי scripting.insertCSS
במניפסט מגרסה V3.
החדרת CSS לדף. אפשר להסיר סגנונות שנוספו בשיטה הזו באמצעות scripting.removeCSS
. פרטים נוספים מופיעים בקטע הזרקה פרוגרמטית במסמך בנושא סקריפטים של תוכן.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה שאליה יש להוסיף את ה-CSS. הכרטיסייה הפעילה של החלון הנוכחי כברירת מחדל.
-
פרטים
פרטי הטקסט ב-CSS להוספה. יש להגדיר את הקוד או את מאפייני הקובץ, אבל לא ניתן להגדיר את שניהם בו-זמנית.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
move()
chrome.tabs.move(
tabIds: number | number[],
moveProperties: object,
callback?: function,
)
העברת כרטיסייה אחת או יותר למיקום חדש בחלון, או לחלון חדש. הערה: ניתן להעביר כרטיסיות רק אל חלונות רגילים (window.type === "regular") ומהם חלונות רגילים.
פרמטרים
-
tabIds
מספר | מספר[]
מזהה הכרטיסייה או רשימת מזהי הכרטיסיות להעברה.
-
moveProperties
אובייקט
-
index
number
המיקום שאליו רוצים להעביר את החלון. משתמשים במשתנה
-1
כדי למקם את הכרטיסייה בסוף החלון. -
windowId
מספר אופציונלי
ברירת המחדל היא החלון שבו הכרטיסייה נמצאת כרגע.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(tabs: Tab | Tab[]) => void
החזרות
-
Chrome מגרסה 88 ואילך
הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
query()
chrome.tabs.query(
queryInfo: object,
callback?: function,
)
הפונקציה מקבלת את כל הכרטיסיות עם המאפיינים שצוינו, או את כל הכרטיסיות אם לא צוינו מאפיינים.
פרמטרים
-
queryInfo
אובייקט
-
פעיל
ערך בוליאני אופציונלי
אם הכרטיסיות פעילות בחלונות שלהן.
-
audible, אודיבל
ערך בוליאני אופציונלי
Chrome 45+האם הכרטיסיות מושמעות.
-
autoDiscardable
ערך בוליאני אופציונלי
Chrome 54+ההגדרה קובעת אם הדפדפן יכול למחוק את הכרטיסיות באופן אוטומטי כשהמשאבים נמוכים.
-
currentWindow
ערך בוליאני אופציונלי
האם הכרטיסיות נמצאות בחלון הנוכחי.
-
דחית את
ערך בוליאני אופציונלי
Chrome 54+האם הכרטיסיות נמחקו. כרטיסייה שנמחקה היא כרטיסייה שהתוכן שלה הוסר מהזיכרון, אבל הוא עדיין מופיע בשורת הכרטיסיות. התוכן שלו ייטען מחדש בפעם הבאה שהוא יופעל.
-
groupId
מספר אופציונלי
Chrome מגרסה 88 ואילךמזהה הקבוצה שהכרטיסיות נמצאות בה, או
tabGroups.TAB_GROUP_ID_NONE
לכרטיסיות לא מקובצות. -
מודגש
ערך בוליאני אופציונלי
האם הכרטיסיות מודגשות.
-
index
מספר אופציונלי
מיקום הכרטיסיות בחלונות שלהן.
-
lastFocusedWindow
ערך בוליאני אופציונלי
האם הכרטיסיות נמצאות בחלון האחרון שבו מתמקדים.
-
הושתק
ערך בוליאני אופציונלי
Chrome 45+האם הכרטיסיות מושתקות.
-
מוצמד
ערך בוליאני אופציונלי
האם הכרטיסיות מוצמדות.
-
status
TabStatus אופציונלי
סטטוס הטעינה של הכרטיסייה.
-
title
מחרוזת אופציונלי
התאמת כותרות דפים לפי דפוס. המערכת תתעלם מהנכס הזה אם לתוסף אין את ההרשאה
"tabs"
. -
כתובת אתר
string | string[] אופציונלי
מתאימים כרטיסיות לפי תבנית URL אחת או יותר. אין התאמה למזהי המקטעים. המערכת תתעלם מהנכס הזה אם לתוסף אין את ההרשאה
"tabs"
. -
windowId
מספר אופציונלי
המזהה של חלון ההורה, או
windows.WINDOW_ID_CURRENT
של החלון הנוכחי. -
windowType
WindowType אופציונלי
סוג החלון שבו נמצאות הכרטיסיות.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(result: Tab[]) => void
-
תוצאה
Tab[]
-
החזרות
-
התחייבות<Tab[]>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
reload()
chrome.tabs.reload(
tabId?: number,
reloadProperties?: object,
callback?: function,
)
טוענים כרטיסייה מחדש.
פרמטרים
-
tabId
מספר אופציונלי
המזהה של הכרטיסייה שצריך לטעון מחדש. ברירת המחדל של הכרטיסייה הנבחרת של החלון הנוכחי.
-
reloadProperties
אובייקט אופציונלי
-
bypassCache
ערך בוליאני אופציונלי
הגדרה שקובעת אם לעקוף שמירה מקומית במטמון. ברירת המחדל היא
false
.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
remove()
chrome.tabs.remove(
tabIds: number | number[],
callback?: function,
)
הלחצן סוגר כרטיסייה אחת או יותר.
פרמטרים
-
tabIds
מספר | מספר[]
מזהה הכרטיסייה או רשימת מזהי הכרטיסיות לסגירה.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
removeCSS()
chrome.tabs.removeCSS(
tabId?: number,
details: DeleteInjectionDetails,
callback?: function,
)
הוחלף על ידי scripting.removeCSS
במניפסט מגרסה V3.
הסרה משירות CSS של דף שהוחדר בעבר באמצעות קריאה אל scripting.insertCSS
.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה שממנה יש להסיר את ה-CSS. הכרטיסייה הפעילה של החלון הנוכחי כברירת מחדל.
-
פרטים
פרטי הטקסט בשירות ה-CSS להסרה. יש להגדיר את הקוד או את מאפייני הקובץ, אבל לא ניתן להגדיר את שניהם בו-זמנית.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
sendMessage()
chrome.tabs.sendMessage(
tabId: number,
message: any,
options?: object,
callback?: function,
)
שולחת הודעה יחידה לסקריפטים של התוכן בכרטיסייה שצוינה, עם קריאה חוזרת(callback) אופציונלית שתרוץ כשתגובה נשלחת חזרה. האירוע runtime.onMessage
מופעל בכל סקריפט תוכן שפועל בכרטיסייה שצוינה עבור התוסף הנוכחי.
פרמטרים
-
tabId
number
-
הודעה
כל
ההודעה שצריך לשלוח. ההודעה הזו צריכה להיות אובייקט שאפשר להשתמש בו בפורמט JSON.
-
אפשרויות
אובייקט אופציונלי
-
קריאה חוזרת (callback)
פונקציה אופציונלית
Chrome מגרסה 99 ואילךהפרמטר
callback
נראה כך:(response: any) => void
-
תשובה
כל
אובייקט התשובה בפורמט JSON שנשלח על ידי ה-handler של ההודעה. אם תתרחש שגיאה במהלך ההתחברות לכרטיסייה שצוינה, הקריאה החוזרת (callback) תופעל ללא ארגומנטים והפרמטר
runtime.lastError
יוגדר בהודעת השגיאה.
-
החזרות
-
הבטחה<כלשהו>
Chrome מגרסה 99 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
sendRequest()
chrome.tabs.sendRequest(
tabId: number,
request: any,
callback?: function,
)
יש להשתמש ב-runtime.sendMessage
.
שולחת בקשה יחידה לסקריפטים של התוכן בכרטיסייה שצוינה, עם קריאה חוזרת(callback) אופציונלית שתרוץ כאשר תשובה נשלחת חזרה. האירוע extension.onRequest
מופעל בכל סקריפט תוכן שפועל בכרטיסייה שצוינה עבור התוסף הנוכחי.
פרמטרים
-
tabId
number
-
בקשה
כל
-
קריאה חוזרת (callback)
פונקציה אופציונלית
Chrome מגרסה 99 ואילךהפרמטר
callback
נראה כך:(response: any) => void
-
תשובה
כל
האובייקט של תגובת JSON שנשלח על ידי ה-handler של הבקשה. אם תתרחש שגיאה במהלך ההתחברות לכרטיסייה שצוינה, הקריאה החוזרת (callback) תופעל ללא ארגומנטים והפרמטר
runtime.lastError
יוגדר בהודעת השגיאה.
-
החזרות
-
הבטחה<כלשהו>
Chrome מגרסה 99 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
setZoom()
chrome.tabs.setZoom(
tabId?: number,
zoomFactor: number,
callback?: function,
)
שינוי מרחק תצוגה של כרטיסייה מסוימת.
פרמטרים
-
tabId
מספר אופציונלי
המזהה של הכרטיסייה שרוצים לשנות את מרחק התצוגה; הכרטיסייה הפעילה של החלון הנוכחי כברירת מחדל.
-
zoomFactor
number
הגורם החדש לשינוי מרחק התצוגה. הערך
0
מגדיר את הכרטיסייה לפי גורם הזום הנוכחי שלה שמוגדר כברירת מחדל. ערכים גדולים מ-0
מציינים גורם שינוי מרחק התצוגה (שכנראה אינו ברירת המחדל) לכרטיסייה. -
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
setZoomSettings()
chrome.tabs.setZoomSettings(
tabId?: number,
zoomSettings: ZoomSettings,
callback?: function,
)
קובע את הגדרות הזום עבור כרטיסייה מסוימת, שקובעות את אופן הטיפול בשינויים של מרחק התצוגה. ההגדרות האלה מאפסות לברירות המחדל במהלך הניווט בכרטיסייה.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה שבה יש לשנות את הגדרות הזום; הכרטיסייה הפעילה של החלון הנוכחי כברירת מחדל.
-
zoomSettings
מגדירה את אופן הטיפול בשינויי מרחק התצוגה ובאיזה היקף.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
ungroup()
chrome.tabs.ungroup(
tabIds: number | [number, ...number[]],
callback?: function,
)
מסירה כרטיסייה אחת או יותר מהקבוצות המתאימות. אם יהיו קבוצות ריקות, הן נמחקות.
פרמטרים
-
tabIds
מספר | [מספר, ...מספר[]]
מזהה הכרטיסייה או הרשימה של מזהי הכרטיסיות שצריך להסיר מהקבוצות המתאימות.
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:() => void
החזרות
-
הבטחה<Empty>
הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
update()
chrome.tabs.update(
tabId?: number,
updateProperties: object,
callback?: function,
)
שינוי המאפיינים של כרטיסייה. מאפיינים שלא צוינו ב-updateProperties
לא משתנים.
פרמטרים
-
tabId
מספר אופציונלי
ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.
-
updateProperties
אובייקט
-
פעיל
ערך בוליאני אופציונלי
האם הכרטיסייה צריכה להיות פעילה. לא תהיה לכך השפעה על התמקדות החלון (ראו
windows.update
). -
autoDiscardable
ערך בוליאני אופציונלי
Chrome 54+ההגדרה קובעת אם הדפדפן ימחק את הכרטיסייה באופן אוטומטי כשהמשאבים נמוכים.
-
מודגש
ערך בוליאני אופציונלי
הוספה או הסרה של הכרטיסייה מהבחירה הנוכחית.
-
הושתק
ערך בוליאני אופציונלי
Chrome 45+ההגדרה קובעת אם להשתיק את הכרטיסייה.
-
openerTabId
מספר אופציונלי
המזהה של הכרטיסייה שפתחה את הכרטיסייה. אם השדה הזה מוגדר, לשונית הפתיחה חייבת להיות באותו חלון שבו נמצאת הכרטיסייה.
-
מוצמד
ערך בוליאני אופציונלי
האם צריך להצמיד את הכרטיסייה.
-
נבחר
ערך בוליאני אופציונלי
הוצא משימושיש להשתמש במודגש.
האם לבחור את הכרטיסייה.
-
כתובת אתר
מחרוזת אופציונלי
כתובת ה-URL שאליה אפשר לנווט בכרטיסייה. כתובות URL של JavaScript אינן נתמכות. יש להשתמש ב-
scripting.executeScript
במקום זאת.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלית
הפרמטר
callback
נראה כך:(tab?: Tab) => void
החזרות
-
Promise<Tab | לא מוגדר>
Chrome מגרסה 88 ואילךהבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
אירועים
onActivated
chrome.tabs.onActivated.addListener(
callback: function,
)
מופעלת כשהכרטיסייה הפעילה בחלון משתנה. חשוב לדעת: יכול להיות שכתובת ה-URL של הכרטיסייה לא מוגדרת בזמן שהאירוע הזה הופעל, אבל אפשר להאזין לאירועים ב-Updates כדי לקבל הודעה כשמוגדרת כתובת URL.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(activeInfo: object) => void
-
activeInfo
אובייקט
-
tabId
number
המזהה של הכרטיסייה שהפכה לפעילה.
-
windowId
number
מזהה החלון שכולל שינויים בכרטיסייה הפעילה.
-
-
onActiveChanged
chrome.tabs.onActiveChanged.addListener(
callback: function,
)
יש להשתמש ב-tabs.onActivated
.
מופעלת כשהכרטיסייה שנבחרה בחלון משתנה. חשוב לשים לב: יכול להיות שכתובת ה-URL של הכרטיסייה לא מוגדרת בזמן שהאירוע הזה מופעל, אבל אפשר להאזין לאירועי tabs.onUpdated
כדי לקבל התראה כשמוגדרת כתובת URL.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(tabId: number, selectInfo: object) => void
-
tabId
number
-
selectInfo
אובייקט
-
windowId
number
מזהה החלון שכולל את הכרטיסייה שנבחרה.
-
-
onAttached
chrome.tabs.onAttached.addListener(
callback: function,
)
מופעל כשכרטיסייה מצורפת לחלון; למשל, כי הוא הועבר בין חלונות.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(tabId: number, attachInfo: object) => void
-
tabId
number
-
attachInfo
אובייקט
-
newPosition
number
-
newWindowId
number
-
-
onCreated
chrome.tabs.onCreated.addListener(
callback: function,
)
מופעל כשכרטיסייה נוצרת. חשוב לדעת: ייתכן שכתובת ה-URL של הכרטיסייה והחברות בקבוצת הכרטיסיות לא מוגדרות בזמן שהאירוע הזה מופעל, אבל אפשר להאזין לאירועים 'מתעדכנים' כדי לקבל הודעה כשמוגדרת כתובת URL או כשהכרטיסייה מתווספת לקבוצת כרטיסיות.
onDetached
chrome.tabs.onDetached.addListener(
callback: function,
)
מופעל כשכרטיסייה מנותקת מחלון. למשל, כי הוא הועבר בין חלונות.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(tabId: number, detachInfo: object) => void
-
tabId
number
-
detachInfo
אובייקט
-
oldPosition
number
-
oldWindowId
number
-
-
onHighlightChanged
chrome.tabs.onHighlightChanged.addListener(
callback: function,
)
יש להשתמש ב-tabs.onHighlighted
.
מופעל כשהכרטיסיות המודגשות או שנבחרו בחלון משתנה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(selectInfo: object) => void
-
selectInfo
אובייקט
-
tabIds
מספר[]
כל הכרטיסיות המודגשות בחלון.
-
windowId
number
החלון שהכרטיסיות שלו השתנו.
-
-
onHighlighted
chrome.tabs.onHighlighted.addListener(
callback: function,
)
מופעל כשהכרטיסיות המודגשות או שנבחרו בחלון משתנה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(highlightInfo: object) => void
-
highlightInfo
אובייקט
-
tabIds
מספר[]
כל הכרטיסיות המודגשות בחלון.
-
windowId
number
החלון שהכרטיסיות שלו השתנו.
-
-
onMoved
chrome.tabs.onMoved.addListener(
callback: function,
)
מופעל כשכרטיסייה מועברת בתוך חלון. רק אירוע העברה אחד מופעל, שמייצג את הכרטיסייה שהמשתמש העביר ישירות. אירועי העברה לא מופעלים עבור כרטיסיות אחרות שחייבות לעבור בתגובה לכרטיסייה שהועברה באופן ידני. האירוע הזה לא מופעל כשכרטיסייה מועברת בין חלונות. אפשר לקרוא פרטים נוספים בכתובת tabs.onDetached
.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(tabId: number, moveInfo: object) => void
-
tabId
number
-
moveInfo
אובייקט
-
fromIndex
number
-
toIndex
number
-
windowId
number
-
-
onRemoved
chrome.tabs.onRemoved.addListener(
callback: function,
)
מופעל כשכרטיסייה נסגרת.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(tabId: number, removeInfo: object) => void
-
tabId
number
-
removeInfo
אובייקט
-
isWindowClosing
בוליאני
הערך הוא True כשהכרטיסייה נסגרה כי החלון ההורה שלה נסגר.
-
windowId
number
החלון שהכרטיסייה שלו סגורה.
-
-
onReplaced
chrome.tabs.onReplaced.addListener(
callback: function,
)
מופעל כשכרטיסייה מוחלפת בכרטיסייה אחרת בגלל עיבוד מראש או הצגה מיידית.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(addedTabId: number, removedTabId: number) => void
-
addedTabId
number
-
removedTabId
number
-
onSelectionChanged
chrome.tabs.onSelectionChanged.addListener(
callback: function,
)
יש להשתמש ב-tabs.onActivated
.
מופעלת כשהכרטיסייה שנבחרה בחלון משתנה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(tabId: number, selectInfo: object) => void
-
tabId
number
-
selectInfo
אובייקט
-
windowId
number
מזהה החלון שכולל את הכרטיסייה שנבחרה.
-
-
onUpdated
chrome.tabs.onUpdated.addListener(
callback: function,
)
מופעל כשכרטיסייה מתעדכנת.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(tabId: number, changeInfo: object, tab: Tab) => void
-
tabId
number
-
changeInfo
אובייקט
-
audible, אודיבל
ערך בוליאני אופציונלי
Chrome 45+מצב האודיו החדש של הכרטיסייה.
-
autoDiscardable
ערך בוליאני אופציונלי
Chrome 54+המצב החדש של הכרטיסייה לשליפה אוטומטית.
-
דחית את
ערך בוליאני אופציונלי
Chrome 54+מצב המחיקה החדש של הכרטיסייה.
-
favIconUrl
מחרוזת אופציונלי
כתובת ה-URL של סמל האתר החדש בכרטיסייה.
-
groupId
מספר אופציונלי
Chrome מגרסה 88 ואילךהקבוצה החדשה של הכרטיסייה.
-
mutedInfo
MutedInfo אופציונלי
Chrome 46 ואילךמצב ההשתקה החדש של הכרטיסייה והסיבה לשינוי.
-
מוצמד
ערך בוליאני אופציונלי
המצב המוצמד החדש של הכרטיסייה.
-
status
TabStatus אופציונלי
סטטוס הטעינה של הכרטיסייה.
-
title
מחרוזת אופציונלי
Chrome 48 ואילךהשם החדש של הכרטיסייה.
-
כתובת אתר
מחרוזת אופציונלי
כתובת ה-URL של הכרטיסייה, אם היא השתנתה.
-
-
כרטיסייה
-
onZoomChange
chrome.tabs.onZoomChange.addListener(
callback: function,
)
מופעל כשמשנים את מרחק התצוגה בכרטיסייה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(ZoomChangeInfo: object) => void
-
ZoomChangeInfo
אובייקט
-
newZoomFactor
number
-
oldZoomFactor
number
-
tabId
number
-
zoomSettings
-
-