Skip to content

Callout

A highlighted note, tip or warning.

Updated View as Markdown
Preview

Loading preview…

root = Stack(Callout("Your trial ends in 3 days.", title:"Heads up", tone:warning), Callout("Deploy finished in 41 s.", tone:success, v:bar, icon:check-circle))

Signature

This is the line a model reads in the system prompt.

Callout(content, title:str, tone:Tone, v:soft|bar, icon:Icon2)
  • Group: Content
  • Children: No
  • Positional arguments: content (a trailing ? means it may be left out)

Props

Prop Type How to write it Notes
content string positional, required
title string named: title:…
tone neutral · info · success · warning · danger · accent named: tone:… Default "info". Also accepts error, red, green, blue, yellow, primary.
v soft · bar named: v:… Default "soft".
icon name (open list) named: icon:… Also accepts money, revenue, price, cost, payment, chart, analytics, trend, growth, decline, people, team, customers, person, company, office, location, place, travel, flight, food, restaurant, time, date, email, chat, security, idea, ai, launch, speed, energy, warning, error, success, video, movie, streaming, game, education, nature, health, legal, document, photo, shop, shopping, house, storage, api, winner, goal, sunny, clear, cloudy, partly-cloudy, rain, rainy, snow, storm, thunder, temperature, takeoff, departure, landing, arrival, baggage, seat, bag.

Use your own component

Keep the name and schema, swap what is drawn. The prompt and the model’s output do not change.

import { ui } from "@gistui/react/ui";

const lib = ui.extend({ Callout: MyCallout });
<GistUI library={lib} stream={response.body} />;
<GistUI :source="answer" :components="{ Callout: MyCallout }" />
<GistUI source={answer} components={{ Callout: MyCallout }} />
<GistUI source={answer()} components={{ Callout: MyCallout }} />
import { ui } from "@gistui/vanilla/ui";

const lib = ui.extend({ Callout: (ctx) => ({ el: myElement(ctx) }) });

See Custom components for the full contract. Style hook: [data-gistui="Callout"].

Navigation

Type to search…

↑↓ navigate↵ selectEsc close