Text

Import: import { Text, type TextProps, type TextFont, type TextColor } from "@opal/components";

A styled text component with string-enum props for font preset and color selection. Supports inline markdown rendering via RichStr — pass markdown("*bold* text") as children to enable.

Props

TextFont

TextColor

"text-01" | "text-02" | "text-03" | "text-04" | "text-05" | "text-inverted-01" | "text-inverted-02" | "text-inverted-03" | "text-inverted-04" | "text-inverted-05" | "text-light-03" | "text-light-05" | "text-dark-03" | "text-dark-05"

Usage Examples

import { Text } from "@opal/components";

// Basic
<Text font="main-ui-body" color="text-03">
  Hello world
</Text>

// Heading
<Text font="heading-h2" color="text-05" as="h2">
  Page Title
</Text>

// Inverted (for dark backgrounds)
<Text font="main-ui-body" color="text-inverted-05">
  Light text on dark
</Text>

// As paragraph
<Text font="main-content-body" color="text-03" as="p">
  A full paragraph of text.
</Text>

Inline Markdown via RichStr

Inline markdown is opt-in via the markdown() function, which returns a RichStr. When Text receives a RichStr as children, it parses the inner string as inline markdown. Plain strings are rendered as-is — no parsing, no surprises. Text does not accept arbitrary JSX as children; use string | RichStr only.

import { Text } from "@opal/components";
import { markdown } from "@opal/utils";

// Inline markdown — bold, italic, links, code, strikethrough
<Text font="main-ui-body" color="text-05">
  {markdown("*Hello*, **world**! Visit [Onyx](https://onyx.app) and run `onyx start`.")}
</Text>

// Plain string — no markdown parsing
<Text font="main-ui-body" color="text-03">
  This *stays* as-is, no formatting applied.
</Text>

Supported syntax: **bold**, *italic*, `code`, [link](url), ~~strikethrough~~, \n (newline → ).

Markdown rendering uses react-markdown internally, restricted to inline elements only. http(s) links open in a new tab; mailto: and tel: links open natively. Inline code inherits the parent font size and switches to the monospace family.

Newlines (\n) are converted to elements that inherit the parent's line-height, so line spacing is proportional to the font size. For full block-level markdown (code blocks, headings, lists), use MinimalMarkdown instead.

Using RichStr in component props

Components that want to support optional markdown in their text props should accept string | RichStr:

import type { RichStr } from "@opal/types";

interface MyComponentProps {
  title: string | RichStr;
  description?: string | RichStr;
}

This avoids API coloring — no markdown boolean needs to be threaded through intermediate components. The decision to use markdown lives at the call site.

Compatibility

@/refresh-components/texts/Text is an independent legacy component that implements the same font/color presets via a boolean-flag API. It is not a wrapper around this component. New code should import directly from @opal/components.