Object Display Templates
Object Display templates define how your Sui objects appear in wallets, explorers, and other clients. Each template maps a display property (for example, name, description, image_url) to a format string that references fields on your object using {field_name} syntax.
The interactive tool below lets you experiment with Object Display V2 templates. You can modify template values and see how different field references and formatting options affect the rendered output.
How to use the preview tool
- Select an object type from the available options in the tool.
- Edit the template values to change how the object renders. Use
{field_name}syntax to reference object fields. - The preview updates in real time as you modify template values.
Common template properties
Display templates typically include the following properties:
| Property | Purpose | Example value |
|---|---|---|
name | Object title shown in wallets | {collection_name} #{number} |
description | Object description | A collectible from the {collection_name} series |
image_url | Preview image URL | https://example.com/images/{image_id}.png |
link | URL to the object's detail page | https://example.com/items/{id} |
project_url | Project homepage | https://example.com |
creator | Creator name or address | Example Studio |
For the full reference on creating and managing displays programmatically, see Using Object Display.