block list docs

2.24.0

Block List

Block-list Component in Bolt

Published

History
View changes
Install
yarn add @bolt/components-block-list
Source code
View on Github
Dependencies
@bolt/core-v3.x @bolt/lazy-queue

Overview

Block list for stacked full-width content. Part of the Bolt “Components” CSS framework that powers the Bolt Design System.

Install via NPM
npm install @bolt/components-block-list
Overview Usage Schema Edit this page Testing Steps

Usage

{% include "@bolt-components-block-list/block-list.twig" with { items: [ include("@bolt-components-link/link.twig", { text: "Link 1", url: "#!", icon: { name: "chevron-right", position: "before" } }), include("@bolt-components-link/link.twig", { text: "Link 2", url: "#!", icon: { name: "chevron-right", position: "before" } }), include("@bolt-components-link/link.twig", { text: "Link 3", url: "#!", icon: { name: "chevron-right", position: "before" } }), "Simple text example" ] } 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 —
  • —
items

All of the items in the block list - can have simple text oritems

 array —
  • [items]:
    • Type: string, object, array

      Renderable content (i.e. a string, render array, or included pattern) for a single list item

block list

  • Link 1
  • Link 2
  • Link 3
  • Simple text example

block list theme variation

Theme: xlight

  • Link 1
  • Link 2
  • Link 3
  • Simple text example

Theme: light

  • Link 1
  • Link 2
  • Link 3
  • Simple text example

Theme: medium

  • Link 1
  • Link 2
  • Link 3
  • Simple text example

Theme: dark

  • Link 1
  • Link 2
  • Link 3
  • Simple text example

Theme: xdark

  • Link 1
  • Link 2
  • Link 3
  • Simple text example

Debug Panel