Referenzdokument Darstellungsfelder

Ein Darstellungsfeld gibt die Seite im Dashboard an, auf der Ihre Ansicht erscheinen kann. Ein Darstellungsfeld kann ein environment.objectContext-Objekt bereitstellen, mit dem Sie Kontext zum Stripe-Objekt einer aktuellen Seite erhalten können. Weitere Informationen finden Sie unter Zugriff auf Stripe-Objekte im Dashboard.

Verfügbare Darstellungsfelder für Ihre Erweiterung der Nutzeroberfläche:

App-Verfügbarkeit

Sie können Ihre Anwendung auf allen Seiten oder speziell für eine einzelne Seite im Dashboard zur Verfügung stellen.

Verfügbarkeit im gesamten Dashboard

Wenn Ihre App eine Ansicht für das Darstellungsfeld stripe.dashboard.drawer.default bereitstellt, wird diese Ansicht auf jeder Seite im Dashboard angezeigt, außer dort, wo Sie seitenspezifische Ansichten definiert haben.

Wenn das Feld ui_extension.views im stripe-app.json-Manifest Ihrer App beispielsweise wie folgt lautet:

{
  "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“ würde angezeigt, wenn die Anwendung auf der Kundendetailseite geöffnet ist, und „EverywhereElseView“ würde auf jeder anderen Seite im Dashboard angezeigt.

Die Ansicht stripe.dashboard.drawer.default empfängt keine objectContext-Daten, wie dies bei einer seitenspezifischen Ansicht der Fall ist. Wenn Ihre App auf Informationen wie die id einer Rechnung zugreifen muss, die auf einer Seite mit „Rechnungsdetails“ angezeigt wird, müssen Sie eine Ansicht erstellen, die den Darstellungsbereich stripe.dashboard.invoice.detail verwendet. Weitere Informationen finden Sie unter Seitenspezifische Verfügbarkeit.

Seitenspezifische Verfügbarkeit

Seitenspezifische Ansichten beziehen sich auf die aktuell aufgerufene Seite und ermöglichen es Apps, über die Eigenschaft environment zusätzlichen Kontext über die Seite zu erhalten. Weitere Informationen finden Sie unter Zugriff auf Stripe-Objekte im Dashboard.

Wenn Ihre App zum Beispiel über eine Ansicht für das Darstellungsfeld stripe.dashboard.product.detail verfügt und ein/e Nutzer/in Ihre App auf der Seite „Produktdetails“ öffnet, wird diese Ansicht in der App angezeigt.

Wenn Ihre App weder über eine seitenspezifische Ansicht für die aktuelle Seite noch über eine App-spezifische Standardansicht verfügt, wird eine allgemeine Standardansicht angezeigt, die dem/der Nutzer/in den Zugriff auf die App veranschaulicht.

Wenn Ihre App beispielsweise über zwei Ansichten auf seitenspezifischen Darstellungsfeldern verfügt, die im folgenden App-Manifest angezeigt werden:

{
  "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"
      }
    ]
  }
}

Wenn die Endnutzer/innen Ihre App auf der Startseite des Dashboards öffnen, werden Links zu den Seiten „Kund/innen“ und „Produkte“ angezeigt. Wenn die Nutzer/innen dann die Kundenseite aufrufen, zeigt die App eine Meldung an, in der sie aufgefordert werden, einen Kunden/eine Kundin auszuwählen, um zugehörige Informationen in Ihrer App anzuzeigen.