Typography

Inline emphasis and tokens

Compose InlineCode for monospace tokens and Text toggles for semantic emphasis patterns inside paragraphs.

Run pnpm install then ship.

Typography foundations

Explicit size, weight, leading and tracking override preset styling. Explicit weight also overrides the legacy bold prop. Existing defaults remain unchanged; fluid sizing is opt-in.

Semantic inline emphasis


Use importance, stress, and fine print without losing the surrounding text tone.

Variants showcase

Tone tokens align with dark shells across Zentauri previews—swap surfaces thoughtfully.

Tone default with token

Tone muted with token

Tone primary with token

Tone secondary with token

Tone accent with token

Tone destructive with token

Tone info with token

Tone success with token

Tone warning with token

Tone error with token

Tone gradient-pink-violet with token

Tone gradient-cyan-violet with token

Tone gradient-cyan-blue with token

Tone gradient-cyan-green with token

Tone gradient-cyan-orange with token

Tone gradient-cyan-red with token

Tone gradient-cyan-purple with token

Tone gradient-cyan-pink with token

Formatting showcase

Boolean emphasis props layer Tailwind utilities consistently.

Bold + italic + underline

Highlight + muted + strike

Combination examples

Patterns you can paste into marketing pages and dashboards.

Deploy via npx zentauri-ui add typography then verify destructive warnings when deleting routes.

Typography variants examples

Density mirrors other previews: each row pairs live output with the matching import and JSX. Use Show output / Show code on every row; snippets start with Variant naming the token row.


Variant: INLINE · TONE · DEFAULT

Run pnpm lint before merge.


Variant: INLINE · TONE · MUTED

Run pnpm lint before merge.


Variant: INLINE · TONE · PRIMARY

Run pnpm lint before merge.


Variant: INLINE · TONE · SECONDARY

Run pnpm lint before merge.


Variant: INLINE · TONE · ACCENT

Run pnpm lint before merge.


Variant: INLINE · TONE · DESTRUCTIVE

Run pnpm lint before merge.


Variant: INLINE · TONE · INFO

Run pnpm lint before merge.


Variant: INLINE · TONE · SUCCESS

Run pnpm lint before merge.


Variant: INLINE · TONE · WARNING

Run pnpm lint before merge.


Variant: INLINE · TONE · ERROR

Run pnpm lint before merge.


Variant: INLINE · TONE · GRADIENT-PINK-VIOLET

Run pnpm lint before merge.


Variant: INLINE · TONE · GRADIENT-CYAN-VIOLET

Run pnpm lint before merge.


Variant: INLINE · TONE · GRADIENT-CYAN-BLUE

Run pnpm lint before merge.


Variant: INLINE · TONE · GRADIENT-CYAN-GREEN

Run pnpm lint before merge.


Variant: INLINE · TONE · GRADIENT-CYAN-ORANGE

Run pnpm lint before merge.


Variant: INLINE · TONE · GRADIENT-CYAN-RED

Run pnpm lint before merge.


Variant: INLINE · TONE · GRADIENT-CYAN-PURPLE

Run pnpm lint before merge.


Variant: INLINE · TONE · GRADIENT-CYAN-PINK

Run pnpm lint before merge.


Variant: INLINE · NESTED EMPHASIS · BOLD SPAN

Deploy via npx zentauri-ui add typography then verify destructive warnings

Typography API

Generated from the package prop types and variant definitions.

Blockquote

BlockquoteProps

Variants

PropTypeDefault
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default

Behavior

PropTypeDefault
attributionAttribution label; distinct from the native cite URL attribute.string | undefinednone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLQuoteElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLQuoteElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

CodeBlock

CodeBlockProps

Variants

PropTypeDefault
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default

Behavior

PropTypeDefault
languagestring | undefinednone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLPreElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLPreElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

DescriptionList

DescriptionListProps

Variants

PropTypeDefault
layout
inlineresponsivestacked
responsive
separators
falsetrue
false
size
baselgsm
base
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLDListElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLDListElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

DescriptionListDetails

DescriptionListDetailsProps

Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

DescriptionListItem

DescriptionListItemProps

Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLDivElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLDivElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

DescriptionListTerm

DescriptionListTermProps

Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

Emphasis

EmphasisProps

Variants

PropTypeDefault
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

ExpandableText

ExpandableTextProps

Behavior

PropTypeDefault
buttonClassNamestring | undefinednone
contentClassNamestring | undefinednone
contentIdstring | undefinednone
defaultExpandedboolean | undefinednone
expandedboolean | undefinednone
lessLabelstring | undefinednone
linesnumber | undefinednone
moreLabelstring | undefinednone
onExpandedChange((expanded: boolean) => void) | undefinednone
showToggleAlways exposes the control when layout measurement is unavailable.'overflow' | 'always' | undefinednone
text*stringnone
Inherited HTML props
PropTypeDefault
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLDivElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLDivElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

