chrome.tabs

refresh date: 2026-09-25 robots: noindex

תיאור

משתמשים ב-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.
}

דוגמאות לתוספים

לדוגמאות נוספות של תוספים ל-Tabs API, אפשר לעיין באחת מהאפשרויות הבאות:

סוגים

MutedInfo

‫Chrome מגרסה 46 ואילך

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

מאפיינים

  • extensionId

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

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

  • מושתק

    בוליאני

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

  • reason

    MutedInfoReason אופציונלי

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

MutedInfoReason

‫Chrome מגרסה 46 ואילך

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

טיפוסים בני מנייה (enum)

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

"capture"
התחילה הקלטה של הכרטיסייה, מה שגרם לשינוי הסטטוס ל"מושתק".

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

Tab

מאפיינים

  • פעיל

    בוליאני

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

  • audible, אודיבל

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

    ‫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

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

  • lastAccessed

    number

    ‫Chrome מגרסה 121 ואילך

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

  • mutedInfo

    ‫MutedInfo אופציונלי

    ‫Chrome מגרסה 46 ואילך

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

  • openerTabId

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

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

  • pendingUrl

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

    ‫Chrome מגרסה 79 ואילך

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

  • מוצמד

    בוליאני

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

  • נבחר

    בוליאני

    הוצא משימוש

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

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

  • sessionId

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

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

  • splitViewId

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

    ‫Chrome מגרסה 140 ואילך

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

  • status

    TabStatus אופציונלי

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

  • title

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

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

  • url

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

    כתובת ה-URL האחרונה שהוקצתה למסגרת הראשית של הכרטיסייה. המאפיין הזה קיים רק אם לתוסף יש את ההרשאה "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 אופציונלי

    מגדירה איך המערכת מטפלת בשינויים של מרחק התצוגה, כלומר, איזו ישות אחראית לשינוי קנה המידה של הדף בפועל. ברירת המחדל היא 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 נשמרים במקור, כלומר כשמנווטים לדפים אחרים באותו מקור, כולם מוגדלים לאותו גורם זום. ההיקף per-origin זמין רק במצב automatic.

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

מאפיינים

MAX_CAPTURE_VISIBLE_TAB_CALLS_PER_SECOND

‫Chrome מגרסה 92 ואילך

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

ערך

2

SPLIT_VIEW_ID_NONE

‫Chrome מגרסה 140 ואילך

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

ערך

-1

TAB_ID_NONE

‫Chrome מגרסה 46 ואילך

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

ערך

-1

TAB_INDEX_NONE

‫Chrome מגרסה 123 ואילך

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

ערך

-1

Methods

captureVisibleTab()

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

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

פרמטרים

  • windowId

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

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

  • אפשרויות

    ‫ImageDetails אופציונלי

  • callback

    function optional

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

    (dataUrl: string) => void

    • dataUrl

      מחרוזת

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

החזרות

  • Promise<string>

    ‫Chrome מגרסה 88 ואילך

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

connect()

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

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

פרמטרים

  • tabId

    number

  • connectInfo

    object optional

    • documentId

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

      ‫Chrome מגרסה 106 ואילך

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

    • frameId

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

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

    • שם

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

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

החזרות

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

create()

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

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

פרמטרים

  • createProperties

    אובייקט

    • פעיל

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

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

    • אינדקס

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

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

    • openerTabId

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

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

    • מוצמד

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

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

    • נבחר

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

      הוצא משימוש

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

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

    • splitWithTabId

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

      ‫Chrome מגרסה 155 ואילך

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

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

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

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

    • windowId

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

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

  • callback

    function optional

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

    (tab: Tab) => void

החזרות

  • Promise<Tab>

    ‫Chrome מגרסה 88 ואילך

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

createSplit()

Promise Chrome 155 ואילך
chrome.tabs.createSplit(
  tabIds: [number, number],
  callback?: function,
)
: Promise<number>

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

פרמטרים

  • tabIds

    [number, number]

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

    הם חייבים להיות סמוכים. הם לא יכולים להיות כבר בתצוגה מפוצלת. הם צריכים להיות במצבים תואמים של windowId, pinned ו-groupId.

  • callback

    function optional

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

    (splitViewId: number) => void

    • splitViewId

      number

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

החזרות

  • Promise<number>

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

detectLanguage()

Promise
chrome.tabs.detectLanguage(
  tabId?: number,
  callback?: function,
)
: Promise<string>

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

