forked from astral-sh/uv
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve copy of console command examples (astral-sh#5397)
## Summary This PR improves the copy of the console command example by: - Preventing the selection of generic prompts and generic output - Lazily setting copy content by leveraging intersection observer Most of the changes are inspired by opensafely/documentation#1461 Some other useful refs: - squidfunk/mkdocs-material#3647 - https://mkdocstrings.github.io/recipes/#prevent-selection-of-prompts-and-output-in-python-code-blocks Resolves astral-sh#5355 ## Test Plan - ``` shell-session mkdocs serve -f mkdocs.public.yml ``` - Navigate to http://localhost:8000/uv/first-steps/#viewing-the-version - Try clicking the copy button - Try copying by selecting the content --------- Co-authored-by: Zanie Blue <[email protected]>
- Loading branch information
Showing
3 changed files
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
function cleanupClipboardText(targetSelector) { | ||
const targetElement = document.querySelector(targetSelector); | ||
|
||
// exclude "Generic Prompt" and "Generic Output" spans from copy | ||
const excludedClasses = ["gp", "go"]; | ||
|
||
const clipboardText = Array.from(targetElement.childNodes) | ||
.filter( | ||
(node) => | ||
!excludedClasses.some((className) => | ||
node?.classList?.contains(className), | ||
), | ||
) | ||
.map((node) => node.textContent) | ||
.filter((s) => s != ""); | ||
return clipboardText.join("").trim(); | ||
} | ||
|
||
// Sets copy text to attributes lazily using an Intersection Observer. | ||
function setCopyText() { | ||
// The `data-clipboard-text` attribute allows for customized content in the copy | ||
// See: https://www.npmjs.com/package/clipboard#copy-text-from-attribute | ||
const attr = "clipboardText"; | ||
// all "copy" buttons whose target selector is a <code> element | ||
const elements = document.querySelectorAll( | ||
'button[data-clipboard-target$="code"]', | ||
); | ||
const observer = new IntersectionObserver((entries) => { | ||
entries.forEach((entry) => { | ||
// target in the viewport that have not been patched | ||
if ( | ||
entry.intersectionRatio > 0 && | ||
entry.target.dataset[attr] === undefined | ||
) { | ||
entry.target.dataset[attr] = cleanupClipboardText( | ||
entry.target.dataset.clipboardTarget, | ||
); | ||
} | ||
}); | ||
}); | ||
|
||
elements.forEach((elt) => { | ||
observer.observe(elt); | ||
}); | ||
} | ||
|
||
// Using the document$ observable is particularly important if you are using instant loading since | ||
// it will not result in a page refresh in the browser | ||
// See `How to integrate with third-party JavaScript libraries` guideline: | ||
// https://squidfunk.github.io/mkdocs-material/customization/?h=javascript#additional-javascript | ||
document$.subscribe(function () { | ||
setCopyText(); | ||
}); |
This file contains 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
This file contains 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