Skip to main content

Tile

The tile component displays interactive buttons for the POS smart grid. Use tiles as customizable shortcuts that allow merchants to quickly access workflows, actions, and information from the smart grid.

Tiles can change their appearance, content, and enabled state based on surrounding context such as cart contents, device conditions, or runtime state. They can display contextual information through headings, subheadings, and badge values.

Each POS UI extension can only render one tile component for each home screen tile target.

Support
Targets (1)

Supported targets

Anchor to PropertiesProperties

Displays tappable content in a compact tile layout.

Anchor to disabled
disabled
boolean
Default: false

Disables the tile meaning it cannot be clicked or receive focus.

Anchor to heading
heading
string
Default: ''

A title that describes the content of the tile.

Anchor to id
id
string

A unique identifier for the element.

Anchor to itemCount
itemCount
number

A numeric indicator rendered within the tile (for example, a count or a step number).

  • When provided, the indicator is displayed inside the tile.
  • Intended for small integers. It may clamp, truncate, or abbreviate larger values.
Anchor to subheading
subheading
string
Default: ''

Supporting text displayed below the heading.

Anchor to tone
tone
'auto' | 'neutral' | 'accent'
Default: 'auto'

Sets the tone of the tile, based on the intention of the information being conveyed.

Anchor to EventsEvents

The tile component provides event callbacks for handling user interactions. Learn more about handling events.

Anchor to click
click
(event: <"s-tile">) => void

Callback when the tile is activated.

Anchor to ExamplesExamples

Anchor to Create a smart grid tileCreate a smart grid tile

Create interactive smart grid shortcuts using a tile component with customizable heading, subheading, and badge. This example shows a basic tile for the POS smart grid.

Create a smart grid tile

Create interactive smart grid shortcuts using a tile component with customizable heading, subheading, and badge. This example shows a basic tile for the POS smart grid.

Create a smart grid tile

<s-tile heading="Extension title" subheading="Subtitle" />
<s-tile heading="Extension title" subheading="Subtitle" tone="accent" />

Anchor to Best practicesBest practices

  • Write action-oriented headings: Use specific language like "Apply loyalty discount" rather than generic terms like "Loyalty app."
  • Provide contextual subheadings: Show dynamic information like cart totals, eligibility requirements, or current status.
  • Use meaningful item counts: Display counts for actionable items like pending notifications or items requiring action, not just informational counts.
  • Launch modals for workflows: Use onClick with shopify.action.presentModal() rather than performing complex operations directly.

Anchor to LimitationsLimitations

The tile component supports click and long press interactions only. Swipe, drag, and other gestures aren't supported.

Was this page helpful?