+
Skip to content

Embed tooltips in to docs #2399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Embed tooltips in to docs #2399

wants to merge 7 commits into from

Conversation

NWylynko
Copy link
Contributor

@NWylynko NWylynko commented Jul 10, 2025

Also blocked by clerk/clerk new tooltip component

🔎 Previews:

What does this solve?

Extracts

<Tooltip src="_tooltips/content.mdx">Hover me</Tooltip>

and transforms it in to

<Tooltip>
  <TooltipTitle>Hover me</TooltipTitle>
  <TooltipDescription>Content of the tooltip</TooltipDescription>
</Tooltip>

This is because mdx is weird and children props get treated differently to standard props. So to ensure that both the title text and the tooltip content are treated as mdx not just a string, we need to embed them in to there own children inside components.

Checklist

  • I have clicked on "Files changed" and performed a thorough self-review
  • All existing checks pass

@NWylynko NWylynko requested a review from a team as a code owner July 10, 2025 04:30
Copy link

vercel bot commented Jul 10, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
clerk-docs ✅ Ready (Inspect) Visit Preview Jul 10, 2025 6:29pm

@NWylynko NWylynko changed the base branch from main to nick/include-tooltips July 10, 2025 15:13
Base automatically changed from nick/include-tooltips to main July 10, 2025 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
点击 这是indexloc提供的php浏览器服务,不要输入任何密码和下载