Article

An editorial container that styles children HTML elements.

Published

Last updated: 5.5.0

Github

NPM

Twig Usage

{% include '@bolt-elements-article/article.twig' with {
  content: 'This is an article.',
} only %}

Schema

Prop Name	Description	Type	Default Value	Option(s)
attributes	A Drupal-style attributes object with extra attributes to append to this component.	`object`	—	—
content *	Content of the article.	`any`	—	—
tag	Set the HTML tag for the content container.	`string`	`article`	`article` or `div`

Install

npm install @bolt/elements-article

Dependencies

@bolt/core-v3.x

Basic Article

An Article element can be used for any free-form content areas where a WYSIWYG editor is enabled. Basic HTML elements are styled within the Article element.

Important Notes:

Even though plain <table> elements are styled, they are not responsive. Please wrap all <table> elements with <bolt-table> web component to enable responsive styles (JavaScript required). View Table Component

As for <pre> and <code> elements, they do not have syntax highlighting. To enable syntax highlighting, please use <code> web component instead (JavaScript required). View Code Snippet Component

Demo

The is a list of all supported plain HTML elements:

p
dl
ol
ul
header
section
h1 ~ h6
blockquote
details
figure
small
table
code
kbd
pre
hr

The following is a kitchen sink of all supported plain HTML elements:

H1 heading text

H2 heading text

H3 heading text

H4 heading text

H5 heading text

H6 heading text

Text: bold, italic, linked, code, kbd, small, super^script, sub_script.

First level unordered item
First level unordered item
1. Second level ordered item
  - Third level unordered item
  - Third level unordered item
2. Second level ordered item
First level unordered item

First level ordered item
First level ordered item
- Second level unordered item
  1. Third level ordered item
  2. Third level ordered item
- Second level unordered item
First level ordered item

First level ordered item 1
First level ordered item 2
1. Second level ordered item 1
2. Second level ordered item 2
  1. Third level ordered item 1
  2. Third level ordered item 2
    1. Fourth level ordered item 1
    2. Fourth level ordered item 2
      1. Fifth level ordered item 1
      2. Fifth level ordered item 2
        
        Sixth level ordered item 1
        
        Sixth level ordered item 2
        
        Sixth level ordered item 3
      3. Fifth level ordered item 3
    3. Fourth level ordered item 3
  3. Third level ordered item 3
3. Second level ordered item 3
First level ordered item 3

Summary sums up the details

Details elaborate on the summary.

Definition list: A list of text and description.
Morgawr: A sea serpent.
Owlman: A giant owl-like creature.

pre {
  padding: .5em 1em; color: black; border-left: 5px solid; background-color: white;
}

Pull Quote. Darkness cannot drive out darkness; only light can do that. Hate cannot drive out hate; only love can do that.

The time is always right to do what is right.

Col1	Col2	Col3
Row1	Row1	Row1
Row2	Row2	Row2

Twig

// Render content
{% set article_content %}
  <h1>
    H1 heading text
  </h1>
  <h2>
    H2 heading text
  </h2>
  <h3>
    H3 heading text
  </h3>
  <h4>
    H4 heading text
  </h4>
  <h5>
    H5 heading text
  </h5>
  <h6>
    H6 heading text
  </h6>
  <p>
    Text: <strong>bold</strong>, <em>italic</em>, <a href="#!">linked</a>, <code>code</code>, <kbd>kbd</kbd>, <small>small</small>, super<sup>script</sup>, sub<sub>script</sub>.
  </p>
{% endset %}

// Pass content to the component and set proper HTML tag
{% include '@bolt-elements-article/article.twig' with {
  content: article_content,
  tag: 'article',
} only %}

HTML

<article class="e-bolt-article">
  <h1>
    H1 heading text
  </h1>
  <h2>
    H2 heading text
  </h2>
  <h3>
    H3 heading text
  </h3>
  <h4>
    H4 heading text
  </h4>
  <h5>
    H5 heading text
  </h5>
  <h6>
    H6 heading text
  </h6>
  <p>
    Text: <strong>bold</strong>, <em>italic</em>, <a href="#!">linked</a>, <code>code</code>, <kbd>kbd</kbd>, <small>small</small>, super<sup>script</sup>, sub<sub>script</sub>.
  </p>
</article>

Button

A graphical element that indicates interactivity.

Published

Last updated: 5.5.0

Change log

Github

NPM

Twig Usage

{% include '@bolt-elements-button/button.twig' with {
  content: 'This is a button',
  attributes: {
    type: 'submit'
  }
} only %}

Schema

Prop Name	Description	Type	Default Value	Option(s)
attributes	A Drupal-style attributes object with extra attributes to append to this component.	`object`	—	—
content *	Content of the button.	`any`	—	—
icon_before	Append an icon before the button content. Icon element is recommended. However, <img> elements are also acceptable.	`any`	—	—
icon_after	Append an icon after the button content. Icon element is recommended. However, <img> elements are also acceptable.	`any`	—	—
icon_only	Append an icon to the button content and visually hide the text content. This prop trumps icon_before and icon_after.	`any`	—	—
hierarchy	Style the button appropriately based on information hierarchy.	`string`	`primary`	`primary`, `secondary`, `tertiary`, `transparent`
size	Control the font-size and padding of the button.	`string`	`medium`	`xsmall`, `small`, `medium`, `large`
border_radius	Control the border radius of the button.	`string`	`small`	`small`, `large`, `full`
display	Control the display of the button.	`string`	`inline`	`inline`, `block`, `inline@from-small`

Install

npm install @bolt/elements-button

Dependencies

@bolt/core-v3.x

Basic Button

A button is generally an inline interactive graphical element. Its main purpose is to help the user perform a function (sometimes navigate). <button class="e-bolt-button"> is acceptable at rendering a button, though the Twig template is the recommended usage for Drupal.

Important Notes:

Only text should be passed to the content prop. However, <span>, <em>, and <strong> elements can be used.

Button element is a replacement for the Button component.

Demo

Light

Dark

Twig

{% include '@bolt-elements-button/button.twig' with {
  content: 'This is a button',
  attributes: {
    type: 'button'
  }
} only %}

HTML

<button type="button" class="e-bolt-button">This is a button</button>

Button as an <a> element

When appropriate, an <a> element can use the button style. For example, the button helps to navigate to another page.

Important Notes:

If a button serves navigational purpose, the proper URL must be set with the href attribute.

Demo

This looks like a button but semantically is an anchor

Twig

{% include '@bolt-elements-button/button.twig' with {
  content: 'This looks like a button but semantically is an anchor',
  attributes: {
    href: 'https://google.com',
  }
} only %}

HTML

<a href="https://google.com" class="e-bolt-button">This looks like a button but semantically is an anchor</a>

HTML Attributes for Button

Depending on if the <a> element or the <button> element is being used, the proper HTML attributes should be passed.

Important Notes:

<a> requires the href attribute.

<button> requires the type attribute.

Demo

This button has the "href", "target", "rel", and "id" attributes

Twig

// <button>
{% include '@bolt-elements-button/button.twig' with {
  content: 'This button has the "type" attribute',
  attributes: {
    type: 'submit',
  }
} only %}

// <a>
{% include '@bolt-elements-button/button.twig' with {
  content: 'This button has the "href", "target", and "id" attributes',
  attributes: {
    href: 'https://google.com',
    target: '_blank',
    rel: 'noopener',
    id: 'js-bolt-some-unique-id'
  }
} only %}

HTML

<a href="https://google.com" target="_blank" rel="noopener" id="js-bolt-some-unique-id" class="e-bolt-button">This button has the "href", "target", "rel", and "id" attributes</a>

Button with Icon

Icons can be used in tandem with a button. An icon can be placed before and/or after the button text. The icon component is recommended for appending icons. However, an <img> element is also acceptable.

Important Notes:

Icons are set inline with text so icon size will grow or shrink with text size. The size and background props for the icon component are not well supported in this scenario.

When writing in plain HTML, all white space must be eliminated to have the icon display correctly next to text (in terms of spacing and wrapping). The markup must be written all in one line and spaces between HTML elements must be removed.

When writing in plain HTML, <span class="e-bolt-button__icon-before"> and <span class="e-bolt-button__icon-after"> are required to wrap around the icon markup. The wrapper ensures that the icon will always wrap with the final word of the text. It will never wrap to the next line on its own.

Demo

Twig

// Icon vars
{% set icon_custom %}
  <img src="/images/placeholders/500x500.jpg">
{% endset %}
{% set icon_chevron_down %}
  {% include '@bolt-elements-icon/icon.twig' with {
    name: 'chevron-down',
  } only %}
{% endset %}

