menuConfig (depuis v2.0.4)
Utilisation
Ce paramètre existait déjà avant la version 2.0.4, mais était utilisé avec les anciens paramètres baseMenu, customMenu et subMenu. Cette version utilise uniqument le paramètre menu, qui contient quant à lui le paramètre categories décrit ci-après.
Menu
Mis en place depuis la version 2.0.4 et DISPONIBLE DANS LES PARAMETRES DE PERSONNALISATION DE RETORIK STUDIO, le paramètre menu permet de définir les éléments qui apparaitront dans le menu de l'application
| Nom | Requis | Type | Description |
|---|---|---|---|
categories | Non | tableau d'objets de type Category | Contient les données des items contenus dans le menu de l'application |
Category
Une catégorie représente une ligne d'items dans les menus en mode desktop et borne, et une colonne avec un titre et des délimitations supérieure et inférieure en mode mobile. C'est un objet contenant un titre (facultatif) et un tableau d'objets de type MenuItem.
| Nom | Requis | Type | Description |
|---|---|---|---|
title | Non | string | Titre de la catégorie des tuiles affichées |
tiles | Oui | tableau d'objets de type MenuItem | Les tuiles affichées dans le menu pour cette catégorie |
MenuItem
| Nom | Requis | Type | Description |
|---|---|---|---|
index | Oui | number | Index utilisé pour l'ordre d'affichage des items |
text | Oui | string | Titre de la tuile. Markdown pris en charge |
textColor | Non | string | Couleur du texte |
backgroundColor | Non | string | Couleur du fond de la tuile |
image | Non | { url: string, color?: string } | Icône de la tuile. Color est utilisé pour modifier la couleur des SVG |
action | Oui | Action | Action au clic sur la tuile. |
Action
| Nom | Requis | Type | Description |
|---|---|---|---|
type | Oui | "message" | "event" | "url" | "internal" | "message" : envoi d'un message vers le bot dont le texte est la valeur du champ text de l'item / "event" : envoi d'un event vers le bot avec le contenu de value.name et value.value / "url" : ouverture d'une page externe (Qrcode en mode borne) vers le contenu de value.url / "internal" : action interne à Retorik Framework (liste ici) |
value | Non | Record<string, any> | Données utilisées en fonction de la valeur du champ type |
Actions internes
| Nom | Action |
|---|---|
openlanguage | Ouvre la page de choix de langue |
openhistory | Ouvre l'historique de conversation |
opentutorial | Déclenche le tutoriel (rien pour le moment) |
opennews | Ouvre la chaîne d'informations |
openweather | Ouvre la page contenant les données météo |
openemergency | Ouvre la page contenant les numéros d'urgence |
fullscreenimage | Ouvre le contenu du champ value.url en pleine page |