Skip to content

The Unified and Autonomous Development Platform

feat: Enhance editable components with copy-to-clipboard functionality

Robin Shenb461004efbbe
diff --git a/server-core/src/main/java/io/onedev/server/web/component/beaneditmodal/BeanEditContentPanel.html b/server-core/src/main/java/io/onedev/server/web/component/beaneditmodal/BeanEditContentPanel.html
index 5732b5142c..908b705498 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/beaneditmodal/BeanEditContentPanel.html
+++ b/server-core/src/main/java/io/onedev/server/web/component/beaneditmodal/BeanEditContentPanel.html
@@ -5,7 +5,7 @@
<button wicket:id="close" type="button" class="close"><wicket:svg href="times" class="icon"/></button>
</div>
<div class="modal-body">
- <div wicket:id="description" class="alert alert-light alert-notice"></div>
+ <div wicket:id="description" class="alert alert-light alert-notice editable-description"></div>
<div wicket:id="feedback"></div>
<div wicket:id="editor"></div>
</div>
@@ -14,4 +14,4 @@
<button wicket:id="cancel" class="btn btn-secondary"><wicket:t>Cancel</wicket:t></button>
</div>
</form>
-</wicket:panel>
\ No newline at end of file
+</wicket:panel>
diff --git a/server-core/src/main/java/io/onedev/server/web/component/link/copytoclipboard/copy-to-clipboard.js b/server-core/src/main/java/io/onedev/server/web/component/link/copytoclipboard/copy-to-clipboard.js
index 7337a755a9..8a045a5c69 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/link/copytoclipboard/copy-to-clipboard.js
+++ b/server-core/src/main/java/io/onedev/server/web/component/link/copytoclipboard/copy-to-clipboard.js
@@ -13,7 +13,7 @@ onedev.server.copyToClipboard = {
var iconHref = $iconUse.attr("xlink:href");
var $icon = $iconUse.closest("svg");
var iconRotated = $icon.hasClass("rotate-45");
- var $modal = $button.closest(".modal-dialog");
+ var $modal = $button.closest(".modal");
if ($modal.length != 0)
options.container = $modal[0];
var clipboard = new ClipboardJS($button[0], options);
@@ -41,5 +41,98 @@ onedev.server.copyToClipboard = {
}, 1000);
});
$button.attr("data-tippy-content", tooltip);
+ },
+ initCodeSpans: function($container, tooltip, copiedTooltip) {
+ $container.find("code").addBack("code").each(function() {
+ var $code = $(this);
+ if ($code.closest("pre").length != 0 || $code.hasClass("code-span"))
+ return;
+
+ $code.addClass("code-span");
+ $code.attr("data-tippy-content", tooltip);
+
+ var dragStart = null;
+ var dragged = false;
+ $code.on("mousedown", function(e) {
+ dragStart = {x: e.clientX, y: e.clientY};
+ dragged = false;
+ }).on("mousemove", function(e) {
+ if (dragStart && (Math.abs(e.clientX - dragStart.x) > 4 || Math.abs(e.clientY - dragStart.y) > 4))
+ dragged = true;
+ }).on("click", function(e) {
+ if (dragged)
+ return;
+ var selection = window.getSelection();
+ if (selection && selection.toString().length > 0)
+ return;
+
+ e.preventDefault();
+ e.stopPropagation();
+
+ var text = $code.text();
+ var showCopied = function() {
+ $code.addClass("copied");
+ var tooltipInstance = $code[0]._tippy;
+ if (tooltipInstance) {
+ clearTimeout($code[0].copyFeedbackTimeout);
+ $code.off("mouseleave.copyFeedback");
+ tooltipInstance.enable();
+ tooltipInstance.setContent(copiedTooltip);
+ tooltipInstance.show();
+ $code[0].copyFeedbackTimeout = setTimeout(function() {
+ if (!tooltipInstance.state.isDestroyed) {
+ tooltipInstance.hide();
+ if ($code.is(":hover")) {
+ tooltipInstance.disable();
+ $code.one("mouseleave.copyFeedback", function() {
+ if (!tooltipInstance.state.isDestroyed) {
+ tooltipInstance.setContent(tooltip);
+ tooltipInstance.enable();
+ }
+ });
+ } else {
+ tooltipInstance.setContent(tooltip);
+ }
+ }
+ }, 1000);
+ }
+ setTimeout(function() {
+ $code.removeClass("copied");
+ }, 150);
+ };
+ var copyWithClipboardJs = function() {
+ var options = {
+ text: function() {
+ return text;
+ }
+ };
+ var $modal = $code.closest(".modal");
+ if ($modal.length != 0)
+ options.container = $modal[0];
+
+ var $triggerContainer = $modal.length != 0 ? $modal : $(document.body);
+ var $trigger = $("<button></button>").css({
+ position: "fixed",
+ left: "-9999px"
+ }).appendTo($triggerContainer);
+ var clipboard = new ClipboardJS($trigger[0], options);
+ clipboard.on("success", function() {
+ clipboard.destroy();
+ $trigger.remove();
+ showCopied();
+ });
+ clipboard.on("error", function() {
+ clipboard.destroy();
+ $trigger.remove();
+ });
+ $trigger[0].click();
+ };
+ if (navigator.clipboard && window.isSecureContext) {
+ navigator.clipboard.writeText(text).then(showCopied).catch(copyWithClipboardJs);
+ } else {
+ copyWithClipboardJs();
+ }
+ });
+ });
}
};
diff --git a/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js b/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js
index 6e0a37a1fa..e56b0f936b 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js
+++ b/server-core/src/main/java/io/onedev/server/web/component/markdown/markdown.js
@@ -1366,74 +1366,9 @@ onedev.server.markdown = {
}
});
- $rendered.find("code").each(function() {
- var $code = $(this);
- if ($code.closest("pre").length != 0)
- return;
-
- $code.addClass("code-span");
- $code.attr("data-tippy-content", onedev.server.markdown.translations["click-to-copy"]);
-
- var dragStart = null;
- var dragged = false;
- $code.on("mousedown", function(e) {
- dragStart = {x: e.clientX, y: e.clientY};
- dragged = false;
- }).on("mousemove", function(e) {
- if (dragStart && (Math.abs(e.clientX - dragStart.x) > 4 || Math.abs(e.clientY - dragStart.y) > 4))
- dragged = true;
- }).on("click", function(e) {
- if (dragged)
- return;
- var selection = window.getSelection();
- if (selection && selection.toString().length > 0)
- return;
-
- e.preventDefault();
- e.stopPropagation();
-
- var text = $code.text();
- var options = {
- text: function() {
- return text;
- }
- };
- var $modal = $code.closest(".modal-dialog");
- if ($modal.length != 0)
- options.container = $modal[0];
-
- var $trigger = $("<button></button>").css({
- position: "fixed",
- left: "-9999px"
- }).appendTo(document.body);
- var clipboard = new ClipboardJS($trigger[0], options);
- clipboard.on("success", function() {
- clipboard.destroy();
- $trigger.remove();
- $code.addClass("copied");
- var tooltipInstance = $code[0]._tippy;
- if (tooltipInstance) {
- clearTimeout($code[0].copyFeedbackTimeout);
- tooltipInstance.setContent(onedev.server.markdown.translations["copied"]);
- tooltipInstance.show();
- $code[0].copyFeedbackTimeout = setTimeout(function() {
- if (!tooltipInstance.state.isDestroyed) {
- tooltipInstance.hide();
- tooltipInstance.setContent(onedev.server.markdown.translations["click-to-copy"]);
- }
- }, 1000);
- }
- setTimeout(function() {
- $code.removeClass("copied");
- }, 150);
- });
- clipboard.on("error", function() {
- clipboard.destroy();
- $trigger.remove();
- });
- $trigger[0].click();
- });
- });
+ onedev.server.copyToClipboard.initCodeSpans($rendered,
+ onedev.server.markdown.translations["click-to-copy"],
+ onedev.server.markdown.translations["copied"]);
var $mermaid = $container.find(".mermaid");
if ($mermaid.length != 0)
diff --git a/server-core/src/main/java/io/onedev/server/web/component/polymorphiceditor/PolymorphicEditor.html b/server-core/src/main/java/io/onedev/server/web/component/polymorphiceditor/PolymorphicEditor.html
index 1821d4ce6d..8a9a029340 100644
--- a/server-core/src/main/java/io/onedev/server/web/component/polymorphiceditor/PolymorphicEditor.html
+++ b/server-core/src/main/java/io/onedev/server/web/component/polymorphiceditor/PolymorphicEditor.html
@@ -2,8 +2,8 @@
<div class="polymorphic">
<div wicket:id="typeSelectorContainer" class="type-selector">
<select wicket:id="typeSelector" class="form-control custom-select"></select>
- <div wicket:id="typeDescription" class="form-text text-muted"></div>
+ <div wicket:id="typeDescription" class="form-text text-muted editable-description"></div>
</div>
<div wicket:id="beanEditor"></div>
</div>
-</wicket:panel>
\ No newline at end of file
+</wicket:panel>
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.html b/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.html
index d278292047..969d7688ac 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.html
+++ b/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.html
@@ -11,9 +11,9 @@
</wicket:enclosure>
<div wicket:id="value" class="value"></div>
<div wicket:id="feedback"></div>
- <div wicket:id="description" class="text-muted form-text"></div>
+ <div wicket:id="description" class="text-muted form-text editable-description"></div>
</div>
</div>
</div>
<div class="disable-mask"></div>
-</wicket:panel>
\ No newline at end of file
+</wicket:panel>
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.java b/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.java
index d99ad00d83..3e11de403f 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.java
+++ b/server-core/src/main/java/io/onedev/server/web/editable/BeanEditor.java
@@ -31,6 +31,7 @@ import org.apache.wicket.util.convert.ConversionException;
import org.apache.wicket.util.visit.IVisit;
import org.apache.wicket.util.visit.IVisitor;
import org.unbescape.html.HtmlEscape;
+import org.unbescape.javascript.JavaScriptEscape;
import io.onedev.commons.loader.AppLoader;
import io.onedev.server.annotation.OmitName;
@@ -333,7 +334,9 @@ public class BeanEditor extends ValueEditor<Serializable> {
@Override
public void renderHead(IHeaderResponse response) {
super.renderHead(response);
- String script = String.format("onedev.server.editable.onBeanEditorDomReady('%s');", getMarkupId());
+ String script = String.format("onedev.server.editable.onBeanEditorDomReady('%s', '%s', '%s');",
+ getMarkupId(), JavaScriptEscape.escapeJavaScript(_T("Click to copy")),
+ JavaScriptEscape.escapeJavaScript(_T("Copied")));
response.render(OnDomReadyHeaderItem.forScript(script));
}
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/EditableResourceReference.java b/server-core/src/main/java/io/onedev/server/web/editable/EditableResourceReference.java
index 64ec15e686..5ea3481a3a 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/EditableResourceReference.java
+++ b/server-core/src/main/java/io/onedev/server/web/editable/EditableResourceReference.java
@@ -4,7 +4,9 @@ import java.util.List;
import org.apache.wicket.markup.head.CssHeaderItem;
import org.apache.wicket.markup.head.HeaderItem;
+import org.apache.wicket.markup.head.JavaScriptHeaderItem;
+import io.onedev.server.web.component.link.copytoclipboard.CopyToClipboardResourceReference;
import io.onedev.server.web.page.base.BaseDependentCssResourceReference;
import io.onedev.server.web.page.base.BaseDependentResourceReference;
@@ -19,6 +21,7 @@ public class EditableResourceReference extends BaseDependentResourceReference {
@Override
public List<HeaderItem> getDependencies() {
List<HeaderItem> dependencies = super.getDependencies();
+ dependencies.add(JavaScriptHeaderItem.forReference(new CopyToClipboardResourceReference()));
dependencies.add(CssHeaderItem.forReference(new BaseDependentCssResourceReference(
EditableResourceReference.class, "editable.css")));
return dependencies;
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/buildspec/param/instance/ParamMapEditPanel.html b/server-core/src/main/java/io/onedev/server/web/editable/buildspec/param/instance/ParamMapEditPanel.html
index 9199356382..2def31455a 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/buildspec/param/instance/ParamMapEditPanel.html
+++ b/server-core/src/main/java/io/onedev/server/web/editable/buildspec/param/instance/ParamMapEditPanel.html
@@ -8,7 +8,7 @@
<select wicket:id="valueProvider" class="form-control value-provider custom-select mb-3"></select>
<div wicket:id="value" class="value"></div>
<div wicket:id="feedback" class="feedback"></div>
- <p wicket:id="description" class="form-text text-muted"></p>
+ <p wicket:id="description" class="form-text text-muted editable-description"></p>
</div>
</div>
-</wicket:panel>
\ No newline at end of file
+</wicket:panel>
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/buildspec/param/instance/ParamMatrixEditPanel.html b/server-core/src/main/java/io/onedev/server/web/editable/buildspec/param/instance/ParamMatrixEditPanel.html
index 8f947e8de3..8718a0341d 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/buildspec/param/instance/ParamMatrixEditPanel.html
+++ b/server-core/src/main/java/io/onedev/server/web/editable/buildspec/param/instance/ParamMatrixEditPanel.html
@@ -8,7 +8,7 @@
<select wicket:id="valuesProvider" class="form-control values-provider custom-select mb-3"></select>
<div wicket:id="values" class="values"></div>
<div wicket:id="feedback" class="feedback"></div>
- <p wicket:id="description" class="form-text text-muted"></p>
+ <p wicket:id="description" class="form-text text-muted editable-description"></p>
</div>
</div>
<wicket:fragment wicket:id="specifiedValuesFrag">
@@ -22,4 +22,4 @@
<a wicket:id="add" class="btn btn-light btn-hover-primary btn-block mb-1" t:data-tippy-content="Add value"><wicket:svg href="plus" class="icon"></wicket:svg></a>
<div wicket:id="matrixDescription" class="text-muted font-size-sm"></div>
</wicket:fragment>
-</wicket:panel>
\ No newline at end of file
+</wicket:panel>
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/buildspec/step/StepEditContentPanel.html b/server-core/src/main/java/io/onedev/server/web/editable/buildspec/step/StepEditContentPanel.html
index 44c19133a9..3b5a5b312e 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/buildspec/step/StepEditContentPanel.html
+++ b/server-core/src/main/java/io/onedev/server/web/editable/buildspec/step/StepEditContentPanel.html
@@ -10,7 +10,7 @@
<button wicket:id="close" type="button" class="close"><wicket:svg href="times" class="icon"/></button>
</div>
<div class="modal-body">
- <div wicket:id="description" class="alert alert-light alert-notice"></div>
+ <div wicket:id="description" class="alert alert-light alert-notice editable-description"></div>
<div wicket:id="feedback"></div>
<div wicket:id="editor"></div>
</div>
@@ -19,4 +19,4 @@
<button wicket:id="cancel" class="btn btn-secondary"><wicket:t>Cancel</wicket:t></button>
</div>
</form>
-</wicket:panel>
\ No newline at end of file
+</wicket:panel>
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/editable.css b/server-core/src/main/java/io/onedev/server/web/editable/editable.css
index d3354bc720..5c958e69ec 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/editable.css
+++ b/server-core/src/main/java/io/onedev/server/web/editable/editable.css
@@ -160,6 +160,14 @@
margin: 0.8rem 0;
}
+.editable-description code.code-span {
+ cursor: pointer;
+}
+.editable-description code.code-span.copied {
+ background-color: var(--primary);
+ color: white;
+}
+
.property-editor .select2-container {
width: 100%;
}
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/editable.js b/server-core/src/main/java/io/onedev/server/web/editable/editable.js
index be1c6fe98a..e8443156d3 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/editable.js
+++ b/server-core/src/main/java/io/onedev/server/web/editable/editable.js
@@ -1,6 +1,10 @@
onedev.server.editable = {
- onBeanEditorDomReady: function(containerId) {
+ onBeanEditorDomReady: function(containerId, clickToCopy, copied) {
var $container = $("#" + containerId);
+ onedev.server.editable.codeCopyTranslations = {
+ clickToCopy: clickToCopy,
+ copied: copied
+ };
var $groups = $container.children(".group");
$groups.children("a").click(function() {
var $parent = $(this).parent();
@@ -17,6 +21,7 @@ onedev.server.editable = {
onedev.server.editable.checkGroup($group);
});
$container.find(".feedbackPanelERROR").parents(".group.bean-properties").addClass("expanded");
+ onedev.server.editable.initDescriptionCodeSpans($(document));
},
onBeanViewerDomReady: function(containerId) {
var $container = $("#" + containerId);
@@ -48,10 +53,19 @@ onedev.server.editable = {
else
$group.hide();
},
+ initDescriptionCodeSpans: function($container) {
+ var translations = onedev.server.editable.codeCopyTranslations;
+ if (translations) {
+ onedev.server.copyToClipboard.initCodeSpans(
+ $container.find(".editable-description").addBack(".editable-description"),
+ translations.clickToCopy, translations.copied);
+ }
+ }
};
$(document).on("afterElementReplace", function(event, componentId) {
var $component = $("#" + componentId);
var $group = $component.closest(".bean-properties.group");
if ($group.length != 0 && $group.children("a").length != 0)
onedev.server.editable.checkGroup($group);
-});
\ No newline at end of file
+ onedev.server.editable.initDescriptionCodeSpans($component);
+});
diff --git a/server-core/src/main/java/io/onedev/server/web/editable/issue/fieldinstance/FieldListEditPanel.html b/server-core/src/main/java/io/onedev/server/web/editable/issue/fieldinstance/FieldListEditPanel.html
index 4c0bce6fc4..7951a5d82c 100644
--- a/server-core/src/main/java/io/onedev/server/web/editable/issue/fieldinstance/FieldListEditPanel.html
+++ b/server-core/src/main/java/io/onedev/server/web/editable/issue/fieldinstance/FieldListEditPanel.html
@@ -8,7 +8,7 @@
<select wicket:id="valueProvider" class="form-control custom-select value-provider"></select>
<div wicket:id="value" class="value"></div>
<div wicket:id="feedback" class="feedback"></div>
- <p wicket:id="description" class="form-text text-muted"></p>
+ <p wicket:id="description" class="form-text text-muted editable-description"></p>
</div>
</div>
-</wicket:panel>
\ No newline at end of file
+</wicket:panel>