GitHub

heading.side

The name of one side in a side-by-side comparison: With intents, Without. A step smaller than heading.item, so it reads as a label over what is compared

Component

<Text>

Renders

<h3>

Profile

UI
View as Markdown

Heading intents

Example

Preview

The quick brown fox

<Text intent="heading.side">The quick brown fox</Text>

Choosing between neighbours

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

  • If it is

    Use

  • The name of one side in a side-by-side comparison: With intents, Without. A step smaller than heading.item, so it reads as a label over what is compared

    heading.side this page

  • The title of a single thing

    heading.item

  • A label above a heading

    heading.kicker

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 heading.side 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.

  • tone.default

    Main text colour

    text-foreground
  • heading.side

    The name of one side in a side-by-side comparison: With intents, Without. A step smaller than heading.item, so it reads as a label over what is compared

    text-sm font-medium tracking-[0.02em]
Final classes
text-foreground text-sm font-medium tracking-[0.02em]
Definition
TS
'heading.side': {
  kind: 'semantic',
  description: 'The name of one side in a side-by-side comparison: With intents, Without. A step smaller than heading.item, so it reads as a label over what is compared',
  refs: ['tone.default'],
  binding: { classes: 'text-sm font-medium tracking-[0.02em]', element: 'h3' },
  notFor: [
    { context: 'the title of a single thing', instead: 'heading.item' },
    { context: 'a label above a heading', instead: 'heading.kicker' },
  ],
},