פרמטרים

  • tabId

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

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

  • callback

    function optional

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

    (language: string) => void

    • language

      מחרוזת

      קוד שפה לפי תקן ISO, כמו en או fr. הרשימה המלאה של השפות שנתמכות בשיטה הזו מופיעה ב-kLanguageInfoTable. המערכת בודקת את העמודות השנייה עד הרביעית ומחזירה את הערך הראשון שהוא לא NULL, חוץ מאשר בסינית פשוטה, שבה מוחזר הערך zh-CN. אם השפה לא ידועה או לא מוגדרת, הערך שמוחזר הוא und.

החזרות

  • Promise<string>

    ‫Chrome מגרסה 88 ואילך

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

discard()

Promise Chrome 54 ואילך
chrome.tabs.discard(
  tabId?: number,
  callback?: function,
)
: Promise<Tab | undefined>

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

פרמטרים

  • tabId

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

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

  • callback

    function optional

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

    (tab?: Tab) => void

    • Tab

      כרטיסייה אופציונלי

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

החזרות

  • Promise<Tab | undefined>

    ‫Chrome מגרסה 88 ואילך

    הפעולה מסתיימת אחרי שהיא הושלמה.

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

duplicate()

Promise
chrome.tabs.duplicate(
  tabId: number,
  callback?: function,
)
: Promise<Tab | undefined>

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

פרמטרים

  • tabId

    number

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

  • callback

    function optional

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

    (tab?: Tab) => void

    • Tab

      כרטיסייה אופציונלי

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

החזרות

  • Promise<Tab | undefined>

    ‫Chrome מגרסה 88 ואילך

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

executeScript()

Promise &leq; MV2 הוצא משימוש בגרסה Chrome 91
chrome.tabs.executeScript(
  tabId?: number,
  details: InjectDetails,
  callback?: function,
)
: Promise<any[] | undefined>

הוחלף על ידי scripting.executeScript ב-Manifest V3.

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

פרמטרים

  • tabId

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

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

  • פרטים

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

  • callback

    function optional

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

    (result?: any[]) => void

    • תוצאה

      any[] אופציונלי

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

החזרות

  • Promise<any[] | undefined>

    ‫Chrome מגרסה 88 ואילך

    ההבטחה מתקיימת אחרי שכל ה-JavaScript מופעל.

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

get()

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

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

פרמטרים

  • tabId

    number

  • callback

    function optional

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

    (tab: Tab) => void

החזרות

  • Promise<Tab>

    ‫Chrome מגרסה 88 ואילך

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

getAllInWindow()

Promise &leq; MV2 הוצאה משימוש
chrome.tabs.getAllInWindow(
  windowId?: number,
  callback?: function,
)
: Promise<Tab[]>

צריך להשתמש ב-tabs.query {windowId: windowId}.

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

פרמטרים

  • windowId

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

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

  • callback

    function optional

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

    (tabs: Tab[]) => void

החזרות

  • Promise<Tab[]>

    ‫Chrome מגרסה 88 ואילך

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

getCurrent()

Promise
chrome.tabs.getCurrent(
  callback?: function,
)
: Promise<Tab | undefined>

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

פרמטרים

  • callback

    function optional

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

    (tab?: Tab) => void

החזרות

  • Promise<Tab | undefined>

    ‫Chrome מגרסה 88 ואילך

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

getSelected()

Promise &leq; MV2 הוצאה משימוש
chrome.tabs.getSelected(
  windowId?: number,
  callback?: function,
)
: Promise<Tab>

צריך להשתמש ב-tabs.query {active: true}.

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

פרמטרים

החזרות

  • Promise<Tab>

    ‫Chrome מגרסה 88 ואילך

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

getZoom()

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

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

פרמטרים

  • tabId

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

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

  • callback

    function optional

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

    (zoomFactor: number) => void

    • zoomFactor

      number

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

החזרות

  • Promise<number>

    ‫Chrome מגרסה 88 ואילך

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

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

getZoomSettings()

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

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

פרמטרים

  • tabId

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

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

  • callback

    function optional

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

    (zoomSettings: ZoomSettings) => void

    • zoomSettings

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

החזרות

  • Promise<ZoomSettings>

    ‫Chrome מגרסה 88 ואילך

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

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

goBack()

Promise Chrome 72 ואילך
chrome.tabs.goBack(
  tabId?: number,
  callback?: function,
)
: Promise<void>

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

פרמטרים

  • tabId

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

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 88 ואילך

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

goForward()

Promise Chrome 72 ואילך
chrome.tabs.goForward(
  tabId?: number,
  callback?: function,
)
: Promise<void>

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

