CodeBlock

Preformatted code surface for docs and examples.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import the component from its dedicated entry point to keep the dependency and generated bundle explicit.

TSX

tsximport { CodeBlock } from "@tavojs/ui/code-block";

Normal Tavo.js applications load component styles through the Tavo.js UI plugin. If the application manages component CSS manually, also import @tavojs/ui/css/code-block.

When to use

Use it when

Use `CodeBlock` for code examples

Choose something else when

Avoid CodeBlock when replacing interactive controls with content-only components.

Examples

CodeBlock example

TSX

tsximport { CodeBlock } from "@tavojs/ui/code-block";

export function CodeBlockExample1() {
  return (
    <>
      <CodeBlock language="bash" code="npm install @tavojs/ui" />
    </>
  );
}

Common props and defaults

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`code`	`string`	—	Configures code for this component.
`language`	`string`	—	Configures language for this component.
`highlighted`	`boolean`	—	defaults to `true` for string code.
`editorTheme`	`"auto" \| "light" \| "dark"`	—	defaults to `auto` and inherits the active Tavo.js theme tokens.
`wrap`	`boolean`	—	Configures wrap for this component.

Complete TypeScript API

Import from @tavojs/ui/code-block. Published exports: CodeBlock, CodeBlockEditorTheme, CodeBlockProps.

`CodeBlockProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by CodeBlock.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by CodeBlock.
`id`	`string`	No	Inherited id attribute accepted by CodeBlock.
`role`	`string`	No	Inherited role attribute accepted by CodeBlock.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by CodeBlock.
`title`	`string`	No	Inherited title attribute accepted by CodeBlock.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by CodeBlock.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by CodeBlock.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by CodeBlock.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by CodeBlock.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by CodeBlock.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by CodeBlock.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by CodeBlock.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by CodeBlock.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by CodeBlock.
`code`	`string`	No	Configures code for this component.
`language`	`string`	No	Configures language for this component.
`highlighted`	`boolean`	No	defaults to `true` for string code.
`editorTheme`	`CodeBlockEditorTheme`	No	defaults to `auto` and inherits the active Tavo.js theme tokens.
`wrap`	`boolean`	No	Configures wrap for this component.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid CodeBlock when replacing interactive controls with content-only components.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Content components should keep meaningful text and media alternatives available to assistive technology.

Provide alt text for meaningful images.
Use semantic text variants for headings and paragraphs.
Do not hide essential content visually unless VisuallyHidden is intentional.

Component status

Contract	Current value
Maturity	stable
Category	content
Component import	`@tavojs/ui/code-block`
Explicit CSS import	`@tavojs/ui/css/code-block`
Preview	Interactive preview available on this page