API Reference

Callouts

Interrupt the reading flow with something the reader must not miss — by intent, not colour.

Use a callout to interrupt the reading flow with something the reader must not miss. Pick the variant by intent, not colour — the severity is what serializes to the knowledge face. There are six aliases over five severities: Info/Note (neutral), Tip, Check (success), Warning, and Danger.

When to use it

Reach for a callout when a single idea needs to break out of the prose — a caveat the reader will trip over, a shortcut worth knowing, a confirmation, or a destructive action. One per idea: don't stack many in a row or you flatten their signal.

Variants

ComponentSeverityWhen to use
<Info> / <Note>infoNeutral context worth keeping in mind
<Tip>tipA shortcut or a better way to do something
<Check>successA confirmation or a passing state
<Warning>warningSomething that will bite you if ignored
<Danger>dangerA destructive or irreversible action

Props

Each takes an optional title and its children as the body.

PropTypeDefaultDescription
titleReactNodeBold heading shown above the body
childrenReactNodeThe callout body

Live example

Info

Neutral context the reader should keep in mind.

Tip

A shortcut or better way to do something.

Check

A confirmation that a step succeeded.

Warning

Something that will bite you if ignored.

Danger

A destructive or irreversible action.

Best practice

Don't stack many callouts in a row — it flattens their signal. One per idea.

What the agent sees

A callout is one of the few primitives that serializes. The body is flattened to plain text and the severity is preserved, so an agent can surface "every warning on this page" without parsing colour:

{
  "kind": "callout",
  "id": "warning",
  "title": "Warning",
  "severity": "warning",
  "body": "Something that will bite you if ignored.",
  "summary": "Something that will bite you if ignored."
}

On this page

Built withsuperlore