// Button include
{% include '@bolt-elements-button/button.twig' with {
  content: 'This is a button with icons before and after',
  icon_before: icon_custom,
  icon_after: icon_chevron_down,
  attributes: {
    type: 'button'
  }
} only %}

HTML

<button type="button" class="e-bolt-button"><span class="e-bolt-button__icon-before"><!-- Icon or image markup --></span>This is a button with icons before and after<span class="e-bolt-button__icon-after"><!-- Icon or image markup --></span></button>

Icon Only Button

Icon only button visually hides the text content of the button. Such a button should be used sparingly and only in places where screen real estate is a concern.

Important Notes:

It is recommended that icon only buttons to be used in tandem with tooltip to give the user more context about the button’s function.

When writing in plain HTML, aria-label is required to render the button text. For example: <button type="button" class="e-bolt-button e-bolt-button--icon-only" aria-label="Download">. Text should not be used inside the button when using aria-label.

When writing in plain HTML, <span class="e-bolt-button__icon-center"> is required to wrap around the icon markup. The wrapper ensures that the icon will always center within the button.

Demo

File size: 25MB

Add another row

Twig

// Icon only button combined with tooltip
{% set icon_download %}
  {% include '@bolt-elements-icon/icon.twig' with {
    name: 'download',
  } only %}
{% endset %}
{% set tooltip_trigger %}
  {% include '@bolt-elements-button/button.twig' with {
    content: 'Download',
    icon_only: icon_download,
    attributes: {
      type: 'button'
    }
  } only %}
{% endset %}
{% include '@bolt-components-tooltip/tooltip.twig' with {
  trigger: tooltip_trigger,
  content: 'File size: 25MB',
} only %}

HTML

// Icon only button combined with tooltip
<bolt-tooltip>
  <button type="button" class="e-bolt-button e-bolt-button--icon-only" aria-label="Download">
    <span class="e-bolt-button__icon-center"><!-- Icon or image markup --></span>
  </button>
  <span slot="content">File size: 25MB</span>
</bolt-tooltip>

Button Hierarchy

A button can be assigned to various levels of the content hierarchy based on the information architecture of the layout.

Important Notes:

Transparent button is the lowest in the hierarchy level. This style has the lowest affordances and it should NEVER be used alone. Always pair it with a primary, secondary, or tertiary button.

Demo

Light

Dark

Twig

{% include '@bolt-elements-button/button.twig' with {
  content: 'This is a secondary button',
  hierarchy: 'secondary',
  attributes: {
    type: 'button'
  }
} only %}

HTML

<button type="button" class="e-bolt-button e-bolt-button--secondary">This is a secondary button</button>

Button Size

A button’s size can be modified per use case.

Demo

Twig

{% include '@bolt-elements-button/button.twig' with {
  content: 'This is a small button',
  size: 'small',
  attributes: {
    type: 'button'
  }
} only %}

HTML

<button type="button" class="e-bolt-button e-bolt-button--small">This is a small button</button>

Button Border Radius

Rounded buttons are possible with the border_radius prop.

Demo

Twig

{% include '@bolt-elements-button/button.twig' with {
  content: 'This is a fully rounded button',
  border_radius: 'full',
  attributes: {
    type: 'button'
  }
} only %}

HTML

<button type="button" class="e-bolt-button e-bolt-button--border-radius-full">This is a fully rounded button</button>

Button Display

The display of a button can be changed from inline to block (full width), and there is an extra option to make it transform from inline to block at the small breakpoint.

Important Notes:

When display prop is set to inline@from-small, it means the button is block display below the small breakpoint, and transform to inline display from small breakpoint and up. Resize the browser to see the demo below.

Demo

Twig

{% include '@bolt-elements-button/button.twig' with {
  content: 'This is a full width button',
  display: 'block',
  attributes: {
    type: 'button'
  }
} only %}

HTML

<button type="button" class="e-bolt-button e-bolt-button--block">This is a full width button</button>

Upload Button

The button classes can also be used on a file input.

Important Notes:

This is an advanced use case and the Twig template does not support this.

Hierarchy should be set to tertiary.

Size should be set to small.

Demo

Twig

Not available in Twig. Please use plain HTML.

HTML

<input id="unique-file-id" type="file" class="e-bolt-button e-bolt-button--small e-bolt-button--tertiary">

Icon

Inline SVG icon system.

Published

Last updated: 5.5.0

Change log

Github

NPM

Twig Usage

{% include '@bolt-elements-icon/icon.twig' with {
  name: 'bell-solid',
} only %}

Schema

Prop Name	Description	Type	Default Value	Option(s)
attributes	A Drupal-style attributes object with extra attributes to append to this component.	`object`	—	—
name	Name of Icon	`string`	—	`add-circle`, `add-solid`, `add`, `agile`, `app-development`, `arrow-left`, `bar-chart-circle`, `bar-chart`, `bell-solid`, `bolt-logo-colored`, `briefcase`, `bullseye`, `calendar`, `certification`, `check-circle`, `check-solid`, `check`, `chevron-down`, `chevron-left`, `chevron-right`, `chevron-up`, `clock-circle`, `close-circle`, `close-solid`, `close`, `cloud`, `co-browse`, `collaboration`, `communications`, `copy-to-clipboard`, `credit-card`, `cube`, `customer-decision-hub`, `customer-onboarding`, `customer-service`, `data-integrations`, `documentation`, `dollar-circle`, `download`, `email`, `energy`, `entertainment`, `exclamation`, `external-link`, `eye-off`, `eye`, `face-happy`, `face-sad`, `facebook-solid`, `facebook`, `filter`, `financial`, `flag-solid`, `full-screen-off`, `full-screen-on`, `github`, `globe-circle`, `globe`, `government`, `grid`, `heart-solid`, `heart`, `hospitality`, `ideas`, `industries`, `info-circle`, `info-solid`, `insurance`, `integration`, `intelligent-virtual-assistant`, `interactive`, `java`, `knowledgebase`, `life-sciences`, `link`, `linkedin-solid`, `linkedin`, `list`, `lock-solid`, `lock`, `manufacturing`, `map-pin-solid`, `map-pin`, `media`, `menu`, `meteor`, `minus-circle`, `minus-solid`, `minus`, `mobility`, `molecule`, `more`, `omni-channel`, `orbit`, `partners`, `pega-announce`, `pega-book`, `pega-building-complex`, `pega-cart`, `pega-catalyst`, `pega-chat-question`, `pega-chat-typing`, `pega-chat`, `pega-compass`, `pega-connection-hierarchy`, `pega-cosmos`, `pega-database`, `pega-disability`, `pega-download-pdf`, `pega-handshake`, `pega-health-shield`, `pega-hub`, `pega-instructor`, `pega-map`, `pega-mention`, `pega-network`, `pega-patterns`, `pega-people`, `pega-phone-call`, `pega-pie-chart`, `pega-pin`, `pega-plane`, `pega-process-fabric`, `pega-send-submit`, `pega-setting`, `pega-shuffle`, `pega-subtitle`, `pega-tag`, `pega-thumbs-up`, `pega-timer`, `pega-wifi`, `pencil`, `picture`, `platform`, `podcast`, `presentation`, `print`, `product-delivery`, `refresh`, `reply`, `reporting`, `retail`, `ribbon`, `robo-auto`, `rocket`, `sales-automation`, `scalability`, `search`, `share`, `speed-dial`, `star-solid`, `support`, `system-admin`, `text-align-left`, `transportation`, `trash`, `triangle`, `truck`, `twitter-solid`, `twitter`, `unlock`, `upload`, `user-interface`, `user`, `video`, `warning`, `watch`, `workforce-intelligence`, `youtube-solid`
custom_icon_path	Full source path to the custom icon.	`string`	—	—
size	Set icon size. If size is not set, the icon size will default to text size.	`string`	—	`small`, `medium`, `large`, `xlarge`
color	Set the icon color. If color is not set, the icon will default to text color.	`string`	—	`teal`, `navy`, `yellow`, `orange`, `pink`, `berry`, `wine`, `violet`

Install

npm install @bolt/elements-icon

Dependencies

@bolt/core-v3.x

svgson

Basic Icon

An Icon is an inline SVG element. <svg class="e-bolt-icon"> is acceptable at rendering an icon, though the Twig template is the recommended usage for Drupal.

Important Notes:

Icon element is a replacement for the Icon component.

When writing inline SVG manually using <svg> HTML element, be sure to minifiy the SVG, add the element class class="e-bolt-icon", and add the attribute aria-hidden="true".

