chrome.declarativeContent

תיאור

הרשאות

מושגים ושימוש

ה-Delarative Content API מאפשר להפעיל את הפעולה של התוסף בהתאם לכתובת ה-URL של דף האינטרנט, או במקרה שסלקטור ב-CSS תואם לרכיב בדף, ללא צורך בהוספת הרשאות מארח או בהחדרת סקריפט תוכן.

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

כללים

כללים מורכבים מתנאים ומפעולות. אם מתקיים אחד מהתנאים, כל הפעולות יבוצעו. הפעולות הן setIcon() וגם showAction().

הפרמטר PageStateMatcher מתאים לדפי אינטרנט אם ורק אם כל הקריטריונים הרשומים מתקיימים. היא יכולה להתאים לכתובת URL של דף, לבורר מורכב ב-css או למצב הסימנייה של הדף. הכלל הבא מפעיל את הפעולה של התוסף בדפי Google כשמופיע שדה סיסמה:

let rule1 = {
  conditions: [
    new chrome.declarativeContent.PageStateMatcher({
      pageUrl: { hostSuffix: '.google.com', schemes: ['https'] },
      css: ["input[type='password']"]
    })
  ],
  actions: [ new chrome.declarativeContent.ShowAction() ]
};

כדי להפעיל את הפעולה של התוסף באתרים של Google שכוללים סרטון, אפשר להוסיף תנאי שני, כי כל תנאי מספיק כדי להפעיל את כל הפעולות שצוינו:

let rule2 = {
  conditions: [
    new chrome.declarativeContent.PageStateMatcher({
      pageUrl: { hostSuffix: '.google.com', schemes: ['https'] },
      css: ["input[type='password']"]
    }),
    new chrome.declarativeContent.PageStateMatcher({
      css: ["video"]
    })
  ],
  actions: [ new chrome.declarativeContent.ShowAction() ]
};

באירוע onPageChanged נבדק אם כלל כלשהו מכיל לפחות תנאי אחד שמתקיים, ומבצע את הפעולות. הכללים נשארים בכל הסשנים. לכן, במהלך ההתקנה של התוסף יש להשתמש תחילה ב-removeRules כדי להסיר כללים שהותקנו בעבר, ואז להשתמש ב-addRules כדי לרשום כללים חדשים.

chrome.runtime.onInstalled.addListener(function(details) {
  chrome.declarativeContent.onPageChanged.removeRules(undefined, function() {
    chrome.declarativeContent.onPageChanged.addRules([rule2]);
  });
});

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

התאמה לכתובת ה-URL של הדף

הערך PageStateMatcher.pageurl תואם כשהקריטריונים של כתובת ה-URL מתקיימים. הקריטריונים הנפוצים ביותר הם שרשור של מארח, נתיב או כתובת URL, ואחריו 'מכיל', 'שווה ל-', 'קידומת' או 'סיומת'. הטבלה הבאה כוללת מספר דוגמאות:

קריטריונים	תואם את:
{ hostSuffix: 'google.com' }	כל כתובות ה-URL של Google
{ pathPrefix: '/docs/extensions' }	כתובות URL של מסמכי תוספים
{ urlContains: 'developer.chrome.com' }	כל כתובות ה-URL של המסמכים למפתחי Chrome

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

התאמות CSS

התנאים של PageStateMatcher.css חייבים להיות סלקטורים מורכבים, כלומר, אי אפשר לכלול קומבינטורים כמו רווח לבן או ">" בבוררים. כך Chrome יכול להתאים את הבוררים בצורה יעילה יותר.

בוררים מורכבים (אישור)	בוררים מרוכבים (לא תקין)
a	div p
iframe.special[src^='http']	p>span.highlight
ns|*	p + ol
#abcd:checked	p::first-line

תנאי ה-CSS תואמים רק לרכיבים המוצגים: אם רכיב שתואם לבורר הוא display:none או שאחד מהאלמנטים שלו ברמת הורה הוא display:none, התנאי לא גורם להתאמה. גם אלמנטים שמעוצבים עם visibility:hidden, ממוקמים מחוץ למסך או מוסתרים על ידי רכיבים אחרים יכולים להתאים לתנאי.

התאמה למצבים שנוספו לסימניות

התנאי PageStateMatcher.isBookmarked מאפשר התאמה למצב הסימניות של כתובת ה-URL הנוכחית בפרופיל המשתמש. כדי להשתמש בתנאי הזה, צריך להצהיר על ההרשאה 'סימניות' במניפסט של התוסף.