data.json: בקשת הנתונים הנדרשים

הקובץ הזה מצהיר אילו נתוני פלטפורמה נדרשים לרכיבים. זוהי רשימה קטנה של בקשות בעלות שם, ולא מקום לכתיבת GraphQL, ‏SQL, קריאות fetch או קוד להרצה.

data.json

{
  "content": {
    "source": "content"
  },
  "recentArticles": {
    "source": "articles",
    "blog": {
      "slug": "journal"
    },
    "order": "newest",
    "take": 3,
    "allowUserSelection": true
  }
}

המפתח הופך למאפיין ברכיב

השם recentArticles הוא לבחירתכם. הבקשה שלו מבקשת את שלושת המאמרים החדשים ביותר בבלוג journal. הרכיב מקבל את התוצאה דרך data.recentArticles. בקשת content חושפת את התוכן הניתן לעריכה בשפה הנוכחית דרך data.content; ה־SDK מספק גם את content ישירות.

מקור	תוצאה	מפתחות נוספים
content	אובייקט התוכן בשפה הנוכחית	אין
assets	נכסי תמונה שנפתרו	אין
settings	אובייקט הגדרות הפלטפורמה	אין
design	הגדרות עיצוב	אין
pages	דפי תוכן גלויים שאינם מאמרי בלוג	אין
articles	מערך מוגבל של מאמרי בלוג	blog, ‏order, ‏take; ואפשר גם allowUserSelection
article	מאמר יחיד או null	blog, ‏slug
blog	בלוג, מאמריו וגודל עמוד	blog, ‏pageSize

ברשימת מאמרים, order הוא newest, ‏oldest או editorial, ו־take הוא בין 1 ל־100. בבקשת בלוג, pageSize הוא בין 1 ל־100.

בלוג קבוע או בלוג שבוחר בעל האתר

ההגדרה "blog": { "slug": "journal" } קובעת מקור קבוע בקוד. לחלופין, "blog": { "field": "journalBlog" } קוראת שדה טקסט מוגדר מתוך התוכן. הוסיפו את השדה להגדרה לפני השימוש. בחרו דרך אחת, ולא את שתיהן.

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

זה שונה מ־editor.json.collections: בחירת מאמרים בוחרת מאמרי פלטפורמה, ואילו הגדרות האוסף מסדרות שדות list שהגדרתם בעצמכם.

לאחר שינוי בקשות הריצו shoplifter types. הפקודה מעדכנת את src/generated/project.d.ts כדי שהרכיבים ישתמשו בשמות ובמבני התוצאות בצורה בטוחה.