Skip to content

Commit

Permalink
docs: vf-hero imagery sizing and usage (#1734)
Browse files Browse the repository at this point in the history
Closes #1641
  • Loading branch information
khawkins98 committed Nov 30, 2021
1 parent d758aae commit 2a78bcb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
5 changes: 5 additions & 0 deletions components/vf-hero/CHANGELOG.md
@@ -1,3 +1,8 @@
### 3.3.3

* Improve docs on vf-hero image sizing
* https://github.com/visual-framework/vf-core/issues/1641

### 3.3.2

* Drop use of vf-stack-margin--custom.
Expand Down
12 changes: 10 additions & 2 deletions components/vf-hero/README.md
Expand Up @@ -8,9 +8,17 @@ The `vf-hero` component is to be used as a visual queue and page header. As need

## Usage

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.
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 `vf-hero--1200`.

The default variant is equivalent to `vf-hero--1200` and the recommended image size is 3000 by 1000 pixels.
### 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.

### Content

Expand Down

0 comments on commit 2a78bcb

Please sign in to comment.