chrome.tabGroups

תיאור

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

הרשאות

tabGroups

זמינות

‫Chrome 89 ואילך MV3 ואילך

סוגים

Color

הצבע של הקבוצה.

Enum

"grey"

"blue"

"red"

‎"yellow"

"green"

"pink"

'purple'

‪"cyan"

"orange"

TabGroup

מאפיינים

  • מכווץ

    בוליאני

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

  • צבע

    צבע

    הצבע של הקבוצה.

  • id [מזהה]

    number

    המזהה של הקבוצה. מזהי הקבוצות הם ייחודיים בסשן דפדפן.

  • משותפת

    בוליאני

    ‫Chrome 137+

    האם הקבוצה משותפת.

  • title

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

    השם של הקבוצה.

  • windowId

    number

    המזהה של החלון שמכיל את הקבוצה.

מאפיינים

TAB_GROUP_ID_NONE

מזהה שמייצג את העובדה שאין קבוצה.

ערך

-1

Methods

get()

chrome.tabGroups.get(
  groupId: number,
): Promise<TabGroup>

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

פרמטרים

  • groupId

    number

החזרות

  • Promise<TabGroup>

    ‫Chrome 90 ואילך

move()

chrome.tabGroups.move(
  groupId: number,
  moveProperties: object,
): Promise<TabGroup | undefined>

העברת הקבוצה וכל הכרטיסיות שלה בתוך החלון שלה, או לחלון חדש.

פרמטרים

  • groupId

    number

    המזהה של הקבוצה שרוצים להעביר.

  • moveProperties

    אובייקט

    • אינדקס

      number

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

    • windowId

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

      החלון שאליו רוצים להעביר את הקבוצה. ברירת המחדל היא החלון שבו הקבוצה נמצאת כרגע. הערה: אפשר להעביר קבוצות רק לחלונות מסוג windows.WindowType "normal" ומחלונות מסוג windows.WindowType "normal".

החזרות

  • Promise<TabGroup | undefined>

    ‫Chrome 90 ואילך

query()

chrome.tabGroups.query(
  queryInfo: object,
): Promise<TabGroup[]>

מקבל/ת את כל הקבוצות עם המאפיינים שצוינו, או את כל הקבוצות אם לא צוינו מאפיינים.

פרמטרים

  • queryInfo

    אובייקט

    • מכווץ

      ‫boolean אופציונלי

      אם הקבוצות מכווצות.

    • צבע

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

      הצבע של הקבוצות.

    • משותפת

      ‫boolean אופציונלי

      ‫Chrome 137+

      האם הקבוצה משותפת.

    • title

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

      התאמה של שמות קבוצות לתבנית.

    • windowId

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

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

החזרות

  • Promise<TabGroup[]>

    ‫Chrome 90 ואילך

update()

chrome.tabGroups.update(
  groupId: number,
  updateProperties: object,
): Promise<TabGroup | undefined>

הפונקציה משנה את המאפיינים של קבוצה. מאפיינים שלא מצוינים ב-updateProperties לא משתנים.

פרמטרים

  • groupId

    number

    המזהה של הקבוצה שרוצים לשנות.

  • updateProperties

    אובייקט

    • מכווץ

      ‫boolean אופציונלי

      האם הקבוצה צריכה להיות מכווצת.

    • צבע

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

      הצבע של הקבוצה.

    • title

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

      השם של הקבוצה.

החזרות

  • Promise<TabGroup | undefined>

    ‫Chrome 90 ואילך

אירועים

onCreated

chrome.tabGroups.onCreated.addListener(
  callback: function,
)

מופעל כשקבוצה נוצרת.

פרמטרים

  • callback

    פונקציה

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

    (group: TabGroup) => void

onMoved

chrome.tabGroups.onMoved.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (group: TabGroup) => void

onRemoved

chrome.tabGroups.onRemoved.addListener(
  callback: function,
)

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

פרמטרים

  • callback

    פונקציה

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

    (group: TabGroup) => void

onUpdated

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

מופעל כשקבוצה מתעדכנת.

פרמטרים

  • callback

    פונקציה

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

    (group: TabGroup) => void