Choose a version:

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

pos.home.tile.render

Anchor to PropertiesProperties

Configure the following properties on the Tile component.

Anchor to disabled disabled boolean Default: false: Whether the field is disabled, preventing user interaction. Use when the field is temporarily unavailable due to application state, permissions, or dependencies.
Anchor to heading heading string Default: '': A title that describes the content of the section. If omitted and no secondary actions are provided, the section will be rendered without a header.
Anchor to id id string: A unique identifier for the element used for targeting with CSS, JavaScript, or accessibility features.
Anchor to itemCount itemCount number: A numeric value displayed as a counter or badge. Used for showing quantities, notifications, or step numbers.
Anchor to subheading subheading string Default: '': A secondary page heading displayed under the main heading in the action bar.
Anchor to tone tone 'auto' | 'neutral' | 'accent' Default: 'auto': Sets the visual tone of the tile based on the intention of the information being conveyed. Use 'accent' to highlight important or primary actions, 'neutral' for standard actions, or 'auto' (default) to let the system determine the appropriate tone based on context.

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: The callback when the element is activated.

CallbackEvent

Represents the event object passed to callback functions when interactive events occur. Contains metadata about the event, including the target element, event phase, and propagation behavior.

bubbles
Whether the event bubbles up through the DOM tree.
```
boolean
```
cancelable
Whether the event can be canceled.
```
boolean
```
composed
Whether the event will trigger listeners outside of a shadow root.
```
boolean
```
currentTarget
The element that the event listener is attached to.
```
HTMLElementTagNameMap[T]
```
detail
Additional data associated with the event.
```
any
```
eventPhase
The current phase of the event flow.
```
number
```
target
The element that triggered the event.
```
HTMLElementTagNameMap[T] | null
```

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

<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?