UI Components

UI Component

UI components are a way of describing some UI when using Plain's Customer Timeline Entries and Customer Cards.

For example - this is a button that links to Stripe.

{
  "componentLinkButton": {
    "linkButtonUrl": "http://stripe.com/",
    "linkButtonLabel": "View in Stripe"
  }
}

and it looks like this:

Example button linking to stripe

In the GraphQL API schema, we have two separate unions for Custom Timeline Entry Components and Customer Card Components, but both unions share the same types therefore they can be treated as the same.

To see UI components in action you can experiment with them: