תצורת הרכיב
הגדירו את הרכיב באמצעות מאפייני data-* על תגית הסקריפט.
אתם מגדירים את הרכיב באמצעות מאפייני data-* על תגית הסקריפט. הנה הסט המלא.
<script
type="module"
src="https://cdn.syncanix.com/widget.js"
data-key="pk_test_..."
data-position="bottom-left"
data-env="development"
data-chat-size="large"
data-locale="fr"
data-config-load="eager"
></script>מאפיינים מרכזיים
- data-key — המפתח לפרסום שלכם (pk_test_… או pk_live_…). חובה.
- data-enabled — הגדירו false כדי לטעון את הסקריפט בלי לטעון את הווידג׳ט (true כברירת מחדל).
- data-position — פינת המשגר: bottom-right (ברירת מחדל), bottom-left, top-right או top-left.
- data-locale — קובע את השפה וכיוון הכתיבה של הדף הזה (למשל ar או en-US). אם לא תגדירו אותו, הווידג'ט עוקב אחרי שפת הדף שלכם אוטומטית.
- data-chat-size — small (ברירת מחדל), medium, large, fullscreen או embedded.
- data-chat-mode — normal (ברירת מחדל) או split (פריסת שני חלוניות).
- data-env — development או production (אחרת מוסק מקידומת המפתח).
- data-theme — מחרוזת JSON של דריסות אסימוני ערכ ת נושא.
הווידג'ט עוקב אחרי שפת הדף שלכם בעצמו — בלי שום מאפיין. הוא קורא את <html lang> שלכם, וכשהדף מציג כתב שונה מזה שהוא מכריז עליו, הוא סומך על מה שמופיע במסך. הפעילו את מחליף השפה שלכם והצ'אט יעקוב אחריו, בצד הדפדפן, בלי רענון ובלי לאבד את השיחה. השתמשו ב-data-locale רק אם אתם רוצים לעקוף זאת בדף מסוים.
ההודעה הראשונה של המבקר קובעת את שפת השיחה, והיא נשארת כך גם אם הוא יחליף אחר כך את שפת האתר שלכם: שיחה שהתחילה בעברית ממשיכה לענות בעברית. התוויות של הווידג'ט וההודעה על שימוש בבינה מלאכותית עדיין עוקבות אחרי הדף שלכם, כך שההודעה תמיד קריאה בשפה שבה הוא גולש. מי שרוצה להחליף שפה — פשוט מבקש זאת בצ'אט.
מאפיינים מתקדמים
- data-origin — מקור ה-API של Syncanix (ברירת המחדל היא ה-API של הייצור).
- data-theme-name — בוחר עיצוב מסוים מהספרייה שלכם; הערך auto עוקב אחר הגדרת בהיר/כהה של האתר המארח.
- data-prompt-profile — מריץ בדף הזה פרופיל הנחיה מסוים, לפי השם שבו פרסמתם אותו. אפשר לנקוב רק בפרופילים שפורסמו; כל ערך אחר חוזר לפרופיל הפעיל שלכם.
- data-mount-target — בורר CSS למקום שבו לרכיב רכיב מוטמע.
- data-split-page — כתובת ה-URL של הדף להצגה לצד הצ׳אט במצב split.
- data-config-load — lazy (טעינת הגדרות בפתיחה הראשונה, ברירת מחדל) או eager (בעת ההרכבה).
- data-executor — שם פונקציה גלובלית שמריצה פעולות דפדפן/מארח.
- data-token-provider — שם פונקציה גלובלית שמחזירה את האסימון של משתמש הקצה.
- data-step-up-provider — שם פונקציה גלובלית שמפעילה אימות-מחדש מוגבר.
- data-headers-provider — שם של פונקציה גלובלית המחזירה כותרות בקשה נוספות.
- data-client-witness — הצטרפות לתצפית פסיבית על תעבורת ה-API, צורנית בלבד (כבוי כברירת מחדל).
- data-act-on-behalf-consent — דרישת הסכמה חד-פעמית של «פעולה בשמכם» (כבוי כברירת מחדל).