תיאור
צריך להשתמש ב-API של chrome.tabGroups
כדי לבצע אינטראקציה עם מערכת קיבוץ הכרטיסיות של הדפדפן. תוכלו להשתמש ב-API הזה כדי לשנות את קבוצות הכרטיסיות בדפדפן ולסדר אותן מחדש. כדי לקבץ כרטיסיות ולהסיר אותן, או כדי להריץ שאילתות לגבי הכרטיסיות בקבוצות, צריך להשתמש ב-API של chrome.tabs
.
הרשאות
tabGroups
זמינות
סוגים
Color
הצבע של הקבוצה.
טיפוסים בני מנייה (enum)
TabGroup
תכונות
-
מכווץ
boolean
האם הקבוצה מכווצת. קבוצה מכווצת היא קבוצה שהכרטיסיות שלה מוסתרות.
-
color [צבע]
הצבע של הקבוצה.
-
id
number
המזהה של הקבוצה. מזהי הקבוצות הם ייחודיים בכל סשן בדפדפן.
-
title
מחרוזת אופציונלי
כותרת הקבוצה.
-
windowId
number
מזהה החלון שמכיל את הקבוצה.
תכונות
TAB_GROUP_ID_NONE
מזהה שמייצג את ההיעדרות של קבוצה.
ערך
1-
שיטות
get()
chrome.tabGroups.get(
groupId: number,
callback?: function,
)
אחזור פרטים על הקבוצה שצוינה.
פרמטרים
-
groupId
number
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(group: TabGroup) => void
-
קבוצה
-
החזרות
-
Promise<TabGroup>
Chrome 90 ומעלהיש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
move()
chrome.tabGroups.move(
groupId: number,
moveProperties: object,
callback?: function,
)
מעביר את הקבוצה ואת כל הכרטיסיות שלה בתוך החלון שלה, או לחלון חדש.
פרמטרים
-
groupId
number
המזהה של הקבוצה להעברה.
-
moveProperties
אובייקט
-
index
number
המיקום שאליו צריך להעביר את הקבוצה. בעזרת
-1
אפשר למקם את הקבוצה בסוף החלון. -
windowId
מספר אופציונלי
החלון שאליו רוצים להעביר את הקבוצה. ברירת המחדל היא החלון שבו הקבוצה נמצאת כרגע. לתשומת ליבך, אפשר להעביר קבוצות אל חלונות וממנו רק עם סוג
windows.WindowType
מסוג"normal"
.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(group?: TabGroup) => void
-
קבוצה
TabGroup אופציונלי
פרטים על הקבוצה שהועברה.
-
החזרות
-
Promise<TabGroup | undefined>
Chrome 90 ומעלהיש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
query()
chrome.tabGroups.query(
queryInfo: object,
callback?: function,
)
מאחזרת את כל הקבוצות עם המאפיינים שצוינו, או את כל הקבוצות אם לא צוינו מאפיינים.
פרמטרים
-
queryInfo
אובייקט
-
מכווץ
בוליאני אופציונלי
האם הקבוצות מכווצות.
-
color [צבע]
צבע אופציונלי
צבע הקבוצות.
-
title
מחרוזת אופציונלי
מתאימים את שמות הקבוצות לפי דפוס מסוים.
-
windowId
מספר אופציונלי
המזהה של חלון ההורה, או
windows.WINDOW_ID_CURRENT
של החלון הנוכחי.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(result: TabGroup[]) => void
-
תוצאה אחת
TabGroup[]
-
החזרות
-
Promise<TabGroup[]>
Chrome 90 ומעלהיש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
update()
chrome.tabGroups.update(
groupId: number,
updateProperties: object,
callback?: function,
)
שינוי המאפיינים של קבוצה. מאפיינים שלא צוינו ב-updateProperties
לא משתנים.
פרמטרים
-
groupId
number
מזהה הקבוצה שברצונך לשנות.
-
updateProperties
אובייקט
-
מכווץ
בוליאני אופציונלי
האם צריך לכווץ את הקבוצה.
-
color [צבע]
צבע אופציונלי
הצבע של הקבוצה.
-
title
מחרוזת אופציונלי
כותרת הקבוצה.
-
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(group?: TabGroup) => void
-
קבוצה
TabGroup אופציונלי
פרטים על הקבוצה המעודכנת.
-
החזרות
-
Promise<TabGroup | undefined>
Chrome 90 ומעלהיש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
אירועים
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,
)
מופעל כשקבוצה מתעדכנת.