Skip to content

Commit

Permalink
Add Mermaid copy button, avoid unnecessary tooltip hide (#22225)
Browse files Browse the repository at this point in the history
- Add Copy button to mermaid diagrams which copies their source.
- Set tippy to not hide on click and avoid tooltip re-creation for
temporary tooltips. This avoids hide and show when copying repo url.
Popovers still hide the tooltip as usual.


<img width="815" alt="Screenshot 2022-12-23 at 14 02 32"
src="https://user-images.githubusercontent.com/115237/209341696-98e30953-f246-46d9-9157-2ececfd791c9.png">

Co-authored-by: Lauris BH <lauris@nix.lv>
Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
  • Loading branch information
3 people committed Dec 25, 2022
1 parent 3bd49f7 commit f5cd0d9
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 9 deletions.
13 changes: 8 additions & 5 deletions web_src/js/markup/codecopy.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
import {svg} from '../svg.js';

export function renderCodeCopy() {
const els = document.querySelectorAll('.markup .code-block code');
if (!els.length) return;

export function makeCodeCopyButton() {
const button = document.createElement('button');
button.classList.add('code-copy', 'ui', 'button');
button.innerHTML = svg('octicon-copy');
return button;
}

export function renderCodeCopy() {
const els = document.querySelectorAll('.markup .code-block code');
if (!els.length) return;

for (const el of els) {
const btn = button.cloneNode(true);
const btn = makeCodeCopyButton();
btn.setAttribute('data-clipboard-text', el.textContent);
el.after(btn);
}
Expand Down
10 changes: 9 additions & 1 deletion web_src/js/markup/mermaid.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import {isDarkTheme} from '../utils.js';
import {makeCodeCopyButton} from './codecopy.js';

const {mermaidMaxSourceCharacters} = window.config;

const iframeCss = `
Expand Down Expand Up @@ -58,7 +60,13 @@ export async function renderMermaid() {
iframe.sandbox = 'allow-scripts';
iframe.style.height = `${Math.ceil(parseFloat(heightStr))}px`;
iframe.srcdoc = `<html><head><style>${iframeCss}</style></head><body>${svgStr}</body></html>`;
el.closest('pre').replaceWith(iframe);
const mermaidBlock = document.createElement('div');
mermaidBlock.classList.add('mermaid-block');
mermaidBlock.append(iframe);
const btn = makeCodeCopyButton();
btn.setAttribute('data-clipboard-text', source);
mermaidBlock.append(btn);
el.closest('pre').replaceWith(mermaidBlock);
});
} catch (err) {
displayError(el, err);
Expand Down
3 changes: 2 additions & 1 deletion web_src/js/modules/tippy.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export function createTippy(target, opts = {}) {
placement: target.getAttribute('data-placement') || 'top-start',
animation: false,
allowHTML: false,
hideOnClick: false,
interactiveBorder: 30,
ignoreAttributes: true,
maxWidth: 500, // increase over default 350px
Expand Down Expand Up @@ -46,7 +47,7 @@ export function showTemporaryTooltip(target, content) {
}

tippy.setContent(content);
tippy.show();
if (!tippy.state.isShown) tippy.show();
tippy.setProps({
onHidden: (tippy) => {
if (oldContent) {
Expand Down
6 changes: 4 additions & 2 deletions web_src/less/markup/codecopy.less
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.markup .code-block {
.markup .code-block,
.markup .mermaid-block {
position: relative;
}

Expand Down Expand Up @@ -26,7 +27,8 @@
background: var(--color-secondary-dark-1) !important;
}

.markup .code-block:hover .code-copy {
.markup .code-block:hover .code-copy,
.markup .mermaid-block:hover .code-copy {
visibility: visible;
animation: fadein .2s both;
}

0 comments on commit f5cd0d9

Please sign in to comment.