mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
4b465465dd
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
34 lines
1.4 KiB
Plaintext
34 lines
1.4 KiB
Plaintext
---
|
|
title: "工具提示"
|
|
description: "添加工具提示，在用户悬停在文档中的术语、缩写或技术概念上时显示上下文定义和解释。"
|
|
keywords: ["tooltips", "hover help", "contextual information", "explanatory", "definitions"]
|
|
boost: 3
|
|
---
|
|
|
|
使用工具提示可在用户将鼠标悬停在文本上时提供额外的上下文或定义。工具提示还可以包含可选的行动呼吁链接。
|
|
|
|
**示例**: <Tooltip headline="API" tip="应用程序编程接口：一组用于使软件应用彼此通信的协议。" cta="阅读我们的 API 指南" href="/zh/api-reference">API</Tooltip> 文档可帮助开发者了解如何将您的服务集成到他们的系统中。
|
|
|
|
```mdx Tooltip example wrap
|
|
<Tooltip headline="API" tip="应用程序编程接口：一组用于使软件应用彼此通信的协议。" cta="阅读我们的 API 指南" href="/api-reference">API</Tooltip> 文档可帮助开发者了解如何将您的服务集成到他们的系统中。
|
|
```
|
|
|
|
<div id="properties">
|
|
## 属性
|
|
</div>
|
|
|
|
<ResponseField name="tip" type="string" required>
|
|
悬浮提示中显示的文本。
|
|
</ResponseField>
|
|
|
|
<ResponseField name="headline" type="string">
|
|
显示在 `tip` 文本之前的文本。
|
|
</ResponseField>
|
|
|
|
<ResponseField name="cta" type="string">
|
|
悬浮提示内链接的行动呼吁文本。
|
|
</ResponseField>
|
|
|
|
<ResponseField name="href" type="string">
|
|
行动呼吁链接的URL。使用 `cta` 时为必填。
|
|
</ResponseField> |