Icon element can be used in tandem with Shape element to create a square or circle container around the icon. In such scenario, size and color should not be set on the Icon, they should be set on the Shape instead.

Demo

Light

Brand Icons

pega-announce

pega-book

pega-building-complex

pega-cart

pega-catalyst

pega-chat-question

pega-chat-typing

pega-chat

pega-compass

pega-connection-hierarchy

pega-cosmos

pega-database

pega-disability

pega-download-pdf

pega-handshake

pega-health-shield

pega-hub

pega-instructor

pega-map

pega-mention

pega-network

pega-patterns

pega-people

pega-phone-call

pega-pie-chart

pega-pin

pega-plane

pega-process-fabric

pega-send-submit

pega-setting

pega-shuffle

pega-subtitle

pega-tag

pega-thumbs-up

pega-timer

pega-wifi

Other Icons

add-circle

add-solid

add

agile

app-development

arrow-left

bar-chart-circle

bar-chart

bell-solid

bolt-logo-colored

briefcase

bullseye

calendar

certification

check-circle

check-solid

check

chevron-down

chevron-left

chevron-right

chevron-up

clock-circle

close-circle

close-solid

close

cloud

co-browse

collaboration

communications

copy-to-clipboard

credit-card

cube

customer-decision-hub

customer-onboarding

customer-service

data-integrations

documentation

dollar-circle

download

email

energy

entertainment

exclamation

external-link

eye-off

eye

face-happy

face-sad

facebook-solid

facebook

filter

financial

flag-solid

full-screen-off

full-screen-on

github

globe-circle

globe

government

grid

heart-solid

heart

hospitality

ideas

industries

info-circle

info-solid

insurance

integration

intelligent-virtual-assistant

interactive

java

knowledgebase

life-sciences

link

linkedin-solid

list

lock-solid

lock

manufacturing

map-pin-solid

map-pin

media

menu

meteor

minus-circle

minus-solid

minus

mobility

molecule

more

omni-channel

orbit

partners

pencil

picture

platform

podcast

presentation

print

product-delivery

refresh

reply

reporting

retail

ribbon

robo-auto

rocket

sales-automation

scalability

search

share

speed-dial

star-solid

support

system-admin

text-align-left

transportation

trash

triangle

truck

twitter-solid

twitter

unlock

upload

user-interface

user

video

warning

watch

workforce-intelligence

youtube-solid

Dark

Brand Icons

pega-announce

pega-book

pega-building-complex

pega-cart

pega-catalyst

pega-chat-question

pega-chat-typing

pega-chat

pega-compass

pega-connection-hierarchy

pega-cosmos

pega-database

pega-disability

pega-download-pdf

pega-handshake

pega-health-shield

pega-hub

pega-instructor

pega-map

pega-mention

pega-network

pega-patterns

pega-people

pega-phone-call

pega-pie-chart

pega-pin

pega-plane

pega-process-fabric

pega-send-submit

pega-setting

pega-shuffle

pega-subtitle

pega-tag

pega-thumbs-up

pega-timer

pega-wifi

Other Icons

add-circle

add-solid

add

agile

app-development

arrow-left

bar-chart-circle

bar-chart

bell-solid

bolt-logo-colored

briefcase

bullseye

calendar

certification

check-circle

check-solid

check

chevron-down

chevron-left

chevron-right

chevron-up

clock-circle

close-circle

close-solid

close

cloud

co-browse

collaboration

communications

copy-to-clipboard

credit-card

cube

customer-decision-hub

customer-onboarding

customer-service

data-integrations

documentation

dollar-circle

download

email

energy

entertainment

exclamation

external-link

eye-off

eye

face-happy

face-sad

facebook-solid

facebook

filter

financial

flag-solid

full-screen-off

full-screen-on

github

globe-circle

globe

government

grid

heart-solid

heart

hospitality

ideas

industries

info-circle

info-solid

insurance

integration

intelligent-virtual-assistant

interactive

java

knowledgebase

life-sciences

link

linkedin-solid

list

lock-solid

lock

manufacturing

map-pin-solid

map-pin

media

menu

meteor

minus-circle

minus-solid

minus

mobility

molecule

more

omni-channel

orbit

partners

pencil

picture

platform

podcast

presentation

print

product-delivery

refresh

reply

reporting

retail

ribbon

robo-auto

rocket

sales-automation

scalability

search

share

speed-dial

star-solid

support

system-admin

text-align-left

transportation

trash

triangle

truck

twitter-solid

twitter

unlock

upload

user-interface

user

video

warning

watch

workforce-intelligence

youtube-solid

Twig

{% include '@bolt-elements-icon/icon.twig' with {
  name: 'bell-solid',
} only %}

HTML

<svg class="e-bolt-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" aria-hidden="true">...</svg>

Icon Size

A Icon’s size can be modified per use case.

Important Notes:

Reference the schema for all options.

Again, Icon element can be used in tandem with Shape element to create a square or circle container around the icon. In such scenario, size and color should not be set on the Icon, they should be set on the Shape instead.

Demo

Twig

{% include '@bolt-elements-icon/icon.twig' with {
  size: 'xlarge',
  ...
} only %}

HTML

<svg class="e-bolt-icon e-bolt-icon--xlarge" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" aria-hidden="true">...</svg>

Icon Color

A Icon’s color can be modified per use case.

Important Notes:

Reference the schema for all options.

Additionally, a CSS custom property is available to change the icon color to any brand color. Define --e-bolt-icon-color inline style rule to set the desired color. Reference Color Tokens for all available brand colors.

Again, Icon element can be used in tandem with Shape element to create a square or circle container around the icon. In such scenario, size and color should not be set on the Icon, they should be set on the Shape instead.

Demo

Twig

{% include '@bolt-elements-icon/icon.twig' with {
  color: 'navy',
  ...
} only %}

HTML

<svg class="e-bolt-icon e-bolt-icon--navy" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" aria-hidden="true">...</svg>

Icon Use Case: Custom SVG

Custom SVG can be used instead to render an icon that is not available in the design system.

Important Notes:

When creating a custom SVG, start with a 32px by 32px artboard in the design tool (Adobe Illustrator, Sketch, etc.).

Make sure all layers have been converted to objects, meaning there is no stroke, only shapes with color fill.

Combine all objects if they visually connect (i.e. create one big shape).

Set the object’s fill color to #151619.

Set the widest side to 32px and center the icon within the artboard.

Save the SVG and then use imgoptim or another tool to minify it.

Lastly:

If you choose Twig usage: Add the relevant attributes {{ attributes.addClass(classes)|without('aria-hidden') }} aria-hidden="true" to the <svg> HTML element and save it as a Twig file. Then you can display the icon using include statement by passing the icon source path to the custom_icon_path prop.

If you choose HTML usage: Add class="e-bolt-icon" along with relevant modifier class for each prop, and the attribute aria-hidden="true" to the <svg> HTML element. Then you can display the icon using the modified <svg> markup.

Demo

Twig

{% include '@bolt-elements-icon/icon.twig' with {
  custom_icon_path: 'full/path/to/custom-icon-file.twig',
} only %}

HTML

<svg class="e-bolt-icon e-bolt-icon--xlarge e-bolt-icon--orange" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" aria-hidden="true"><path fill="#151619" d="m32 16c0 8.8-7.2 16-16 16s-16-7.2-16-16 7.2-16 16-16 16 7.2 16 16zm-3.1 0-1.7 1.4-4-3.8 1.1-5.4 2.2.2c-1.6-2.2-3.9-3.9-6.5-4.7l.9 2.1-4.9 2.7-4.8-2.7.8-2.1c-2.6.9-4.8 2.5-6.5 4.7l2.2-.2 1 5.4-4 3.8-1.6-1.4c0 2.8.9 5.4 2.5 7.6l.5-2.2 5.5.7 2.3 5-1.9 1.2c2.6.8 5.4.8 8 0l-1.9-1.1 2.3-5 5.5-.7.5 2.2c1.6-2.3 2.5-4.9 2.5-7.7zm-16 4.5-1.9-5.9 5-3.6 5 3.6-1.9 5.9z"/></svg>

Icon Javascript Use

Import icons individually: import { iconChevronDown } from '@bolt/elements-icon/src/icons/js/chevron-down';. Importing icons individually reduces the compiled JS file size.

The imported icon is a function that returns an <svg> element as a string. It automatically includes the e-bolt-icon class on the SVG. The function accepts a JSON object as an argument. It supports the same props as the Icon element, for example: chevronDown({ size: 'xsmall', class: 'u-bolt-margin-right-xsmall' }).

