Reference Guide

מאפיינים

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

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

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

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

  • data-channel – שם הערוץ המשויך ללחצן. ערך לדוגמה: GoogleDevelopers.
  • data-channelid – מזהה הערוץ המשויך ללחצן. ערך לדוגמה: UC_x5XG1OV2P6uZZ5FSM9Ttw. אפשר לאחזר את מזהה הערוץ בהגדרות של חשבון YouTube או באמצעות APIs Explorer בסוף המסמך. למידע נוסף על עבודה עם מזהי ערוצים.

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

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

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

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

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

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

אירועים

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

רינדור דינמי

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

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

‏Method	תיאור
gapi.ytsubscribe.go(   opt_container )	רינדור של כל לחצני המינויים במאגר התגים שצוין. השיטה הזו מתאימה אם רכיבי לחצן המינוי שאתם רוצים לעבד כבר קיימים. לדוגמה, אם האפליקציה שולחת בקשת AJAX שמחזירה את הרכיב <div> המלא עבור Subscribe Button, יש לקרוא לשיטה 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 כדי לעבד לחצן באופן דינמי כאשר לוחצים על הקישור: