Docs

Hero

8 min read • 1,603 words
Share via

Shows a hero banner on the top of the page. The section supports a background image with an overlay to improve contrast. The hero includes a headline and optional breadcrumb for site navigation.

Overview   Arguments   Background Type   Heading Type   Illustration Type   Links Type   Examples   Illustrated Hero   Full-Screen Hero  

  Important

Content blocks are a new feature that is still in beta  . The implementation is subject to change. The documentation on this website is still being worked on.

Overview  

The hero content block renders a page hero, typically at the top of the page. Set cover to true to display a full-page hero.

Background image
Title
Hero content
yml 
- _bookshop_name: hero
  heading:
    title: Title
    align: start
    content: Hero content
    width: 8
  background:
    backdrop: /assets/img/nat-9l98kFByiao-unsplash.jpg
  breadcrumb: true

Arguments  

The content block supports the following arguments:

Name Type Required Default Comment
_bookshop_name string Unique name of the bookshop component.
align select start Alignment of the headline, content, or icon. Supported values: [start, center, end].
background background, string Background style of the section.
breadcrumb bool Flag to include a breadcrumb in the element.
cover bool true Flag indicating if the element should be rendered fullscreen.
heading Heading Heading of the content block, including a preheading and content element.
illustration Illustration Featured illustration of the element.
justify select center Justification of the child elements. Supported values: [start, end, center, between, around, evenly].
link-type select button Style of the link. Supported values: [button, link].
links [] Links Links to add as buttons.
order select last Order of the illustration. Supported values: [first, last].
orientation select stacked Placement of the thumbnail or icon. Supported values: [stacked, horizontal, horizontal-sm, overlay, none].
overlay-mode select Overlay mode of the element, overrides the site’s general configuration. Supported values: [light, dark, none].
width int 8 Column width of the element. For embedded elements, the width is relative to the parent’s container. Supported values: [1 - 12].
Name Type Required Default
_bookshop_name string
Unique name of the bookshop component.
align select start
Alignment of the headline, content, or icon. Supported values: [start, center, end].
background background, string
Background style of the section.
breadcrumb bool
Flag to include a breadcrumb in the element.
cover bool true
Flag indicating if the element should be rendered fullscreen.
heading Heading
Heading of the content block, including a preheading and content element.
illustration Illustration
Featured illustration of the element.
justify select center
Justification of the child elements. Supported values: [start, end, center, between, around, evenly].
link-type select button
Style of the link. Supported values: [button, link].
links [] Links
Links to add as buttons.
order select last
Order of the illustration. Supported values: [first, last].
orientation select stacked
Placement of the thumbnail or icon. Supported values: [stacked, horizontal, horizontal-sm, overlay, none].
overlay-mode select
Overlay mode of the element, overrides the site’s general configuration. Supported values: [light, dark, none].
width int 8
Column width of the element. For embedded elements, the width is relative to the parent’s container. Supported values: [1 - 12].

Background Type  

Name Type Required Default Comment
backdrop string Background image with a mask to improve contrast.
color select Theme color of the element. Supported values: [primary, secondary, success, danger, warning, info, light, dark, white, black, body, body-tertiary].
subtle bool Apply subtle theme colors.
Name Type Required Default
backdrop string
Background image with a mask to improve contrast.
color select
Theme color of the element. Supported values: [primary, secondary, success, danger, warning, info, light, dark, white, black, body, body-tertiary].
subtle bool
Apply subtle theme colors.

Heading Type  

Name Type Required Default Comment
align select start Alignment of the headline, content, or icon. Supported values: [start, center, end].
arrangement select above Arrangement of the preheading, either left or above the header. On smaller screens, the preheading is always placed on top. Supported values: [above, first].
content string, template.HTML Section content displayed below the title.
preheading string Preheading of the section heading.
size int 4 Display size of the headline. Supported values: [1 - 6].
title string, hstring.RenderedString, hstring.HTML, template.HTML Title of the element. If the element references a (local) page, the title overrides the referenced page’s title.
width int 8 Column width of the element. For embedded elements, the width is relative to the parent’s container. Supported values: [1 - 12].
Name Type Required Default
align select start
Alignment of the headline, content, or icon. Supported values: [start, center, end].
arrangement select above
Arrangement of the preheading, either left or above the header. On smaller screens, the preheading is always placed on top. Supported values: [above, first].
content string, template.HTML
Section content displayed below the title.
preheading string
Preheading of the section heading.
size int 4
Display size of the headline. Supported values: [1 - 6].
title string, hstring.RenderedString, hstring.HTML, template.HTML
Title of the element. If the element references a (local) page, the title overrides the referenced page’s title.
width int 8
Column width of the element. For embedded elements, the width is relative to the parent’s container. Supported values: [1 - 12].