If you are using a web component, wrap the icon in unsafeHTML() as follows: ${unsafeHTML(iconChevronDown())}.

Important Notes:

A real-world example can currently be found in AccordionItemTrigger.js, shown in an altered demo below.

import { html, unsafeHTML } from '@bolt/element';
import { iconChevronDown } from '@bolt/elements-icon/src/icons/js/chevron-down';

return html`
  
    ${unsafeHTML(iconChevronDown())}
  
`;

Image

A responsive image embed.

Published

Last updated: 5.5.0

Change log

Github

NPM

Twig Usage

{% include '@bolt-elements-image/image.twig' with {
  fill: true,
  attributes: {
    alt: 'Image alt text',
    src: 'path/image.jpg',
    width: 500,
    height: 500,
  },
} only %}

Schema

Prop Name	Description	Type	Default Value	Option(s)
attributes	A Drupal-style attributes object with extra attributes to append to this element.	`object`	—	—
fill	Render the image 100% wide, filling up the full width of its parent container.	`boolean`	—	—
background	Render the image as a background image. This sets the image to be absolute positioned, only use this prop if the image is inside a non-static container.	`boolean`	—	—

Install

npm install @bolt/elements-image

Dependencies

@bolt/core-v3.x

Basic Image

An image element embeds a responsive graphic on the page.

Important Notes:

To make an image accessible to screen readers and other assistive technology, make sure to include text description via the alt attribute.

To indicate an image as decoration, leave the alt attribute blank, do not remove it. For example: alt="".

It is best practice to always define the width and height attributes, so the space that the image would take up is already calculated before the image finishes loading. This helps to reduce cumulative layout shifts.

If responsiveness is not needed, please use a plain <img> element instead.

Demo

Twig

{% include '@bolt-elements-image/image.twig' with {
  attributes: {
    alt: 'Alt text.',
    src: 'path/image.jpg',
    width: 400,
    height: 225,
  },
} only %}

HTML

<img alt="Alt text." src="path/image.jpg" width=400 height=225 class="e-bolt-image">

Responsive Resolutions

Use the srcset and sizes attributes to render various resolutions of the same image at specific breakpoints.

Important Notes:

The srcset attribute accepts one or more strings separated by commas, indicating possible image sources for the user agent to use. Each string is composed of a URL to an image and a width descriptor. For example, srcset="image/400x300.jpg 400w, image/800x600.jpg 800w, image/1600x1200.jpg 1600w".

The sizes attribute should contain a number value with the vw unit. The number should be determined by the largest size which the image could take up relative to screen size. For example, a large image taking up full width of a page should use something around 96vw to 100vw; a small image taking up 1 column of a 3-column layout should use 33vw.

For more advanced use cases, reference the MDN article on responsive images.

Demo

Twig

{% include '@bolt-elements-image/image.twig' with {
  attributes: {
    alt: 'Alt text.',
    src: 'path/image-800.jpg',
    srcset: 'path/image-400.jpg 400w, path/image-800.jpg 800w',
    sizes: '50vw',
    width: 800,
    height: 450,
  },
} only %}

HTML

<img alt="Alt text." src="path/image-800.jpg" srcset="path/image-400.jpg 400w, path/image-800.jpg 800w" sizes="50vw" width=800 height=450 class="e-bolt-image">

Fill Image

The fill prop will stretch the image to fill up 100% width of its parent container, ignoring the image’s true width and height.

Important Notes:

Even though they are ignored, it is best practice to always define the width and height attributes, so the space that the image would take up is already calculated before the image finishes loading. This helps to reduce cumulative layout shifts.

Demo

Twig

{% include '@bolt-elements-image/image.twig' with {
  fill: true,
  attributes: {
    alt: 'Alt text.',
    src: 'path/image-800.jpg',
    srcset: 'path/image-400.jpg 400w, path/image-800.jpg 800w',
    sizes: '96vw',
    width: 800,
    height: 450,
  },
} only %}

HTML

<img alt="Alt text." src="path/image-800.jpg" srcset="path/image-400.jpg 400w, path/image-800.jpg 800w" sizes="96vw" width=800 height=450 class="e-bolt-image e-bolt-image--fill">

Simple Background Image

The background prop will transform the image into a background image.

Important Notes:

The image must be placed into a container that is not positioned static (e.g. absolute, fixed, relative, or sticky).

It must be the first child of said container.

All foreground content of said container must be positioned relative.

Most background images are decorative, it is reasonable to leave the alt attribute blank for such case.

It is recommended to use the srcset and sizes attributes for better performance.

Demo

This is a non-static container

Twig

<div style="position:relative;">
  // This image will fill up the non-static parent container
  {% include '@bolt-elements-image/image.twig' with {
    background: true,
    attributes: {
      src: 'path/image-1600.jpg',
      srcset: 'path/image-400.jpg 400w, path/image-800.jpg 800w, path/image-1600.jpg 1600w',
      sizes: '100vw',
      width: 1600,
      height: 900,
    },
  } only %}

  <div style="position:relative;">
    // Content goes here after the image
  </div>
</div>

HTML

<div style="position:relative;">
  // This image will fill up the non-static parent container
  <img src="path/image-1600.jpg" srcset="path/image-400.jpg 400w, path/image-800.jpg 800w, path/image-1600.jpg 1600w" sizes="100vw" width=1600 height=900 class="e-bolt-image e-bolt-image--bg" alt="">

  <div style="position:relative;">
    // Content goes here after the image
  </div>
</div>

Use Case: Advanced Background Image

In addition to the background prop, there are 2 CSS custom properties available for use to further customize background image(s). They are commonly used when multiple decorative background images are required.

Important Notes:

--e-bolt-image-fit

Setting this to none will allow the background image to stay exactly at its specified width and height.

Setting this to contain will allow the background image to be contained within its parent container. No cropping will happen to the image.

By default, this is set to cover.

More advanced options are supported, reference the CSS property object-fit.

--e-bolt-image-position

This custom property accepts pair values: x-axis and y-axis position tokens (e.g. top left, top center, top right, bottom left, bottom center, bottom right, left center, right center, center center).

By default, this is set to center center.

More advanced options are supported, reference the CSS property object-position.

Demo

Setting fit to contain

Setting fit to none and position to exact directions

Twig

<div style="position:relative;">
  // This background image will not be cropped and it is positioned to center of the non-static parent container.
  {% include '@bolt-elements-image/image.twig' with {
    background: true,
    attributes: {
      src: 'path/image.jpg',
      width: 500,
      height: 500,
      style: '--e-bolt-image-fit: contain; --e-bolt-image-position: center center;',
    },
  } only %}

  // This background image will not stretch and it is positioned to top left of the non-static parent container.
  {% include '@bolt-elements-image/image.twig' with {
    background: true,
    attributes: {
      src: 'path/image.jpg',
      width: 150,
      height: 150,
      style: '--e-bolt-image-fit: none; --e-bolt-image-position: top left;',
    },
  } only %}
</div>

HTML

<div style="position:relative;">
  // This background image will not be cropped and it is positioned to center of the non-static parent container.
  <img src="path/image.jpg" width=500 height=500 style="--e-bolt-image-fit: contain; --e-bolt-image-position: center center;" class="e-bolt-image e-bolt-image--bg" alt="">

  // This background image will not stretch and it is positioned to top left of the non-static parent container.
  <img src="path/image.jpg" width=150 height=150 style="--e-bolt-image-fit: none; --e-bolt-image-position: top left;" class="e-bolt-image e-bolt-image--bg" alt="">
</div>

Use Case: Art Direction

The <picture> HTML element can help with art directing a particular graphical area of a page.

Important Notes:

When to use just the image element: loading different resolutions of the same image based on screen size.

When to use the <picture> HTML element: loading completely different images altogether based on screen size.

The srcset attribute should be used.

The x descriptor should be used after the image file URL. This helps with loading higher resolution images for monitors with higher DPI.

The media attribute should be used to indicate multiple breakpoints.

For more advanced use cases, reference the MDN article on responsive images.

Demo

Completely different images are loaded via the <picture> HTML element, resize this page to see the image on the left change.

Twig

<picture>
  // Set the image sources
  <source srcset="path/image-2x.jpg 2x, path/image.jpg" media="(min-width: 1000px)">
  <source srcset="path/image-b-1200.jpg 2x, path/image-b-600.jpg" media="(min-width: 600px)">
  <source srcset="path/image-a-600.jpg 2x, path/image-a-300.jpg" media="(min-width: 300px)">

  // Set the fallback image
  {% include '@bolt-elements-image/image.twig' with {
    attributes: {
      alt: 'Alt text.',
      src: 'path/image.jpg',
      srcset: 'path/image-2x.jpg 2x',
      width: 1000,
      height: 500,
    },
  } only %}