FootnoteBacklink

FootnoteBacklinkProps

Behavior

PropTypeDefault
label*stringnone
noteId*stringnone
referenceId*stringnone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
downloadanynone
idstring | undefinednone
onClickMouseEventHandler<HTMLAnchorElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLAnchorElement> | undefinednone
referrerPolicyHTMLAttributeReferrerPolicy | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
targetHTMLAttributeAnchorTarget | undefinednone
titlestring | undefinednone

FootnoteItem

FootnoteItemProps

Behavior

PropTypeDefault
noteId*stringnone
number*numbernone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
onClickMouseEventHandler<HTMLLIElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLLIElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

FootnoteReference

FootnoteReferenceProps

Behavior

PropTypeDefault
noteId*stringnone
number*numbernone
referenceId*stringnone
Inherited HTML props
PropTypeDefault
classNamestring | undefinednone
downloadanynone
onClickMouseEventHandler<HTMLAnchorElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLAnchorElement> | undefinednone
referrerPolicyHTMLAttributeReferrerPolicy | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
targetHTMLAttributeAnchorTarget | undefinednone
titlestring | undefinednone

Footnotes

FootnotesProps

Behavior

PropTypeDefault
scopeIdstring | undefinednone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLDivElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLDivElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

FootnotesList

FootnotesListProps

Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLOListElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLOListElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

Heading

HeadingProps

Variants

PropTypeDefault
align
centerendjustifystart
none
leading
normalrelaxedtight
none
level*
123456
none
measure
nonereadablewide
none
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default
tracking
normaltightwide
none
weight
boldmediumnormalsemibold
none
wrap
balancenormalnowrappretty
none

Behavior

PropTypeDefault
boldExplicit weight takes precedence over bold.boolean | undefinednone
displayLevelVisual scale; defaults to level. Does not change the semantic heading tag.HeadingLevel | undefinednone
displaySizeMarketing display size. Takes precedence over displayLevel.NonNullable<'md' | 'sm' | 'lg' | null | undefined> | undefinednone
italicboolean | undefinednone
scaleFluid sizing is opt-in; default retains the existing responsive scale.'default' | 'fluid' | undefinednone
strikethroughboolean | undefinednone
underlineboolean | undefinednone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLHeadingElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLHeadingElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

HighlightText

HighlightTextProps

Behavior

PropTypeDefault
caseSensitiveUnicode simple case folding, without locale or accent normalization.boolean | undefinednone
markClassNamestring | undefinednone
query*string | readonly string[]none
text*stringnone
Inherited HTML props
PropTypeDefault
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLSpanElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLSpanElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

InlineCode

InlineCodeProps

Variants

PropTypeDefault
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

List

ListProps

Variants

PropTypeDefault
marker
circlediscnone
disc
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default

Behavior

