תיאור
שימוש ב-API של chrome.tabs
לאינטראקציה עם מערכת הכרטיסיות של הדפדפן. ממשק ה-API הזה מאפשר לכם ליצור כרטיסיות, לשנות אותן ולסדר אותן מחדש בדפדפן.
סקירה כללית
נוסף לכך, ה-Tabs API כולל תכונות לשינוי ולניהול של כרטיסיות, וגם יכול לזהות את השפה של הכרטיסייה, לבצע צילום מסך ולתקשר עם סקריפטים של תוכן בכרטיסייה.
הרשאות
רוב התכונות לא דורשות הרשאות כדי להשתמש בהן. לדוגמה: יצירת כרטיסייה חדשה, טעינה מחדש של כרטיסייה, ניווט לכתובת URL אחרת וכו'.
יש שלוש הרשאות שמפתחים צריכים להיות מודעים אליהן כשהם עובדים עם Tabs API.
- הרשאת 'כרטיסיות'
- ההרשאה הזו לא נותנת גישה למרחב השמות של
chrome.tabs
. במקום זאת, התוסף יכול להפעיל אתtabs.query()
כנגד ארבעה מאפיינים רגישים במכונות של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.
}
דוגמאות לתוספים
להדגמות נוספות של תוספי API של Tabs API אפשר להיעזר בנושאים הבאים:
סוגים
MutedInfo
מצב ההשתקה של הכרטיסייה והסיבה לשינוי המצב האחרון.
תכונות
-
extensionId
מחרוזת אופציונלי
המזהה של התוסף ששינה את מצב ההשתקה. לא מוגדר אם תוסף לא היה הסיבה לשינוי האחרון של מצב ההשתקה.
-
הושתק
boolean
האם הכרטיסייה מושתקת (מונע השמעת צליל). יכול להיות שהכרטיסייה תושתק גם אם היא לא הושמעה או שלא מושמע בה צליל כרגע. זהה לזו של אינדיקטור האודיו 'מושתק'.
-
סיבה
MutedInfoReason אופציונלי
הסיבה להשתקה או לביטול ההשתקה של הכרטיסייה. לא מוגדר אם מצב ההשתקה של הכרטיסייה לא השתנה אף פעם.
MutedInfoReason
אירוע שגרם לשינוי מצב מושתק.
טיפוסים בני מנייה (enum)
"user"
פעולת קלט של משתמש הגדירה את המצב המושתק.
"צילום"
צילום הכרטיסייה הופעל, והמצב הזה אלץ שינוי במצב מושתק.
"תוסף"
תוסף, שמזוהה באמצעות השדה extensionsId, מגדיר את מצב ההשתקה.
Tab
תכונות
-
פעיל
boolean
האם הכרטיסייה פעילה בחלון שלה. זה לא אומר בהכרח שהחלון נמצא במוקד.
-
audible, אודיבל
בוליאני אופציונלי
Chrome 45 ואילךאם הכרטיסייה הנפיקה צליל בשניות האחרונות (אבל ייתכן שהיא לא תישמע אם גם מושתקת). זהה לזו של האינדיקטור 'אודיו של הרמקול' מוצג.
-
autoDiscardable
boolean
Chrome בגרסה 54 ומעלהקביעה אם הדפדפן יכול למחוק את הכרטיסייה באופן אוטומטי כשהמשאבים מועטים.
-
דחית את
boolean
Chrome בגרסה 54 ומעלההאם הכרטיסייה נמחקה. כרטיסייה שנמחקה היא כרטיסייה שהתוכן שלה הוסר מהזיכרון, אך הוא עדיין גלוי בשורת הכרטיסיות. התוכן שלו ייטען מחדש בפעם הבאה שהוא יופעל.
-
favIconUrl
מחרוזת אופציונלי
כתובת ה-URL של סמל הכרטיסייה. המאפיין הזה מוצג רק אם המניפסט של התוסף כולל את ההרשאה
"tabs"
. היא גם יכולה להיות מחרוזת ריקה אם הכרטיסייה נטענת. -
groupId
number
Chrome 88 ומעלהמזהה הקבוצה שאליה שייכת הכרטיסייה.
-
גובה
מספר אופציונלי
גובה הכרטיסייה בפיקסלים.
-
מודגש
boolean
אם הכרטיסייה מודגשת.
-
id
מספר אופציונלי
מזהה הכרטיסייה. מזהי הכרטיסיות הם ייחודיים בכל סשן בדפדפן. במקרים מסוימים, יכול להיות שלא יוקצה מזהה לכרטיסייה. לדוגמה, כשמריצים שאילתות לגבי כרטיסיות זרות באמצעות
sessions
API, ובמקרים כאלה יכול להיות מזהה סשן. אפשר גם להגדיר את מזהה הכרטיסייה ל-chrome.tabs.TAB_ID_NONE
עבור אפליקציות וחלונות של כלי פיתוח. -
גלישה פרטית
boolean
אם הכרטיסייה נמצאת בחלון פרטי.
-
index
number
האינדקס מבוסס-אפס של הכרטיסייה בתוך החלון שלה.
-
lastAccessed
מספר אופציונלי
Chrome 121 ומעלההפעם האחרונה שבה בוצעה גישה לכרטיסייה כמספר אלפיות השנייה מאז תחילת התקופה.
-
mutedInfo
MutedInfo אופציונלי
Chrome 46 ואילךמצב ההשתקה של הכרטיסייה והסיבה לשינוי המצב האחרון.
-
openerTabId
מספר אופציונלי
מזהה הכרטיסייה שבה נפתחה הכרטיסייה הזו, אם בכלל. המאפיין הזה מוצג רק אם הכרטיסייה הפתוחה עדיין קיימת.
-
pendingUrl
מחרוזת אופציונלי
Chrome 79 ומעלהכתובת ה-URL שאליה הכרטיסייה מנווטת, לפני ההתחייבות. המאפיין הזה מופיע רק אם המניפסט של התוסף כולל את ההרשאה
"tabs"
וקיים ניווט בהמתנה. -
מוצמד
boolean
האם הכרטיסייה מוצמדת.
-
נבחר
boolean
הוצא משימושיש להשתמש ב-
tabs.Tab.highlighted
.אם הכרטיסייה נבחרה.
-
sessionId
מחרוזת אופציונלי
מזהה הסשן ששימש לזיהוי ייחודי של כרטיסייה שהתקבלה מ-
sessions
API. -
status
TabStatus אופציונלי
סטטוס הטעינה של הכרטיסייה.
-
title
מחרוזת אופציונלי
כותרת הכרטיסייה. המאפיין הזה מוצג רק אם המניפסט של התוסף כולל את ההרשאה
"tabs"
. -
כתובת אתר
מחרוזת אופציונלי
כתובת ה-URL האחרונה שהוקצתה למסגרת הראשית של הכרטיסייה. המאפיין הזה מופיע רק אם המניפסט של התוסף כולל את ההרשאה
"tabs"
, ויכול להיות שהוא יהיה מחרוזת ריקה אם הכרטיסייה עדיין לא הוזמנה. למידע נוסף, ראוTab.pendingUrl
. -
רוחב
מספר אופציונלי
רוחב הכרטיסייה בפיקסלים.
-
windowId
number
מזהה החלון שמכיל את הכרטיסייה.
TabStatus
סטטוס הטעינה של הכרטיסייה.
טיפוסים בני מנייה (enum)
WindowType
סוג החלון.
טיפוסים בני מנייה (enum)
ZoomSettings
הגדרת אופן הטיפול בשינויים של מרחק התצוגה בכרטיסייה ובאיזה היקף.
תכונות
-
defaultZoomFactor
מספר אופציונלי
Chrome מגרסה 43 ואילךמשמש להחזרת רמת ברירת המחדל של מרחק התצוגה בכרטיסייה הנוכחית בשיחות ל-tab.getZoomSettings.
-
אמצעי תחבורה
ZoomSettingsMode אופציונלי
הגדרת אופן הטיפול בשינויים של מרחק התצוגה, כלומר, איזו ישות אחראית לשינוי הגודל בפועל של הדף. ברירת המחדל היא
automatic
. -
היקף
ZoomSettingsScope אופציונלי
המדיניות קובעת אם השינויים בשינוי מרחק התצוגה יישמרו במקור של הדף, או ייכנסו לתוקף רק בכרטיסייה הזו. ברירת המחדל היא
per-origin
במצבautomatic
. אחרת, ברירת המחדל היאper-tab
.
ZoomSettingsMode
הגדרת אופן הטיפול בשינויים של מרחק התצוגה, כלומר, איזו ישות אחראית לשינוי הגודל בפועל של הדף. ברירת המחדל היא automatic
.
טיפוסים בני מנייה (enum)
'אוטומטית'
שינויי המרחק מהתצוגה מטופלים באופן אוטומטי על-ידי הדפדפן.
"manual"
ביטול הטיפול האוטומטי בשינויים של מרחק התצוגה. האירוע onZoomChange
עדיין יישלח, והתוסף אחראי להאזין לאירוע הזה ולהתאים את הדף באופן ידני. במצב הזה אין תמיכה בשינוי מרחק התצוגה של per-origin
, ולכן המערכת מתעלמת מהגדרת המרחק מהתצוגה של scope
ומתבססת על ההנחה per-tab
.
"disabled"
השבתת כל שינוי מרחק התצוגה בכרטיסייה. הכרטיסייה חוזרת לרמת ברירת המחדל של מרחק התצוגה, והמערכת מתעלמת מכל ניסיון לשינוי מרחק התצוגה.
ZoomSettingsScope
המדיניות קובעת אם השינויים בשינוי מרחק התצוגה יישמרו במקור של הדף, או ייכנסו לתוקף רק בכרטיסייה הזו. ברירת המחדל היא per-origin
במצב automatic
. אחרת, ברירת המחדל היא per-tab
.
טיפוסים בני מנייה (enum)
"לכל מקור"
שינויי מרחק התצוגה מתעדכנים במקור של הדף עם המרחק מהתצוגה, כלומר, גם כל שאר הכרטיסיות שהועברו לאותו מקור מוגדלות. בנוסף, שינויים של מרחק התצוגה ב-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
אינדקס שמייצג את המחסור באינדקס כרטיסיות ב-tab_strip.
ערך
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
string
כתובת URL של נתונים שמקודדת תמונה של האזור הגלוי בכרטיסייה שצולמה. יכולה להיות מוקצית למאפיין 'src' של רכיב HTML
img
לרשת המדיה.
-
החזרות
-
הבטחה<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
במקום כל הפריימים בכרטיסייה. -
name
מחרוזת אופציונלי
מועבר ל-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
הכרטיסייה שנוצרה.
-
החזרות
-
Promise<Tab>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
detectLanguage()
chrome.tabs.detectLanguage(
tabId?: number,
callback?: function,
)
מזהה את השפה הראשית של התוכן בכרטיסייה.
פרמטרים
-
tabId
מספר אופציונלי
ברירת המחדל היא הכרטיסייה הפעילה של החלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(language: string) => void
-
language
string
קוד שפת ISO כמו
en
אוfr
. לרשימה מלאה של השפות הנתמכות בשיטה זו, ראה kLanguageInfoTable. העמודה השנייה עד רביעית מסומנת ומוחזר הערך הראשון שאינו NULL, מלבד סינית פשוטה שבה מוחזרzh-CN
. לשפה לא ידועה/לא מוגדרת, מוחזרund
.
-
החזרות
-
הבטחה<string>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
discard()
chrome.tabs.discard(
tabId?: number,
callback?: function,
)
מחיקת כרטיסייה מהזיכרון. הכרטיסיות המחוקות עדיין גלויות בשורת הכרטיסיות והן נטענות מחדש לאחר הפעלתן.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה למחיקה. אם הכרטיסייה מוגדרת, היא נמחקת אלא אם היא פעילה או שכבר נמחקה. אם פרט זה יושמט, הדפדפן ימחק את הכרטיסייה הכי פחות חשובה. אם אין כרטיסיות שניתן למחוק, הפעולה הזאת יכולה להיכשל.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(tab?: Tab) => void
-
tab
Tab אופציונלי
הכרטיסייה שנמחקה, אם היא נמחקה בהצלחה; לא הוגדר אחרת.
-
החזרות
-
Promise<Tab | undefined>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
duplicate()
chrome.tabs.duplicate(
tabId: number,
callback?: function,
)
שכפול של כרטיסייה.
פרמטרים
-
tabId
number
המזהה של הכרטיסייה שיש לשכפל.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(tab?: Tab) => void
החזרות
-
Promise<Tab | undefined>
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[] | undefined>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
get()
chrome.tabs.get(
tabId: number,
callback?: function,
)
מאחזר פרטים על הכרטיסייה שצוינה.
פרמטרים
-
tabId
number
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(tab: Tab) => void
-
tab
-
החזרות
-
Promise<Tab>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getAllInWindow()
chrome.tabs.getAllInWindow(
windowId?: number,
callback?: function,
)
יש להשתמש ב-tabs.query
{windowId: windowId}
.
קבלת פרטים על כל הכרטיסיות בחלון שצוין.
פרמטרים
-
windowId
מספר אופציונלי
ברירת המחדל היא החלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(tabs: Tab[]) => void
-
כרטיסיות
מקש Tab[]
-
החזרות
-
Promise<Tab[]>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getCurrent()
chrome.tabs.getCurrent(
callback?: function,
)
קבלת הכרטיסייה שממנה מתבצעת הקריאה הזו לסקריפט. הפונקציה מחזירה את הערך undefined
אם היא נקראת מהקשר שאינו כרטיסייה (לדוגמה, דף רקע או תצוגה של חלון קופץ).
פרמטרים
החזרות
-
Promise<Tab | undefined>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getSelected()
chrome.tabs.getSelected(
windowId?: number,
callback?: function,
)
יש להשתמש ב-tabs.query
{active: true}
.
מקבל את הכרטיסייה המסומנת בחלון שצוין.
פרמטרים
-
windowId
מספר אופציונלי
ברירת המחדל היא החלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(tab: Tab) => void
-
tab
-
החזרות
-
Promise<Tab>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getZoom()
chrome.tabs.getZoom(
tabId?: number,
callback?: function,
)
הפונקציה מקבלת את גורם הזום הנוכחי של כרטיסייה שצוינה.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה שממנה מגיע גורם המרחק מהתצוגה הנוכחי. ברירת המחדל היא הכרטיסייה הפעילה של החלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(zoomFactor: number) => void
-
zoomFactor
number
גורם מרחק התצוגה הנוכחי של הכרטיסייה.
-
החזרות
-
הבטחה<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
החזרות
-
Promise<void>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
goForward()
chrome.tabs.goForward(
tabId?: number,
callback?: function,
)
עבור לדף הבא, אם זמין.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה לניווט קדימה. ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
group()
chrome.tabs.group(
options: object,
callback?: function,
)
הוספה של כרטיסייה אחת או יותר לקבוצה ספציפית, או אם לא צוינה קבוצה, מוסיף את הכרטיסיות הנתונות לקבוצה חדשה שנוצרה.
פרמטרים
-
אפשרויות
אובייקט
-
createProperties
אובייקט אופציונלי
הגדרות ליצירת קבוצה. לא ניתן להשתמש אם ה-groupId כבר צוין.
-
windowId
מספר אופציונלי
החלון של הקבוצה החדשה. ברירת המחדל היא החלון הנוכחי.
-
-
groupId
מספר אופציונלי
מזהה הקבוצה שאליה רוצים להוסיף את הכרטיסיות. אם לא מגדירים קבוצה חדשה, תיווצר קבוצה חדשה.
-
tabIds
מספר | [מספר, ...מספר[]]
מזהה הכרטיסייה או רשימת מזהי הכרטיסיות שיש להוסיף לקבוצה שצוינה.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(groupId: number) => void
-
groupId
number
מזהה הקבוצה שאליה נוספו הכרטיסיות.
-
החזרות
-
הבטחה<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
החזרות
-
Promise<void>
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)
פונקציה אופציונלי
החזרות
-
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[]
-
החזרות
-
Promise<Tab[]>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
reload()
chrome.tabs.reload(
tabId?: number,
reloadProperties?: object,
callback?: function,
)
טוענים כרטיסייה מחדש.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה לטעינה מחדש. ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.
-
reloadProperties
אובייקט אופציונלי
-
bypassCache
בוליאני אופציונלי
האם לעקוף את השמירה המקומית במטמון. ברירת המחדל היא
false
.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
remove()
chrome.tabs.remove(
tabIds: number | number[],
callback?: function,
)
סוגר כרטיסייה אחת או יותר.
פרמטרים
-
tabIds
מספר | מספר[]
מזהה הכרטיסייה או רשימת מזהי הכרטיסיות לסגירה.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
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
החזרות
-
Promise<void>
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 של ההודעה. אם תתרחש שגיאה במהלך ההתחברות לכרטיסייה שצוינה, תתבצע קריאה חוזרת ללא ארגומנטים וה-
runtime.lastError
יוגדר כהודעת השגיאה.
-
החזרות
-
מבטיח<any>
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 שנשלח על ידי הגורם המטפל בבקשה. אם תתרחש שגיאה במהלך ההתחברות לכרטיסייה שצוינה, תתבצע קריאה חוזרת ללא ארגומנטים וה-
runtime.lastError
יוגדר כהודעת השגיאה.
-
החזרות
-
מבטיח<any>
Chrome 99 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
setZoom()
chrome.tabs.setZoom(
tabId?: number,
zoomFactor: number,
callback?: function,
)
שינוי מרחק התצוגה של כרטיסייה מסוימת.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה לשינוי מרחק התצוגה. ברירת המחדל היא הכרטיסייה הפעילה של החלון הנוכחי.
-
zoomFactor
number
גורם הזום החדש. הערך
0
מגדיר את הכרטיסייה לגורם ברירת המחדל הנוכחי של הזום. ערכים גדולים מ-0
מציינים גורם זום (אולי לא ברירת המחדל) של הכרטיסייה. -
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
setZoomSettings()
chrome.tabs.setZoomSettings(
tabId?: number,
zoomSettings: ZoomSettings,
callback?: function,
)
מגדיר את הגדרות מרחק התצוגה עבור כרטיסייה מסוימת, שקובעות את אופן הטיפול בשינויים של מרחק התצוגה. ההגדרות האלה מתאפסות לברירות המחדל במהלך הניווט בכרטיסייה.
פרמטרים
-
tabId
מספר אופציונלי
מזהה הכרטיסייה שעבורה יש לשנות את הגדרות מרחק התצוגה. ברירת המחדל היא הכרטיסייה הפעילה של החלון הנוכחי.
-
zoomSettings
המדיניות הזו מגדירה את אופן הטיפול בשינויים של מרחק התצוגה ובאיזה היקף.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
ungroup()
chrome.tabs.ungroup(
tabIds: number | [number, ...number[]],
callback?: function,
)
הסרה של כרטיסייה אחת או יותר מהקבוצות המתאימות. אם הקבוצות יהיו ריקות, הן יימחקו.
פרמטרים
-
tabIds
מספר | [מספר, ...מספר[]]
מזהה הכרטיסייה או רשימת מזהי הכרטיסיות שיש להסיר מהקבוצות המתאימות.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
הבטחות נתמכות רק במניפסט מגרסה 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 | undefined>
Chrome 88 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
אירועים
onActivated
chrome.tabs.onActivated.addListener(
callback: function,
)
מופעלת כשהכרטיסייה הפעילה בחלון משתנה. שים לב: לא ניתן להגדיר את כתובת ה-URL של הכרטיסייה בזמן שהאירוע הזה הופעל, אבל אפשר להאזין לאירועי onUpdated כדי לקבל הודעה כאשר מוגדרת כתובת 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 ואת החברות בקבוצת הכרטיסיות של הכרטיסייה כשהאירוע הזה מופעל. עם זאת, אפשר להאזין לאירועי onUpdated כדי לקבל הודעה כשהוגדרה כתובת 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
boolean
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 של הכרטיסייה, אם היא השתנתה.
-
-
tab
-
onZoomChange
chrome.tabs.onZoomChange.addListener(
callback: function,
)
מופעל בעת שינוי מרחק תצוגה בכרטיסייה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(ZoomChangeInfo: object) => void
-
ZoomChangeInfo
אובייקט
-
newZoomFactor
number
-
oldZoomFactor
number
-
tabId
number
-
zoomSettings
-
-