</picture>

HTML

<picture>
  // Set the image sources
  <source srcset="path/image-2x.jpg 2x, path/image.jpg" media="(min-width: 1000px)">
  <source srcset="path/image-b-1200.jpg 2x, path/image-b-600.jpg" media="(min-width: 600px)">
  <source srcset="path/image-a-600.jpg 2x, path/image-a-300.jpg" media="(min-width: 300px)">

  // Set the fallback image
  <img src="path/image.jpg" srcset="path/image-2x.jpg 2x" width=1000 height=500 class="e-bolt-image" alt="Alt text.">
</picture>

Printable

An media container that styles children HTML elements for print.

Published

Last updated: 5.5.0

Change log

Github

NPM

Install

npm install @bolt/elements-printable

Dependencies

@bolt/core-v3.x

Basic Printable

A Printable element can be used for any content you wish to be visible and styled in print mode.

Important Notes:

You must add the e-bolt-printable class to the <body> element. It will hide everything on the page in print mode.

Then add the the e-bolt-printable__article class to the article container. This class will make the article visible in print mode. Additionally, print specific styles are set for many plain HTML elements.

Demo

This is an example of an element to be printed

Only the heading and this paragraph will be shown in print mode. Click “Open in new tab” to view it outside of Pattern Lab, then in the browser menu click “Print”.

Twig

Not available in Twig. Please use plain HTML.

HTML

<body class="e-bolt-printable">
  <article class="e-bolt-printable__article">
    <h2>This is an example of an article to be printed</h2>
    <p>Only the heading and this paragraph will be shown in print mode.</p>
  </article>
</body>

Ratio

A ratio displays an image or video embed at a specific aspect ratio.

Published

Last updated: 5.5.0

Change log

Github

NPM

Twig Usage

{% set image %}
  {% include '@bolt-elements-image/image.twig' with {
    attributes: {
      alt: 'Alt text.',
      src: 'https://via.placeholder.com/400x300',
      width: 400,
      height: 300,
    },
  } only %}
{% endset %}
{% include '@bolt-elements-ratio/ratio.twig' with {
  content: image,
  ratio: 'wide',
} only %}

Schema

Prop Name	Description	Type	Default Value	Option(s)
attributes	A Drupal-style attributes object with extra attributes to append to this element.	`object`	—	—
content	A nested element with proportions defined through ratio property. It can be for example image or video.	`any`	—	—
ratio	An aspect ratio between the width and height. Expressed as width divided by height. You can choose from: standard(4/3), square(1/1), wide(16/9). Custom aspect ratio can be set via the CSS custom property `--e-bolt-aspect-ratio`.	`string`	`standard`	`standard`, `square`, `wide`

Install

npm install @bolt/elements-ratio

Dependencies

@bolt/core-v3.x

Basic Ratio

Aspect ratio is most commonly expressed as two integers and a division sign: width / height. To measure the aspect ratio of an image or video, divide the width by the height. For example, an image or video that is 400x300 pixels and one that is 260x195 pixels have the same ratio 4/3 (standard).

Important Notes:

Reference the schema for all options.

Use in tandem with an image: set a different aspect ratio than the image’s natural aspect ratio. This will crop the image.

Do not use the Ratio element if cropping is not needed.

When the image’s width is smaller than the parent container, the image will stretch to fill the available space.

Use in tandem with a video: the Ratio element preserves the needed space to load a video embed, preventing Cumulative Layout Shift.

Additionally, a CSS custom property is available to change the aspect ratio to anything. Define --e-bolt-aspect-ratio inline style rule to set the desired aspect ratio.

Demo

The ratio prop is set to standard. The aspect ratio is 4/3.

The ratio prop is set to square. The aspect ratio is 1/1.

The ratio prop is set to wide. The aspect ratio is 16/9.

The ratio prop is set with --e-bolt-aspect-ratio via inline CSS style. The aspect ratio is 7/3.

Twig

{% set image %}
  {% include '@bolt-elements-image/image.twig' with {
    attributes: {
      alt: 'Alt text.',
      src: 'https://via.placeholder.com/400x300',
      width: 200,
      height: 200,
    },
  } only %}
{% endset %}
{% include '@bolt-elements-ratio/ratio.twig' with {
  content: image,
  ratio: 'square',
} only %}

HTML

<div class="e-bolt-ratio e-bolt-ratio--square">
  <!-- image or video goes here -->
</div>

Ratio for Videos

The most common aspect ratio for videos is wide (16/9).

Important Notes:

A 16/9 ratio is typically seen as optimal because it is capable of the highest resolution. It is also easy to capture this aspect ratio on almost all devices.

Demo

Twig

{% set video %}
  <video-js
    data-account="1900410236"
    data-player="O3FkeBiaDz"
    data-embed="default"
    data-video-id="6236693947001"
    data-media-duration
    data-media-title
    controls
    class="c-base-video"></video-js>
{% endset %}
{% include '@bolt-elements-ratio/ratio.twig' with {
  content: video,
  ratio: 'wide',
} only %}

HTML

<div class="e-bolt-ratio e-bolt-ratio--wide">
  <video-js
    data-account="1900410236"
    data-player="O3FkeBiaDz"
    data-embed="default"
    data-video-id="6236693947001"
    data-media-duration
    data-media-title
    controls
    class="c-base-video"></video-js>
</div>

Use Case: Image Fit and Position within Ratio

The Image element comes with advanced position and fit options. They can work in tandem with the Ratio element.

Important Notes:

Reference the Image element for all options.

Demo

Twig

{% set image %}
  {% include '@bolt-elements-image/image.twig' with {
    attributes: {
      alt: 'Alt text.',
      src: 'https://via.placeholder.com/400x250',
      width: 400,
      height: 250,
      style: '--e-bolt-image-position: top right',
    },
  } only %}
{% endset %}
{% include '@bolt-elements-ratio/ratio.twig' with {
  content: image,
  ratio: 'square',
} only %}

HTML

<div class="e-bolt-ratio e-bolt-ratio--square">
  <img src="https://via.placeholder.com/400x250" width=400 height=250 class="e-bolt-image" alt="" style="--e-bolt-image-position: top right">
</div>

Shape

A 1:1 ratio container that displays decorative content.

Published

Last updated: 5.5.0

Change log

Github

NPM

Twig Usage

{% include '@bolt-elements-shape/shape.twig' with {
  content: 'MM',
} only %}

Schema

Prop Name	Description	Type	Default Value	Option(s)
content *	Content of the shape.	`any`	—	—
attributes	A Drupal-style attributes object with extra attributes to append to this element.	`object`	—	—
size	Changes the size of the interior element	`string`	`small`	`small`, `medium`, `large`, `xlarge`
border_radius	Customizes the outside radius of the shape. "none" will render as a square shape, "small" and "large" will render as a rounded corners square and "full" will render as a circle.	`string`	`full`	`none`, `small`, `large`, `full`

Install

npm install @bolt/elements-shape

Dependencies

@bolt/core-v3.x

Basic Shape

A Shape is a 1:1 ratio container that displays decorative content.

Important Notes:

Content can be letters, icons, or images.

When passing letters to the content, it can accept up to 2 letters.

Demo

Light

MM

Dark

MM

Twig

{% include '@bolt-elements-shape/shape.twig' with {
  content: 'MM',
} only %}

HTML

<span class="e-bolt-shape">
  <span class="e-bolt-shape__content">
    <!-- Letters, icon, or image go here -->
  </span>
</span>

Shape Border Radius

A Shape’s border radius can be modified to create various shapes.

Important Notes:

Reference the schema for all options.

Demo

MM

Twig

{% include "@bolt-elements-shape/shape.twig" with {
  border_radius: 'full',
  ...
} only %}

HTML

<span class="e-bolt-shape e-bolt-shape--border-radius-full">
  <span class="e-bolt-shape__content">
    <!-- Letters, icon, or image go here -->
  </span>
</span>

Shape Size

A Shape’s size can be modified per use case.

Important Notes:

Reference the schema for all options.

When passing letters to the content, text size scales with the shape size.

When passing an icon to the content, icon size is ignored. Icon size scales with the shape size.

When passing an image to the content, image size is ignored. Image size scales with the shape size.

Demo

MM

Twig

{% include '@bolt-elements-shape/shape.twig' with {
  size: 'large',
  ...
} only %}

HTML

<span class="e-bolt-shape e-bolt-shape--large">
  <span class="e-bolt-shape__content">
    <!-- Letters, icon, or image go here -->
  </span>