פרמטרים

  • tabId

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

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 88 ואילך

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

group()

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

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

פרמטרים

  • אפשרויות

    אובייקט

    • createProperties

      object optional

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

      • windowId

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

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

    • groupId

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

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

    • tabIds

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

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

  • callback

    function optional

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

    (groupId: number) => void

    • groupId

      number

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

החזרות

  • Promise<number>

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

highlight()

Promise
chrome.tabs.highlight(
  highlightInfo: object,
  callback?: function,
)
: Promise<windows.Window>

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

פרמטרים

  • highlightInfo

    אובייקט

    • כרטיסיות

      number | number[]‎

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

    • windowId

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

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

  • callback

    function optional

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

    (window: Window) => void

    • חלון

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

החזרות

  • ‫Chrome מגרסה 88 ואילך

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

insertCSS()

Promise &leq; MV2 הוצא משימוש בגרסה Chrome 91
chrome.tabs.insertCSS(
  tabId?: number,
  details: InjectDetails,
  callback?: function,
)
: Promise<void>

הוחלף על ידי scripting.insertCSS ב-Manifest V3.

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

פרמטרים

  • tabId

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

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

  • פרטים

    פרטי טקסט ה-CSS שצריך להוסיף. צריך להגדיר את מאפיין הקוד או את מאפיין הקובץ, אבל אי אפשר להגדיר את שניהם בו-זמנית.

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 88 ואילך

    ההבטחה מתממשת כשכל ה-CSS מוכנס.

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

move()

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

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

פרמטרים

  • tabIds

    number | number[]‎

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

  • moveProperties

    אובייקט

    • אינדקס

      number

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

    • windowId

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

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

  • callback

    function optional

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

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

    • כרטיסיות

      Tab | Tab[]

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

החזרות

  • Promise<Tab | Tab[]>

    ‫Chrome מגרסה 88 ואילך

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

query()

Promise
chrome.tabs.query(
  queryInfo: object,
  callback?: function,
)
: Promise<Tab[]>

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

פרמטרים

  • queryInfo

    אובייקט

    • פעיל

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

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

    • audible, אודיבל

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

      ‫Chrome 45 ואילך

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

    • autoDiscardable

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

      ‫Chrome מגרסה 54 ואילך

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

    • currentWindow

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

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

    • דחית את

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

      ‫Chrome מגרסה 54 ואילך

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

    • במצב קפוא

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

      ‫Chrome מגרסה 132 ואילך

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

    • groupId

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

      ‫Chrome מגרסה 88 ואילך

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

    • מודגש

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

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

    • אינדקס

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

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

    • lastFocusedWindow

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

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

    • מושתק

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

      ‫Chrome 45 ואילך

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

    • מוצמד

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

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

    • splitViewId

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

      ‫Chrome מגרסה 140 ואילך

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

    • status

      TabStatus אופציונלי

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

    • title

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

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

    • url

      string | string[] אופציונלי

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

    • windowId

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

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

    • windowType

      ‫WindowType אופציונלי

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

  • callback

    function optional

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

    (result: Tab[]) => void

החזרות

  • Promise<Tab[]>

    ‫Chrome מגרסה 88 ואילך

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

reload()

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

לטעון מחדש כרטיסייה.

פרמטרים

  • tabId

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

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

  • reloadProperties

    object optional

    • bypassCache

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

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 88 ואילך

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

remove()

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

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

פרמטרים

  • tabIds

    number | number[]‎

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 88 ואילך

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

removeCSS()

Promise Chrome 87+ &leq; MV2 Deprecated since Chrome 91
chrome.tabs.removeCSS(
  tabId?: number,
  details: DeleteInjectionDetails,
  callback?: function,
)
: Promise<void>

הוחלף על ידי scripting.removeCSS ב-Manifest V3.

הסרה מדף CSS שהוזרק בעבר על ידי קריאה ל-scripting.insertCSS.

פרמטרים

  • tabId

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

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

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 88 ואילך

    הבעיה נפתרת כשכל ה-CSS הוסר.

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

sendMessage()

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

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

פרמטרים

  • tabId

    number

  • הודעה

    כל

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

  • אפשרויות

    object optional

    • documentId

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

      ‫Chrome מגרסה 106 ואילך

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

    • frameId

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

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

  • callback

    function optional

    ‫Chrome מגרסה 99 ואילך

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

    (response: any) => void

    • תשובה

      כל

      אובייקט התגובה ב-JSON שנשלח על ידי ה-handler של ההודעה.