PropTypeDefault
orderedboolean | undefinednone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLOListElement> | MouseEventHandler<HTMLUListElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).((instance: HTMLUListElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLUListElement | null> | ((instance: HTMLOListElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLOListElement | null> | null | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

ListItem

ListItemProps

Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLLIElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLLIElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

Mark

MarkProps

Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

NumberText

NumberTextProps

Variants

PropTypeDefault
align
centerendjustifystart
none
font
bodymono
none
leading
normalrelaxedtight
none
measure
nonereadablewide
none
numeric
normaltabular
tabular
size
baselgsmxlxs
base
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default
tracking
normaltightwide
none
weight
boldmediumnormalsemibold
none
wrap
balancenormalnowrappretty
none

State

PropTypeDefault
value*number | bigintnone

Behavior

PropTypeDefault
as'div' | 'p' | 'span' | undefinednone
formatOptionsIntl's style is separate from the native React CSS style prop.Intl.NumberFormatOptions | undefinednone
localestring | string[] | undefinednone
partClassNamesStyles native parts without replacing their text or order.Partial<Record<keyof Intl.NumberFormatPartTypeRegistry, string>> | undefinednone
Inherited HTML props
PropTypeDefault
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLDivElement> | MouseEventHandler<HTMLSpanElement> | MouseEventHandler<HTMLParagraphElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).((instance: HTMLDivElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement | null> | ((instance: HTMLSpanElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLSpanElement | null> | ((instance: HTMLParagraphElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLParagraphElement | null> | null | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

Prose

ProseProps

Variants

PropTypeDefault
measure
nonereadablewide
readable
size
baselgsm
base
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default

Behavior

PropTypeDefault
as'div' | 'article' | undefinednone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLDivElement> | MouseEventHandler<HTMLElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).((instance: HTMLDivElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement | null> | ((instance: HTMLElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLElement | null> | null | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

Small

SmallProps

Variants

PropTypeDefault
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

Strong

StrongProps

Variants

PropTypeDefault
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLElement> | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

Text

TextProps

Variants

PropTypeDefault
align
centerendjustifystart
none
font
bodymono
none
leading
normalrelaxedtight
none
measure
nonereadablewide
none
numeric
normaltabular
none
preset
bodycaptionleadoverline
body
size
baselgsmxlxs
base
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default
tracking
normaltightwide
none
underline
alwayshovernone
always
weight
boldmediumnormalsemibold
none
wrap
balancenormalnowrappretty
none

Behavior

PropTypeDefault
as'div' | 'label' | 'p' | 'span' | undefinednone
boldExplicit weight, then a preset's weight, take precedence over bold.boolean | undefinednone
highlightVisual highlighting only; use semantic emphasis for importance.boolean | undefinednone
italicboolean | undefinednone
strikethroughboolean | undefinednone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLDivElement> | MouseEventHandler<HTMLSpanElement> | MouseEventHandler<HTMLParagraphElement> | MouseEventHandler<HTMLLabelElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).((instance: HTMLDivElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement | null> | ((instance: HTMLSpanElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLSpanElement | null> | ((instance: HTMLParagraphElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLParagraphElement | null> | ((instance: HTMLLabelElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLLabelElement | null> | null | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

TextLink

TextLinkProps

Variants

PropTypeDefault
align
centerendjustifystart
none
leading
normalrelaxedtight
none
measure
nonereadablewide
none
size
baselgsmxlxs
base
tone
accentdefaultdestructiveerrorgradient-cyan-bluegradient-cyan-greengradient-cyan-orangegradient-cyan-pinkgradient-cyan-purplegradient-cyan-redgradient-cyan-violetgradient-pink-violet+6
default
tracking
normaltightwide
none
underline
alwayshovernone
always
weight
boldmediumnormalsemibold
none
wrap
balancenormalnowrappretty
none

Behavior

PropTypeDefault
externalIndicatorDecorative external-link marker; does not change target or accessible name.boolean | undefinednone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
downloadanynone
hrefstring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLAnchorElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).Ref<HTMLAnchorElement> | undefinednone
referrerPolicyHTMLAttributeReferrerPolicy | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
targetHTMLAttributeAnchorTarget | undefinednone
titlestring | undefinednone

TruncateText

TruncateTextProps

Behavior

PropTypeDefault
as'div' | 'p' | 'span' | undefinednone
linesnumber | undefinednone

Content

PropTypeDefault
children*stringnone
Inherited HTML props
PropTypeDefault
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLDivElement> | MouseEventHandler<HTMLSpanElement> | MouseEventHandler<HTMLParagraphElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).((instance: HTMLDivElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement | null> | ((instance: HTMLSpanElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLSpanElement | null> | ((instance: HTMLParagraphElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLParagraphElement | null> | null | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

VisuallyHidden

VisuallyHiddenProps

Behavior

PropTypeDefault
as'div' | 'span' | undefinednone
focusableReveal on focus-within, for example when containing a skip-link anchor.boolean | undefinednone
Inherited HTML props
PropTypeDefault
childrenReactNodenone
classNamestring | undefinednone
idstring | undefinednone
onClickMouseEventHandler<HTMLDivElement> | MouseEventHandler<HTMLSpanElement> | undefinednone
refAllows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).((instance: HTMLDivElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLDivElement | null> | ((instance: HTMLSpanElement | null) => void | (() => VoidOrUndefinedOnly) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | RefObject<HTMLSpanElement | null> | null | undefinednone
relstring | undefinednone
styleCSSProperties | undefinednone
titlestring | undefinednone

What it does

Demonstrates emphasis combinations on Text and monospace InlineCode surfaces.

Tones align with the broader typography palette.

Composition and API

Nest InlineCode inside Text or headings sparingly.

Avoid deeply nested emphasis toggles.

Common use cases

  • CLI snippets beside sentences.
  • API parameter names in prose.
  • Warnings with destructive tone.
  • Highlighted beta labels.

Accessibility

Underline complements links elsewhere—avoid conflicting patterns.

Highlight should not be the only cue.

Next.js integration notes

Static docs can ship Inline-heavy paragraphs from MDX.

Ensure code tokens escape user-provided strings.

FAQ

Should InlineCode wrap keyboard keys?

Yes for monospace clarity; pair with Text emphasis when describing shortcuts.

Can InlineCode sit inside buttons?

Technically yes, but prefer plain spans inside buttons unless monospace is required.

Does destructive tone imply errors?

It applies rose text styling—reserve for risky actions or validation messaging.