Reference Guide

מאפיינים

בקטע הזה מוסבר איך ליצור רכיב <div> ללחצן הרשמה למינוי. ברשימות שבהמשך מפורטים מאפייני החובה והמאפיינים האופציונליים של הרכיב. מאפיינים אופציונליים מאפשרים לכם לשלוט בפריסה ובעיצוב של הלחצן, וגם לבחור אם להציג את מספר המנויים של הערוץ.

מאפיינים נדרשים

  • ‫class – מגדירים את הערך ל-g-ytsubscribe. הסיווג הזה מזהה את הרכיב <div> כמאגר ללחצן הרשמה, ומאפשר ל-YouTube לשנות את הגודל של הלחצן המוטמע באופן דינמי, כפי שמוסבר בקטע הבא.

  • חובה לציין ערך לאחד משני המאפיינים הבאים:

מאפיינים אופציונליים

  • ‫data-layout – הפורמט של הלחצן. ערכי המאפיין החוקיים הם:

    • ‫default – מוצג סמל של לחצן הפעלה והמילה 'הרשמה' בשפה של המשתמש, שנבחרת לפי הגדרת השפה או המיקום של המשתמש.
    • ‫full – בנוסף לכפתור הרגיל, מוצגים הדמות של הערוץ וכותרת הערוץ.

  • ‫data-theme – מציין את ערכת הצבעים שבה יש להשתמש עבור הכפתור. הערכים החוקיים הם default ו-dark. העיצוב dark מיועד לאפליקציות שבהן הלחצנים מוצבים על רכיב רקע כהה יותר.

  • ‫data-count – מציין אם בלחצן מוצג מספר המנויים של הערוץ. התנהגות ברירת המחדל של הכפתור היא הצגת מספר המנויים. הערכים החוקיים הם default ו-hidden.

  • ‫data-onytevent – הערה: המאפיין הזה יצא משימוש.

אירועים

הערה: האירועים subscribe ו-unsubscribe של לחצן ההרשמה הוצאו משימוש. באופן דומה, גם המאפיין data-ytonevent, שאפשר היה להוסיף בעבר לרכיב הווידג'ט כדי לציין מאזין להתראות על אירועים, הוצא משימוש.

רינדור דינמי

במקום להשתמש בקוד ההטמעה הרגיל מכלי ההגדרה, אפשר להציג את Subscribe Button באופן דינמי. הגישה הזו מונעת מ-JavaScript של ה-API לעבור על כל DOM כדי לאתר לחצנים, וכך יכולה לשפר את זמן העיבוד של הלחצנים.

כחלק מGoogle+ JavaScript API, Subscribe Button תומך בשיטות go ו-render רגילות, שאפשר להשתמש בהן כדי להציג באופן דינמי לחצני מינוי. לדוגמה, אפשר להשתמש בשיטות האלה כדי להציג לחצן שלא קיים כשהאירוע DOM ready מופעל, למשל בדף שמתעדכן באמצעות AJAX.

שיטה תיאור
gapi.ytsubscribe.go(
  opt_container
)		 הפונקציה מעבדת את כל לחצני ההרשמה במאגר התגים שצוין. כדאי להשתמש בשיטה הזו אם רכיבי לחצן המינוי שרוצים להציג כבר קיימים. לדוגמה, אם האפליקציה שולחת בקשת AJAX שמחזירה את רכיב <div> המלא עבור Subscribe Button, צריך לקרוא ל-method ‏go() כדי להציג את הלחצן.
opt_container
‫
רכיב ה-HTML שמכיל את לחצני המינוי שיוצגו. מציינים את המזהה של הרכיב או את רכיב ה-DOM עצמו. אם לא מציינים את הפרמטר הזה, כל לחצני ההרשמה בדף מוצגים.
gapi.ytsubscribe.render(
  container,
  parameters
)		 התג Subscribe Button מוצג בקונטיינר שצוין. משתמשים בשיטה הזו אם הרכיב שיכיל את Subscribe Button עדיין לא קיים וצריך ליצור אותו.
מאגר
מזהה את רכיב ה-HTML הריק שבו יבוצע העיבוד של Subscribe Button. מציינים את המזהה של הרכיב או את רכיב ה-DOM עצמו.
פרמטרים
אובייקט שמכיל מאפיינים של לחצן הרשמה כזוגות של key:value, כמו {"channel": "GoogleDevelopers", "layout": "full"}.

איך מעבדים לחצן באמצעות gapi.ytsubscribe.go

בדוגמה שלמטה מוצג הקוד שבו משתמשים כדי להפעיל את השיטה gapi.ytsubscribe.go כדי להציג באופן דינמי לחצן כשלוחצים על הקישור.

הערה: כלי ההגדרה שלמעלה משתמש גם הוא בשיטה go כדי להציג לחצן חדש כשמעדכנים את אפשרויות הלחצן או את הקוד.

איך מעבדים כפתור באמצעות gapi.ytsubscribe.render

בדוגמה הבאה מוסבר איך להפעיל את השיטה gapi.ytsubscribe.render כדי להציג באופן דינמי לחצן כשלוחצים על הקישור: