Text

Theme-aware typography primitive.

Preview

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

Loading preview…

Import

Import from the focused entry point below, or use the same named export from @tavojs/ui. Both are public APIs; measure the built application when comparing their bundle cost.

TSX

tsximport { Text } from "@tavojs/ui/text";

The component import loads compiled component CSS. Enable tavoUi() for your project theme variables, or import @tavojs/ui/theme.css once for the package default theme. The equivalent CSS-safe component alias is @tavojs/ui/css/text.

When to use

Use it when

Use `Text` for token-backed typography

Choose something else when

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

Examples

These examples include imports and local state where interaction requires it. Render the exported component in a page after completing UI installation. Demo state stays in the mounted component; connect file handling, persistence, and data loading to your application as needed.

Text example

TSXCreate: src/components/examples/TextExample1.tsx

tsximport { Text } from "@tavojs/ui/text";

export function TextExample1() {
  return (
    <>
      <Text variant="h1">Dashboard</Text>
      <Text variant="p">Paragraph copy.</Text>
      <Text color="muted">Updated just now.</Text>
    </>
  );
}

Common props and defaults

A curated starting point. The complete TypeScript API below includes additional props and compound member contracts.

Prop	Type	Default	Description
`as`	`string \| Component<Record<string, unknown>>`	—	Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
`className`	`string`	—	Optional class hook for app-level styling.
`variant`	`"h1" \| "h2" \| "h3" \| "h4" \| "h5" \| "h6" \| "p" \| "body" \| "hint" \| "span"`	—	Configures variant for this component.
`color`	`"auto" \| "heading" \| "muted" \| "inherit" \| "primary" \| "secondary" \| Tone`	—	Configures color for this component.
`tone`	`Tone \| "default"`	—	Configures tone for this component.
`error`	`boolean`	—	Configures error for this component.

Complete TypeScript API

Import from @tavojs/ui/text. Published exports: Text, TextProps.

`TextProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by Text.
`className`	`string`	No	Optional class hook for app-level styling.
`sx`	`Sx`	No	Inherited sx attribute accepted by Text.
`id`	`string`	No	Inherited id attribute accepted by Text.
`role`	`string`	No	Inherited role attribute accepted by Text.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by Text.
`title`	`string`	No	Inherited title attribute accepted by Text.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by Text.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by Text.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by Text.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by Text.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by Text.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by Text.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by Text.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by Text.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by Text.
`as`	`PolymorphicAs`	No	Changes the rendered root element or component while preserving Tavo.js UI styling and public props.
`variant`	`TextVariant`	No	Configures variant for this component.
`color`	`TextColor`	No	Configures color for this component.
`tone`	`"default" \| Tone`	No	Configures tone for this component.
`error`	`boolean`	No	Configures error 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	The public root follows the as/component prop. Root attributes, className, style, and supported events are forwarded there.

Anatomy and related components

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

Limitations

Avoid Text 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/text`
Explicit CSS import	`@tavojs/ui/css/text`
Preview	Interactive preview available on this page