Skip to main content
v0.1 dev

Structure

Code block

Formats code in a labelled, scrollable container with optional actions.

implementedReference catalogfigure + pre + codeSemantics + SelectableText

Overview

Formats code in a labelled, scrollable container with optional actions. Its semantic foundation is Preformatted code with accessible language and copy action. Source scope: Reference catalog.

This element owns a standalone primitive contract and does not depend on a product-specific component.

Visual Example

JavaScript
const state = resolveToken("color.text.primary");

When to Use

Use Code block when its semantic purpose matches the user task. Prefer native platform behavior, concise labels, predictable placement, and content that remains understandable without visual styling.

Do

  • Use the canonical element ID and semantic role.
  • Keep labels and state programmatically available.
  • Test the element with real content and every supported input modality.

Don't

  • Do not substitute a visually similar element with different semantics.
  • Do not add focusable descendants without a documented keyboard model.
  • Do not communicate state through color or motion alone.

Anatomy

1Container
2Heading or label
3Content region
4Optional action

Variants

defaultcompactbordered

Variants preserve the same semantics and accessible name. Density changes never reduce the minimum interactive target.

States

defaultexpandedcollapsedselecteddisabled

Focus-visible takes precedence over hover and selected styling. Loading and disabled behavior never silently remove essential information or recovery paths.

Behavior

Structural containers add no keyboard behavior unless they own a documented disclosure, tab, link, or button. Web targets are at least 44 × 44 CSS pixels and Flutter targets are at least 48 × 48 dp.

Accessibility

Preformatted code with accessible language and copy action. The element exposes an accessible name, role, state, value, and result where applicable; retains visible 3:1 focus indication; supports 200% text scaling and 320 CSS pixel reflow; and preserves structure in forced-colors and reduced-motion modes.

Tokens

color.* semantic rolesnative semantic compositionfigure + pre + code

Spacing, sizing, typography, border, radius, icon, motion, focus, and color decisions resolve from canonical tokens. Element code does not contain arbitrary visual literals.

Web and Flutter API

Web

<figure + pre + code>Code block</figure>

Flutter

Semantics + SelectableText(/* semantic content */)

ds-code-block is a registry identifier only; this library does not register an autonomous custom element under that name. Use the mapped component or native semantic composition shown above.

When an element includes an icon, use the exact Tabler name and semantic size from Foundations · Iconography.

Status

implemented. The contract is registered, visually represented, and included in automated documentation and accessibility validation. This status describes contract coverage, not independent production certification.