Fiche recette

Une recette en un coup d’œil : le plat et sa photo, le temps et les portions, les ingrédients et la méthode numérotée, avec l’étape en cours mise en surbrillance.

Carte en direct

Cette carte est dessinée dans votre navigateur par le même code que les lecteurs, avec des données d’exemple.

Catégorie : Nourriture et boisson. Étiquettes : Restaurants et cafés, Magasins.

Mises en page

Cette carte plein écran occupe tout l’écran en mode paysage ou portrait et n’est pas placée en coin, puce ou bande.

Mises en page : pleine. Formes : paysage, portrait.

Mises en page, thèmes et publication des cartes. Parcourir les cartes.

Données et confidentialité

Cette carte utilise ses propriétés configurées et les données de carte en direct.

Propriétés

Pour le thème, l’arrière-plan, l’accent et la position, voir Propriétés communes.

Définissez les propriétés statiques dans les params de la carte lorsque vous la créez. Son document de données ne contient que des propriétés dynamiques. Les lignes imbriquées décrivent le contenu de leur propriété parente.

Propriétés statiques

NomTypePar défautValeurs et limitesDescription
pageSecondsinteger10minimum : 4 ; maximum : 60Quand les listes ne tiennent pas, les secondes que chaque page reste affichée.
backgroundColorchaîne, nulnullmotif : "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Remplace le fond et la plaque de la carte par une couleur plate ordonnée en CSS. #RRGGBBAA fournit l’opacité. background none a la priorité.
textColorchaîne, nulnullmotif : "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Remplace les couleurs du texte principal et secondaire. Les couleurs d’accentuation et de statut sémantique conservent leur rôle.

Propriétés dynamiques

NomTypePar défautValeurs et limitesDescription
titlestring""maxLength : 120Le plat.
subtitlestring""maxLength : 80Une ligne de signature : la cuisine, le cuisinier, le plat.
imagestring""maxLength : 200Une référence média de projet pour la photo du plat.
prepinteger0minimum : 0 ; maximum : 1440Minutes de préparation.
cookinteger0minimum : 0 ; maximum : 1440Minutes de cuisson.
servesinteger0minimum : 0 ; maximum : 1000Combien il dessert.
tagsarray[]minItems : 0 ; maxItems : 6Marques courtes : Végétarien, Sans gluten, Rapide.
ingredientsarray[]minItems : 0 ; maxItems : 60
ingredients[].headingstring""maxLength : 40Un titre de section tel que Pour la sauce ; remplace le nom.
ingredients[].amountstring""maxLength : 16La quantité : 2 c. à soupe, 400 g.
ingredients[].namestring""maxLength : 80L’ingrédient.
ingredients[].notestring""maxLength : 40Préparé comment : haché, divisé.
stepsarray[]minItems : 0 ; maxItems : 40
stepinteger0minimum : 0 ; maximum : 40L’étape en cours, comptée à partir de 1. Les étapes précédentes sont atténuées et celle-ci est mise en évidence. 0 ne met aucune en évidence.
tipstring""maxLength : 200Un conseil de clôture.
stepAtchaîne, nulnullInstant ISO 8601 où le cuisinier est passé à step ; Primetime joue le moment de l’étape suivante à partir de là. Envoyez-le avec l’étape.

Exemple de canevas

Enregistrez les propriétés statiques comme params.json et créez la carte. Le résultat contient son identifiant crd_.

{
  "theme": "neomustard"
}
screenrig card create --type recipe --major 1 --file params.json

Ajoutez cet élément aux primitives d’une page de liste de lecture, en remplaçant l’identifiant de l’exemple par celui de votre carte. Publiez la liste de lecture et assignez un écran.

{
  "id": "recipe",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

Écrire des données en direct

Écrivez le document dans la carte après l’avoir créée, puis remplacez-le pour mettre à jour l’écran sans republier. La carte vérifie chaque écriture par rapport à ses propriétés dynamiques et refuse un document qu’elle rejette. Utilisez le même projet que la liste de lecture.

Enregistrez le document sous card-data.json. La CLI lit le document lui-même, sans enveloppe :

{
  "title": "",
  "subtitle": "",
  "image": "",
  "prep": 0,
  "cook": 0,
  "serves": 0,
  "tags": [],
  "ingredients": [],
  "steps": [],
  "step": 0,
  "tip": "",
  "stepAt": null
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

Ou appelez directement l’API. L’API enveloppe le même document dans un champ document. Un jeton agent nomme déjà son projet, donc aucun en-tête de projet n’est envoyé ; si vous envoyez ScreenRig-Project, il doit correspondre au projet du jeton. Fournissez votre autorisation API via l’environnement ; voir Authentification API.

curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"title":"","subtitle":"","image":"","prep":0,"cook":0,"serves":0,"tags":[],"ingredients":[],"steps":[],"step":0,"tip":"","stepAt":null}}'