chrome.tabs

תיאור

משתמשים ב-chrome.tabs API כדי ליצור אינטראקציה עם מערכת הכרטיסיות של הדפדפן. אתם יכולים להשתמש ב-API הזה כדי ליצור, לשנות ולסדר מחדש כרטיסיות בדפדפן.

‫Tabs API לא רק מציע תכונות לשינוי ולניהול כרטיסיות, אלא גם יכול לזהות את השפה של הכרטיסייה, לצלם צילום מסך ולתקשר עם סקריפטים של תוכן בכרטיסייה.

הרשאות

כדי להשתמש ברוב התכונות לא נדרשות הרשאות. לדוגמה: יצירת כרטיסייה חדשה, טעינה מחדש של כרטיסייה, מעבר לכתובת URL אחרת וכו'.

יש שלוש הרשאות שמפתחים צריכים להכיר כשהם עובדים עם Tabs API.

ההרשאה 'כרטיסיות'

ההרשאה הזו לא מעניקה גישה למרחב השמות chrome.tabs. במקום זאת, היא מעניקה לתוסף את היכולת לקרוא ל-tabs.query() מול ארבעה מאפיינים רגישים במופעים של tabs.Tab: ‏ url,‏ pendingUrl,‏ title ו-favIconUrl.

{
  "name": "My extension",
  ...
  "permissions": [
    "tabs"
  ],
  ...
}
הרשאות למארחים

הרשאות מארח מאפשרות לתוסף לקרוא ולהריץ שאילתות על ארבעה מאפיינים רגישים של כרטיסייה תואמת:tabs.Tab הם יכולים גם ליצור אינטראקציה ישירה עם הכרטיסיות התואמות באמצעות שיטות כמו tabs.captureVisibleTab(),‏ scripting.executeScript(),‏ scripting.insertCSS() ו-scripting.removeCSS().

{
  "name": "My extension",
  ...
  "host_permissions": [
    "http://*/*",
    "https://*/*"
  ],
  ...
}
ההרשאה activeTab

ההרשאה activeTab מעניקה לתוסף הרשאת מארח זמנית לכרטיסייה הנוכחית בתגובה להפעלה של המשתמש. בניגוד להרשאות מארח, activeTab לא מפעיל אזהרות.

