יישום פעולה

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

רישום הפעולה

כדי להשתמש ב-chrome.action API, מוסיפים את המפתח "action" לקובץ manifest של התוסף. תיאור מלא של מאפייני האופציונליים של השדה הזה מופיע בקטע המניפסט של חומר העזר בנושא chrome.action API.

manifest.json:

{
  "name": "My Awesome action Extension",
 ...
  "action": {
   ...
  }
 ...
}

תגובה לפעולה

רושמים handler של onClicked שיפעל כשהמשתמש ילחץ על סמל הפעולה. האירוע הזה לא מופעל אם חלון קופץ רשום בקובץ manifest.json.

service-worker.js:

chrome.action.onClicked.addListener((tab) => {
  chrome.action.setTitle({
    tabId: tab.id,
    title: `You are on tab: ${tab.id}`});
});

הפעלת הפעולה באופן מותנה

‫chrome.declarativeContent API מאפשר להפעיל את סמל הפעולה של התוסף על סמך כתובת ה-URL של הדף או כשסלקטורים ב-CSS תואמים לאלמנטים בדף. כשסמל הפעולה של תוסף מושבת, הסמל מופיע באפור. אם המשתמש לוחץ על הסמל המושבת, מופיע תפריט ההקשר של התוסף.

תג פעולה

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

מגדירים את הטקסט של התג באמצעות הקריאה chrome.action.setBadgeText() ואת צבע הרקע באמצעות הקריאה chrome.action.setBadgeBackgroundColor().

service-worker.js:

chrome.action.setBadgeText({text: 'ON'});
chrome.action.setBadgeBackgroundColor({color: '#4688F1'});

הסבר קצר

רושמים את תיאורי הכלים בשדה "default_title" מתחת למפתח "action" בקובץ manifest.json.

manifest.json:

{
  "name": "Tab Flipper",
 ...
  "action": {
    "default_title": "Press Ctrl(Win)/Command(Mac)+Shift+Right/Left to flip tabs"
  }
...
}

אפשר גם להגדיר או לעדכן את תיאורי הכלים באמצעות הקריאה ל-action.setTitle(). אם לא מוגדר תיאור קצר, מוצג השם של התוסף.