Typography

NumberText and locale-aware number formatting

Preserve native locale grouping, currency placement, spacing, rounding and units when displaying numbers and bigint values.

₹12,34,567.89

The formatter chooses grouping, symbols, spacing and rounding. Changing the currency can change its default fractional precision.

Numeric presentation

Use explicit locales for server-rendered content. The default and final locale fallback is en-US. Intl rounds displayed output; it does not change the source value or provide a money-storage calculation model. NaN, infinity and negative zero retain native localized output. NumberText and the hook accept numbers or bigint values and reject numeric strings.

Explicit locale and currency


₹12,34,567.89

The formatter chooses grouping, symbols, spacing and rounding. Changing the currency can change its default fractional precision.

Grouping, currencies, percent, compact, units and edge values


US grouping
1,234,567.89
Indian grouping
12,34,567.89
USD
$1,234.50
INR
₹1,23,456.75
JPY
¥1,235
Percentage
12.5%
Compact
1.2M
Speed
90 km/h
Large bigint
9,007,199,254,740,993,123
Negative zero
-0
Not a number
NaN
Infinity
∞

Styling native formatter parts


1 234,56 €

Part spans retain the native text and order, including French grouping and the space before the currency symbol.

Optional integer motion composition


Localized static count

1,234

Decorative integer motion

1,234 requests

AnimatedNumber animates plain digit strings. Its decorative output stays separate from the localized accessible count. NumberText itself has no Motion dependency.

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

Numeric presentation

  • Product prices, metrics, counts, measurements and numeric tables.

Composition and API

NumberText accepts value, locale and formatOptions, separately from native CSS style. Optional partClassNames styles native parts without replacing characters or rearranging them. Tabular digits are the default. useNumberFormat returns format, formatToParts, resolvedLocale and formatter, backed by a cache of at most 50 instances.

Accessibility

Keep the formatted text readable and preserve every native part, including spacing and signs. Numeric strings are not parsed. NaN, infinity and negative zero use Intl output; an application can validate inputs or supply its own empty/error state. Display precision is presentation rather than arithmetic.

FAQ

Does NumberText animate a localized value?

No. NumberText is static and has no Motion dependency. The separate integer motion example uses a localized accessible count alongside decorative digit animation.

What happens without a locale?

The deterministic default and final preference fallback is en-US. Invalid locale syntax and invalid Intl options still throw native errors. Matching Intl locale data is required for exact output across environments.