WritedocsWritedocs

Hint

View as MarkdownView this page as plain textOpen in ChatGPTAsk questions about this pageOpen in ClaudeAsk questions about this pageOpen in PerplexityAsk questions about this page
Connect to CursorUse these docs in CursorConnect to VS CodeUse these docs in VS Code

A word or phrase with a dotted underline and a small info icon, that shows a tooltip when the reader points at it or reaches it with the keyboard. It explains a term without breaking up the sentence, the way a Callout would:

The timeout field is measured in milliseconds1000ms = 1 second, not seconds.

The `timeout` field is measured in <Hint tip="1000ms = 1 second">milliseconds</Hint>, not seconds.

Hint goes inside a sentence, not on a line of its own. On a touch screen, tapping the text shows the tooltip.

Props

tip string required

The tooltip’s text. Plain text: Markdown is shown as written.

headline string

A bold line above tip.

cta string

Link text shown below tip. Needs href. The tooltip stays open while the pointer moves onto it, so the link can be clicked.

href string

Where cta links to.

icon boolean default: true

The small info icon after the text. icon={false} leaves just the dotted underline: like thisNo icon on this one.

headline adds a bold line above the tip, and cta with href a link below it. Point at rate limitRate limitRequests allowed per minute, per API key.See the limits to see one:

<Hint headline="Rate limit" tip="Requests allowed per minute, per API key." cta="See the limits" href="/docs/limits/">rate limit</Hint>