add copy button

just-the-docs · Sep 3, 2022 · f6a96f7 · f6a96f7
1 parent adbc25d
commit f6a96f7
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 17 deletions.
diff --git a/_includes/icons/code_copy.html b/_includes/icons/code_copy.html
@@ -0,0 +1,14 @@
+<symbol id="svg-copy" viewBox="0 0 16 16">
+  <title>Copy</title>
+  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
+    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
+    <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
+  </svg>
+</symbol>
+<symbol id="svg-copied" viewBox="0 0 16 16">
+  <title>Copied</title>
+  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
+    <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
+    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
+  </svg>
+</symbol>
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -39,6 +39,7 @@
       </svg>
     </symbol>
     {% include icons/external_link.html %}
+    {% include icons/code_copy.html %}
   </svg>
 
   <div class="side-bar">

diff --git a/_sass/code.scss b/_sass/code.scss
@@ -48,17 +48,62 @@ a:visited code {
 
 // ```[LANG]...```
 div.highlighter-rouge,
-div.listingblock {
-  padding: $sp-3;
+div.listingblock,
+figure.highlight {
   margin-top: 0;
   margin-bottom: $sp-3;
-  overflow-x: auto;
   background-color: $code-background-color;
   border-radius: $border-radius;
   box-shadow: none;
   -webkit-overflow-scrolling: touch;
+  position: relative;
+  padding: 0;
+
+  >button {
+    width: $sp-3;
+    height: $sp-3;
+    opacity: 0;
+    position: absolute;
+    top: 0;
+    right: 0;
+    border: $sp-3 solid $code-background-color;
+    background-color: $code-background-color;
+    outline: none;
+    color: $body-text-color;
+    box-sizing: content-box;
+
+    svg {
+      fill: $body-text-color;
+    }
+
+    &:active {
+      text-decoration: none;
+      outline: none;
+      opacity: 1;
+    }
+
+    &:focus {
+      opacity: 1;
+    }
+  }
+
+  &:hover {
+    >button {
+      opacity: 1;
+    }
+  }
+}
+
+div.highlighter-rouge,
+div.listingblock {
+
+  div.highlight {
+    overflow-x: auto;
+    padding: $sp-3;
+    margin: 0;
+    border: 0;
+  }
 
-  div.highlight,
   pre.highlight,
   code {
     padding: 0;
@@ -70,18 +115,11 @@ div.listingblock {
 // {% highlight LANG %}...{% endhighlight %},
 // {% highlight LANG linenos %}...{% endhighlight %}:
 figure.highlight {
-  padding: $sp-3;
-  margin-top: 0;
-  margin-bottom: $sp-3;
-  overflow-x: auto;
-  background-color: $code-background-color;
-  border-radius: $border-radius;
-  box-shadow: none;
-  -webkit-overflow-scrolling: touch;
 
   pre,
   code {
-    padding: 0;
+    overflow-x: auto;
+    padding: $sp-3;
     margin: 0;
     border: 0;
   }
@@ -126,9 +164,9 @@ figure.highlight {
   border: 1px solid $border-color;
   border-radius: $border-radius;
 
-  + .highlighter-rouge,
-  + .sectionbody .listingblock,
-  + figure.highlight {
+  +.highlighter-rouge,
+  +.sectionbody .listingblock,
+  +figure.highlight {
     position: relative;
     margin-top: -$sp-4;
     border-right: 1px solid $border-color;
@@ -146,4 +184,4 @@ code.language-mermaid {
   border: 0;
 }
 
-// {% endraw %}
+// {% endraw %}
diff --git a/assets/js/just-the-docs.js b/assets/js/just-the-docs.js
@@ -479,6 +479,38 @@ jtd.onReady(function(){
   scrollNav();
 });
 
+jtd.onReady(function(){
+  // Copy button on code
+
+  var codeBlocks = document.querySelectorAll('div.highlighter-rouge, div.listingblock, figure.highlight');
+
+  var svgCopied =  '<svg viewBox="0 0 24 24" class="copy-icon"><use xlink:href="#svg-copied"></use></svg>';
+  var svgCopy =  '<svg viewBox="0 0 24 24" class="copy-icon"><use xlink:href="#svg-copy"></use></svg>';
+
+  [...codeBlocks].forEach(codeBlock => {
+    var copyButton = document.createElement('button');
+    copyButton.type = 'button';
+    copyButton.ariaLabel = 'Copy code to clipboard';
+    copyButton.innerHTML = svgCopy;
+    codeBlock.append(copyButton);
+
+    copyButton.addEventListener('click', function () {
+      var code = codeBlock.querySelector('code').innerText.trim();
+      window.navigator.clipboard.writeText(code);
+
+      copyButton.innerHTML = svgCopied;
+      var fourSeconds = 4000;
+
+      setTimeout(function () {
+        copyButton.innerHTML = svgCopy;
+      }, fourSeconds);
+    });
+  });
+
+});
+
 })(window.jtd = window.jtd || {});
 
+
+
 {% include js/custom.js %}