GitHub

text.snippet

A short piece of code inside a sentence: an element, an intent, a command

Component

<Text>

Renders

<code>

Profile

UI
View as Markdown

Text intents

Example

Preview
Pack my box with five dozen liquor jugs.
<Text intent="text.snippet">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 short piece of code inside a sentence: an element, an intent, a command

    text.snippet this page

  • A code sample of several lines

    text.code

  • Code named inside a sentence

    rather than text.token
    text.snippet 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.snippet 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
  • text.snippet

    A short piece of code inside a sentence: an element, an intent, a command

    rounded-sm bg-surface-active px-1 py-px
Final classes
text-foreground rounded-sm bg-surface-active px-1 py-px
Definition
TS
'text.snippet': {
  kind: 'semantic',
  description: 'A short piece of code inside a sentence: an element, an intent, a command',
  refs: ['tone.default'],
  binding: { element: 'code', classes: 'rounded-sm bg-surface-active px-1 py-px' },
  notFor: [{ context: 'a code sample of several lines', instead: 'text.code' }],
},