Content types
Promo List
Reference: the Promo List block, a list of promos with an optional heading, link and background image.
Overview
- Name: Promo List
- Type: Block
- Purpose: Shows a list of promos on a page, with an optional heading, link and background image. The promo size sets how many promos appear across on desktop, from two (wide) to five (small).
- Examples:
- Legacy functional requirements: https://bigpond.jira.com/wiki/spaces/AFLP/pages/3147366401/Promo+List+Functional+Requirements
- Legacy configuration instructions:
Content model
Properties
| Group | Name | Description | Data type | Required | Select Many | Limits | Allowed Values | Default Value | Example | Comments |
|---|---|---|---|---|---|---|---|---|---|---|
| General | Title | The heading shown above the promos. | String | No | No | Latest offers | Legacy: widgetTitle. Shown as the heading in the widget header above the list. Name set by override rules. | |||
| General | Link | The destination of the link shown above the promos. | Link | No | No | /offers | Legacy: linkTo (text). Shown as a link beside the widget heading. Link chosen as the data type for a link. The legacy link label (linkToLabel) has been combined into this property. | |||
| General | Detail Level | Controls how much detail each promo shows. Choose Detailed to show details such as price. | String | No | No | Basic, Standard, Detailed | Standard | Standard | Legacy: detail (select). Name set by override rules. Not read by the template apart from the widget schema, so the effect of Detailed is TBC. | |
| General | Promos | The promos to show in the list. | Content Reference (Promo) | No | Yes | Spring offers, Partner offers | Legacy: contentReference. Select Many is Yes because the legacy widget lists several promos from a playlist. The legacy allowed types are a playlist containing promos, photos, videos, articles and playlists; Promo is the closest match to this type. | |||
| General | Promo Size | The size of each promo in the list, which sets how many show across the page. | String | No | No | Small, Medium, Large, Wide | Large | Medium | Legacy: promoSize (select). Wide shows 2 across on desktop, Large 3, Medium 4 and Small 5 (default layout when no size matches). The analysis default is Large for every legacy type, but each legacy type has its own default size (Small, Medium, Large, Wide): confirm which default to use. Consolidates the four legacy types. | |
| General | Background Image | An image shown behind the promos. Only shows when the promo size is Large. | Content Reference (Photo) | No | No | Stadium crowd | Legacy: bgImage (contentReference). Only a photo is shown, and only for the Large size. Photo type taken from the legacy behaviour. | |||
| General | Background Style | Chooses a light or dark look. Dark uses the theme colour for the background and promo text. | String | No | No | Light, Dark | Light | Light | Legacy: darkMode (checkbox). Name, data type, allowed values and default set by override rules. | |
| General | Additional CSS | Extra styling applied to the promo list. | String | No | No | CssClass1, CssClass2 | CssClass1 | Legacy: additionalCss (text). The template reads a class passed here: promo-list--image-only hides the captions and uses the promo title as the image description. The legacy analysis gives placeholder allowed values (CssClass1, CssClass2); the supported class list is TBC. | ||
| General | Anchor Name | A unique name for linking to this promo list. Use letters, numbers and hyphens only, with no spaces. | String | No | No | Generated automatically | latest-promos | Legacy: anchorName. Used to create an anchor for linking to the list. Legacy default is a randomly generated UUID. | ||
| Migration | Legacy ID | The ID of this promo list in the legacy system. | String | No | No | 88 |
Implementation differences
Retired content types
| Name | Comments |
|---|---|
| Promo List Large | Consolidated into Promo List. Differs only in showing 3 promos across on desktop and in its default promo size, which is now the Promo Size property. |
| Promo List Medium | Consolidated into Promo List. Differs only in showing 4 promos across on desktop and in its default promo size, which is now the Promo Size property. |
| Promo List Small | Consolidated into Promo List. Differs only in showing 5 promos across on desktop and in its default promo size, which is now the Promo Size property. |
| Promo List Wide | Consolidated into Promo List. Differs only in showing 2 promos across on desktop and in its default promo size, which is now the Promo Size property. |
Retired attributes
| Name | Comments |
|---|---|
| playlistTypeRestriction | Restriction will be enforced by restricting references to only supported types. |
| linkToLabel | Combined into the Link property. |
| page | Not migrated: excluded for legacy playlist widgets (Playlist Widget - V2). |
| pageSize | Not migrated: excluded for legacy playlist widgets (Playlist Widget - V2). |
| contentRefExpression | Not migrated: excluded for legacy playlist widgets (Playlist Widget - V2). |
| tags | Not migrated: excluded for legacy playlist widgets (Playlist Widget - V2). |
| preventFetchingTotalItemsTotalPages | Not migrated: excluded for legacy playlist widgets (Playlist Widget - V2). |
Data migration
Coming soon...