</span>

Shape Theming

A Shape can accept all existing themes.

Important Notes:

Pass a .t-bolt-* theme class to the parent element to color a shape.

Reference the Theming System for all available themes.

Demo

Light

.t-bolt-white
.t-bolt-black
.t-bolt-gray-xlight
.t-bolt-navy-dark
.t-bolt-navy
.t-bolt-navy-light
.t-bolt-teal
.t-bolt-yellow
.t-bolt-orange
.t-bolt-pink
.t-bolt-wine
.t-bolt-berry
.t-bolt-violet

Dark

.t-bolt-white
.t-bolt-black
.t-bolt-gray-xlight
.t-bolt-navy-dark
.t-bolt-navy
.t-bolt-navy-light
.t-bolt-teal
.t-bolt-yellow
.t-bolt-orange
.t-bolt-pink
.t-bolt-wine
.t-bolt-berry
.t-bolt-violet

Twig

{% include '@bolt-elements-shape/shape.twig' with {
  attributes: {
    class: 't-bolt-navy',
  }
  ...
} only %}

HTML

<span class="e-bolt-shape t-bolt-navy">
  <span class="t-bolt-shape__content">
    <!-- Letters, icon, or image go here -->
  </span>
</span>

Text Link

Underlined text that indicates interactivity.

Published

Last updated: 5.5.0

Change log

Github

NPM

Twig Usage

{% include '@bolt-elements-text-link/text-link.twig' with {
  content: 'This is a text link',
  attributes: {
    href: 'https://google.com'
  }
} only %}

Schema

Prop Name	Description	Type	Default Value	Option(s)
attributes	A Drupal-style attributes object with extra attributes to append to this component.	`object`	—	—
content *	Content of the text link.	`any`	—	—
icon_before	Append an icon before the text. Icon element is recommended. However, <img> elements are also acceptable.	`any`	—	—
icon_after	Append an icon after the text. Icon element is recommended. However, <img> elements are also acceptable.	`any`	—	—
reversed_underline	Set the underline style to appear on hover instead of being always visible.	`boolean`	`false`	—
expand_click_target	Expand the click target to cover up the entire area of its closest container that is not positioned static.	`boolean`	`false`	—

Install

npm install @bolt/elements-text-link

Dependencies

@bolt/core-v3.x

@bolt/elements-icon

Basic Text Link

A text link is generally an inline interactive element that is styled as underlined text. Its main purpose is to help the user navigate (sometimes perform a function). Both <a class="e-bolt-text-link"> and <a> are acceptable at rendering a text link, though the Twig template is the recommended usage for Drupal.

Important Notes:

There are advanced features with the text link element, class="e-bolt-text-link" is required to get those features. Reference respective doc page for each feature.

Only text should be passed to the content prop. <span>, <em>, and <strong> tags are allowed.

Text Link element is a replacement for the Link component.

Demo

Light

Click me to go to google.com

Dark

Click me to go to google.com

Twig

{% include '@bolt-elements-text-link/text-link.twig' with {
  content: 'Click me to go to google.com',
  attributes: {
    href: 'https://google.com',
    target: '_blank',
    rel: 'noopener'
  }
} only %}

HTML

<a href="https://google.com" target="_blank" rel="noopener" class="e-bolt-text-link">Click me to go to google.com</a>

Text Link as a <button> Element

When appropriate, a <button> element can use the text link style. For example, the text link performs a function such as opening a modal or popover.

Important Notes:

If a text link serves no navigational purpose, the proper type attribute must be set: button, submit, or reset.

Demo

Twig

{% include '@bolt-elements-text-link/text-link.twig' with {
  content: 'This looks like a text link but semantically is a reset button',
  attributes: {
    type: 'reset',
  }
} only %}

HTML

<button type="reset" class="e-bolt-text-link">This looks like a text link but semantically is a reset button</button>

HTML Attributes for Text Link

Depending on if the <a> element or the <button> element is being used, the proper HTML attributes should be passed.

Important Notes:

<a> requires the href attribute.

<button> requires the type attribute.

Demo

This text link has the "href", "target", "rel" and "id" attributes

Twig

{% include '@bolt-elements-text-link/text-link.twig' with {
  content: 'This text link has the "href", "target", "rel" and "id" attributes',
  attributes: {
    href: 'https://google.com',
    target: '_blank',
    rel: 'noopener',
    id: 'js-bolt-some-unique-id'
  }
} only %}

HTML

<a href="https://google.com" target="_blank" rel="noopener" id="js-bolt-some-unique-id" class="e-bolt-text-link">This text link has the "href", "target", "rel" and "id" attributes</a>

Text Link with Icon

Icons can be used in tandem with a text link. An icon can be placed before and/or after the text. The icon component is recommended for appending icons. However, an <img> element is also acceptable.

Important Notes:

Icons are set inline with text so icon size will grow or shrink with text size. The size and background props for the icon component are not well supported in this scenario.

When writing in plain HTML, all white space must be eliminated to have the text underline and icon display correctly. The markup must be written all in one line and spaces between HTML elements must be removed.

When writing in plain HTML, <span class="e-bolt-text-link__icon-before"> and <span class="e-bolt-text-link__icon-after"> are required to wrap around the icon markup. The wrapper ensures that the icon will always wrap with the final word of the text. It will never wrap to the next line on its own.

Demo

This is a text link with icons before and after

This is a text link with an icon before

This is a text link with an icon after

Twig

{% set icon_custom %}
  <img src="/images/placeholders/500x500.jpg">
{% endset %}
{% set icon_chevron_down %}
  {% include '@bolt-elements-icon/icon.twig' with {
    name: 'chevron-down',
  } only %}
{% endset %}

{% include '@bolt-elements-text-link/text-link.twig' with {
  content: 'This is a text link with icons before and after',
  icon_before: icon_custom,
  icon_after: icon_chevron_down,
  attributes: {
    href: 'https://google.com',
  }
} only %}

HTML

<a href="https://google.com" class="e-bolt-text-link"><span class="e-bolt-text-link__icon-before"><!-- Icon or image markup --></span>This is a text link with icons before and after<span class="e-bolt-text-link__icon-after"><!-- Icon or image markup --></span></a>

Reversed Underline Text Link

Text link has a style variant called reversed underline. This is commonly used in headlines with icons because an icon may already indicate interactivity, reducing the need for the underline. The underline will appear on hover instead of being visible always.

Important Notes:

It is recommended to use this style variant while having either an icon before or after.

Demo

This is a reversed underline headline text link

This is a reversed underline body text link

Twig

{% include '@bolt-elements-text-link/text-link.twig' with {
  content: 'This is a reversed underline text link',
  icon_after: icon_chevron_right,
  reversed_underline: true,
  attributes: {
    href: 'https://google.com',
  }
} only %}

HTML

<a href="https://google.com" class="e-bolt-text-link e-bolt-text-link--reversed-underline">This is a reversed underline text link</a>

Expand Click Target

The text link will increase its click target to cover a particular block of content.

Important Notes:

When creating a block text link (such as trying to make an entire card clickable while retaining the headline as the link) with the expand_click_target prop, the text link must be placed into a container that is not positioned static (e.g. absolute, fixed, relative, or sticky), and the text must explain clearly the block of content that it’s trying to cover.

Only 1 block text link should be used within a particular block of content.

Demo

This is a block text link, its click target will cover the entire area of its closest container that is not positioned static

Hover over this box, the whole thing is clickable.

Twig

// Wrap this text link with a container that is not positioned static.
{% include '@bolt-elements-text-link/text-link.twig' with {
  content: 'This is a block text link, its click target will cover the entire area of its closest container that is not positioned static.',
  expand_click_target: true,
  attributes: {
    href: 'https://google.com',
  }
} only %}

HTML

// Wrap this text link with a container that is not positioned static.
<a href="https://google.com" class="e-bolt-text-link e-bolt-text-link--expand-click-target">This is a block text link, its click target will cover the entire area of its closest container that is not positioned static.</a>

Type

Pega branded typography.

Published

Last updated: 5.5.0

Change log

Github

NPM

Twig Usage

{% include '@bolt-elements-type/type.twig' with {
  content: 'This is a type element.'
} only %}

Schema

