Refactor image diff (#31444)

And remove some jQuery functions

templates/repo/diff/image_diff.tmpl

@@ -7,7 +7,7 @@
 			data-mime-before="{{.sniffedTypeBase.GetMimeType}}"
 			data-mime-after="{{.sniffedTypeHead.GetMimeType}}"
 		>
-			<overflow-menu class="ui secondary pointing tabular top attached borderless menu">
+			<overflow-menu class="ui secondary pointing tabular menu custom">
 				<div class="overflow-menu-items tw-justify-center">
 					<a class="item active" data-tab="diff-side-by-side-{{.file.Index}}">{{ctx.Locale.Tr "repo.diff.image.side_by_side"}}</a>
 					{{if and .blobBase .blobHead}}

web_src/js/features/common-form.js

@@ -1,7 +1,9 @@
 import $ from 'jquery';
+import {initAreYouSure} from '../vendor/jquery.are-you-sure.js';
 import {handleGlobalEnterQuickSubmit} from './comp/QuickSubmit.js';
 
 export function initGlobalFormDirtyLeaveConfirm() {
+  initAreYouSure(window.jQuery);
   // Warn users that try to leave a page after entering data into a form.
   // Except on sign-in pages, and for forms marked as 'ignore-dirty'.
   if (!$('.user.signin').length) {

web_src/js/features/common-page.js

@@ -26,7 +26,7 @@ export function initFootLanguageMenu() {
   $('.language-menu a[lang]').on('click', linkLanguageAction);
 }
 
-export function initGlobalComponents() {
+export function initGlobalDropdown() {
   // Semantic UI modules.
   const $uiDropdowns = $('.ui.dropdown');
 
@@ -68,8 +68,10 @@ export function initGlobalComponents() {
   //   eg: the "Create New Repo" menu on the navbar.
   $uiDropdowns.filter('.upward').dropdown('setting', 'direction', 'upward');
   $uiDropdowns.filter('.downward').dropdown('setting', 'direction', 'downward');
+}
 
-  $('.ui.menu.tabular .item').tab({autoTabActivation: false});
+export function initGlobalTabularMenu() {
+  $('.ui.menu.tabular:not(.custom) .item').tab({autoTabActivation: false});
 }
 
 /**

web_src/js/features/imagediff.js

@@ -1,11 +1,11 @@
 import $ from 'jquery';
 import {GET} from '../modules/fetch.js';
-import {hideElem, loadElem, queryElemChildren} from '../utils/dom.js';
+import {hideElem, loadElem, queryElemChildren, queryElems} from '../utils/dom.js';
 import {parseDom} from '../utils.js';
 
 function getDefaultSvgBoundsIfUndefined(text, src) {
-  const DefaultSize = 300;
+  const defaultSize = 300;
-  const MaxSize = 99999;
+  const maxSize = 99999;
 
   const svgDoc = parseDom(text, 'image/svg+xml');
   const svg = svgDoc.documentElement;
@@ -17,7 +17,7 @@ function getDefaultSvgBoundsIfUndefined(text, src) {
   if (width.unitType === SVGLength.SVG_LENGTHTYPE_PERCENTAGE || height.unitType === SVGLength.SVG_LENGTHTYPE_PERCENTAGE) {
     const img = new Image();
     img.src = src;
-    if (img.width > 1 && img.width < MaxSize && img.height > 1 && img.height < MaxSize) {
+    if (img.width > 1 && img.width < maxSize && img.height > 1 && img.height < maxSize) {
       return {
         width: img.width,
         height: img.height,
@@ -26,13 +26,13 @@ function getDefaultSvgBoundsIfUndefined(text, src) {
     if (svg.hasAttribute('viewBox')) {
       const viewBox = svg.viewBox.baseVal;
       return {
-        width: DefaultSize,
+        width: defaultSize,
-        height: DefaultSize * viewBox.width / viewBox.height,
+        height: defaultSize * viewBox.width / viewBox.height,
       };
     }
     return {
-      width: DefaultSize,
+      width: defaultSize,
-      height: DefaultSize,
+      height: defaultSize,
     };
   }
   return null;
@@ -67,28 +67,31 @@ function createContext(imageAfter, imageBefore) {
   };
 }
 
-export function initImageDiff() {
+class ImageDiff {
-  $('.image-diff:not([data-image-diff-loaded])').each(async function() {
+  async init(containerEl) {
-    const $container = $(this);
+    this.containerEl = containerEl;
-    this.setAttribute('data-image-diff-loaded', 'true');
+    containerEl.setAttribute('data-image-diff-loaded', 'true');
+
+    // the only jQuery usage in this file
+    $(containerEl).find('.ui.menu.tabular .item').tab({autoTabActivation: false});
 
     // the container may be hidden by "viewed" checkbox, so use the parent's width for reference
-    const diffContainerWidth = Math.max($container.closest('.diff-file-box').width() - 300, 100);
+    this.diffContainerWidth = Math.max(containerEl.closest('.diff-file-box').clientWidth - 300, 100);
 
     const imageInfos = [{
-      path: this.getAttribute('data-path-after'),
+      path: containerEl.getAttribute('data-path-after'),
-      mime: this.getAttribute('data-mime-after'),
+      mime: containerEl.getAttribute('data-mime-after'),
-      $images: $container.find('img.image-after'), // matches 3 <img>
+      images: containerEl.querySelectorAll('img.image-after'), // matches 3 <img>
-      boundsInfo: this.querySelector('.bounds-info-after'),
+      boundsInfo: containerEl.querySelector('.bounds-info-after'),
     }, {
-      path: this.getAttribute('data-path-before'),
+      path: containerEl.getAttribute('data-path-before'),
-      mime: this.getAttribute('data-mime-before'),
+      mime: containerEl.getAttribute('data-mime-before'),
-      $images: $container.find('img.image-before'), // matches 3 <img>
+      images: containerEl.querySelectorAll('img.image-before'), // matches 3 <img>
-      boundsInfo: this.querySelector('.bounds-info-before'),
+      boundsInfo: containerEl.querySelector('.bounds-info-before'),
     }];
 
     await Promise.all(imageInfos.map(async (info) => {
-      const [success] = await Promise.all(Array.from(info.$images, (img) => {
+      const [success] = await Promise.all(Array.from(info.images, (img) => {
         return loadElem(img, info.path);
       }));
       // only the first images is associated with boundsInfo
@@ -98,41 +101,41 @@ export function initImageDiff() {
         const text = await resp.text();
         const bounds = getDefaultSvgBoundsIfUndefined(text, info.path);
         if (bounds) {
-          info.$images.each(function() {
+          for (const el of info.images) {
-            this.setAttribute('width', bounds.width);
+            el.setAttribute('width', bounds.width);
-            this.setAttribute('height', bounds.height);
+            el.setAttribute('height', bounds.height);
-          });
+          }
           hideElem(info.boundsInfo);
         }
       }
     }));
 
-    const $imagesAfter = imageInfos[0].$images;
+    const imagesAfter = imageInfos[0].images;
-    const $imagesBefore = imageInfos[1].$images;
+    const imagesBefore = imageInfos[1].images;
 
-    initSideBySide(this, createContext($imagesAfter[0], $imagesBefore[0]));
+    this.initSideBySide(createContext(imagesAfter[0], imagesBefore[0]));
-    if ($imagesAfter.length > 0 && $imagesBefore.length > 0) {
+    if (imagesAfter.length > 0 && imagesBefore.length > 0) {
-      initSwipe(createContext($imagesAfter[1], $imagesBefore[1]));
+      this.initSwipe(createContext(imagesAfter[1], imagesBefore[1]));
-      initOverlay(createContext($imagesAfter[2], $imagesBefore[2]));
+      this.initOverlay(createContext(imagesAfter[2], imagesBefore[2]));
+    }
+    queryElemChildren(containerEl, '.image-diff-tabs', (el) => el.classList.remove('is-loading'));
   }
 
-    queryElemChildren(this, '.image-diff-tabs', (el) => el.classList.remove('is-loading'));
+  initSideBySide(sizes) {
-
-    function initSideBySide(container, sizes) {
     let factor = 1;
-      if (sizes.maxSize.width > (diffContainerWidth - 24) / 2) {
+    if (sizes.maxSize.width > (this.diffContainerWidth - 24) / 2) {
-        factor = (diffContainerWidth - 24) / 2 / sizes.maxSize.width;
+      factor = (this.diffContainerWidth - 24) / 2 / sizes.maxSize.width;
     }
 
     const widthChanged = sizes.imageAfter && sizes.imageBefore && sizes.imageAfter.naturalWidth !== sizes.imageBefore.naturalWidth;
     const heightChanged = sizes.imageAfter && sizes.imageBefore && sizes.imageAfter.naturalHeight !== sizes.imageBefore.naturalHeight;
     if (sizes.imageAfter) {
-        const boundsInfoAfterWidth = container.querySelector('.bounds-info-after .bounds-info-width');
+      const boundsInfoAfterWidth = this.containerEl.querySelector('.bounds-info-after .bounds-info-width');
       if (boundsInfoAfterWidth) {
         boundsInfoAfterWidth.textContent = `${sizes.imageAfter.naturalWidth}px`;
         boundsInfoAfterWidth.classList.toggle('green', widthChanged);
       }
-        const boundsInfoAfterHeight = container.querySelector('.bounds-info-after .bounds-info-height');
+      const boundsInfoAfterHeight = this.containerEl.querySelector('.bounds-info-after .bounds-info-height');
       if (boundsInfoAfterHeight) {
         boundsInfoAfterHeight.textContent = `${sizes.imageAfter.naturalHeight}px`;
         boundsInfoAfterHeight.classList.toggle('green', heightChanged);
@@ -140,12 +143,12 @@ export function initImageDiff() {
     }
 
     if (sizes.imageBefore) {
-        const boundsInfoBeforeWidth = container.querySelector('.bounds-info-before .bounds-info-width');
+      const boundsInfoBeforeWidth = this.containerEl.querySelector('.bounds-info-before .bounds-info-width');
       if (boundsInfoBeforeWidth) {
         boundsInfoBeforeWidth.textContent = `${sizes.imageBefore.naturalWidth}px`;
         boundsInfoBeforeWidth.classList.toggle('red', widthChanged);
       }
-        const boundsInfoBeforeHeight = container.querySelector('.bounds-info-before .bounds-info-height');
+      const boundsInfoBeforeHeight = this.containerEl.querySelector('.bounds-info-before .bounds-info-height');
       if (boundsInfoBeforeHeight) {
         boundsInfoBeforeHeight.textContent = `${sizes.imageBefore.naturalHeight}px`;
         boundsInfoBeforeHeight.classList.add('red', heightChanged);
@@ -171,68 +174,71 @@ export function initImageDiff() {
     }
   }
 
-    function initSwipe(sizes) {
+  initSwipe(sizes) {
     let factor = 1;
-      if (sizes.maxSize.width > diffContainerWidth - 12) {
+    if (sizes.maxSize.width > this.diffContainerWidth - 12) {
-        factor = (diffContainerWidth - 12) / sizes.maxSize.width;
+      factor = (this.diffContainerWidth - 12) / sizes.maxSize.width;
     }
 
     if (sizes.imageAfter) {
-        const container = sizes.imageAfter.parentNode;
+      const imgParent = sizes.imageAfter.parentNode;
-        const swipeFrame = container.parentNode;
+      const swipeFrame = imgParent.parentNode;
       sizes.imageAfter.style.width = `${sizes.sizeAfter.width * factor}px`;
       sizes.imageAfter.style.height = `${sizes.sizeAfter.height * factor}px`;
-        container.style.margin = `0px ${sizes.ratio[0] * factor}px`;
+      imgParent.style.margin = `0px ${sizes.ratio[0] * factor}px`;
-        container.style.width = `${sizes.sizeAfter.width * factor + 2}px`;
+      imgParent.style.width = `${sizes.sizeAfter.width * factor + 2}px`;
-        container.style.height = `${sizes.sizeAfter.height * factor + 2}px`;
+      imgParent.style.height = `${sizes.sizeAfter.height * factor + 2}px`;
       swipeFrame.style.padding = `${sizes.ratio[1] * factor}px 0 0 0`;
       swipeFrame.style.width = `${sizes.maxSize.width * factor + 2}px`;
     }
 
     if (sizes.imageBefore) {
-        const container = sizes.imageBefore.parentNode;
+      const imgParent = sizes.imageBefore.parentNode;
-        const swipeFrame = container.parentNode;
+      const swipeFrame = imgParent.parentNode;
       sizes.imageBefore.style.width = `${sizes.sizeBefore.width * factor}px`;
       sizes.imageBefore.style.height = `${sizes.sizeBefore.height * factor}px`;
-        container.style.margin = `${sizes.ratio[3] * factor}px ${sizes.ratio[2] * factor}px`;
+      imgParent.style.margin = `${sizes.ratio[3] * factor}px ${sizes.ratio[2] * factor}px`;
-        container.style.width = `${sizes.sizeBefore.width * factor + 2}px`;
+      imgParent.style.width = `${sizes.sizeBefore.width * factor + 2}px`;
-        container.style.height = `${sizes.sizeBefore.height * factor + 2}px`;
+      imgParent.style.height = `${sizes.sizeBefore.height * factor + 2}px`;
       swipeFrame.style.width = `${sizes.maxSize.width * factor + 2}px`;
       swipeFrame.style.height = `${sizes.maxSize.height * factor + 2}px`;
     }
 
     // extra height for inner "position: absolute" elements
-      const swipe = $container.find('.diff-swipe')[0];
+    const swipe = this.containerEl.querySelector('.diff-swipe');
     if (swipe) {
       swipe.style.width = `${sizes.maxSize.width * factor + 2}px`;
       swipe.style.height = `${sizes.maxSize.height * factor + 30}px`;
     }
 
-      $container.find('.swipe-bar').on('mousedown', function(e) {
+    this.containerEl.querySelector('.swipe-bar').addEventListener('mousedown', (e) => {
       e.preventDefault();
-
+      this.initSwipeEventListeners(e.currentTarget);
-        const $swipeBar = $(this);
-        const $swipeFrame = $swipeBar.parent();
-        const width = $swipeFrame.width() - $swipeBar.width() - 2;
-
-        $(document).on('mousemove.diff-swipe', (e2) => {
-          e2.preventDefault();
-
-          const value = Math.max(0, Math.min(e2.clientX - $swipeFrame.offset().left, width));
-          $swipeBar[0].style.left = `${value}px`;
-          $container.find('.swipe-container')[0].style.width = `${$swipeFrame.width() - value}px`;
-
-          $(document).on('mouseup.diff-swipe', () => {
-            $(document).off('.diff-swipe');
-          });
-        });
     });
   }
 
-    function initOverlay(sizes) {
+  initSwipeEventListeners(swipeBar) {
+    const swipeFrame = swipeBar.parentNode;
+    const width = swipeFrame.clientWidth;
+    const onSwipeMouseMove = (e) => {
+      e.preventDefault();
+      const rect = swipeFrame.getBoundingClientRect();
+      const value = Math.max(0, Math.min(e.clientX - rect.left, width));
+      swipeBar.style.left = `${value}px`;
+      this.containerEl.querySelector('.swipe-container').style.width = `${swipeFrame.clientWidth - value}px`;
+    };
+    const removeEventListeners = () => {
+      document.removeEventListener('mousemove', onSwipeMouseMove);
+      document.removeEventListener('mouseup', removeEventListeners);
+    };
+    document.addEventListener('mousemove', onSwipeMouseMove);
+    document.addEventListener('mouseup', removeEventListeners);
+  }
+
+  initOverlay(sizes) {
     let factor = 1;
-      if (sizes.maxSize.width > diffContainerWidth - 12) {
+    if (sizes.maxSize.width > this.diffContainerWidth - 12) {
-        factor = (diffContainerWidth - 12) / sizes.maxSize.width;
+      factor = (this.diffContainerWidth - 12) / sizes.maxSize.width;
     }
 
     if (sizes.imageAfter) {
@@ -258,14 +264,21 @@ export function initImageDiff() {
       overlayFrame.style.height = `${sizes.maxSize.height * factor + 2}px`;
     }
 
-      const rangeInput = $container[0].querySelector('input[type="range"]');
+    const rangeInput = this.containerEl.querySelector('input[type="range"]');
+
     function updateOpacity() {
       if (sizes.imageAfter) {
         sizes.imageAfter.parentNode.style.opacity = `${rangeInput.value / 100}`;
       }
     }
+
     rangeInput?.addEventListener('input', updateOpacity);
     updateOpacity();
   }
-  });
+}
+
+export function initImageDiff() {
+  for (const el of queryElems('.image-diff:not([data-image-diff-loaded])')) {
+    (new ImageDiff()).init(el); // it is async, but we don't need to await for it
+  }
 }

web_src/js/index.js

@@ -79,7 +79,12 @@ import {initRepositorySearch} from './features/repo-search.js';
 import {initColorPickers} from './features/colorpicker.js';
 import {initAdminSelfCheck} from './features/admin/selfcheck.js';
 import {initGlobalFetchAction} from './features/common-fetch-action.js';
-import {initFootLanguageMenu, initGlobalComponents, initHeadNavbarContentToggle} from './features/common-page.js';
+import {
+  initFootLanguageMenu,
+  initGlobalDropdown,
+  initGlobalTabularMenu,
+  initHeadNavbarContentToggle,
+} from './features/common-page.js';
 import {
   initGlobalButtonClickOnEnter,
   initGlobalButtons,
@@ -95,7 +100,8 @@ initDirAuto();
 initSubmitEventPolyfill();
 
 onDomReady(() => {
-  initGlobalComponents();
+  initGlobalDropdown();
+  initGlobalTabularMenu();
   initGlobalShowModal();
   initGlobalFetchAction();
   initGlobalTooltips();

web_src/js/vendor/jquery.are-you-sure.js

@@ -1,5 +1,6 @@
-// Fork of the upstream module. The only changes are the addition of `const` on
+// Fork of the upstream module. The only changes are:
-// lines 93 and 161 to make it strict mode compatible.
+// * use export to make it work with ES6 modules.
+// * the addition of `const` to make it strict mode compatible.
 
 /*!
  * jQuery Plugin: Are-You-Sure (Dirty Form Detection)
@@ -13,7 +14,7 @@
  * Version: 1.9.0
  * Date:    13th August 2014
  */
-(function($) {
+export function initAreYouSure($) {
 
   $.fn.areYouSure = function(options) {
 
@@ -192,4 +193,4 @@
       initForm($form);
     });
   };
-})(jQuery);
+}