Video hero
The Video hero is a full width section, which is to be used exclusively at the top of a page, as it utilises a H1 headline. The video should be an ambient background video that conforms to our guidelines. This can be customised as described in the layout specification tab below.
- Overview
- Specification
- Style Guide Manager
- Examples in-situ
- Usage
Centered
Left
Right
Centered
Left
Right
Centered
Left
RightSpecification
This provides guidance on the build, layout and content options for this component.
Layout specification
| Component item | Requirement & purpose | Optional or mandatory | CMS options |
|---|---|---|---|
| Minimum height | Sets minimum height of component for each breakpoint. Component expands based on content. | n/a | Set globally via SGM and affects all instances of the component on the site. |
| Content width | The content is contained by the grid width. Text spans 10 columns on desktop. 12 columns on tablet and mobile. | n/a | n/a |
| Vimeo/MP4 video URL | Allows user to add a link to a Vimeo video. | Optional | Link text input |
| YouTube video URL | Allows user to add a link to a YouTube video. | Optional | Link text input |
| Enable video for mobile device | To turn on autoplay video at mobile device | Optional | Toggle button |
| Upload mobile specific video | To allow uploading a new video at mobile device | Optional | Toggle button |
| Vimeo/MP4 video URL | Allows user to add a link to a Vimeo video. | Optional | Link text Input |
| YouTube Video URL | Allow user to add a link to a YouTube Video | Optional | Link text Input |
| Background video poster image | Allows user to set background image. On mobile, the poster image will show instead of the video. | Optional | Image uploader. |
| Lazy Load Video Poster | To improve the performance. | Optional | On/Off |
| Background image aria label | The aria-label allows us to specify a string to be used as the accessible label. | Optional | Text input field |
| Text alignment on desktop and tablet | Controls text alignment. | Optional | Vertically align top or centre. Horizontally align left, centre or right. |
| Text alignment on mobile | Controls text alignment. | Optional | Horizontally align left, centre or right. |
| Text position | Controls position of text. | Optional | Left, centre or right. |
| Padding top and bottom | Allows control of the top and bottom spacing within this component. This can be configured at brand level. | n/a | Large, medium or small. |
| Margin bottom | Allows control of spacing below component. This can be configured at brand level. | Mandatory | Large, medium, small or none. |
| Pre-heading text | Allows user to set a pre-heading before H1. | Optional | Text input. |
| Pre-heading text colour | Sets pre-heading colour. | Optional | Choose from colour palette. |
| Heading text | Sets heading content. | Optional | Text input. |
| Heading style | Sets heading style | Optional | Select from dropdown |
| Heading colour | Sets heading colour. | Optional | Choose from colour palette. |
| Paragraph text | Sets paragraph content. | Optional | Text input. |
| Paragraph style | Sets paragraph style. | Optional | Paragraph style select. |
| Paragraph colour | Sets paragraph colour. | Optional | Choose from colour palette. |
| WYSIWYG | Allows user to format text where additional styles may be required. | Optional | WYSIWYG. |
| PWA | To enable PWA toggle | Optional | Toggle Button |
| Link 1 | Allows user to link to a URL or launch a modal. | Optional | Link text input. Link style select. Link URL input. Target select: Same window or open in new. Modal ID input. |
| Link 2 | Allows user to link to a URL or launch a modal. | Optional | Link text input. Link style select. Link URL input. Target select: Same window or open in new. Modal ID input. |
| Button Shapes | Allows user to select different button shapes. | Optional | Select from dropdown |
Interaction
These are the interactive aspects of the component.
| Interaction |
|---|
| Link 1 links to either a defined page or can launch a modal. |
| Link 2 links to either a defined page or can launch a modal. |
Animation
For each link there will be option to add button animation. Animation configuration option will be following
| Button animate | Allows users to switch On/Off the animation functionality for the button link. | Optional | On/off. |
|---|---|---|---|
| Select animation | Allow user to select animation from the drop-down list. | Optional | Select list |
| Duration | Set how long in seconds the animation will take to run | Required | Numeric Input |
| Delay | Set a start delay on the animation in seconds | Optional | Numeric Input |
| Iteration | Set the number of times the animation should run | Optional | Numeric Input (Maximum two) |
| offset | Set the animation to start at a specific offset before or after the element has entered the view port | Optional | Numeric Input (Pixel) |
These are the Style Guide Manager settings that are specific to this component. For global settings see the Style Guide Manager section.
| Property | Global | Default | SGM override |
|---|---|---|---|
| Minimum height | No | Desktop - 464px Tablet - 280px Mobile - 360px | Desktop Tablet Mobile |
General usage dos and don'ts
| ✅ Dos | ❌ Don'ts |
|---|---|
| This component contains a H1 and should only be used at the top of a page. | Do not use this component anywhere else on a page. |
| Only use one hero component per page. | Do not use multiple hero components on a page. |
| Ensure the text is legible. | Do not use a background video that makes the text hard to read. |
| Read our guidance on video. |