Examples

Each one is the library drawing it. Press, type and hover.

Code block2 / 3

CodeBlock::new(source, palette)
    .label("rust")
    .sizing(CodeBlockSizing::DOCUMENT)
    .width(width)
    .render(),
CodeBlock::new("", palette)
    .spans(spans)
    .sizing(CodeBlockSizing::DOCUMENT)
    .width(width)
    .render()

Code block3 / 3

CodeSource

CodeBlock::new("cargo test -p limn -p limn-egui -p limn-gallery", palette)
    .label("SH")
    .width(180.0)
    .render()

CodeBlock

The card that holds a block of code inside prose: wrapped, monospaced and passive, under an optional label such as the language.

Import

use limn::{CodeBlock, CodeBlockSizing, Component, FontFamily, TextSpan};

Usage

A code block needs its text and the palette. It reports no actions.

fn view(palette: ComponentPalette) -> Element {
    CodeBlock::new("cargo test -p limn", palette).label("SH").render()
}

The code is set on the palette’s raised fill inside a hairline in its border color.

Label

CodeBlock::new(source, palette).label("RUST").render()

label adds a muted line above the code. The host writes it in the case it wants. Without it the block is the code alone.

Sizing

CodeBlock::new(source, palette)
    .label("rust")
    .sizing(CodeBlockSizing::DOCUMENT)
    .render()

CodeBlockSizing::CHAT, the default, is for a conversation: a small monospaced label over 12 px code. DOCUMENT is a sans label over 13 px code. CodeBlockSizing is a struct of the label’s text role, whether the label is monospaced, and the code’s text role, so a host can write a profile of its own. The code is always monospaced.

Highlighted code

let spans = vec![
    TextSpan::new("fn ", palette.muted, 13.0, FontFamily::Monospace),
    TextSpan::new("main", palette.text, 13.0, FontFamily::Monospace),
];
CodeBlock::new("", palette).spans(spans).render()

spans paints text the host’s own highlighter already colored, in place of the plain text. Each span carries its own color, size and family.

Width

CodeBlock::new(source, palette).width(180.0).render()

width fixes the width and wraps the code inside it. Without it the block fills the width it is given. Values that are negative or not finite are ignored.

API reference

The guide covers composition, options and actions. Generate the complete Rust type and builder reference from the checkout:

cargo doc -p limn --open

Component API overview · State and actions

Preview