Illustration Type  

Name Type Required Default Comment
anchor select Anchor of the image’s crop box, defaults to anchor value set in imaging section of the site configuration (usually Smart). Supported values: [TopLeft, Top, TopRight, Left, Center, Right, BottomLeft, Bottom, BottomRight, Smart].
class string Class attributes of the element. It supports Bootstrap attributes to modify the styling of the element.
hook string Render hook for the element’s partial.
icon string Icon to include. You can use shorthand notation such as fas sort to include a Font Awesome icon. The argument also supports files with an .svg or .json extension.
image string Image to include in the the content block or section heading.
image-overlay bool Trigger to include an image overlay placeholder.
mode bool Flag indicating if the media asset should support color modes. If set, the elements searches for images having a matching color-mode suffix such as -light or -dark.
ratio select Ratio of the media asset. When the asset is an image, it is resized and cropped (not applicable to vector graphics). For video assets, the padding of the embedded frame is adjusted. Supported values: [1x1, 3x2, 4x3, 16x9, 21x9].
width int 8 Column width of the element. For embedded elements, the width is relative to the parent’s container. Supported values: [1 - 12].
Name Type Required Default
anchor select
Anchor of the image’s crop box, defaults to anchor value set in imaging section of the site configuration (usually Smart). Supported values: [TopLeft, Top, TopRight, Left, Center, Right, BottomLeft, Bottom, BottomRight, Smart].
class string
Class attributes of the element. It supports Bootstrap attributes to modify the styling of the element.
hook string
Render hook for the element’s partial.
icon string
Icon to include. You can use shorthand notation such as fas sort to include a Font Awesome icon. The argument also supports files with an .svg or .json extension.
image string
Image to include in the the content block or section heading.
image-overlay bool
Trigger to include an image overlay placeholder.
mode bool
Flag indicating if the media asset should support color modes. If set, the elements searches for images having a matching color-mode suffix such as -light or -dark.
ratio select
Ratio of the media asset. When the asset is an image, it is resized and cropped (not applicable to vector graphics). For video assets, the padding of the embedded frame is adjusted. Supported values: [1x1, 3x2, 4x3, 16x9, 21x9].
width int 8
Column width of the element. For embedded elements, the width is relative to the parent’s container. Supported values: [1 - 12].
Name Type Required Default Comment
force bool Flag to indicate a link should bypass any language redirection. Only applicable when the site param enableLanguageSelectionStorage is set to true. When force is true, the link to a local page is kept as is.
icon string Icon to include. You can use shorthand notation such as fas sort to include a Font Awesome icon. The argument also supports files with an .svg or .json extension.
title string, hstring.RenderedString, hstring.HTML, template.HTML Title of the element. If the element references a (local) page, the title overrides the referenced page’s title.
url string, template.URL Address of the link destination, either a local reference or an external address. Include the scheme when referencing an external address, such as https://google.com. Local references may include an optional anchor link such as blog/bootstrap-elements/#docs.
Name Type Required Default
force bool
Flag to indicate a link should bypass any language redirection. Only applicable when the site param enableLanguageSelectionStorage is set to true. When force is true, the link to a local page is kept as is.
icon string
Icon to include. You can use shorthand notation such as fas sort to include a Font Awesome icon. The argument also supports files with an .svg or .json extension.
title string, hstring.RenderedString, hstring.HTML, template.HTML
Title of the element. If the element references a (local) page, the title overrides the referenced page’s title.
url string, template.URL
Address of the link destination, either a local reference or an external address. Include the scheme when referencing an external address, such as https://google.com. Local references may include an optional anchor link such as blog/bootstrap-elements/#docs.

Examples  

Change the style of your hero with the available arguments.

Illustrated Hero  

Apply an illustration and set orientation to horizontal to create an illustrated, horizontal hero.

Background image
Title
Hero content
Hero image
Hero image
yml 
- _bookshop_name: hero
  heading:
    title: Title
    align: start
    content: Hero content
    width: 8
  background:
    backdrop: /assets/img/nat-9l98kFByiao-unsplash.jpg
  order: last
  illustration:
    image: /img/logo-mono.svg
    mode: true
  orientation: horizontal

Full-Screen Hero  

Set cover to true to add a full-screen hero. A typical use case is to apply such a full-screen element to the top of a landing page.

Background image
Title
Hero content
Hero image
Hero image
yml 
- _bookshop_name: hero
  heading:
    title: Title
    align: start
    content: Hero content
    width: 8
  background:
    backdrop: /assets/img/nat-9l98kFByiao-unsplash.jpg
  align: center
  order: last
  illustration:
    image: /img/logo-mono.svg
    mode: true
  orientation: horizontal
  cover: true
On this page: