feat: add copy button functionality to code blocks in README #636
+139
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
danielroe
reviewed
Feb 1, 2026
| opacity: 1; | ||
| } | ||
| .readme :deep(.readme-copy-button:hover) { |
Member
There was a problem hiding this comment.
this should also be visible when focused 🙏
danielroe
reviewed
Feb 1, 2026
server/utils/readme.ts
Outdated
| const html = highlightCodeSync(shiki, text, lang || 'text') | ||
| // Add copy button | ||
| return `<div class="readme-code-block" dir="ltr"> | ||
| <button type="button" class="readme-copy-button" title="Copy code" check-icon="i-carbon:checkmark" copy-icon="i-carbon:copy" data-copy> |
Member
There was a problem hiding this comment.
I think we need accessible text as well
danielroe
reviewed
Feb 1, 2026
Member
danielroe
left a comment
danielroe
left a comment
There was a problem hiding this comment.
thank you - this looks amazing!
I left some comments for a11y, and I think we'll also need to bump the readme cache key 🙏
Author
|
@danielroe hii! can you check now? ⟡˙⋆ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request enhances the user experience for code blocks in the
Readme.vuecomponent by adding a copy-to-clipboard feature with visual feedback. The changes include frontend event handling, UI improvements for code block interactions, and backend support for rendering copy buttons in code blocks.Frontend functionality and UI improvements:
Readme.vueto enable copying code blocks to the clipboard and provide visual feedback by toggling between copy and success icons.Readme.vueto position and animate the copy button, making it visible on code block hover and improving its appearance.Backend rendering and sanitization:
server/utils/readme.tsto render code blocks with a copy button by default, wrapping highlighted code in a.readme-code-blockdiv and injecting a button for copy functionality.server/utils/readme.tsto supportbuttonelements and necessary attributes for the copy feature.