chrome.declarativeContent

תיאור

הרשאות

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

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

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

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

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

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

התאמת CSS

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

בוררים מורכבים (OK)	בוררים מורכבים (לא תקין)
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 הנוכחית בפרופיל המשתמש, כפי שסומן בסימנייה. כדי להשתמש בתנאים האלה, צריך להצהיר על ההרשאה 'סימניות' בmanifest של התוסף.