background

טיפוס Object
חובה לא
דוגמה
"background": {
  "scripts": ["background.js"]
}

השתמשו במפתח background כדי לכלול תסריט רקע אחד או יותר, עם אפשרות לדף רקע בהרחבתכם.

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

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

ראו גם את הקטע "תסריטי רקע" ב- אנטומיה של הרחבה לפרטים נוספים.

המפתח background הוא אובייקט שעשויות להיות לו שתי תכונות, ושתיהן אופציונליות:

scripts

מערך (Array) של מחרוזות ( Strings), שכל אחת מהן היא מסלול למקור בג'אווה-סקריפט. המסלול יחסי לקובץ manifest.json עצמו. אלה התסריטים שיבוצעו בדף הרקע של ההרחבה.

התסריט משתף את אותו הקשר גלובלי  window.

התסריטים נטענים על פי הסדר בו הם מופיעים במערך.

אם תציינו ערך עבור scripts, דף ריק יווצר בו יורץ התסריט.

לתשומת לבך: אם ברצונך להביא תסריט ממיקום מרוחק עם התגית <script>  (לדוגמה,. <script src = "https://code.jquery.com/jquery-1.7.1.min.js">), יהא עליך לשנות גם את המפתח content_security_policy בקובץ manifest.json של ההרחבה שלך.

לתשומת לבך: בגרסאות פיירפוקס שקדמו לגרסה 50, כשהדיבאגר היה פתוח, תסריטים לא תמיד נטענו על פי הסדר הניתן במערך . כדי לעקוף באג זה, ניתן להשתמש בתכונה page ולכלול תסריטי רקע מהדף באמצעות תגיות  <script>. באג זה תוקן בפיירפוקס 50. מנקודה זו ואילך,  תסריטים נטענים תמיד על פי הסדר הנתון במערך.

page

אם יש לך צורך בתוכן כלשהו בדף, ניתן להגדיר דף משלך באמצעות התכונה  page, שהיא מחרוזת ( String ), המייצגת מסלול, יחסי לקובץ manifest.json, למסמך HTML הכלול בחבילת ההרחבה שלך.

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

המפתח background יכול לכלול גם את התכונה האופציונלית הבאה:

persistent

ערך בוליאני( Boolean ).

  • true מציין כי דף הרקע נועד להישמר בזכרון מהרגע שההרחבה נטענה או שהדפדפן הופעל  עד שההרחבה מבוטלת או מושבתת, או שהדפדפן נסגר (כלומר, דף הרקע תמידי).
  • false מציין כי דף הרקע עשוי להיות מוסר מהזיכרון כשלא פעיל ולהיווצר מחדש במידת הצורך. דפי רקע כאלה קרויים לפעמים דפי אירוע כי הם נטענים לזיכרון כדי לאפשר לדף הרקע לטפל באירועים להם הוא הוסיף מאזינים. רישום המאזיננים הוא תמידי כאשר הדף מוסר מהזיכרון, אך ערכים אחרים אינם ץמידי. אם תרצו לשמור מידע תמידית בדף אירועים , תוכלו להשתמש ב  ממשק הפיתוח storage.

דוגמה

  "background": {
    "scripts": ["jquery.js", "my-background.js"]
  }

טוען שני תסריט רקע.

  "background": {
    "page": "my-background.html"
  }

תואן דף רקע מותאם אישית.

תאימות דפדפנים

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaSafariFirefox for Android
backgroundChrome Full support YesEdge Full support 14Firefox Full support 48Opera Full support YesSafari Full support 14Firefox Android Full support 48
pageChrome Full support YesEdge Full support 14Firefox Full support 48Opera Full support YesSafari Full support 14Firefox Android Full support 48
persistentChrome Full support YesEdge Full support 14
Notes
Full support 14
Notes
Notes The 'persistent' property is mandatory.
Firefox Partial support 48
Notes
Partial support 48
Notes
Notes Only persistent pages are supported.
Notes Before version 66, Firefox would log a warning even if the value was set to true.
Opera Full support YesSafari Partial support 14
Notes
Partial support 14
Notes
Notes Only persistent pages are supported.
Firefox Android Partial support 48
Notes
Partial support 48
Notes
Notes Only persistent pages are supported.
Notes Before version 66, Firefox would log a warning even if the value was set to true.
scriptsChrome Full support YesEdge Full support 14Firefox Full support 48
Notes
Full support 48
Notes
Notes Before Firefox 50, when the debugger is open, scripts are not always loaded in the order given in the array.
Opera Full support YesSafari Full support 14Firefox Android Full support 48
Notes
Full support 48
Notes
Notes Before Firefox 50, when the debugger is open, scripts are not always loaded in the order given in the array.

Legend

Full support  
Full support
Partial support  
Partial support
See implementation notes.
See implementation notes.