Skip to main content
Skip table of contents

Promotional strips

Overview

A promotional strip rail is designed to highlight featured or time-sensitive content, such as special offers, exclusive releases, or marketing-driven material/advertisements. This type of rail may be visually distinct, include attention-grabbing elements, or allow for dynamic content updates based on promotional cycles.

These are designed to work in conjunction with feature_banner rail items, although they can accept any standard rail item.

See Feature banner custom component.

Example configurationProperties response

For a rail that uses a promotional strip blueprint (in this case, the Single Promotion: 3:1 Dual Height Row instance), the rail’s configurationProperties block looks like this.

JSON
...
  "configurationProperties": {
    "client_context": [
      "double height",
      "uniform"
    ],
    "instance": "Single Promotion: 3:1 Dual Height Row",
    "layout_style": "dual_height",
    "visible": true,
    "tile_style": "promotion",
    "type": "promotional_strip",
    "carousel": false,
    "tile_pattern": [
      "3x1"
    ]
  },
...

Fields

The following table lists the fields that are specific to promotional strip blueprints. (SeeRail reponses for a full list of rail fields.)

A custom instance of the standard strip might use any of the available values in the table.

A built-in instance will use specific values as listed in Promotional strip instances, below.

Keys

Type

Values

Description

type

static

promotional_strip

The type field defines the category of rail this blueprint describes.

A promotional_strip rail is designed to highlight featured or time-sensitive content, such as special offers, exclusive releases, or marketing-driven material/advertisements. This type of rail may be visually distinct, include attention-grabbing elements, or allow for dynamic content updates based on promotional cycles.

These are designed to work in conjunction with feature_banner rail items, although they can accept any standard rail item.

layout_style

enum

triple_height,

dual_height,

single_height

The layout_style field specifies how the tiles should be arranged within the rail.

  • triple_height:
    A simple single-row, triple-height layout

  • dual_height:
    A simple single-row, double-height layout

  • single_height:
    A simple single-row, single-height layout

carousel

boolean

The carousel is a special layout variant designed to show a limited number of items at a time (typically three to five). It emphasises a more organised or featured display, often showcasing highlighted content or key items. Carousels are commonly used for promotions, featured items, or spotlight content. Depending on the client’s navigation style, a carousel may include navigation controls, such as:

  • Arrows: To move to the next or previous items.

  • Dots: To show the number of available items and the current position within the carousel.

Carousels are ideal for highlighting specific content, ensuring that the user’s attention is drawn to a select few items within the strip.

Notes:

  • The carousel layout is highly flexible, and the navigation controls (arrows, dots) are not defined in this blueprint but should be implemented as needed by the client.

tile_pattern

enum selector

(duplicates on, re-ordering on)

16x9,

4x3,

2x3,

3x2,

4x5,

1x1,

3x1,

4x1

The tile_pattern field defines the layout and aspect ratio of tiles within the rail. This pattern, which may consist of a combination of aspect ratios, is definitive and will NOT repeat across the rail. Duplicate tiles can be specified.

  • 16x9, 4x3, 3x2, 2x3, 4x5, 1x1, 3x1, 4x1:
    These are fixed aspect ratios for tiles, and will be shown in the order they are selected

Examples:

  • Single aspect ratio:
    4x3
    Result: [4x3] ...

  • Multiple aspect ratios:
    4x3, 16x9
    Result: [4x3] [16x9] ...

  • Multiple aspect ratios with duplicates:
    16x9, 4x1, 16x9
    Result: [16x9] [4x1] [16x9] ...

visible

boolean

The visible setting acts as a simple flag that allows the client to show or hide a rail without removing it from the template or layout.

  • true (default): The rail will be displayed to the user within the layout.

  • false: The rail will be hidden from view but still remains part of the template. It can be toggled back to true later without needing to modify the layout or template structure.

Promotional strip instances

Single Promotion 3:1 Dual Height Row

Appearance

Key

Values

Untitled-20251017-161656.png

type

promotional_strip

layout_style

dual_height

tile_pattern

["3x1"]

visible

true

carousel

false

Single Promotion 4:1 Dual Height Row

Appearance

Key

Values

Untitled-20251017-161720.png

type

promotional_strip

layout_style

dual_height

tile_pattern

["4x1"]

visible

true

carousel

false

Double Promotion 3:1 Dual Height Row

Appearance

Key

Values

Untitled-20251017-161737.png

type

promotional_strip

layout_style

dual_height

tile_pattern

["3x1","3x1"]

visible

true

carousel

false

Double Promotion 4:1 Dual Height Row

Appearance

Key

Values

Untitled-20251017-161803.png

type

promotional_strip

layout_style

dual_height

tile_pattern

["4x1","4x1"]

visible

true

carousel

false

Triple Promotion 3:1 Dual Height Row

Appearance

Key

Values

Untitled-20251017-161820.png

type

promotional_strip

layout_style

double_height

tile_pattern

["3x1","3x1","3x1"]

visible

true

carousel

false

Triple Promotion 4:1 Dual Height Row

Appearance

Key

Values

Untitled-20251017-161835.png

type

promotional_strip

layout_style

double_height

tile_pattern

["4x1","4x1","4x1"]

visible

true

carousel

false

Standard Carousel 16:9

Appearance

Key

Values

Untitled-20251017-161859.png

type

promotional_strip

layout_style

single_height

tile_pattern

["16x9"]

visible

true

carousel

true

Showcase Carousel 3:1

Appearance

Key

Values

Untitled-20251017-161917.png

type

promotional_strip

layout_style

single_height

tile_pattern

["3x1"]

visible

true

carousel

true

Ultra Showcase Carousel 4:1

Appearance

Key

Values

Untitled-20251017-161939.png

type

promotional_strip

layout_style

single_height

tile_pattern

["4x1"]

visible

true

carousel

true

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.