{
  "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

‫Chrome 46 ואילך

האם הכרטיסייה מושתקת והסיבה לשינוי האחרון במצב שלה.

מאפיינים

  • extensionId

    מחרוזת אופציונלי

    המזהה של התוסף ששינה את מצב ההשתקה. הערך לא מוגדר אם התוסף לא היה הסיבה לשינוי האחרון של מצב ההשתקה.

  • הושתק

    בוליאני

    אם הכרטיסייה מושתקת (ההפעלה של הצליל מושבתת). יכול להיות שהכרטיסייה מושתקת גם אם לא הושמע בה צליל או אם לא מושמע בה צליל כרגע. מקביל למצב שבו מוצג אינדיקטור האודיו 'מושתק'.

  • reason

    ‫MutedInfoReason אופציונלי

    הסיבה להשתקה או לביטול ההשתקה של הכרטיסייה. הערך לא מוגדר אם מצב ההשתקה של הכרטיסייה לא השתנה אף פעם.

MutedInfoReason

‫Chrome 46 ואילך

אירוע שגרם לשינוי במצב ההשתקה.

Enum

‫user
פעולת קלט של משתמש הגדירה את מצב ההשתקה.

'צילום'
התחיל צילום של הכרטיסייה, ולכן מצב ההשתקה השתנה.

‫'extension'
תוסף, שמזוהה על ידי השדה extensionId, הגדיר את מצב ההשתקה.

Tab

מאפיינים

  • פעיל

    בוליאני

    האם הכרטיסייה פעילה בחלון שלה. לא בהכרח אומר שהחלון נמצא במיקוד.

  • audible, אודיבל

    ‫boolean אופציונלי

    ‫Chrome 45 ואילך

    האם הכרטיסייה השמיעה צליל בשניות האחרונות (אבל יכול להיות שלא תשמעו אותו אם היא גם מושתקת). מקביל לכך שמוצג האינדיקטור 'אודיו של הדובר'.

  • autoDiscardable

    בוליאני

    ‫Chrome 54 ואילך

    ההגדרה קובעת אם הדפדפן יכול להסיר את הכרטיסייה באופן אוטומטי כשאין מספיק משאבים.

  • דחית את

    בוליאני

    ‫Chrome 54 ואילך

    האם הכרטיסייה נסגרה. כרטיסייה שהוצאה מהזיכרון היא כרטיסייה שהתוכן שלה לא נטען מהזיכרון, אבל היא עדיין מוצגת בשורת הכרטיסיות. התוכן שלו נטען מחדש בפעם הבאה שהוא מופעל.

  • favIconUrl

    מחרוזת אופציונלי

    כתובת ה-URL של סמל האתר של הכרטיסייה. המאפיין הזה מופיע רק אם לתוסף יש הרשאה "tabs" או הרשאות מארח לדף. יכול להיות שהערך יהיה מחרוזת ריקה אם הכרטיסייה נטענת.

  • קפוא

    בוליאני

    ‫Chrome 132 ואילך

    אם הכרטיסייה קפואה. כרטיסייה מוקפאת לא יכולה לבצע משימות, כולל גורמים שמטפלים באירועים או טיימרים. היא גלויה בסרגל הכרטיסיות והתוכן שלה נטען בזיכרון. ההקפאה מבוטלת כשהמינוי מופעל.

  • groupId

    number

    ‫Chrome 88 ואילך

    המזהה של הקבוצה שאליה שייך הכרטיסייה.

  • גובה

    מספר אופציונלי

    גובה הכרטיסייה בפיקסלים.

  • מודגש

    בוליאני

    אם הכרטיסייה מודגשת.

  • id [מזהה]

    מספר אופציונלי

    המזהה של הכרטיסייה. מזהי הכרטיסיות הם ייחודיים בסשן דפדפן. בנסיבות מסוימות, יכול להיות שלא יוקצה מזהה לכרטיסייה. למשל, כשמבצעים שאילתה לגבי כרטיסיות חיצוניות באמצעות API של sessions. במקרה כזה, יכול להיות שיופיע מזהה סשן. אפשר גם להגדיר את מזהה הכרטיסייה ל-chrome.tabs.TAB_ID_NONE עבור אפליקציות וחלונות של כלי פיתוח.

  • מצב פרטי

    בוליאני

    האם הכרטיסייה נמצאת בחלון פרטי.

  • אינדקס

    number

    האינדקס של הכרטיסייה בחלון שלה, כשהספירה מתחילה מ-0.

  • lastAccessed

    number

    ‫Chrome 121 ואילך

    הפעם האחרונה שבה הכרטיסייה הפכה לפעילה בחלון שלה, כמספר אלפיות השנייה מאז תקופת ה-epoch.

  • mutedInfo

    MutedInfo אופציונלי

    ‫Chrome 46 ואילך

    האם הכרטיסייה מושתקת והסיבה לשינוי האחרון במצב שלה.

  • openerTabId

    מספר אופציונלי

    המזהה של הכרטיסייה שפתחה את הכרטיסייה הזו, אם יש כזו. המאפיין הזה קיים רק אם הכרטיסייה שפתחה את החלון עדיין קיימת.

  • pendingUrl

    מחרוזת אופציונלי

    ‫Chrome 79 ואילך

    כתובת ה-URL שאליה הכרטיסייה עוברת, לפני שהיא מאשרת את המעבר. המאפיין הזה מופיע רק אם לתוסף יש הרשאה "tabs" או הרשאות מארח לדף, ויש ניווט בהמתנה.

  • מוצמד

    בוליאני

    האם הכרטיסייה מוצמדת.

  • נבחר

    בוליאני

    הוצא משימוש

    צריך להשתמש ב-tabs.Tab.highlighted.

    האם הכרטיסייה נבחרה.

  • sessionId

    מחרוזת אופציונלי

    מזהה הסשן שמשמש לזיהוי ייחודי של כרטיסייה שהתקבלה מ-API של sessions.

  • status

    ‫TabStatus אופציונלי

    סטטוס הטעינה של הכרטיסייה.

  • title

    מחרוזת אופציונלי

    השם של הכרטיסייה. המאפיין הזה מופיע רק אם לתוסף יש הרשאה "tabs" או הרשאות מארח לדף.

  • כתובת אתר

    מחרוזת אופציונלי

    כתובת ה-URL האחרונה שבוצעה לגביה פעולת commit של המסגרת הראשית בכרטיסייה. המאפיין הזה מופיע רק אם לתוסף יש הרשאה "tabs" או הרשאות מארח לדף. יכול להיות מחרוזת ריקה אם הכרטיסייה עדיין לא בוצעה. ראו גם Tab.pendingUrl.

  • רוחב

    מספר אופציונלי

    רוחב הכרטיסייה בפיקסלים.

  • windowId

    number

    המזהה של החלון שמכיל את הכרטיסייה.

TabStatus

‫Chrome 44 ואילך

סטטוס הטעינה של הכרטיסייה.

Enum

‫"unloaded"

"loading"

‫'complete'

WindowType

‫Chrome 44 ואילך

סוג החלון.

Enum

"normal"

‫"popup"

‫"panel"

‫"app"

"devtools"

ZoomSettings

ההגדרה קובעת איך שינויים בזום בכרטיסייה מטופלים ובאיזה היקף.

מאפיינים

  • defaultZoomFactor

    מספר אופציונלי

    ‫Chrome 43 ואילך

    המאפיין הזה משמש להחזרת רמת הזום שמוגדרת כברירת מחדל עבור הכרטיסייה הנוכחית בקריאות ל-tabs.getZoomSettings.

  • מצב

    ‫ZoomSettingsMode optional

    המאפיין הזה מגדיר איך שינויים בזום מטופלים, כלומר איזו ישות אחראית על שינוי קנה המידה בפועל של הדף. ברירת המחדל היא automatic.

  • היקף

    ‫ZoomSettingsScope אופציונלי

    ההגדרה קובעת אם שינויי הזום יישמרו עבור המקור של הדף, או רק בכרטיסייה הנוכחית. ברירת המחדל היא per-origin במצב automatic, ו-per-tab בכל מצב אחר.

ZoomSettingsMode

‫Chrome 44 ואילך

המאפיין הזה מגדיר איך שינויים בזום מטופלים, כלומר איזו ישות אחראית על שינוי קנה המידה בפועל של הדף. ברירת המחדל היא automatic.

Enum

‫automatic
הדפדפן מטפל בשינויי הזום באופן אוטומטי.

‫'manual'
מבטל את הטיפול האוטומטי בשינויי זום. האירוע onZoomChange עדיין יישלח, והתוסף אחראי להאזין לאירוע הזה ולשנות את קנה המידה של הדף באופן ידני. במצב הזה אין תמיכה בהגדלת התצוגה per-origin, ולכן המערכת מתעלמת מהגדרת הזום scope ומניחה שהזום הוא per-tab.

‫disabled
משבית את כל אפשרויות הזום בכרטיסייה. הכרטיסייה חוזרת למרחק התצוגה שמוגדר כברירת מחדל, וכל הניסיונות לשנות את מרחק התצוגה מתעלמים.

ZoomSettingsScope

‫Chrome 44 ואילך

ההגדרה קובעת אם שינויי הזום יישמרו עבור המקור של הדף, או רק בכרטיסייה הנוכחית. ברירת המחדל היא per-origin במצב automatic, ו-per-tab בכל מצב אחר.

Enum

'לכל מקור'
שינויי הזום נשמרים במקור של הדף המוגדל, כלומר, גם כל הכרטיסיות האחרות שמובילות לאותו מקור מוגדלות. בנוסף, per-origin שינויים בהגדלה נשמרים עם המקור, כלומר כשעוברים לדפים אחרים באותו מקור, כולם מוגדלים באותו גורם הגדלה. ההיקף per-origin זמין רק במצב automatic.

"לכל כרטיסייה"
שינויים בזום משפיעים רק על הכרטיסייה הזו, ושינויים בזום בכרטיסיות אחרות לא משפיעים על הזום בכרטיסייה הזו. בנוסף, per-tab שינויים בהגדלה מאופסים כשעוברים בין דפים. כשעוברים לכרטיסייה, הדפים תמיד נטענים עם per-origin גורמי ההגדלה שלהם.

מאפיינים

MAX_CAPTURE_VISIBLE_TAB_CALLS_PER_SECOND

‫Chrome 92 ואילך

המספר המקסימלי של פעמים שאפשר לקרוא ל-captureVisibleTab בשנייה. השימוש ב-captureVisibleTab יקר ולכן לא מומלץ להשתמש בו לעיתים קרובות מדי.

ערך

2

TAB_ID_NONE

‫Chrome 46 ואילך

מזהה שמייצג את העובדה שלא מוצגת כרטיסייה בדפדפן.

ערך

-1

TAB_INDEX_NONE

‫Chrome 123 ואילך

אינדקס שמייצג את היעדר האינדקס של כרטיסייה ברכיב tab_strip.

ערך

-1

Methods

captureVisibleTab()

Promise 
chrome.tabs.captureVisibleTab(
  windowId?: number,
  options?: ImageDetails,
  callback?: function,
)

מצלם את האזור הגלוי של הכרטיסייה הפעילה כרגע בחלון שצוין. כדי לקרוא לשיטה הזו, לתוסף צריכה להיות ההרשאה <all_urls> או ההרשאה activeTab. בנוסף לאתרים שאליהם יש לתוספים בדרך כלל גישה, השיטה הזו מאפשרת לתוספים לצלם אתרים רגישים שמוגבלים בדרך אחרת, כולל דפים עם סכימת chrome:, דפים של תוספים אחרים וכתובות URL עם נתונים. אפשר לצלם אתרים רגישים רק עם ההרשאה activeTab. אפשר לתעד כתובות URL של קבצים רק אם ניתנה לתוסף גישה לקבצים.

פרמטרים

  • windowId

    מספר אופציונלי

    חלון היעד. ברירת המחדל היא החלון הנוכחי.

  • options

    ‫ImageDetails אופציונלי

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (dataUrl: string) => void

    • dataUrl

      מחרוזת

      כתובת URL של נתונים שמקודדת תמונה של האזור הגלוי בכרטיסייה שצולמה. אפשר להקצות אותו למאפיין src של רכיב img HTML לתצוגה.

החזרות

  • Promise<string>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

connect()

chrome.tabs.connect(
  tabId: number,
  connectInfo?: object,
)

מתחבר לסקריפטים של התוכן בכרטיסייה שצוינה. האירוע runtime.onConnect מופעל בכל סקריפט תוכן שפועל בכרטיסייה שצוינה עבור התוסף הנוכחי. מידע נוסף זמין במאמר בנושא העברת הודעות בסקריפט תוכן.

פרמטרים

  • tabId

    number

  • connectInfo

    אובייקט אופציונלי

    • documentId

      מחרוזת אופציונלי

      ‫Chrome 106 ואילך

      פתיחת יציאה למסמך ספציפי שמזוהה על ידי documentId במקום כל המסגרות בכרטיסייה.

    • frameId

      מספר אופציונלי

      פתיחת יציאה למסגרת ספציפית שמזוהה על ידי frameId במקום לכל המסגרות בכרטיסייה.

    • שם

      מחרוזת אופציונלי

      מועבר אל onConnect עבור סקריפטים של תוכן שמקשיבים לאירוע החיבור.

החזרות

  • יציאה שאפשר להשתמש בה כדי לתקשר עם סקריפטים של תוכן שפועלים בכרטיסייה שצוינה. האירוע runtime.Port של היציאה מופעל אם הכרטיסייה נסגרת או לא קיימת.

create()

Promise 
chrome.tabs.create(
  createProperties: object,
  callback?: function,
)

יצירת כרטיסייה חדשה.

פרמטרים

  • createProperties

    אובייקט

    • פעיל

      ‫boolean אופציונלי

      האם הכרטיסייה צריכה להפוך לכרטיסייה הפעילה בחלון. ההגדרה לא משפיעה על המיקוד בחלון (ראו windows.update). ברירת המחדל היא true.

    • אינדקס

      מספר אופציונלי

      המיקום של הכרטיסייה בחלון. הערך שצוין מוגבל לטווח שבין אפס למספר הכרטיסיות בחלון.

    • openerTabId

      מספר אופציונלי

      המזהה של הכרטיסייה שפתחה את הכרטיסייה הזו. אם מציינים כרטיסייה, היא צריכה להיות באותו חלון כמו הכרטיסייה החדשה שנוצרה.

    • מוצמד

      ‫boolean אופציונלי

      האם להצמיד את הכרטיסייה. ברירת המחדל היא false

    • נבחר

      ‫boolean אופציונלי

      הוצא משימוש

      צריך להשתמש בערך active.

      האם הכרטיסייה צריכה להפוך לכרטיסייה שנבחרה בחלון. ברירת המחדל היא true

    • כתובת אתר

      מחרוזת אופציונלי

      כתובת ה-URL שאליה הכרטיסייה תנווט בהתחלה. כתובות URL שמוגדרות במלואן חייבות לכלול סכימה (כלומר, ‫'http://www.google.com', ולא 'www.google.com'). כתובות URL יחסיות הן יחסיות לדף הנוכחי בתוך התוסף. ברירת המחדל היא דף הכרטיסייה החדשה.

    • windowId

      מספר אופציונלי

      החלון שבו ליצור את הכרטיסייה החדשה. ברירת המחדל היא החלון הנוכחי.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (tab: Tab) => void

    • כרטיסייה

      Tab

      הכרטיסייה שנוצרה.

החזרות

  • Promise<Tab>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

detectLanguage()

Promise 
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 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

discard()

Promise Chrome 54+ 
chrome.tabs.discard(
  tabId?: number,
  callback?: function,
)

הכרטיסייה נמחקת מהזיכרון. הכרטיסיות שהוצאו משימוש עדיין מוצגות בשורת הכרטיסיות, והן נטענות מחדש כשהן מופעלות.

פרמטרים

  • tabId

    מספר אופציונלי

    המזהה של הכרטיסייה שצריך לסגור. אם מציינים את האפשרות הזו, הכרטיסייה מושבתת אלא אם היא פעילה או שכבר הושבתה. אם לא מציינים כרטיסייה, הדפדפן משליך את הכרטיסייה הכי פחות חשובה. הפעולה הזו עלולה להיכשל אם לא קיימות כרטיסיות שאפשר לסגור.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (tab?: Tab) => void

    • כרטיסייה

      Tab אופציונלי

      הכרטיסייה שהוצאה מהזיכרון, אם היא הוצאה בהצלחה. אחרת, הערך הוא undefined.

החזרות

  • Promise<Tab | undefined>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

duplicate()

Promise 
chrome.tabs.duplicate(
  tabId: number,
  callback?: function,
)

שכפול של כרטיסייה.

פרמטרים

  • tabId

    number

    המזהה של הכרטיסייה שרוצים לשכפל.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (tab?: Tab) => void

    • כרטיסייה

      Tab אופציונלי

      פרטים על הכרטיסייה המשוכפלת. המאפיינים url, pendingUrl, title ו-favIconUrl נכללים באובייקט tabs.Tab רק אם לתוסף יש הרשאה "tabs" או הרשאות מארח לדף.

החזרות

  • Promise<Tab | undefined>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

get()

Promise 
chrome.tabs.get(
  tabId: number,
  callback?: function,
)

אחזור פרטים על הכרטיסייה שצוינה.

פרמטרים

  • tabId

    number

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (tab: Tab) => void

    • כרטיסייה

      Tab

החזרות

  • Promise<Tab>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

getCurrent()

Promise 
chrome.tabs.getCurrent(
  callback?: function,
)

מחזירה את הכרטיסייה שממנה מתבצעת הקריאה הזו לסקריפט. הפונקציה מחזירה את הערך undefined אם היא מופעלת בהקשר שאינו כרטיסייה (למשל, דף ברקע או תצוגה של חלון קופץ).

פרמטרים

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (tab?: Tab) => void

    • כרטיסייה

      Tab אופציונלי

החזרות

  • Promise<Tab | undefined>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

getZoom()

Promise 
chrome.tabs.getZoom(
  tabId?: number,
  callback?: function,
)

מקבל את גורם הזום הנוכחי של כרטיסייה שצוינה.

פרמטרים

  • tabId

    מספר אופציונלי

    המזהה של הכרטיסייה שממנה רוצים לקבל את גורם הזום הנוכחי. ברירת המחדל היא הכרטיסייה הפעילה בחלון הנוכחי.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (zoomFactor: number) => void

    • zoomFactor

      number

      גורם הזום הנוכחי של הכרטיסייה.

החזרות

  • Promise<number>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

getZoomSettings()

Promise 
chrome.tabs.getZoomSettings(
  tabId?: number,
  callback?: function,
)

הפונקציה מחזירה את הגדרות הזום הנוכחיות של כרטיסייה שצוינה.

פרמטרים

  • tabId

    מספר אופציונלי

    המזהה של הכרטיסייה שממנה רוצים לקבל את הגדרות הזום הנוכחיות. ברירת המחדל היא הכרטיסייה הפעילה של החלון הנוכחי.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (zoomSettings: ZoomSettings) => void

    • zoomSettings

      ZoomSettings

      הגדרות הזום הנוכחיות של הכרטיסייה.

החזרות

  • Promise<ZoomSettings>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

goBack()

Promise Chrome 72+ 
chrome.tabs.goBack(
  tabId?: number,
  callback?: function,
)

חזרה לדף הקודם, אם יש כזה.

פרמטרים

  • tabId

    מספר אופציונלי

    המזהה של הכרטיסייה שאליה רוצים לחזור. ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

goForward()

Promise Chrome 72+ 
chrome.tabs.goForward(
  tabId?: number,
  callback?: function,
)

מעבר קדימה לדף הבא, אם יש כזה.

פרמטרים

  • tabId

    מספר אופציונלי

    המזהה של הכרטיסייה שאליה רוצים לעבור קדימה. ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

group()

Promise Chrome 88 ואילך 
chrome.tabs.group(
  options: object,
  callback?: function,
)

הפעולה מוסיפה כרטיסייה אחת או יותר לקבוצה שצוינה, או אם לא צוינה קבוצה, היא מוסיפה את הכרטיסיות שצוינו לקבוצה חדשה שנוצרה.

פרמטרים

  • options

    אובייקט

    • createProperties

      אובייקט אופציונלי

      הגדרות ליצירת קבוצה. אי אפשר להשתמש בפרמטר הזה אם כבר צוין groupId.

      • windowId

        מספר אופציונלי

        החלון של הקבוצה החדשה. ברירת המחדל היא החלון הנוכחי.

    • groupId

      מספר אופציונלי

      המזהה של הקבוצה שאליה רוצים להוסיף את הכרטיסיות. אם לא מציינים קבוצה, המערכת תיצור קבוצה חדשה.

    • tabIds

      number | [number, ...number[]]

      מזהה הכרטיסייה או רשימה של מזהי כרטיסיות שרוצים להוסיף לקבוצה שצוינה.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (groupId: number) => void

    • groupId

      number

      המזהה של הקבוצה שאליה נוספו הכרטיסיות.

החזרות

  • Promise<number>

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

highlight()

Promise 
chrome.tabs.highlight(
  highlightInfo: object,
  callback?: function,
)

מדגיש את הכרטיסיות שצוינו ומעביר את המיקוד לכרטיסייה הראשונה בקבוצה. אם הכרטיסייה שצוינה פעילה כרגע, לא יקרה שום דבר.

פרמטרים

  • highlightInfo

    אובייקט

    • כרטיסיות

      number | number[]

      אינדקסים של כרטיסייה אחת או יותר להדגשה.

    • windowId

      מספר אופציונלי

      החלון שמכיל את הכרטיסיות.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (window: Window) => void

    • חלון

      חלון

      מכיל פרטים על החלון שהכרטיסיות שלו הודגשו.

החזרות

  • Promise<windows.Window>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

move()

Promise 
chrome.tabs.move(
  tabIds: number | number[],
  moveProperties: object,
  callback?: function,
)

העברה של כרטיסייה אחת או יותר למיקום חדש בחלון שלהן, או לחלון חדש. שימו לב שאפשר להעביר כרטיסיות רק לחלונות רגילים (window.type === "normal") ומחלונות רגילים.

פרמטרים

  • tabIds

    number | number[]

    מזהה הכרטיסייה או רשימה של מזהי כרטיסיות שרוצים להעביר.

  • moveProperties

    אובייקט

    • אינדקס

      number

      המיקום שאליו רוצים להעביר את החלון. משתמשים ב--1 כדי למקם את הכרטיסייה בסוף החלון.

    • windowId

      מספר אופציונלי

      ברירת המחדל היא החלון שבו הכרטיסייה פתוחה כרגע.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (tabs: Tab | Tab[]) => void

    • כרטיסיות

      ‫Tab | Tab[]

      פרטים על הכרטיסיות שהועברו.

החזרות

  • ‫Promise<Tab | Tab[]>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

query()

Promise 
chrome.tabs.query(
  queryInfo: object,
  callback?: function,
)

מחזירה את כל הכרטיסיות עם המאפיינים שצוינו, או את כל הכרטיסיות אם לא צוינו מאפיינים.

פרמטרים

  • queryInfo

    אובייקט

    • פעיל

      ‫boolean אופציונלי

      האם הכרטיסיות פעילות בחלונות שלהן.

    • audible, אודיבל

      ‫boolean אופציונלי

      ‫Chrome 45 ואילך

      אם הכרטיסיות משמיעות צליל.

    • autoDiscardable

      ‫boolean אופציונלי

      ‫Chrome 54 ואילך

      ההגדרה קובעת אם הדפדפן יכול להסיר כרטיסיות באופן אוטומטי כשאין מספיק משאבים.

    • currentWindow

      ‫boolean אופציונלי

      אם הכרטיסיות נמצאות בחלון הנוכחי.

    • דחית את

      ‫boolean אופציונלי

      ‫Chrome 54 ואילך

      אם הכרטיסיות נסגרות. כרטיסייה שהוצאה מהזיכרון היא כרטיסייה שהתוכן שלה לא נטען מהזיכרון, אבל היא עדיין מוצגת בשורת הכרטיסיות. התוכן שלו נטען מחדש בפעם הבאה שהוא מופעל.

    • קפוא

      ‫boolean אופציונלי

      ‫Chrome 132 ואילך

      אם הכרטיסיות מוקפאות. כרטיסייה מוקפאת לא יכולה לבצע משימות, כולל גורמים שמטפלים באירועים או טיימרים. היא גלויה בסרגל הכרטיסיות והתוכן שלה נטען בזיכרון. ההקפאה מבוטלת כשהמינוי מופעל.

    • groupId

      מספר אופציונלי

      ‫Chrome 88 ואילך

      המזהה של הקבוצה שהכרטיסיות נמצאות בה, או tabGroups.TAB_GROUP_ID_NONE אם הכרטיסיות לא מקובצות.

    • מודגש

      ‫boolean אופציונלי

      אם הכרטיסיות מודגשות.

    • אינדקס

      מספר אופציונלי

      המיקום של הכרטיסיות בחלונות שלהן.

    • lastFocusedWindow

      ‫boolean אופציונלי

      האם הכרטיסיות נמצאות בחלון האחרון שהיה ממוקד.

    • הושתק

      ‫boolean אופציונלי

      ‫Chrome 45 ואילך

      אם הכרטיסיות מושתקות.

    • מוצמד

      ‫boolean אופציונלי

      אם הכרטיסיות מוצמדות.

    • splitViewId

      מספר אופציונלי

      בהמתנה

      המספר הסידורי של התצוגה המפוצלת שבה הכרטיסיות נמצאות, או tabs.SPLIT_VIEW_ID_NONE אם הכרטיסיות לא נמצאות בתצוגה מפוצלת.

    • status

      ‫TabStatus אופציונלי

      סטטוס הטעינה של הכרטיסייה.

    • title

      מחרוזת אופציונלי

      התאמה של כותרות דפים לתבנית. המערכת מתעלמת מהמאפיין הזה אם לתוסף אין הרשאת "tabs" או הרשאות מארח לדף.

    • כתובת אתר

      מחרוזת | מערך מחרוזות אופציונלי

      התאמת כרטיסיות לאחת או יותר תבניות של כתובות URL. לא נמצאה התאמה למזהי קטעים. המערכת מתעלמת מהמאפיין הזה אם לתוסף אין הרשאת "tabs" או הרשאות מארח לדף.

    • windowId

      מספר אופציונלי

      המזהה של חלון ההורה, או windows.WINDOW_ID_CURRENT בשביל החלון הנוכחי.

    • windowType

      ‫WindowType אופציונלי

      סוג החלון שבו הכרטיסיות נמצאות.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (result: Tab[]) => void

    • תוצאה

      ‫Tab[]

החזרות

  • Promise<Tab[]>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

reload()

Promise 
chrome.tabs.reload(
  tabId?: number,
  reloadProperties?: object,
  callback?: function,
)

טוענים מחדש כרטיסייה.

פרמטרים

  • tabId

    מספר אופציונלי

    המזהה של הכרטיסייה לטעינה מחדש. ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.

  • reloadProperties

    אובייקט אופציונלי

    • bypassCache

      ‫boolean אופציונלי

      האם לעקוף את השמירה במטמון המקומי. ברירת המחדל היא false.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

remove()

Promise 
chrome.tabs.remove(
  tabIds: number | number[],
  callback?: function,
)

סגירה של כרטיסייה אחת או יותר.

פרמטרים

  • tabIds

    number | number[]

    מזהה הכרטיסייה או רשימה של מזהי כרטיסיות שרוצים לסגור.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

sendMessage()

Promise 
chrome.tabs.sendMessage(
  tabId: number,
  message: any,
  options?: object,
  callback?: function,
)

שולח הודעה אחת לסקריפטים של התוכן בכרטיסייה שצוינה, עם קריאה חוזרת אופציונלית להפעלה כשנשלחת תשובה. האירוע runtime.onMessage מופעל בכל סקריפט תוכן שפועל בכרטיסייה שצוינה עבור התוסף הנוכחי.

פרמטרים

  • tabId

    number

  • הודעה

    כל

    ההודעה לשליחה. ההודעה הזו צריכה להיות אובייקט שאפשר להמיר ל-JSON.

  • options

    אובייקט אופציונלי

    • documentId

      מחרוזת אופציונלי

      ‫Chrome 106 ואילך

      שליחת הודעה למסמך ספציפי שמזוהה על ידי documentId במקום לכל המסגרות בכרטיסייה.

    • frameId

      מספר אופציונלי

      שליחת הודעה למסגרת ספציפית שמזוהה על ידי frameId במקום לכל המסגרות בכרטיסייה.

  • callback

    פונקציה אופציונלית

    ‫Chrome 99 ואילך

    הפרמטר callback נראה כך: 

    (response: any) => void

    • תשובה

      כל

      אובייקט התגובה ב-JSON שנשלח על ידי ה-handler של ההודעה. אם מתרחשת שגיאה במהלך החיבור לכרטיסייה שצוינה, מתבצעת קריאה חוזרת ללא ארגומנטים, והערך של runtime.lastError מוגדר להודעת השגיאה.

החזרות

  • Promise<any>

    ‫Chrome 99 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

setZoom()

Promise 
chrome.tabs.setZoom(
  tabId?: number,
  zoomFactor: number,
  callback?: function,
)

הגדלה של כרטיסייה ספציפית.

פרמטרים

  • tabId

    מספר אופציונלי

    המזהה של הכרטיסייה לשינוי גודל התצוגה. ברירת המחדל היא הכרטיסייה הפעילה בחלון הנוכחי.

  • zoomFactor

    number

    גורם הזום החדש. הערך 0 מגדיר את כרטיסיית הדפדפן לגורם ברירת המחדל הנוכחי של הזום. ערכים גדולים מ-0 מציינים גורם שינוי גודל (אולי לא ברירת מחדל) לכרטיסייה.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

setZoomSettings()

Promise 
chrome.tabs.setZoomSettings(
  tabId?: number,
  zoomSettings: ZoomSettings,
  callback?: function,
)

ההגדרה הזו קובעת את הגדרות הזום של כרטיסייה ספציפית, ומגדירה איך שינויים בזום מטופלים. ההגדרות האלה מאופסות לברירות המחדל כשעוברים לכרטיסייה.

פרמטרים

  • tabId

    מספר אופציונלי

    המזהה של הכרטיסייה שרוצים לשנות את הגדרות הזום שלה. ברירת המחדל היא הכרטיסייה הפעילה בחלון הנוכחי.

  • zoomSettings

    ZoomSettings

    ההגדרה קובעת איך שינויים בזום מטופלים ובאיזה היקף.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

ungroup()

Promise Chrome 88 ואילך 
chrome.tabs.ungroup(
  tabIds: number | [number, ...number[]],
  callback?: function,
)

מסירים כרטיסייה אחת או יותר מהקבוצות שלהן. אם קבוצות מסוימות מתרוקנות, הן נמחקות.

פרמטרים

  • tabIds

    number | [number, ...number[]]

    מזהה הכרטיסייה או רשימת מזהי הכרטיסיות שרוצים להסיר מהקבוצות שלהן.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

update()

Promise 
chrome.tabs.update(
  tabId?: number,
  updateProperties: object,
  callback?: function,
)

משנה את המאפיינים של כרטיסייה. מאפיינים שלא מצוינים ב-updateProperties לא משתנים.

פרמטרים

  • tabId

    מספר אופציונלי

    ברירת המחדל היא הכרטיסייה שנבחרה בחלון הנוכחי.

  • updateProperties

    אובייקט

    • פעיל

      ‫boolean אופציונלי

      האם הכרטיסייה צריכה להיות פעילה. היא לא משפיעה על המיקוד בחלון (ראו windows.update).

    • autoDiscardable

      ‫boolean אופציונלי

      ‫Chrome 54 ואילך

      ההגדרה קובעת אם הדפדפן צריך להשליך את הכרטיסייה באופן אוטומטי כשאין מספיק משאבים.

    • מודגש

      ‫boolean אופציונלי

      הוספה או הסרה של הכרטיסייה מהבחירה הנוכחית.

    • הושתק

      ‫boolean אופציונלי

      ‫Chrome 45 ואילך

      האם להשתיק את הכרטיסייה.

    • openerTabId

      מספר אופציונלי

      המזהה של הכרטיסייה שפתחה את הכרטיסייה הזו. אם מציינים את זה, כרטיסיית הפתיחה צריכה להיות באותו חלון כמו הכרטיסייה הזו.

    • מוצמד

      ‫boolean אופציונלי

      האם להצמיד את הכרטיסייה.

    • נבחר

      ‫boolean אופציונלי

      הוצא משימוש

      צריך להשתמש ב-highlighted.

      האם הכרטיסייה צריכה להיות מסומנת.

    • כתובת אתר

      מחרוזת אופציונלי

      כתובת URL שאליה הכרטיסייה תנווט. אין תמיכה בכתובות URL של JavaScript. במקום זאת, צריך להשתמש ב-scripting.executeScript.

  • callback

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (tab?: Tab) => void

    • כרטיסייה

      Tab אופציונלי

      פרטים על הכרטיסייה המעודכנת. המאפיינים url, pendingUrl, title ו-favIconUrl נכללים באובייקט tabs.Tab רק אם לתוסף יש הרשאה "tabs" או הרשאות מארח לדף.

החזרות

  • Promise<Tab | undefined>

    ‫Chrome 88 ואילך

    יש תמיכה ב-Promises ב-Manifest V3 ובגרסאות מאוחרות יותר, אבל יש גם קריאות חוזרות (callbacks) לצורך תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. ההבטחה מסתיימת עם אותו סוג שמועבר לפונקציית הקריאה החוזרת.

אירועים

onActivated

chrome.tabs.onActivated.addListener(
  callback: function,
)

מופעל כשמשתנה הכרטיסייה הפעילה בחלון. שימו לב: יכול להיות שכתובת ה-URL של הכרטיסייה לא תוגדר בזמן שהאירוע הזה מופעל, אבל אפשר להאזין לאירועים מסוג onUpdated כדי לקבל הודעה כשכתובת URL מוגדרת.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (activeInfo: object) => void

    • activeInfo

      אובייקט

      • tabId

        number

        המזהה של הכרטיסייה שהפכה לפעילה.

      • 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 מוגדרת או כשהכרטיסייה מתווספת לקבוצת כרטיסיות.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (tab: Tab) => void

    • כרטיסייה

      Tab

onDetached

chrome.tabs.onDetached.addListener(
  callback: function,
)

מופעלת כשמנתקים כרטיסייה מחלון, למשל כי היא הועברה בין חלונות.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (tabId: number, detachInfo: object) => void

    • tabId

      number

    • detachInfo

      אובייקט

      • oldPosition

        number

      • oldWindowId

        number

onHighlighted

chrome.tabs.onHighlighted.addListener(
  callback: function,
)

מופעל כשמשתנה הכרטיסייה שנבחרה או שהודגשה בחלון.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (highlightInfo: object) => void

    • highlightInfo

      אובייקט

      • tabIds

        number[]

        כל הכרטיסיות המודגשות בחלון.

      • 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

onUpdated

chrome.tabs.onUpdated.addListener(
  callback: function,
)

מופעל כשמתבצע עדכון של כרטיסייה.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    (tabId: number, changeInfo: object, tab: Tab) => void

    • tabId

      number

    • changeInfo

      אובייקט

      • audible, אודיבל

        ‫boolean אופציונלי

        ‫Chrome 45 ואילך

        המצב החדש של האודיו בכרטיסייה.

      • autoDiscardable

        ‫boolean אופציונלי

        ‫Chrome 54 ואילך

        המצב החדש של הכרטיסייה שניתן להסרה אוטומטית.

      • דחית את

        ‫boolean אופציונלי

        ‫Chrome 54 ואילך

        המצב החדש של הכרטיסייה אחרי ההסרה.

      • favIconUrl

        מחרוזת אופציונלי

        כתובת ה-URL החדשה של סמל האתר בכרטיסייה.

      • קפוא

        ‫boolean אופציונלי

        ‫Chrome 132 ואילך

        הסטטוס החדש של הכרטיסייה, שהיא קפואה.

      • groupId

        מספר אופציונלי

        ‫Chrome 88 ואילך

        הקבוצה החדשה של הכרטיסייה.

      • mutedInfo

        MutedInfo אופציונלי

        ‫Chrome 46 ואילך

        המצב החדש של הכרטיסייה (השתקה) והסיבה לשינוי.

      • מוצמד

        ‫boolean אופציונלי

        המצב החדש של הכרטיסייה (מוצמדת או לא).

      • splitViewId

        מספר אופציונלי

        בהמתנה

        התצוגה המפוצלת החדשה של הכרטיסייה.

      • 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

        ZoomSettings