החזרות

  • Promise<any>

    ‫Chrome מגרסה 99 ואילך

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

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

sendRequest()

Promise &leq; MV2 הוצאה משימוש
chrome.tabs.sendRequest(
  tabId: number,
  request: any,
  callback?: function,
)
: Promise<any>

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

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

פרמטרים

  • tabId

    number

  • בקשה

    כל

  • callback

    function optional

    ‫Chrome מגרסה 99 ואילך

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

    (response: any) => void

    • תשובה

      כל

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

החזרות

  • Promise<any>

    ‫Chrome מגרסה 99 ואילך

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

setZoom()

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

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

פרמטרים

  • tabId

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

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

  • zoomFactor

    number

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 88 ואילך

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

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

setZoomSettings()

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

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

פרמטרים

  • tabId

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

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

  • zoomSettings

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

    ‫Chrome מגרסה 88 ואילך

    הבעיה נפתרת אחרי שמשנים את הגדרות הזום.

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

ungroup()

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

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

פרמטרים

  • tabIds

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

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

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

unsplit()

Promise Chrome 155 ואילך
chrome.tabs.unsplit(
  splitViewId: number,
  callback?: function,
)
: Promise<void>

הפרדת הכרטיסיות בתצוגה מפוצלת לכרטיסיות נפרדות.

פרמטרים

  • splitViewId

    number

    המזהה של התצוגה המפוצלת שרוצים להפריד.

  • callback

    function optional

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

    () => void

החזרות

  • Promise<void>

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

update()

Promise
chrome.tabs.update(
  tabId?: number,
  updateProperties: object,
  callback?: function,
)
: Promise<Tab | undefined>

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

פרמטרים

  • tabId

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

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

  • updateProperties

    אובייקט

    • פעיל

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

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

    • autoDiscardable

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

      ‫Chrome מגרסה 54 ואילך

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

    • מודגש

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

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

    • מושתק

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

      ‫Chrome 45 ואילך

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

    • openerTabId

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

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

    • מוצמד

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

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

    • נבחר

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

      הוצא משימוש

      צריך להשתמש במודגש.

      אם הכרטיסייה צריכה להיבחר.

    • url

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

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

  • callback

    function optional

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

    (tab?: Tab) => void

    • Tab

      כרטיסייה אופציונלי

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

החזרות

  • Promise<Tab | undefined>

    ‫Chrome מגרסה 88 ואילך

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

אירועים

onActivated

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

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

פרמטרים

  • callback

    פונקציה

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

    (activeInfo: object) => void

    • activeInfo

      אובייקט

      • tabId

        number

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

      • windowId

        number

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

onActiveChanged

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

פרמטרים

  • callback

    פונקציה

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

    (tab: Tab) => void

onDetached

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

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

פרמטרים

  • callback

    פונקציה

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

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

    • tabId

      number

    • detachInfo

      אובייקט

      • oldPosition

        number

      • oldWindowId

        number

onHighlightChanged

‫&leq; MV2 הוצאה משימוש
chrome.tabs.onHighlightChanged.addListener(
  callback: function,
)

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

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

פרמטרים

  • callback

    פונקציה

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

    (selectInfo: object) => void

    • selectInfo

      אובייקט

      • tabIds

        number[]‎

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

      • windowId

        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

        בוליאני

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

      • windowId

        number

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

onReplaced

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

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

פרמטרים

  • callback

    פונקציה

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

    (addedTabId: number, removedTabId: number) => void

    • addedTabId

      number

    • removedTabId

      number

onSelectionChanged

‫&leq; MV2 הוצאה משימוש
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 החדשה של סמל האתר בכרטיסייה.

      • במצב קפוא

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

        ‫Chrome מגרסה 132 ואילך

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

      • groupId

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

        ‫Chrome מגרסה 88 ואילך

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

      • mutedInfo

        ‫MutedInfo אופציונלי

        ‫Chrome מגרסה 46 ואילך

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

      • מוצמד

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

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

      • splitViewId

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

        ‫Chrome מגרסה 140 ואילך

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

      • status

        TabStatus אופציונלי

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

      • title

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

        ‫Chrome מגרסה 48 ואילך

        השם החדש של הכרטיסייה.

      • url

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

        כתובת ה-URL של הכרטיסייה, אם היא השתנתה.

onZoomChange

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

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

פרמטרים

  • callback

    פונקציה

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

    (ZoomChangeInfo: object) => void

    • ZoomChangeInfo

      אובייקט

      • newZoomFactor

        number

      • oldZoomFactor

        number

      • tabId

        number

      • zoomSettings