vf-hero component is to be used as a visual queue and page header. As needed, it can take a kicker, heading, sub-heading, text content, and a 'call to action' link.
By default the
vf-hero makes use of the roundels background image. To keep the raw structure of the HTML and CSS the same this is applied using a CSS custom property. The default variant is equivalent to
Hero background images
You can bring your own image to use with the vf-hero.
- Size: recommended image size for a typical hero is 3000 by 1000 pixels.
- Positioning: people and other important imagery should be placed on the right side. The image will, by default, vertically centre and align to the right side.
- Imagery: most of the image should be abstract as to not visually compete with the text in the hero box.
- Text: do not use raster text as part of the image.
- Consult design: the image should be made in consultation with your organisation's design team for brand alignment and input on how best to create it.
|Heading||To be used for the heading of the page.||
|Heading HREF||To be used as a 'return to home' link for the micro site.||
|Subheading||Optional content to be used along with the Heading for a terse explainer.||
|Kicker||Optional content that helps define the context of overall content of the page.||
|Text||Optional content that can help explain the page content in a brief paragraph.||
|Link Text||The text for the hero 'call to action' link. Only works if there is associated Link HREF.||
|Link HREF||The url that the Link Text would be pointing to and opens in the same browser tab. This only works if there is associated Link Text||
CSS Custom Properties
--vf-hero--bg-image — this is for the url for the background image. It can either be added, inline if you're writing the HTML, using the
.yml data source of
vf_hero_image, or by other needs (a input or upload in WordPress, for example).
---vf-hero--bg-image-size — this is to determine the sizing of the background image. As group sites are using the roundel image it needs specific dimensions so that it works. These dimensions are
auto 28.5rem. We use a fallback here as background images in
vf-hero should be full bleed by default so the fall back in the CSS is for cover —
Internet Explorer support
IE 11 will get the background colour and the "roundels" image. Under the approach of progressive enhancement, IE 11 will not paint a different background image if added.
For EMBL sites, the
vf-hero can take an image (provided by Design) which should be uploaded to the files site and applied using the custom property available (
$ yarn add --dev @visual-framework/vf-hero
The style files included are written in Sass. If you're using a VF-core project, you can import it like this: