Custom banners and fields
A custom banner is a notice that you can display to customers. A custom field is a property that allows users to enter text into a user interface. This guide introduces custom banners and fields, and describes the available resources that you can use to build them in Shopify checkout.
How it worksAnchor link to section titled "How it works"
You can build functionality in your app that allows merchants to display and configure the following experiences:
- Custom banners in checkout
- Custom fields in checkout
Custom bannersAnchor link to section titled "Custom banners"
You can use a checkout UI extension to build a custom banner. The following example shows how to display a banner that renders at the
Checkout::Dynamic::Render extension point.
You can support static extension points so that merchants can use the checkout editor to render the extension in one of the supported locations in checkout.
Custom fieldsAnchor link to section titled "Custom fields"
You can use a checkout UI extension to build a custom field. The following example shows a custom field that collects delivery instructions and renders at the
Checkout::ShippingMethods::RenderAfter extension point:
Getting startedAnchor link to section titled "Getting started"
Follow tutorials to learn how to build custom banners and fields.
Developer tools and resourcesAnchor link to section titled "Developer tools and resources"
Explore the following developer tools and resources to get familiar with building custom banners and fields.
Checkout UI extensions API reference
Consult the API reference for checkout UI extension points and their respective types.
Components for checkout UI extensions
Learn about the components that are available in checkout UI extensions.
Checkout extension configuration
Learn about the properties that you can configure in your checkout UI extension.
- Learn how to add a custom banner to checkout.
- Learn how to add custom fields to checkout that customers can use to add delivery instructions to their order.