GitHub

text.caption

A supporting sentence next to something else: helper text under a field, a note under an image

Component

<Text>

Renders

<p>

Profile

UI
View as Markdown

Text intents

Example

Preview

Pack my box with five dozen liquor jugs.

<Text intent="text.caption">Pack my box with five dozen liquor jugs.</Text>

Choosing between neighbours

Find the row that describes your element, and use the intent on the right.

  • If it is

    Use

  • A supporting sentence next to something else: helper text under a field, a note under an image

    text.caption this page

  • A few words that name a value

    text.label

  • Dates, authors or file sizes

    text.meta

  • Error or success messages

    feedback.error

  • Full sentences

    rather than text.label
    text.caption this page

  • A sentence explaining something

    rather than text.meta
    text.caption this page

Connections

Declared in the registry, both directions. Where an intent is used in your own code is something check and the gallery see; this site has no app code.

For registry authors

Starter intents. These are the intents prongs add puts in your registry, shown in this site’s theme. Yours are your own registry.ts: rename, restyle and add to them, and see them with prongs add gallery.

What this intent is built from and its entry in components/prongs/registry.ts. You only need this to change how it looks or to add an intent like it.

How text.caption resolves, and its definition

Each layer adds to the one before it; a later class wins over an earlier one that sets the same thing.

  • typography.small

    Small reading type

    text-xs
  • tone.muted

    Secondary text colour, readable on every surface

    text-surface-muted
  • text.caption

    A supporting sentence next to something else: helper text under a field, a note under an image

    leading-relaxed
Final classes
text-xs text-surface-muted leading-relaxed
Definition
TS
'text.caption': {
  kind: 'semantic',
  description: 'A supporting sentence next to something else: helper text under a field, a note under an image',
  refs: ['typography.small', 'tone.muted'],
  binding: { element: 'p', classes: 'leading-relaxed' },
  notFor: [
    { context: 'a few words that name a value', instead: 'text.label' },
    { context: 'dates, authors or file sizes', instead: 'text.meta' },
    { context: 'error or success messages', instead: 'feedback.error' },
  ],
},