Overview
The Hero Summary row type creates a visually prominent identity card that summarises the most important information about a record at a glance. It typically appears at the top of the first panel and includes elements like an avatar or icon, the record's title, status tags, metadata items, and quick action buttons.
When to Use
Use the Hero Summary row type when you want to:
- Give records a strong visual identity with an avatar, photo, or icon
- Provide an at-a-glance summary of the most critical fields
- Display status tags, categories, or labels prominently
- Offer quick action buttons without using the main toolbar
- Create a profile-like header for person, organisation, or asset records
Properties
| Property | Required | Description |
|---|---|---|
| Type | Yes | Must be set to heroSummary |
| Background | No | The background style. Options include auto (automatically generated based on record data), subtle (a muted background colour), or a specific colour value. |
| Avatar | No | Configuration for the avatar/image display. Includes the source field, size, and shape (circular or square). |
| Title | No | Configuration for the main title. Specifies which field's value to display as the primary heading. |
| Subtitle | No | A template string for secondary text below the title. Can include field references that are replaced with actual values. |
| Tags | No | An array of tag definitions. Each tag references a field whose value is displayed as a coloured label. |
| Meta | No | An array of metadata items displayed below the title area. Each item shows a label and a field value, such as "Created: 15 Jan 2025" or "Owner: Jane Smith". |
| Actions | No | An array of quick action buttons displayed on the hero card. These provide shortcuts to common operations. |
Avatar Configuration
The avatar section of the Hero Summary can display:
- An image uploaded to the record (such as a profile photo or company logo)
- Automatically generated initials based on the record's name
- A placeholder icon when no image is available
The avatar can be configured with different sizes (small, medium, large) and shapes (circular for people, square or rounded for organisations and assets).
Tags
Tags appear as coloured labels on the hero card. They are typically used to show status, category, priority, or type at a glance. Each tag references an Indexed Select field, and the tag colour is derived from the selected option's colour configuration.
Metadata Items
Metadata items display supplementary information in a compact format. Common metadata items include:
- Record owner or assignee
- Creation or last modified date
- Reference number or identifier
- Location or department
Best Practices
- Place the Hero Summary as the first row in the first column of the General panel
- Keep the number of tags to 2 or 3 for a clean appearance
- Use metadata for static or slowly-changing reference data, not frequently edited fields
- Choose avatar shapes appropriate to the entity type: circular for people, rounded square for organisations