Admin-extensions components

AdminAction

AdminAction is a component used by Admin Action extensions to configure a primary and secondary action and title.

AdminBlock

This component is similar to the AdminBlock, providing a deeper integration with the container your UI is rendered into. However, this only applies to Block Extensions which render inline on a resource page.

View AdminBlock

Badge

Use this component to inform merchants of the status of an object or of an action that’s been taken.

View Badge

Banner

Use this component if you need to communicate to merchants in a prominent way.

View Banner

BlockStack

This structures layout elements along the vertical axis of the page. It's useful for vertical alignment.

View BlockStack

Box

This is your foundational structural element for composing UI. It can be styled using predefined tokens. Use it to build your layout.

View Box

Button

Use this component when you want to provide users the ability to perform specific actions, like saving data.

View Button

Checkbox

Use this component when you want to provide users with a clear selection option, such as for agreeing to terms and conditions or selecting multiple options from a list.

View Checkbox

ChoiceList

Use this component if you need to group together a related list of interactive choices as radio buttons or checkboxes.

View ChoiceList

ColorPicker

Use this component if you need to select a color.

View ColorPicker

CustomerSegmentTemplate

CustomerSegmentTemplate is used to configure a template rendered in the **Customers** section of the Shopify admin. Templates can be applied in the [customer segment editor](https://help.shopify.com/en/manual/customers/customer-segmentation/customer-segments) and used to create segments.

View CustomerSegmentTemplate

DateField

This is a form field that lets users select a date using the DatePicker component.

View DateField

DatePicker

Date pickers let merchants choose dates from a visual calendar that’s consistently applied wherever dates need to be selected across Shopify.

View DatePicker

Divider

Use this to create a clear visual separation between different elements in your user interface.

View Divider

EmailField

Use this when you need users to provide their email addresses.

View EmailField

Form

Use this component when you want to collect input from users. It provides a structure for various input fields and controls, such as text fields, checkboxes, and buttons. It also integrates with the native Contextual Save Bar to handle form submission and reset actions.

View Form

Heading

Use this to display a title. It's similar to the h1-h6 tags in HTML

View Heading

HeadingGroup

This groups headings together, much like the hgroup element in HTML.

View HeadingGroup

Icon

This component renders an icon from a predefined list. Choose the one that suits your needs.

View Icon

Image

Use this when you want to display an image.

View Image

InlineStack

Use this to organize layout elements along the horizontal axis of the page. It's great for horizontal alignment.

View InlineStack

Link

This is an interactive component that directs users to a specified URL. It even supports custom protocols.

View Link

MoneyField

This is the right component for letting users enter Money digits.

View MoneyField

NumberField

This component is specifically designed for numeric data entry.

View NumberField

Paragraph

Use this to display a block of text similar to the `

` tag in HTML.

View Paragraph

PasswordField

This component is for secure input, it obfuscates any text that users enter.

View PasswordField

Pressable

Use this component when you need to capture click or press events on its child elements without adding any additional visual styling. It subtly enhances user interaction by changing the cursor when hovering over the child elements, providing a clear indication of interactivity.

View Pressable

ProgressIndicator

Use this component to notify merchants that their action is being processed or loaded.

View ProgressIndicator

Select

Use this when you want to give users a predefined list of options to choose from.

View Select

Text

This component renders text. Remember, you can also add your own styling.

View Text

TextArea

This component is perfect when you need to allow users to input larger amounts of text, such as for comments, feedback, or any other multi-line input.

View TextArea

TextField

This is your go-to component when you need to let users input textual information.

View TextField

URLField

This is the right component for letting users enter a URL.

View URLField