2.5.1

Code Snippet

Code Snippet Component in Bolt

Published

History

View changes

Install

yarn add @bolt/components-code-snippet

Source code

Dependencies

Overview

Code snippet shows text in a style that is best fit for a monospace font. Part of the Bolt “Components” CSS framework that powers the Bolt Design System.

Install via NPM

npm install @bolt/components-code-snippet

Usage

  {% include "@bolt-components-code-snippet/code-snippet.twig" with {
  display: "block",
  lang: "html",
  content: "Some code snippet"
} 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)
display	Defines if the code text is inline or block.	`string`	`block`	`block` or `inline`
lang	Language of the code text.	`string`	`html`	`css`, `html`, `js`, `scss`, `twig`
syntax	Toggle between a light and dark syntax highlighting, or turn it off. Separate from Bolt theming.	`string`	`light`	`light`, `dark`, `none`