Text

Labels or other single-line text adjacent to other components on the same row.

#

#

#

Used for displaying counts and small body copy. Avoid unless explicitly used in a design, since it's harder to read than a default medium size.

#

This is a default size, that's used for most copy on the page.

#

Used on onboarding pages, where larger fonts and component sizes are used. There may be other limited use cases beyond onboarding pages. Try to stick to a default medium size when possible.

#

Use the monospace variant for displaying monospaced text. This may be used for data references.

#

Use the numeric variant for displaying numerical data. If you need to show a code example, use code instead.

#

When text content comes from users, it's often too long to fit in the UI. To avoid breaking the layout, truncate the overflowing text with an ellipsis ().

#

Use the shimmer prop to add an animated shimmer effect to text. This is useful for drawing attention to new features or important updates. The shimmer automatically uses the 900 shade of the text color (e.g., purple.500purple.900).

You can also provide a custom shimmerColor to override the default:

#

#

  • When displaying a single-line text or a label near the relevant component.

#

  • If text can span multiple lines, use a paragraph instead.

#

  • Avoid overriding font size, unless it's absolutely necessary and requested by design team.

#

  • Enable isMonospace prop for displaying numerical data. If you need to show a code example, use code instead.

#

  • Use medium for a primary column in the table.
  • Use semibold to highlight small amounts of text inside a paragraph. Avoid highlighting entire sentences or paragraphs.

#

  • uppercase text transform and wide letter spacing are reserved for use in table headers. You shouldn't use them directly.

#

#

NameDefaultDescription
isTruncatedfalseboolean

Truncate overflowing text with an ellipsis if needed.

children

ReactNode

Text.

size"md""sm" | "md" | "lg"

Font size.

fontWeight"normal""normal" | "medium" | "semibold"

Font weight

letterSpacing"normal""normal" | "wide"

Letter spacing.

variantundefinedundefined | "numeric" | "monospace"

Variant

shimmerfalseboolean

Enable animated shimmer effect on the text.

shimmerColor

ColorProps["color"]

Color for the shimmer effect. Defaults to the 900 shade of the text color (e.g., "purple.500" → "purple.900"). Override for custom shimmer colors.

On this page

  • Example
  • Usage
  • Small size
  • Medium size
  • Large size
  • Monospace
  • Numeric
  • Truncated
  • Shimmer
  • Guidelines
  • When to use
  • When not to use
  • Font size
  • Font family
  • Font weight
  • Text transform and letter spacing
  • Content
  • Props