Documentation sur les fenêtres d'affichage

Une fenêtre d’affichage précise la page du Dashboard sur laquelle votre vue peut apparaître. Elle fournit également un objet environment.objectContext que vous pouvez utiliser pour obtenir du contexte sur l’un des objets Stripe de la page actuelle. Pour en savoir plus, consultez la section Accéder aux objets Stripe depuis le Dashboard.

Les fenêtres d’affichage disponibles pour votre extension d’interface utilisateur sont :

Disponibilité des applications

Vous pouvez rendre votre application disponible sur toutes les pages ou seulement sur une page spécifique du Dashboard.

Disponibilité à l’échelle du Dashboard

Si vous avez défini une vue pour la fenêtre d’affichage stripe.dashboard.drawer.default dans votre application, elle apparaît sur chaque page du Dashboard, sauf celles pour lesquelles vous avez défini des vues spécifiques.

Par exemple, si le champ ui_extension.views du manifeste stripe-app.json de votre application est :

{
  "id": "com.example.app",
  "version": "1.2.3",
  "name": "Example App",
  "icon": "./example_icon_32.png",
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "Receive access to the customer information"
    }
  ],
  "ui_extension": {
    "views": [
      {
        "viewport": "stripe.dashboard.customer.detail",
        "component": "CustomerView"
      },
      {
        "viewport": "stripe.dashboard.drawer.default",
        "component": "EverywhereElseView"
      }
    ]
  }
}

« CustomerView » apparaît quand l’application est ouverte sur la page relative aux informations d’un client et « EverywhereElseView » apparaît sur toutes les autres pages du Dashboard.

La vue stripe.dashboard.drawer.default ne reçoit pas les données objectContext de la même façon qu’une vue spécifique à une page. Si votre application doit accéder à certaines informations telles que l’id d’une facture sur une page relative aux « informations d’une facture », vous devez créer une vue qui utilise la fenêtre d’affichage stripe.dashboard.invoice.detail. Pour en savoir plus, consultez la section consacrée à la disponibilité spécifique à une page.

Disponibilité spécifique à une page

Les vues spécifiques à une page sont liées à la page que l’utilisateur est en train de consulter, et elles autorisent les applications à recevoir des éléments de contexte supplémentaires sur la page grâce à la propriété environment. Pour en savoir plus, consultez la section Accéder aux objets Stripe depuis le Dashboard.

Par exemple, si votre application possède une vue pour la fenêtre d’affichage stripe.dashboard.product.detail, elle apparaît dans l’application lorsque l’utilisateur ouvre la page relative aux informations d’un produit.

Si votre application ne propose pas de vue spécifique pour la page en question ni de vue par défaut qui lui soit spécifique, le volet affiche une vue par défaut générique qui explique à l’utilisateur comment accéder à l’application.

Par exemple, si votre application possède deux vues sur des fenêtres d’affichage spécifiques à une page, elles sont visibles dans le manifeste comme suit :

{
  "id": "com.example.app",
  "version": "1.2.3",
  "name": "Example App",
  "icon": "./example_icon_32.png",
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "Receive access to the customer information"
    }
  ],
  "ui_extension": {
    "views": [
      {
        "viewport": "stripe.dashboard.customer.detail",
        "component": "CustomerView"
      },
      {
        "viewport": "stripe.dashboard.product.detail",
        "component": "ProductView"
      }
    ]
  }
}

Quand l’utilisateur final ouvre votre application sur la page d’accueil du Dashboard, l’application présente des liens vers les pages Clients et Produits. Si l’utilisateur se rend sur la page Clients, l’application lui demande de sélectionner le client dont il veut afficher les informations sur votre application.