Prop Name	Description	Type	Default Value	Option(s)
attributes	A Drupal-style attributes object with extra attributes to append to this element.	`object`	—	—
content	Content of the type element.	`any`	—	—
tag	Set the semantic tag for the type element. Use `span` for inline text; use `p`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, or `div` for block text. There is no restrictions with this prop, developers must understand semantic HTML to apply the appropriate tag based on the use case.	`string`	`p`	—
size	Control the font-size. If size is not defined or set to auto, font-size inherits from parent container.	`string`	`auto`	`auto`, `xxsmall`, `xsmall`, `small`, `medium`, `large`, `xlarge`, `xxlarge`, `xxxlarge`
hierarchy	Control the hierarch of text. Each option comes with specific typographic styles.	`string`	`body`	`body`, `headline`, `subheadline`, `eyebrow`
icon_before	Append an icon before the text. Icon element is recommended. However, <img> elements are also acceptable.	`any`	—	—
icon_after	Append an icon after the text. Icon element is recommended. However, <img> elements are also acceptable.	`any`	—	—

Install

npm install @bolt/elements-type

Dependencies

@bolt/core-v3.x

Basic Type

The type element displays text in Pega branded typographic styles.

Important Notes:

For regular body text, the type element is the same as a <p> HTML element. Only when additional branded typographic styles are needed, the type element should be used.

There are many HTML elements to style inline text within a type element such as <em>, <strong>, <a>, <small>, <code>, and <kbd> to name a few.

Demo

This is a type element. Use common inline HTML elements to emphasize, bold, link, and more.

Twig

{% include '@bolt-elements-type/type.twig' with {
  content: 'This is a type element. Use common inline HTML elements to <em>emphasize</em>, <strong>bold</strong>, <a href="#!">link</a>, and more.'
} only %}
<p>If no props are set, the above is exactly the same as a <p> HTML element.</p>

HTML

<p class="e-bolt-type">This is a type element. Use common inline HTML elements to <em>emphasize</em>, <strong>bold</strong>, <a href="#!">link</a>, and more.</p>
<p>If no props are set, the above is exactly the same as a <p> HTML element.</p>

Type Tag

Tag defines the semantic tag of the type element.

Important Notes:

When semantics is independent of visual styles, the flexibility allows content authors to create all kinds of text layout. The tag prop only controls semantics, no visual styles are being defined.

Use <span> for inline text. Inline text can be nested inside another type element.

Use <p>, <h1>, <h2>, <h3>, <h4>, <h5>, <h6>, or <div> for block text.

General HTML rules apply here, do not nest block text inside inline text or another block text unless it is a generic <div>.

Demo

This type element is a level 4 heading. No styles are defined so this looks like plain text.

Twig

{% include '@bolt-elements-type/type.twig' with {
  content: 'This type element is a level 4 heading. No styles are defined so this looks like plain text.'
  tag: 'h4',
} only %}

HTML

<h4 class="e-bolt-type">This type element is a level 4 heading. No styles are defined so this looks like plain text.</h4>

Type Size

Size defines the font-size of the type element.

Important Notes:

If size is not defined or set to auto, font-size inherits from parent container.

Each size is paired with a specific line-height to improve legibility.

Demo

This is size auto.

This is size xxsmall.

This is size xsmall.

This is size small.

This is size medium.

This is size large.

This is size xlarge.

This is size xxlarge.

This is size xxxlarge.

Twig

{% include '@bolt-elements-type/type.twig' with {
  content: 'This is size xxxlarge.'
  size: 'xxxlarge',
} only %}

HTML

<p class="e-bolt-type e-bolt-type--xxxlarge">This is size xxxlarge.</p>

Type Hierarchy

Hierarchy defines specific recipes of typographic styles that create visual hierarchy amongst type elements.

Important Notes:

As mentioned before, tag controls semantics while hierarchy controls visual styles.

Using bold text is not the same as using headline hierarchy. Headline, subheadline, and eyebrow have specific typographic styles—color, spacing, and font—that differentiate them from basic text.

Using <strong> in tandem with subheadline hierarchy will create the same styles as headline hierarchy. This flexibility allows content authors to create mixed-weight headlines.

Eyebrow has one size only, because its main purpose is to be short complimentary info above the headline. Due to eyebrow text set to uppercase by design, it is recommended to set aria-label with the proper case to improve accessibility.

When setting size and hierarchy for a particular pair of headline and subheadline (or body text), make sure to set the headline at least one size larger than subheadline to create the visual hierarchy.

Demo

Teaser Text Group

Eyebrow

Headline (size xxxlarge and h1)

Subheadline (size xlarge and h2)

Body text (basic type element).

Mixed-weight Headlines

This entire sentence is a subheadline but part of it is bold

Headlines

This is size auto headline

This is size xxsmall headline

This is size xsmall headline

This is size small headline

This is size medium headline

This is size large headline

This is size xlarge headline

This is size xxlarge headline

This is size xxxlarge headline

Subheadlines

This is size auto subheadline

This is size xxsmall subheadline

This is size xsmall subheadline

This is size small subheadline

This is size medium subheadline

This is size large subheadline

This is size xlarge subheadline

This is size xxlarge subheadline

This is size xxxlarge subheadline

Eyebrow

This is an eyebrow

Body

This is size auto body text

This is size xxsmall body text

This is size xsmall body text

This is size small body text

This is size medium body text

This is size large body text

This is size xlarge body text

This is size xxlarge body text

This is size xxxlarge body text

Twig

{# Teaser Text Group #}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Eyebrow',
  hierarchy: 'eyebrow',
  attributes: {
    'aria-label': 'Eyebrow',
  },
} only %}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Headline (size xxxlarge and h1)',
  hierarchy: 'headline',
  tag: 'h1',
  size: 'xxxlarge',
} only %}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Subheadline (size xlarge and h2)',
  hierarchy: 'subheadline',
  tag: 'h2',
  size: 'xlarge',
} only %}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Paragraph (basic type element).',
} only %}

{# Mixed-weight Headlines #}
{% include '@bolt-elements-type/type.twig' with {
  content: 'This entire sentence is a subheadline <strong>but part of it is bold</strong>',
  hierarchy: 'subheadline',
  tag: 'h1',
  size: 'xxxlarge',
} only %}

HTML

<!-- Teaser Text Group -->
<p class="e-bolt-type e-bolt-type--eyebrow" aria-label="Eyebrow">
  Eyebrow
</p>
<h1 class="e-bolt-type e-bolt-type--headline e-bolt-type--xxxlarge">
  Headline (size xxxlarge and h1)
</h1>
<h2 class="e-bolt-type e-bolt-type--subheadline e-bolt-type--xlarge">
  Subheadline (size xlarge and h2)
</h2>
<p class="e-bolt-type">
  Paragraph (basic type element).
</p>

<!-- Mixed-weight Headlines -->
<h1 class="e-bolt-type e-bolt-type--subheadline e-bolt-type--xxxlarge">
  This entire sentence is a subheadline <strong>but part of it is bold</strong>
</h1>

Type with Icon

Icon can be appended before and/or after a paragraph of text. The Icon element is recommended for appending icons. However, an <img> element is also acceptable.

Important Notes:

Icon added via icon_before or icon_after are rendered to flow with text, so its size will grow or shrink with text size. The size prop for the Icon element is not supported in this scenario.

Instead of adding icons before and after the entire paragraph of text, it can also be done to inline text. To create inline text within a paragraph, set tag to span.

When writing plain HTML, all white space must be eliminated to have the text and icon align correctly. The markup must be written all in one line and spaces between HTML elements must be removed.

When writing plain HTML, <span class="e-bolt-type__icon-before"> and <span class="e-bolt-type__icon-after"> are required to wrap around the icon markup. The wrapper ensures that the icon will always wrap with the final word of the text. It will never wrap to the next line on its own.

Demo

Block Text

Eyebrow with an icon before

Headline with an icon after

Subheadline with an icon before and after

Inline Text

This is a paragraph of text. In the middle of it, it has inline text with icons. This inline text is a type element with its tag set to span.

Twig

{% set icon_pega_thumbs_up %}
  {% include '@bolt-elements-icon/icon.twig' with {
    name: 'pega-thumbs-up',
    size: 'large',
  } only %}
{% endset %}
{% set icon_pega_timer %}
  {% include '@bolt-elements-icon/icon.twig' with {
    name: 'pega-timer',
  } only %}
{% endset %}
{% set icon_arrow_left %}
  {% include '@bolt-elements-icon/icon.twig' with {
    name: 'arrow-left',
  } only %}
{% endset %}

{# Block Text #}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Eyebrow with an icon before',
  icon_before: icon_arrow_left,
  hierarchy: 'eyebrow',
} only %}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Headline with an icon after',
  icon_after: icon_pega_thumbs_up,
  hierarchy: 'headline',
  tag: 'h1',
  size: 'xxxlarge',
} only %}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Subheadline with an icon before and after',
  icon_before: icon_pega_timer,
  icon_after: icon_pega_thumbs_up,
  hierarchy: 'subheadline',
  tag: 'h2',
  size: 'xlarge',
} only %}

