Feature banner custom component
Overview
A feature banner custom component is a visually prominent content item intended for promotional purposes, typically featuring an image and an optional navigation action.
Note that no pre-defined feature banner custom component instances are defined.
Example configurationProperties block
For a rail section that represents a feature banner custom component, the configurationProperties block will look like this:
...
"configurationProperties": {
"instance": "Feature",
"template_id": "ae4e331d-35fc-419a-97c5-14a52568d065",
"type": "feature_banner"
},
...
A feature banner custom component within a rail should also have a key/value pair section (represented by an extendedAttributes block) that specifies the display image to be used.
This will be either:
An internal image – see Internal Image key/value pair group
An external image – see External Image key/value pair group
Fields
The following table lists the fields for a feature banner custom component.
Keys | Type | Values | Description |
|---|---|---|---|
| String | N/A | The name of the instance of the custom component |
| static |
| Defines the type of the rail item. A |
| template selector |
| This field specifies the template to navigate to when the feature banner is selected. |