Web components
Web components are the UI building blocks that you use to display data and trigger API functions. These components are native UI elements that follow Shopify's design system and render optimized interfaces for workflows in customer accounts.
Your target determines which components you can use because different locations in the customer account have different interface requirements and constraints.
You can't override the CSS for UI components. The customer account UI will always render the merchant's own branding. Customer account UI extensions don't have access to the real customer account DOM and can't render arbitrary HTML. They can only render custom HTML elements provided by Shopify.
You can't override the CSS for UI components. The customer account UI will always render the merchant's own branding. Customer account UI extensions don't have access to the real customer account DOM and can't render arbitrary HTML. They can only render custom HTML elements provided by Shopify.
Anchor to Upgrading your extensionUpgrading your extension
The latest version of customer account UI extensions adds new components and target APIs, and replaces checkout metafields with order metafields. Check out the migration guide for the steps to upgrade your extension.
Anchor to ActionsActions
Actions enable users to perform tasks and navigate through the customer account interface with interactive elements like buttons and links.
Button
Trigger actions or events, such as submitting forms, opening dialogs, or navigating to other pages.
Button group
Display multiple related buttons in a single layout.
Clickable
Make any content interactive with customizable styling such as backgrounds, padding, or borders.
Clickable chip
Display interactive filters or tags that can be clicked or removed.
Clipboard item
Copy text or data to the clipboard when activated.
Customer account action
Define the title and action buttons that appear in customer account action extension surfaces.
Link
Make text interactive, allowing users to navigate to other pages or perform specific actions.
Menu
Display a list of actions that users can perform on a resource.
Press button
Make any content interactive and trigger actions when pressed.
Anchor to Feedback and status indicatorsFeedback and status indicators
Feedback and status indicators communicate system states, progress, and important information to users.
Announcement
Communicate important, time-sensitive information to users.
Badge
Use color and text to communicate the state of orders, fulfillments, and other business data.
Banner
Highlight important information or required actions prominently within the interface.
Progress
Display progress through a series of steps or stages.
Spinner
Display an animated indicator to show that content or actions are loading.
Anchor to FormsForms
Forms capture and validate user input with specialized field types optimized for different data collection needs in the customer account.
Checkbox
Capture user selections, such as agreeing to terms or choosing multiple items from a list.
Choice list
Present multiple options for single or multiple selections.
Consent checkbox
Capture consent from customers with a checkbox and associated terms.
Consent phone field
Capture phone numbers with associated consent agreements.
Date field
Capture date input with a consistent interface for date selection and proper validation.
Date picker
Allow customers to select a specific date using a calendar-like picker interface.
Drop zone
Accept file uploads through drag-and-drop or button activation.
Email field
Capture email address input with built-in validation.
Form
Wrap form controls and enable implicit submission when users press Enter.
Money field
Capture monetary values with built-in currency formatting and validation.
Number field
Capture numeric input with built-in validation.
Password field
Securely capture sensitive information.
Phone field
Capture phone number input with built-in formatting and validation.
Select
Enable users to pick one option from a dropdown menu.
Switch
Toggle options on or off.
Text area
Capture longer text content with a multi-line, resizable text input area.
Text field
Capture single-line text input.
URL field
Capture URLs with built-in formatting and validation.
Anchor to Layout and structureLayout and structure
Layout and structure components organize content hierarchically and spatially, creating clear visual relationships in customer account interfaces.
Box
Display a generic container with consistent spacing and styling.
Divider
Create visual separation between content sections.
Grid
Organize content in a matrix of rows and columns to build responsive layouts.
Page
Configure the top-level page layout for full-page extensions.
Query container
Manage loading and error states for data queries.
Scroll box
Create a scrollable container for overflowing content.
Section
Group related content into clearly-defined thematic areas.
Stack
Organize elements horizontally or vertically along the block or inline axis.
Anchor to Media and visualsMedia and visuals
Media and visuals display images, icons, and graphical elements that enhance comprehension and visual communication in the customer account.
Avatar
Display a user's profile image or initials.
Icon
Display standardized visual symbols to represent actions, statuses, or categories consistently.
Image
Add visual content to the interface and customize the presentation of visuals.
Image group
Display a collection of images in a grouped layout.
Map
Display an interactive map with location markers.
Payment icon
Display standardized icons for payment methods.
Product thumbnail
Display small preview images representing products.
QR code
Generate and display QR codes for sharing links or data.
Anchor to OverlaysOverlays
Overlays present content in floating or layered surfaces that appear above the main interface, useful for focused tasks, contextual information, and supplementary content.
Modal
Display content in a layer that overlays the main page, requiring user interaction before returning.
Popover
Display contextual content in a floating container anchored to a trigger element.
Sheet
Display supplementary content in a panel that slides in from the edge of the screen.
Tooltip
Display additional information in an overlay on hover or focus.
Anchor to Typography and contentTypography and content
Typography and content components present textual information with appropriate hierarchy, emphasis, and styling for clear communication.
Abbreviation
Display abbreviated text with a tooltip showing the full term on hover.
Chip
Display user-supplied keywords that label, organize, and categorize objects.
Details
Display a collapsible section that users can expand to reveal additional content.
Heading
Render hierarchical titles to communicate the structure and organization of page content.
Ordered list
Display a numbered list of items.
Paragraph
Display blocks of text that can contain inline elements such as buttons, links, or emphasized text.
Skeleton paragraph
Display a placeholder for paragraph content while data is loading.
Text
Display text with specific visual styles or tones.
Time
Display dates and times in a localized format.
Unordered list
Display a bulleted list of items.