mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
b9363c3d04
* Update components/columns.mdx * Update components/frames.mdx * Update components/mermaid-diagrams.mdx * Update components/tooltips.mdx * copy edit columns * Replace lorem ipsum with example text * update frames page * Update mermaid-diagrams.mdx * copy edit tooltips * update tooltips --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
28 lines
1.1 KiB
Plaintext
28 lines
1.1 KiB
Plaintext
---
|
|
title: "Tooltips"
|
|
description: "Show a definition when you hover over text"
|
|
icon: "message-square"
|
|
---
|
|
|
|
Use tooltips to provide additional context or definitions when a user hovers over a string of text. Tooltips can include optional call-to-action links.
|
|
|
|
**Example**: <Tooltip tip="Application Programming Interface: a set of protocols for software applications to communicate." cta="Read our API guide" href="/api-reference">API</Tooltip> documentation helps developers understand how to integrate with your service.
|
|
|
|
```mdx Tooltip example wrap
|
|
<Tooltip tip="Application Programming Interface: a set of protocols for software applications to communicate." cta="Read our API guide" href="/api-reference">API</Tooltip> documentation helps developers understand how to integrate with your service.
|
|
```
|
|
|
|
## Properties
|
|
|
|
<ResponseField name="tip" type="string" required>
|
|
The text displayed in the tooltip.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="cta" type="string">
|
|
The call-to-action text for a link within the tooltip.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="href" type="string">
|
|
URL for the call-to-action link. Required when using `cta`.
|
|
</ResponseField>
|