Skip to content
TypographyGenerated from the public API

Typography

Roles rather than sizes, and numerals that never lie about their alignment.

@luc/ui/typography

Examples

Default

One paragraph set in the four voices: heading, body, numeric and code.

Portfolio review

Three positions were rebalanced this morning.

+1,284.5
pnpm build⌘

Usage

import { Code } from "@luc/ui/typography";

Package setup — peer requirements, the stylesheet and the provider — is on installation.

API

Read from the published TypeScript API, so a prop that is not listed here does not exist and a default that is listed is the one the compiler sees.

Exported symbols
ExportKindSignature
Code1 documented props({ className, block, ...props }: CodeProps) => import("@types/react").JSX.Element
Heading3 documented props({ className, size, tone, as, ...props }: HeadingProps) => import("@types/react").JSX.Element
Kbd2 documented props({ className, variant, size, ...props }: KbdProps) => import("@types/react").JSX.Element
NumericText8 documented props({ className, value, kind, currency, suffix, signed, locale, minimumFractionDigits, maximumFractionDigits, ...props }: NumericTextProps) => import("@types/react").JSX.Element
Text4 documented props({ className, variant, tone, truncate, as, ...props }: TextProps) => import("@types/react").JSX.Element

Code props

Type: CodeProps

Values the compiler reads from the declaration.

Code props
PropTypeDefaultNotes
block?boolean | undefined—Block form: a monospaced panel that preserves its lines and scrolls horizontally rather than wrapping them.

Heading props

Type: HeadingProps

Values the compiler reads from the declaration.

Heading props
PropTypeDefaultNotes
as?"div" | "h2" | "h3" | "p" | "span" | "h1" | "h4" | undefined—
size?HeadingSize | undefined—
tone?TextTone | undefined—

Kbd props

Type: KbdProps

Values the compiler reads from the declaration.

Kbd props
PropTypeDefaultNotes
size?"sm" | "md" | undefined—
variant?"default" | "raised" | undefined—`default` for an inline hint, `raised` for a shortcut strip.

NumericText props

Type: NumericTextProps

Values the compiler reads from the declaration.

NumericText props
PropTypeDefaultNotes
currency?string | undefined—
kind?NumericFormatKind | undefined—
locale?string | undefined—
maximumFractionDigits?number | undefined—
minimumFractionDigits?number | undefined—
signed?boolean | undefined—
suffix?string | undefined—
valuenumber | null | undefined—

Text props

Type: TextProps

Values the compiler reads from the declaration.

Text props
PropTypeDefaultNotes
as?"div" | "label" | "li" | "p" | "span" | "dd" | "dt" | undefined—
tone?TextTone | undefined—
truncate?boolean | undefined—Single line with an ellipsis.
variant?TextVariant | undefined—
Luc UI v1.0Typographydark theme