OnBoarding

OnBoarding est le tutoriel pour montrer à l'utilisateur comment utiliser l'interface et l'application.

Aperçu

Présentement, 2 types de composante sont présentement utilisés par le onboarding : le pop-up et le tool-tip.

Comportement

Les fonctionnalités du onBoarding est dans AppBaseModule.vue.

Paramètre

Il est possible de passer un fichier JSON mais si aucun fichier n'est passé un fichier default est utilisé. La structure du contenu du fichier JSON a des paramètres nommés "message_XX" (XX remplacer avec un chiffre). Ces paramètres sont de type objet avec 2 paramètres:

  • type
  • value

Type

Type: String_(popup-avert | tooltip)__

Usage: Obligatoire.

Défini l'apparence du message d'onboarding. Si la valeur est popup-avert, c'est un pop-up. Si la valeur est tooltip, c'est un tool-tip.

Value

Type: Object

Usage: Obligatoire.

Si le "Type" est "popup-avert", le contenu de l'object est comme n'importe quel pop-up. Si le "Type" est "tooltip", le contenu de l’object a 3 paramètres:

  • target
  • title
  • content

Target

Type: String

Usage: Obligatoire.

Définit l'emplacement où pointe la flèche du tooltip. Doit être initialiser avant le "mounted" du tooltip.

Title

Type: String

Usage: Optionel.

Le titre du tooltip.

Content

Type: String

Usage: Optionel.

Le contenu du tooltip en HTML.

Style

Accessibilité

Last Updated: 1/31/2023, 6:24:18 PM
Contributors: Huberson Tape, ehoulejohnson, huberson tape