action blocks docs

2.17.0

Action blocks

Action Blocks Component in Bolt

Published

History
View changes
Install
yarn add @bolt/components-action-blocks
Source code
View on Github
Dependencies

Overview

Stylistic block layout for displaying actionable icon and text. Part of the Bolt “Components” CSS framework that powers the Bolt Design System.

Install via NPM
npm install @bolt/components-action-blocks

Description

Action blocks work as a group to provide the user an easy to browse list of options of relativeto take action to discover more information. They commonly exist as links to more detailed content.

Best Practices

  • Can use xlight, light, dark, and xdark themes.
  • Can have an image, icon, and/or text
  • Should link to content
  • Should be limited to 7 (soft limit) unless we're representing a large list of content that is meant to be scanned
  • Can wrap to many rows
  • Top aligned by default
  • Can be vertically centered
  • Are set with a border by default
  • Can be borderless

Usage

  {% include "@bolt-components-action-blocks/action-blocks.twig" with {
  contentItems: [
    {
      text: "Item 1",
      url: "#!",
      icon: {
        name: "icon-name",
        size: "large",
        background: "circle"
      }
    },
    {
      text: "Item 2",
      url: "#!",
      icon: {
        name: "icon-name",
        size: "large",
        background: "circle"
      }
    },
    {
      text: "Item 3",
      url: "#!",
      icon: {
        name: "icon-name",
        size: "large",
        background: "circle"
      }
    }
  ]
} only %}

Schema

Note: when assigning component props as HTML attributes on a web component, make sure to use kebab-case.

Prop Name Description Type Default Value Option(s)
Attributes

A Drupal-style attributes object with extra attributes to append to this component.

 object —
  • —
Max_items_per_row

The max amount of items (action blocks) to be displayed in one row.

 number 6
  • 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
Valign

Vertical alignment of the content inside each action block.

 string start
  • start, center, end
Borderless

Removes the border in between each action block.

 boolean false
  • true or false
ContentItems

Content items to populate the action blocks.

 array —
  • [items]:
    • Type: object
    • Properties:
      • text
        • Type: string
      • url
        • Type: string
      • icon
        • Type: object
        • Properties:
          • name
            • —
          • size
            • —
          • background
            • —
MaxItemsPerRow

Use max_items_per_row prop instead.

 —
  • —
Align

Use valign prop instead.

 —
  • —
Border

Use borderless prop instead.

 —
  • —

action blocks

action blocks valign variations

Vertical alignment: start

Vertical alignment: center

Vertical alignment: end

action blocks borderless variations

Borderless: true

Borderless: false

action blocks theme variations

Action Blocks inside a xlight themed container

Action Blocks inside a light themed container

Action Blocks inside a dark themed container

Action Blocks inside a xdark themed container

action blocks max items per row

Max items per row: 2

Max items per row: 3

Max items per row: 4

Max items per row: 5

Max items per row: 6

Max items per row: 7

Max items per row: 8

Max items per row: 9

Max items per row: 10

Max items per row: 11

Max items per row: 12

Debug Panel