web/forgejo
10
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

Add copy button to markdown code blocks (#17638)

Browse source 
* Add copy button to markdown code blocks

Done mostly in JS because I think it's better not to try getting buttons
past the markup sanitizer.

* add svg module tests

* fix sanitizer regexp

* remove outdated comment

* vertically center button in issue comments as well

* add comment to css

* fix undefined on view file line copy

* combine animation less files

* Update modules/markup/markdown/markdown.go

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

* add test for different sizes

* add cloneNode and add tests for it

* use deep clone

* remove useless optional chaining

* remove the svg node cache

* unify clipboard copy string and i18n

* remove unused var

* remove unused localization

* minor css tweaks to the button

* comment tweak

* remove useless attribute

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
This commit is contained in:
silverwind 2021-11-16 09:16:05 +01:00 • committed by GitHub
parent d789670894
commit 23bd7b1211
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 140 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

34
web_src/js/features/clipboard.js
View file

@ -1,27 +1,25 @@
// For all DOM elements with [data-clipboard-target] or [data-clipboard-text], this copy-to-clipboard will work for them
const {copy_success, copy_error} = window.config.i18n;
// TODO: replace these with toast-style notifications
function onSuccess(btn) {
if (!btn.dataset.content) return;
btn.setAttribute('data-variation', 'inverted tiny');
$(btn).popup('destroy');
const oldContent = btn.dataset.content;
btn.dataset.content = btn.dataset.success;
const oldContent = btn.getAttribute('data-content');
btn.setAttribute('data-content', copy_success);
$(btn).popup('show');
btn.dataset.content = oldContent;
btn.setAttribute('data-content', oldContent || '');
}
function onError(btn) {
if (!btn.dataset.content) return;
const oldContent = btn.dataset.content;
btn.setAttribute('data-variation', 'inverted tiny');
const oldContent = btn.getAttribute('data-content');
$(btn).popup('destroy');
btn.dataset.content = btn.dataset.error;
btn.setAttribute('data-content', copy_error);
$(btn).popup('show');
btn.dataset.content = oldContent;
btn.setAttribute('data-content', oldContent || '');
}
/**
* Fallback to use if navigator.clipboard doesn't exist.
* Achieved via creating a temporary textarea element, selecting the text, and using document.execCommand.
*/
// Fallback to use if navigator.clipboard doesn't exist. Achieved via creating
// a temporary textarea element, selecting the text, and using document.execCommand
function fallbackCopyToClipboard(text) {
if (!document.execCommand) return false;
@ -37,7 +35,8 @@ function fallbackCopyToClipboard(text) {
tempTextArea.select();
// if unsecure (not https), there is no navigator.clipboard, but we can still use document.execCommand to copy to clipboard
// if unsecure (not https), there is no navigator.clipboard, but we can still
// use document.execCommand to copy to clipboard
const success = document.execCommand('copy');
document.body.removeChild(tempTextArea);
@ -45,10 +44,13 @@ function fallbackCopyToClipboard(text) {
return success;
}
// For all DOM elements with [data-clipboard-target] or [data-clipboard-text],
// this copy-to-clipboard will work for them
export default function initGlobalCopyToClipboardListener() {
document.addEventListener('click', (e) => {
let target = e.target;
// in case <button data-clipboard-text><svg></button>, so we just search up to 3 levels for performance.
// in case <button data-clipboard-text><svg></button>, so we just search
// up to 3 levels for performance
for (let i = 0; i < 3 && target; i++) {
let text;
if (target.dataset.clipboardText) {