code snippet docs

2.15.2

Code Snippet

Code Snippet Component in Bolt

Published

History
View changes
Install
yarn add @bolt/components-code-snippet
Source code
View on Github
Dependencies
@bolt/core-v3.x prismjs

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
Overview Usage Schema Edit this page Testing Steps

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

code snippet

Code snippet can be a block of code, and display is set to block by default.

display: block; margin: 0 0 1.65rem 0;

Well, code snippet can also be inline like this display:inline; when you set display to be inline instead.

code snippet display variation

block:

<header> <h1>Headline</h1> </header>

inline:

<header><h1>Headline</h1></header>

code snippet language variation

css:

.my-css { display: block; }

scss:

.my-scss { @include my-mixin; }

html:

<header> <h1>Headline</h1> </header>

javascript:

import { polyfillLoader } from '@bolt/core-v3.x/polyfills';

twig:

{% include "@bolt-components-code-snippet/code-snippet.twig" with { display: "block", lang: "html", content: "Some code snippet" } only %}

code snippet syntax variation

light:

<header> <h1>Headline</h1> </header>

dark:

<header> <h1>Headline</h1> </header>

none:

<header> <h1>Headline</h1> </header>
Debug Panel