Skip to content
UI
On this page

Pre

Renders preformatted text with preserved whitespace.

Overview

Copy the source into your project. Import the parts that you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without a wrapper or replacement package.

Preview

Preformatted text with preserved whitespace

Installation

Run the init command from your project root first. The CLI configures StyleX and installs shared files and dependencies.

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. The CLI keeps existing files.

Usage

Pre renders a native pre element. It preserves whitespace and supports horizontal scrolling. It does not add a toolbar or copy button.

Use Pre for generic preformatted text. Use Codeblock for source code with actions, line numbers, or change markers.

Native attributes, events, and refs target the pre element. Apply custom styles through xstyle. className supports external CSS integration.

Import from the local file installed by the CLI.

API reference

The generator reads the component TypeScript source. Only component and Base UI props appear below. The Required column shows whether you must supply a property. It does not mean you must use the component.

View API reference