ContextView

ContextView allows apps to render next to Stripe content in a drawer so users can look at them side by side and share context.

The root view of your app must be a ContextView.

These in-context modules allow the app to meet users in their existing workflows and provide contextual information and actions.

A user’s interaction with an app always begins with a view type called a ContextView view. Each app must have a single ContextView view (per viewport), which acts as the default view when the page loads (similar to the index.html of a website).

What ContextView looks like

Note

To create a view within an existing ContextView, see FocusView.

Props

Prop	Type	Description
title Required	`string`	The title of the ContextView. This will be displayed at the top of the drawer under that app's name.
actions	`ReactNode`	A React fragment containing up to three Buttons that will be displayed directly under the header and above the children of the ContextView.
banner	`ReactElement<Component<BannerProps>>`	A Banner component that will be displayed directly under the header and above the children of the ContextView.
brandColor	`string`	A CSS color that contrasts well with `brandIcon`.
brandIcon	`string`	A square, 1-color SVG that contrasts well with `brandColor`.
children	`ReactNode`	The contents of the ContextView.
description	`string`	A description of the view's purpose, can also be used as a subtitle.
externalLink	`{ label: string; href: string; }`	A link to an external webpage. This should generally allow the user to view related information on another site with more context than what the app makes available in the app drawer.
footerContent	`ReactNode`	React node adjacent to any actions in the footer.
primaryAction	`ReactElement<Component<ButtonProps>>`	A primary call to action ("Save" or "Continue") button placed in the footer.
secondaryAction	`ReactElement<Component<ButtonProps>>`	A secondary call to action ("Cancel") button placed in the footer.

Example

import {
  Box,
  Button,
  ContextView,
} from '@stripe/ui-extension-sdk';

import appIcon from './icon.svg';

const HappyView = () => (
  <ContextView
    title="Get started with Stripe Apps"
    actions={
      <>
        <Button>Action 1</Button>
        <Button>Action 2</Button>
      </>
    }
    brandColor="#635bff"
    brandIcon={appIcon}
  >
    <Box>
      Example Content
    </Box>
  </ContextView>
);

ContextView

Note

Props

Example

See also