Skip to Content
kindui

Code Block

Show code with its language, a wrap toggle and a copy button.

Use a code block for a file, a command or a snippet the agent wrote. Markdown renders fenced code in one, and you can use it on its own. Name it with aria-label, like the file name.

ts
async function retry<T>(run: () => Promise<T>, tries = 4): Promise<T> {  for (let attempt = 0; ; attempt++) {    try {      return await run();    } catch (error) {      if (attempt + 1 >= tries) throw error;      await sleep(2 ** attempt * 250);    }  }}
Press the wrap button to wrap long lines, or the copy button to copy the code. Tab reaches both, and Enter or Space presses them.

Installation

npx shadcn@latest add @kind-ui/code-block

Usage

Wrapping and Line Numbers

Long lines scroll sideways until someone presses the wrap button, which reports its state with aria-pressed. Pass defaultWrap to start wrapped, or wrap with onWrapChange to control it. Pass lineNumbers to number each line.

Copying

The copy button copies the code and turns into a check for two seconds. It tells screen readers "Copied", or "Copy failed" when the browser refuses the clipboard write.

Without the Header

Pass header={false} to leave out the language, the wrap button and the copy button, when the code sits under your own controls. On <kind-code-block>, add the headerless attribute instead.

Highlighting

No highlighter ships with it. Pass highlight, a function that resolves the code as a list of tokens whose contents, joined, are the code. Each token can have a color, any CSS color, and a fontStyle of italic or bold:

import type { Highlight } from "@kind-ui/agent-ui/core";

const purple = "light-dark(#7c3aed, #c4b5fd)";

const highlight: Highlight = async (code) =>
  code.split(/(\bawait\b)/).map((content) => (content === "await" ? { content, color: purple } : { content }));

Plain text shows until the tokens arrive. A light-dark() color follows the page's color scheme. The block asks for one result at a time, and doesn't ask again for code that failed until the code or the language changes.

Streaming

Set streaming while the code is still arriving, and the view follows its end. Highlighting keeps up: the start that's already colored stays colored, and the new lines show plain until the next result.

API Reference

Prop

Type

Agent

An agent connected with createAgent reads whether the code block wraps. It can run these actions, and press its buttons like a person would:

Prop

Type

Runs in React and Web Components. On <kind-code-block>, each prop is a kebab-case attribute, so lineNumbers is line-numbers, and onWrapChange fires wrapchange. Set highlight as a property.