Strapi Component Banner - kwantu/platformconfiguration GitHub Wiki

Return to Components

1. Banner

1.1 What is a banner?

A banner is a component that contains a reel of images. Each banner image can contain text and a link. The banner slowly rotates through each banner image whilst the user is on the page. The user can also click through each banner image manually.

To use the banner effectively, you want it to be eye-catching at the top of your page. Each banner image will contain a link to key pages of the website.

Banner Example: image

1.2 How to create a banner?

The banner component consists of 2 parts: Banner Images and General Details.

1.2.1 Banner Images

Each banner image contains these fields:

Field Description Required?
Title This is the header for the textbox no
Description This is the paragraph for the textbox no
ButtonText This is the text used for the button that is linked no
Url This is the URL that the button will direct the user to no
Image This is where you upload the image for this section of the banner yes

Banner image fields example: image

1.2.2 General Details

The Other fields consist of:

Field Description Required?
Name This is the name of the banner (is not displayed) yes
Label This is the label of the banner (Not sure if used) no
Description Description of banner no
Uid Unique identifier which will be automatically generated from the Name yes
DisplayTitle A radio button to choose whether the title shows (This is not the banner image title, not sure of use) yes
Height Height of the banner yes

Banner fields example: image

1.3 How can this be developed further?