{# Inline Text #}
{% set inline_text %}
  {% include '@bolt-elements-type/type.twig' with {
    content: 'inline text with icons',
    icon_before: icon_pega_timer,
    icon_after: icon_pega_thumbs_up,
    tag: 'span',
  } only %}
{% endset %}
{% include '@bolt-elements-type/type.twig' with {
  content: 'This is a paragraph of text. In the middle of it, it has ' ~ inline_text|spaceless ~ '. This inline text is a type element with its tag set to <code>span</code>.',
} only %}

HTML

<!-- Block Text -->
<h1 class="e-bolt-type e-bolt-type--headline e-bolt-type--xxxlarge"><span class="e-bolt-type__icon-before"><!-- Icon or image markup --></span>Subheadline with an icon before and after<span class="e-bolt-type__icon-after"><!-- Icon or image markup --></span></h1>

<!-- Inline Text -->
<p class="e-bolt-type">This is a paragraph of text. In the middle of it, it has <span class="e-bolt-type"><span class="e-bolt-type__icon-before"><!-- Icon or image markup --></span>inline text with icons<span class="e-bolt-type__icon-after"><!-- Icon or image markup --></span></span>. This inline text is a type element with its tag set to <code>span</code>.</p>

Headline Links

Link styles for headline, subheadline, and eyebrow.

Important Notes:

Turn headline, subheadline, and eyebrow into links by passing proper HTML attributes via link_attributes. Same as Text Link element, depending on if the <a> or the <button> HTML element is being used, the proper HTML attributes should be passed.

Headline, subheadline, and eyebrow links created this way will utilize the reversed underline style from the Text Link element, icon is recommended to be used as a visual cue while underline is not visible. The twig template has reversed underline on by default, however, when writing plain HTML, this style needs to be written out manually using appropriate Text Link modifier classes.

link_attributes will turn the entire paragraph of text into a link, so it is not recommended for body text links. Instead, use the Text Link element or <a> HTML element for inline links within a paragraph of text.

Demo

Block Link

Eyebrow link

Headline link

Subheadline link

Inline Link

This is a paragraph of text. In the middle of it, it has an inline link. This inline link can be a Text Link element or an HTML anchor element.

Twig

{% set icon_chevron_right %}
  {% include '@bolt-elements-icon/icon.twig' with {
    name: 'chevron-right',
  } only %}
{% endset %}

{# Block Link #}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Eyebrow link',
  hierarchy: 'eyebrow',
  icon_after: icon_chevron_right,
  link_attributes: {
    href: '#!',
  },
} only %}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Headline link',
  hierarchy: 'headline',
  tag: 'h1',
  size: 'xxxlarge',
  icon_after: icon_chevron_right,
  link_attributes: {
    href: '#!',
  },
} only %}
{% include '@bolt-elements-type/type.twig' with {
  content: 'Subheadline link',
  hierarchy: 'subheadline',
  tag: 'h2',
  size: 'xlarge',
  icon_after: icon_chevron_right,
  link_attributes: {
    href: '#!',
  },
} only %}

{# Inline Link #}
{% include '@bolt-elements-type/type.twig' with {
  content: 'This is a paragraph of text. In the middle of it, it has <a href="#!">an inline link</a>. This inline link can be a Text Link element or an HTML anchor element.',
} only %}

HTML

<!-- Block Link -->
<h1 class="e-bolt-type e-bolt-type--size-xxxlarge e-bolt-type--headline"><a href="#!" class="e-bolt-text-link e-bolt-text-link--reversed-underline">Headline link<span class="e-bolt-text-link__icon-after"><!-- Icon or image markup --></span></a></h1>

<!-- Inline Link -->
<p class="e-bolt-type">This is a paragraph of text. In the middle of it, it has <a href="#!">an inline link</a>. This inline link can be a Text Link element or an HTML anchor element.</p>

Use Case: Numbered Headlines

Combine the List component, Shape element, and Type element to create numbered headlines.

Important Notes:

Use the List component to create an inline list with tag set to div, spacing set to small, and nowrap set to true.

Pass the Shape element with a bold number as the first list item.

Pass the Type element as the second list item.

Adjust the Shape and Type element’s size to create the desired design.

Demo

1

Numbered headline xxxlarge

1

Numbered headline xxlarge

Twig

{% set number %}
  {% include '@bolt-elements-shape/shape.twig' with {
    content: '<strong>1</strong>',
    size: 'small',
    attributes: {
      class: 't-bolt-teal',
    },
  } only %}
{% endset %}
{% set headline %}
  {% include '@bolt-elements-type/type.twig' with {
    content: 'Numbered headline xxlarge',
    hierarchy: 'headline',
    tag: 'h4',
    size: 'xxlarge',
  } only %}
{% endset %}
{% include '@bolt-components-list/list.twig' with {
  display: 'inline',
  nowrap: true,
  spacing: 'small',
  items: [
    number,
    headline,
  ],
} only %}

HTML

<bolt-list display="inline" tag="div" spacing="small" nowrap>
  <bolt-list-item>
    <span class="e-bolt-shape"><span class="e-bolt-shape__content"><strong>1</strong></span></span>
  </bolt-list-item>
  <bolt-list-item>
    <h1 class="e-bolt-type e-bolt-type--headline e-bolt-type--xxxlarge">Numbered headline</h1>
  </bolt-list-item>
</bolt-list>

article docs Show Code Hide Code

Article

An editorial container that styles children HTML elements.

article Show Code Hide Code

H1 heading text

H2 heading text

H3 heading text

H4 heading text

H5 heading text

H6 heading text

button docs Show Code Hide Code

Button

A graphical element that indicates interactivity.

button Show Code Hide Code

button link Show Code Hide Code

button attributes Show Code Hide Code

button with icon Show Code Hide Code

button with icon only Show Code Hide Code

button hierarchy Show Code Hide Code

button size Show Code Hide Code

button border radius Show Code Hide Code

button display Show Code Hide Code

button upload Show Code Hide Code

icon docs Show Code Hide Code

Icon

Inline SVG icon system.

icon Show Code Hide Code

icon size Show Code Hide Code

icon color Show Code Hide Code

icon use case custom svg Show Code Hide Code

icon javascript usage Show Code Hide Code

image docs Show Code Hide Code

Image

A responsive image embed.

image Show Code Hide Code

image srcset and sizes Show Code Hide Code

image fill Show Code Hide Code

image background Show Code Hide Code

image use case background fit and position Show Code Hide Code

image use case art direction Show Code Hide Code

printable docs Show Code Hide Code

Printable

An media container that styles children HTML elements for print.

printable Show Code Hide Code

This is an example of an element to be printed

ratio docs Show Code Hide Code

Ratio

A ratio displays an image or video embed at a specific aspect ratio.

ratio Show Code Hide Code

ratio video Show Code Hide Code

ratio use case fit and position Show Code Hide Code

shape docs Show Code Hide Code

Shape

A 1:1 ratio container that displays decorative content.

shape Show Code Hide Code

shape border radius Show Code Hide Code

shape size Show Code Hide Code

shape theming Show Code Hide Code

text link docs Show Code Hide Code

Text Link

Underlined text that indicates interactivity.

text link Show Code Hide Code

text link button Show Code Hide Code

text link attributes Show Code Hide Code

text link with icon Show Code Hide Code

text link reversed underline Show Code Hide Code

text link expand click target Show Code Hide Code

type docs Show Code Hide Code

Type

Pega branded typography.

type Show Code Hide Code

type tag Show Code Hide Code

This type element is a level 4 heading. No styles are defined so this looks like plain text.

type size Show Code Hide Code

type hierarchy Show Code Hide Code

Headline (size xxxlarge and h1)

Subheadline (size xlarge and h2)

This entire sentence is a subheadline but part of it is bold

type with icon Show Code Hide Code

Headline with an icon after

article docs

article

button docs

button

button link

button attributes

button with icon

button with icon only

button hierarchy

button size

button border radius

button display

button upload

icon docs

icon

icon size

icon color

icon use case custom svg

icon javascript usage

image docs

image

image srcset and sizes

image fill

image background

image use case background fit and position

image use case art direction

printable docs

printable

ratio docs

ratio

ratio video

ratio use case fit and position

shape docs

shape

shape border radius

shape size

shape theming

text link docs

text link

text link button

text link attributes

text link with icon

text link reversed underline

text link expand click target

type docs

type

type tag

type size

type hierarchy

type with icon

type headline links

type use case numbered headlines