Article

An editorial container that styles children HTML elements.

Published

Last updated: 4.0.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 <bolt-code-snippet> 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

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: 4.0.0

Change log

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 component is recommended. However, <img> elements are also acceptable.	`any`	—	—
icon_after	Append an icon after the button content. Icon component 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/components-icon

@bolt/core-v3.x

@bolt/lazy-queue

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://pega.com', } } only %}

HTML

<a href="https://pega.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", 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://pega.com', target: '_blank', id: 'js-bolt-some-unique-id' } } only %}

HTML

<a href="https://pega.com" target="_blank" id="js-bolt-some-unique-id" class="e-bolt-button">This button has the "href", "target", 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-components-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"><img src="/images/placeholders/500x500.jpg"></span>This is a button with icons before and after<span class="e-bolt-button__icon-after"><bolt-icon name="chevron-down"></bolt-icon></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-components-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"><bolt-icon name="download"></bolt-icon></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

Printable

An media container that styles children HTML elements for print.

Published

Last updated: 4.0.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.

To see an example of this in action, please go to this Academy Topic Details Page (click “Open in new tab” to view it outside of Pattern Lab) and start the print process.

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>

Text Link

Underlined text that indicates interactivity.

Published

Last updated: 4.0.0

Change log

NPM

Twig Usage

  {% include '@bolt-elements-text-link/text-link.twig' with {
  content: 'This is a text link',
  attributes: {
    href: 'https://pega.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 component is recommended. However, <img> elements are also acceptable.	`any`	—	—
icon_after	Append an icon after the text. Icon component 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/components-icon

@bolt/core-v3.x

@bolt/lazy-queue

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 pega.com

Dark

Click me to go to pega.com

Twig

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

HTML

<a href="https://pega.com" target="_blank" class="e-bolt-text-link">Click me to go to pega.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", and "id" attributes

Twig

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

HTML

<a href="https://pega.com" target="_blank" id="js-bolt-some-unique-id" class="e-bolt-text-link">This text link has the "href", "target", 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-components-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://pega.com', } } only %}

HTML

<a href="https://pega.com" class="e-bolt-text-link"><span class="e-bolt-text-link__icon-before"><img src="/images/placeholders/500x500.jpg"></span>This is a text link with icons before and after<span class="e-bolt-text-link__icon-after"><bolt-icon name="chevron-down"></bolt-icon></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://pega.com', } } only %}

HTML

<a href="https://pega.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://pega.com', } } only %}

HTML

// Wrap this text link with a container that is not positioned static. <a href="https://pega.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>

article

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

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

printable

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

text link

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

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

printable docs

printable

text link docs

text link

text link button

text link attributes

text link with icon

text link reversed underline

text link expand click target