katalyst-tables 2.2.12 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea4e17cca2f486696e4cc5b8bff2bc6b06aeb33e131f0774f881b324964eae90
-  data.tar.gz: 5bc402aef25bee8f49418225d603f36246565622749f1fa6d06d922f341f6348
+  metadata.gz: 16f4a66ac1715abeba201402eedf3c19f27dbd0c53291b841164ad79f085ec77
+  data.tar.gz: 80aad00ee67b5d3d760a7b47ba3ffc735d704d49edb4e42942197c4d93ff8eea
 SHA512:
-  metadata.gz: d87f264fb30eab8e5a9f43b1a85464f5b0fc32f499e11bc64acc745a804dda081ed58e3eb368b1a50b4e01eeb28b6ace4e9b550a86fb0addb2cf4fb0a61aa38d
-  data.tar.gz: 3afaa276a44921bdb7a5b62d60701d77c71da24741a651b0fe3b89c36a2fc059b037fe1c5859680f6be43c0bb324fe4e9924067b2d0c2b58cffcad1c1b7b585a
+  metadata.gz: 6713a3de4a8ee62071f3c34e1557691add7b02428eee13f994b107261571de84b6be57b9f1c7c997ab6bd87a23a4fecf68dfd52b311a412e26399b099fac4c0e
+  data.tar.gz: 7fdd72501c7f780181fc2d3a0d182fd989c57a4aa4a4418a90a599c64fbc2bf1c960b27ebb8ce90ae9fdbdb9184c3020976d0f2b7cffbf9f19b5e704341e936c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [2.3.0]
+
+- Remove support for Ruby < 3.0 (no longer used at Katalyst)
+
 ## [2.2.0]
 
 - Add support for ordinal columns with batch updating

data/README.md

@@ -14,6 +14,16 @@ And then execute:
 
     $ bundle install
 
+Add the Gem's javascript and CSS to your build pipeline. This assumes that
+you're using `rails-dartsass` and `importmaps` to manage your assets.
+
+```javascript
+// app/javascript/controllers/application.js
+import { application } from "controllers/application";
+import tables from "@katalyst/tables";
+application.load(tables);
+```
+
 ## Usage
 
 This gem provides entry points for backend and frontend concerns:

data/app/assets/builds/katalyst/tables.esm.js

@@ -0,0 +1,496 @@
+import { Controller } from '@hotwired/stimulus';
+import { Turbo } from '@hotwired/turbo-rails';
+
+class TurboCollectionController extends Controller {
+  static values = {
+    query: String,
+    sort: String,
+  };
+
+  queryValueChanged(query) {
+    Turbo.navigator.history.replace(this.#url(query));
+  }
+
+  sortValueChanged(sort) {
+    document.querySelectorAll(this.#sortSelector).forEach((input) => {
+      if (input) input.value = sort;
+    });
+  }
+
+  get #sortSelector() {
+    return "input[name='sort']";
+  }
+
+  #url(query) {
+    const frame = this.element.closest("turbo-frame");
+    let url;
+
+    if (frame) {
+      url = new URL(frame.baseURI);
+    } else {
+      url = new URL(window.location.href);
+    }
+
+    url.search = query;
+
+    return url;
+  }
+}
+
+class OrderableRowController extends Controller {
+  static values = {
+    params: Object,
+  };
+
+  connect() {
+    // index from server may be inconsistent with the visual ordering,
+    // especially if this is a new node. Use positional indexes instead,
+    // as these are the values we will send on save.
+    this.index = domIndex(this.row);
+  }
+
+  paramsValueChanged(params) {
+    this.id = params.id_value;
+  }
+
+  dragUpdate(offset) {
+    this.dragOffset = offset;
+    this.row.style.position = "relative";
+    this.row.style.top = offset + "px";
+    this.row.style.zIndex = "1";
+    this.row.toggleAttribute("dragging", true);
+  }
+
+  /**
+   * Called on items that are not the dragged item during drag. Updates the
+   * visual position of the item relative to the dragged item.
+   *
+   * @param index {number} intended index of the item during drag
+   */
+  updateVisually(index) {
+    this.row.style.position = "relative";
+    this.row.style.top = `${
+      this.row.offsetHeight * (index - this.dragIndex)
+    }px`;
+  }
+
+  /**
+   * Set the index value of the item. This is called on all items after a drop
+   * event. If the index is different to the params index then this item has
+   * changed.
+   *
+   * @param index {number} the new index value
+   */
+  updateIndex(index) {
+    this.index = index;
+  }
+
+  /**
+   * Restore any visual changes made during drag and remove the drag state.
+   */
+  reset() {
+    delete this.dragOffset;
+    this.row.removeAttribute("style");
+    this.row.removeAttribute("dragging");
+  }
+
+  /**
+   * @returns {boolean} true when the item has a change to its index value
+   */
+  get hasChanges() {
+    return this.paramsValue.index_value !== this.index;
+  }
+
+  /**
+   * Calculate the relative index of the item during drag. This is used to
+   * sort items during drag as it takes into account any uncommitted changes
+   * to index caused by the drag offset.
+   *
+   * @returns {number} index for the purposes of drag and drop ordering
+   */
+  get dragIndex() {
+    if (this.dragOffset && this.dragOffset !== 0) {
+      return this.index + Math.round(this.dragOffset / this.row.offsetHeight);
+    } else {
+      return this.index;
+    }
+  }
+
+  /**
+   * Index value for use in comparisons during drag. This is used to determine
+   * whether the dragged item is above or below another item. If this item is
+   * being dragged then we offset the index by 0.5 to ensure that it jumps up
+   * or down when it reaches the midpoint of the item above or below it.
+   *
+   * @returns {number}
+   */
+  get comparisonIndex() {
+    if (this.dragOffset) {
+      return this.dragIndex + (this.dragOffset > 0 ? 0.5 : -0.5);
+    } else {
+      return this.index;
+    }
+  }
+
+  /**
+   * The containing row element.
+   *
+   * @returns {HTMLElement}
+   */
+  get row() {
+    return this.element.parentElement;
+  }
+}
+
+function domIndex(element) {
+  return Array.from(element.parentElement.children).indexOf(element);
+}
+
+class OrderableListController extends Controller {
+  static outlets = ["tables--orderable--item", "tables--orderable--form"];
+
+  //region State transitions
+
+  startDragging(dragState) {
+    this.dragState = dragState;
+
+    document.addEventListener("mousemove", this.mousemove);
+    document.addEventListener("mouseup", this.mouseup);
+    window.addEventListener("scroll", this.scroll, true);
+
+    this.element.style.position = "relative";
+  }
+
+  stopDragging() {
+    const dragState = this.dragState;
+    delete this.dragState;
+
+    document.removeEventListener("mousemove", this.mousemove);
+    document.removeEventListener("mouseup", this.mouseup);
+    window.removeEventListener("scroll", this.scroll, true);
+
+    this.element.removeAttribute("style");
+    this.tablesOrderableItemOutlets.forEach((item) => item.reset());
+
+    return dragState;
+  }
+
+  drop() {
+    // note: early returns guard against turbo updates that prevent us finding
+    // the right item to drop on. In this situation it's better to discard the
+    // drop than to drop in the wrong place.
+
+    const dragItem = this.dragItem;
+
+    if (!dragItem) return;
+
+    const newIndex = dragItem.dragIndex;
+    const targetItem = this.tablesOrderableItemOutlets[newIndex];
+
+    if (!targetItem) return;
+
+    // swap the dragged item into the correct position for its current offset
+    if (newIndex < dragItem.index) {
+      targetItem.row.insertAdjacentElement("beforebegin", dragItem.row);
+    } else if (newIndex > dragItem.index) {
+      targetItem.row.insertAdjacentElement("afterend", dragItem.row);
+    }
+
+    // reindex all items based on their new positions
+    this.tablesOrderableItemOutlets.forEach((item, index) =>
+      item.updateIndex(index)
+    );
+
+    // save the changes
+    this.commitChanges();
+  }
+
+  commitChanges() {
+    // clear any existing inputs to prevent duplicates
+    this.tablesOrderableFormOutlet.clear();
+
+    // insert any items that have changed position
+    this.tablesOrderableItemOutlets.forEach((item) => {
+      if (item.hasChanges) this.tablesOrderableFormOutlet.add(item);
+    });
+
+    this.tablesOrderableFormOutlet.submit();
+  }
+
+  //endregion
+
+  //region Events
+
+  mousedown(event) {
+    if (this.isDragging) return;
+
+    const target = this.#targetItem(event.target);
+
+    if (!target) return;
+
+    event.preventDefault(); // prevent built-in drag
+
+    this.startDragging(new DragState(this.element, event, target.id));
+
+    this.dragState.updateCursor(this.element, target.row, event, this.animate);
+  }
+
+  mousemove = (event) => {
+    if (!this.isDragging) return;
+
+    event.preventDefault(); // prevent build-in drag
+
+    if (this.ticking) return;
+
+    this.ticking = true;
+
+    window.requestAnimationFrame(() => {
+      this.ticking = false;
+      this.dragState.updateCursor(
+        this.element,
+        this.dragItem.row,
+        event,
+        this.animate
+      );
+    });
+  };
+
+  scroll = (event) => {
+    if (!this.isDragging || this.ticking) return;
+
+    this.ticking = true;
+
+    window.requestAnimationFrame(() => {
+      this.ticking = false;
+      this.dragState.updateScroll(
+        this.element,
+        this.dragItem.row,
+        this.animate
+      );
+    });
+  };
+
+  mouseup = (event) => {
+    if (!this.isDragging) return;
+
+    this.drop();
+    this.stopDragging();
+    this.tablesOrderableFormOutlets.forEach((form) => delete form.dragState);
+  };
+
+  tablesOrderableFormOutletConnected(form, element) {
+    if (form.dragState) {
+      // restore the previous controller's state
+      this.startDragging(form.dragState);
+    }
+  }
+
+  tablesOrderableFormOutletDisconnected(form, element) {
+    if (this.isDragging) {
+      // cache drag state in the form
+      form.dragState = this.stopDragging();
+    }
+  }
+
+  //endregion
+
+  //region Helpers
+
+  /**
+   * Updates the position of the drag item with a relative offset. Updates
+   * other items relative to the new position of the drag item, as required.
+   *
+   * @callback {OrderableListController~animate}
+   * @param {number} offset
+   */
+  animate = (offset) => {
+    const dragItem = this.dragItem;
+
+    // Visually update the dragItem so it follows the cursor
+    dragItem.dragUpdate(offset);
+
+    // Visually updates the position of all items in the list relative to the
+    // dragged item. No actual changes to orderings at this stage.
+    this.#currentItems.forEach((item, index) => {
+      if (item === dragItem) return;
+      item.updateVisually(index);
+    });
+  };
+
+  get isDragging() {
+    return !!this.dragState;
+  }
+
+  get dragItem() {
+    if (!this.isDragging) return null;
+
+    return this.tablesOrderableItemOutlets.find(
+      (item) => item.id === this.dragState.targetId
+    );
+  }
+
+  /**
+   * Returns the current items in the list, sorted by their current index.
+   * Current uses the drag index if the item is being dragged, if set.
+   *
+   * @returns {Array[OrderableRowController]}
+   */
+  get #currentItems() {
+    return this.tablesOrderableItemOutlets.toSorted(
+      (a, b) => a.comparisonIndex - b.comparisonIndex
+    );
+  }
+
+  /**
+   * Returns the item outlet that was clicked on, if any.
+   *
+   * @param element {HTMLElement} the clicked ordinal cell
+   * @returns {OrderableRowController}
+   */
+  #targetItem(element) {
+    return this.tablesOrderableItemOutlets.find(
+      (item) => item.element === element
+    );
+  }
+
+  //endregion
+}
+
+/**
+ * During drag we want to be able to translate a document-relative coordinate
+ * into a coordinate relative to the list element. This state object calculates
+ * and stores internal state so that we can translate absolute page coordinates
+ * from mouse events into relative offsets for the list items within the list
+ * element.
+ *
+ * We also keep track of the drag target so that if the controller is attached
+ * to a new element during the drag we can continue after the turbo update.
+ */
+class DragState {
+  /**
+   * @param list {HTMLElement} the list controller's element (tbody)
+   * @param event {MouseEvent} the initial event
+   * @param id {String} the id of the element being dragged
+   */
+  constructor(list, event, id) {
+    // cursor offset is the offset of the cursor relative to the drag item
+    this.cursorOffset = event.offsetY;
+
+    // initial offset is the offset position of the drag item at drag start
+    this.initialPosition = event.target.offsetTop - list.offsetTop;
+
+    // id of the item being dragged
+    this.targetId = id;
+  }
+
+  /**
+   * Calculates the offset of the drag item relative to its initial position.
+   *
+   * @param list {HTMLElement} the list controller's element (tbody)
+   * @param row {HTMLElement} the row being dragged
+   * @param event {MouseEvent} the current event
+   * @param callback {OrderableListController~animate} updates the drag item with a relative offset
+   */
+  updateCursor(list, row, event, callback) {
+    // Calculate and store the list offset relative to the viewport
+    // This value is cached so we can calculate the outcome of any scroll events
+    this.listOffset = list.getBoundingClientRect().top;
+
+    // Calculate the position of the cursor relative to the list.
+    // Accounts for scroll offsets by using the item's bounding client rect.
+    const cursorPosition = event.clientY - this.listOffset;
+
+    // intended item position relative to the list, from cursor position
+    let itemPosition = cursorPosition - this.cursorOffset;
+
+    this.#updateItemPosition(list, row, itemPosition, callback);
+  }
+
+  /**
+   * Animates the item's position as the list scrolls. Requires a previous call
+   * to set the scroll offset.
+   *
+   * @param list {HTMLElement} the list controller's element (tbody)
+   * @param row {HTMLElement} the row being dragged
+   * @param callback {OrderableListController~animate} updates the drag item with a relative offset
+   */
+  updateScroll(list, row, callback) {
+    const previousScrollOffset = this.listOffset;
+
+    // Calculate and store the list offset relative to the viewport
+    // This value is cached so we can calculate the outcome of any scroll events
+    this.listOffset = list.getBoundingClientRect().top;
+
+    // Calculate the change in scroll offset since the last update
+    const scrollDelta = previousScrollOffset - this.listOffset;
+
+    // intended item position relative to the list, from cursor position
+    const position = this.position + scrollDelta;
+
+    this.#updateItemPosition(list, row, position, callback);
+  }
+
+  #updateItemPosition(list, row, position, callback) {
+    // ensure itemPosition is within the bounds of the list (tbody)
+    position = Math.max(position, 0);
+    position = Math.min(position, list.offsetHeight - row.offsetHeight);
+
+    // cache the item's position relative to the list for use in scroll events
+    this.position = position;
+
+    // Item has position: relative, so we want to calculate the amount to move
+    // the item relative to it's DOM position to represent how much it has been
+    // dragged by.
+    const offset = position - this.initialPosition;
+
+    // Convert itemPosition from offset relative to list to offset relative to
+    // its position within the DOM (if it hadn't moved).
+    callback(offset);
+  }
+}
+
+class OrderableFormController extends Controller {
+  add(item) {
+    const { id_name, id_value, index_name } = item.paramsValue;
+    this.element.insertAdjacentHTML(
+      "beforeend",
+      `<input type="hidden" name="${id_name}" value="${id_value}" data-generated>
+              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`
+    );
+  }
+
+  submit() {
+    if (this.inputs.length === 0) return;
+
+    this.element.requestSubmit();
+  }
+
+  clear() {
+    this.inputs.forEach((input) => input.remove());
+  }
+
+  get inputs() {
+    return this.element.querySelectorAll("input[data-generated]");
+  }
+}
+
+const Definitions = [
+  {
+    identifier: "tables--turbo--collection",
+    controllerConstructor: TurboCollectionController,
+  },
+  {
+    identifier: "tables--orderable--item",
+    controllerConstructor: OrderableRowController,
+  },
+  {
+    identifier: "tables--orderable--list",
+    controllerConstructor: OrderableListController,
+  },
+  {
+    identifier: "tables--orderable--form",
+    controllerConstructor: OrderableFormController,
+  },
+];
+
+export { Definitions as default };

data/app/assets/builds/katalyst/tables.js

@@ -0,0 +1,496 @@
+import { Controller } from '@hotwired/stimulus';
+import { Turbo } from '@hotwired/turbo-rails';
+
+class TurboCollectionController extends Controller {
+  static values = {
+    query: String,
+    sort: String,
+  };
+
+  queryValueChanged(query) {
+    Turbo.navigator.history.replace(this.#url(query));
+  }
+
+  sortValueChanged(sort) {
+    document.querySelectorAll(this.#sortSelector).forEach((input) => {
+      if (input) input.value = sort;
+    });
+  }
+
+  get #sortSelector() {
+    return "input[name='sort']";
+  }
+
+  #url(query) {
+    const frame = this.element.closest("turbo-frame");
+    let url;
+
+    if (frame) {
+      url = new URL(frame.baseURI);
+    } else {
+      url = new URL(window.location.href);
+    }
+
+    url.search = query;
+
+    return url;
+  }
+}
+
+class OrderableRowController extends Controller {
+  static values = {
+    params: Object,
+  };
+
+  connect() {
+    // index from server may be inconsistent with the visual ordering,
+    // especially if this is a new node. Use positional indexes instead,
+    // as these are the values we will send on save.
+    this.index = domIndex(this.row);
+  }
+
+  paramsValueChanged(params) {
+    this.id = params.id_value;
+  }
+
+  dragUpdate(offset) {
+    this.dragOffset = offset;
+    this.row.style.position = "relative";
+    this.row.style.top = offset + "px";
+    this.row.style.zIndex = "1";
+    this.row.toggleAttribute("dragging", true);
+  }
+
+  /**
+   * Called on items that are not the dragged item during drag. Updates the
+   * visual position of the item relative to the dragged item.
+   *
+   * @param index {number} intended index of the item during drag
+   */
+  updateVisually(index) {
+    this.row.style.position = "relative";
+    this.row.style.top = `${
+      this.row.offsetHeight * (index - this.dragIndex)
+    }px`;
+  }
+
+  /**
+   * Set the index value of the item. This is called on all items after a drop
+   * event. If the index is different to the params index then this item has
+   * changed.
+   *
+   * @param index {number} the new index value
+   */
+  updateIndex(index) {
+    this.index = index;
+  }
+
+  /**
+   * Restore any visual changes made during drag and remove the drag state.
+   */
+  reset() {
+    delete this.dragOffset;
+    this.row.removeAttribute("style");
+    this.row.removeAttribute("dragging");
+  }
+
+  /**
+   * @returns {boolean} true when the item has a change to its index value
+   */
+  get hasChanges() {
+    return this.paramsValue.index_value !== this.index;
+  }
+
+  /**
+   * Calculate the relative index of the item during drag. This is used to
+   * sort items during drag as it takes into account any uncommitted changes
+   * to index caused by the drag offset.
+   *
+   * @returns {number} index for the purposes of drag and drop ordering
+   */
+  get dragIndex() {
+    if (this.dragOffset && this.dragOffset !== 0) {
+      return this.index + Math.round(this.dragOffset / this.row.offsetHeight);
+    } else {
+      return this.index;
+    }
+  }
+
+  /**
+   * Index value for use in comparisons during drag. This is used to determine
+   * whether the dragged item is above or below another item. If this item is
+   * being dragged then we offset the index by 0.5 to ensure that it jumps up
+   * or down when it reaches the midpoint of the item above or below it.
+   *
+   * @returns {number}
+   */
+  get comparisonIndex() {
+    if (this.dragOffset) {
+      return this.dragIndex + (this.dragOffset > 0 ? 0.5 : -0.5);
+    } else {
+      return this.index;
+    }
+  }
+
+  /**
+   * The containing row element.
+   *
+   * @returns {HTMLElement}
+   */
+  get row() {
+    return this.element.parentElement;
+  }
+}
+
+function domIndex(element) {
+  return Array.from(element.parentElement.children).indexOf(element);
+}
+
+class OrderableListController extends Controller {
+  static outlets = ["tables--orderable--item", "tables--orderable--form"];
+
+  //region State transitions
+
+  startDragging(dragState) {
+    this.dragState = dragState;
+
+    document.addEventListener("mousemove", this.mousemove);
+    document.addEventListener("mouseup", this.mouseup);
+    window.addEventListener("scroll", this.scroll, true);
+
+    this.element.style.position = "relative";
+  }
+
+  stopDragging() {
+    const dragState = this.dragState;
+    delete this.dragState;
+
+    document.removeEventListener("mousemove", this.mousemove);
+    document.removeEventListener("mouseup", this.mouseup);
+    window.removeEventListener("scroll", this.scroll, true);
+
+    this.element.removeAttribute("style");
+    this.tablesOrderableItemOutlets.forEach((item) => item.reset());
+
+    return dragState;
+  }
+
+  drop() {
+    // note: early returns guard against turbo updates that prevent us finding
+    // the right item to drop on. In this situation it's better to discard the
+    // drop than to drop in the wrong place.
+
+    const dragItem = this.dragItem;
+
+    if (!dragItem) return;
+
+    const newIndex = dragItem.dragIndex;
+    const targetItem = this.tablesOrderableItemOutlets[newIndex];
+
+    if (!targetItem) return;
+
+    // swap the dragged item into the correct position for its current offset
+    if (newIndex < dragItem.index) {
+      targetItem.row.insertAdjacentElement("beforebegin", dragItem.row);
+    } else if (newIndex > dragItem.index) {
+      targetItem.row.insertAdjacentElement("afterend", dragItem.row);
+    }
+
+    // reindex all items based on their new positions
+    this.tablesOrderableItemOutlets.forEach((item, index) =>
+      item.updateIndex(index)
+    );
+
+    // save the changes
+    this.commitChanges();
+  }
+
+  commitChanges() {
+    // clear any existing inputs to prevent duplicates
+    this.tablesOrderableFormOutlet.clear();
+
+    // insert any items that have changed position
+    this.tablesOrderableItemOutlets.forEach((item) => {
+      if (item.hasChanges) this.tablesOrderableFormOutlet.add(item);
+    });
+
+    this.tablesOrderableFormOutlet.submit();
+  }
+
+  //endregion
+
+  //region Events
+
+  mousedown(event) {
+    if (this.isDragging) return;
+
+    const target = this.#targetItem(event.target);
+
+    if (!target) return;
+
+    event.preventDefault(); // prevent built-in drag
+
+    this.startDragging(new DragState(this.element, event, target.id));
+
+    this.dragState.updateCursor(this.element, target.row, event, this.animate);
+  }
+
+  mousemove = (event) => {
+    if (!this.isDragging) return;
+
+    event.preventDefault(); // prevent build-in drag
+
+    if (this.ticking) return;
+
+    this.ticking = true;
+
+    window.requestAnimationFrame(() => {
+      this.ticking = false;
+      this.dragState.updateCursor(
+        this.element,
+        this.dragItem.row,
+        event,
+        this.animate
+      );
+    });
+  };
+
+  scroll = (event) => {
+    if (!this.isDragging || this.ticking) return;
+
+    this.ticking = true;
+
+    window.requestAnimationFrame(() => {
+      this.ticking = false;
+      this.dragState.updateScroll(
+        this.element,
+        this.dragItem.row,
+        this.animate
+      );
+    });
+  };
+
+  mouseup = (event) => {
+    if (!this.isDragging) return;
+
+    this.drop();
+    this.stopDragging();
+    this.tablesOrderableFormOutlets.forEach((form) => delete form.dragState);
+  };
+
+  tablesOrderableFormOutletConnected(form, element) {
+    if (form.dragState) {
+      // restore the previous controller's state
+      this.startDragging(form.dragState);
+    }
+  }
+
+  tablesOrderableFormOutletDisconnected(form, element) {
+    if (this.isDragging) {
+      // cache drag state in the form
+      form.dragState = this.stopDragging();
+    }
+  }
+
+  //endregion
+
+  //region Helpers
+
+  /**
+   * Updates the position of the drag item with a relative offset. Updates
+   * other items relative to the new position of the drag item, as required.
+   *
+   * @callback {OrderableListController~animate}
+   * @param {number} offset
+   */
+  animate = (offset) => {
+    const dragItem = this.dragItem;
+
+    // Visually update the dragItem so it follows the cursor
+    dragItem.dragUpdate(offset);
+
+    // Visually updates the position of all items in the list relative to the
+    // dragged item. No actual changes to orderings at this stage.
+    this.#currentItems.forEach((item, index) => {
+      if (item === dragItem) return;
+      item.updateVisually(index);
+    });
+  };
+
+  get isDragging() {
+    return !!this.dragState;
+  }
+
+  get dragItem() {
+    if (!this.isDragging) return null;
+
+    return this.tablesOrderableItemOutlets.find(
+      (item) => item.id === this.dragState.targetId
+    );
+  }
+
+  /**
+   * Returns the current items in the list, sorted by their current index.
+   * Current uses the drag index if the item is being dragged, if set.
+   *
+   * @returns {Array[OrderableRowController]}
+   */
+  get #currentItems() {
+    return this.tablesOrderableItemOutlets.toSorted(
+      (a, b) => a.comparisonIndex - b.comparisonIndex
+    );
+  }
+
+  /**
+   * Returns the item outlet that was clicked on, if any.
+   *
+   * @param element {HTMLElement} the clicked ordinal cell
+   * @returns {OrderableRowController}
+   */
+  #targetItem(element) {
+    return this.tablesOrderableItemOutlets.find(
+      (item) => item.element === element
+    );
+  }
+
+  //endregion
+}
+
+/**
+ * During drag we want to be able to translate a document-relative coordinate
+ * into a coordinate relative to the list element. This state object calculates
+ * and stores internal state so that we can translate absolute page coordinates
+ * from mouse events into relative offsets for the list items within the list
+ * element.
+ *
+ * We also keep track of the drag target so that if the controller is attached
+ * to a new element during the drag we can continue after the turbo update.
+ */
+class DragState {
+  /**
+   * @param list {HTMLElement} the list controller's element (tbody)
+   * @param event {MouseEvent} the initial event
+   * @param id {String} the id of the element being dragged
+   */
+  constructor(list, event, id) {
+    // cursor offset is the offset of the cursor relative to the drag item
+    this.cursorOffset = event.offsetY;
+
+    // initial offset is the offset position of the drag item at drag start
+    this.initialPosition = event.target.offsetTop - list.offsetTop;
+
+    // id of the item being dragged
+    this.targetId = id;
+  }
+
+  /**
+   * Calculates the offset of the drag item relative to its initial position.
+   *
+   * @param list {HTMLElement} the list controller's element (tbody)
+   * @param row {HTMLElement} the row being dragged
+   * @param event {MouseEvent} the current event
+   * @param callback {OrderableListController~animate} updates the drag item with a relative offset
+   */
+  updateCursor(list, row, event, callback) {
+    // Calculate and store the list offset relative to the viewport
+    // This value is cached so we can calculate the outcome of any scroll events
+    this.listOffset = list.getBoundingClientRect().top;
+
+    // Calculate the position of the cursor relative to the list.
+    // Accounts for scroll offsets by using the item's bounding client rect.
+    const cursorPosition = event.clientY - this.listOffset;
+
+    // intended item position relative to the list, from cursor position
+    let itemPosition = cursorPosition - this.cursorOffset;
+
+    this.#updateItemPosition(list, row, itemPosition, callback);
+  }
+
+  /**
+   * Animates the item's position as the list scrolls. Requires a previous call
+   * to set the scroll offset.
+   *
+   * @param list {HTMLElement} the list controller's element (tbody)
+   * @param row {HTMLElement} the row being dragged
+   * @param callback {OrderableListController~animate} updates the drag item with a relative offset
+   */
+  updateScroll(list, row, callback) {
+    const previousScrollOffset = this.listOffset;
+
+    // Calculate and store the list offset relative to the viewport
+    // This value is cached so we can calculate the outcome of any scroll events
+    this.listOffset = list.getBoundingClientRect().top;
+
+    // Calculate the change in scroll offset since the last update
+    const scrollDelta = previousScrollOffset - this.listOffset;
+
+    // intended item position relative to the list, from cursor position
+    const position = this.position + scrollDelta;
+
+    this.#updateItemPosition(list, row, position, callback);
+  }
+
+  #updateItemPosition(list, row, position, callback) {
+    // ensure itemPosition is within the bounds of the list (tbody)
+    position = Math.max(position, 0);
+    position = Math.min(position, list.offsetHeight - row.offsetHeight);
+
+    // cache the item's position relative to the list for use in scroll events
+    this.position = position;
+
+    // Item has position: relative, so we want to calculate the amount to move
+    // the item relative to it's DOM position to represent how much it has been
+    // dragged by.
+    const offset = position - this.initialPosition;
+
+    // Convert itemPosition from offset relative to list to offset relative to
+    // its position within the DOM (if it hadn't moved).
+    callback(offset);
+  }
+}
+
+class OrderableFormController extends Controller {
+  add(item) {
+    const { id_name, id_value, index_name } = item.paramsValue;
+    this.element.insertAdjacentHTML(
+      "beforeend",
+      `<input type="hidden" name="${id_name}" value="${id_value}" data-generated>
+              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`
+    );
+  }
+
+  submit() {
+    if (this.inputs.length === 0) return;
+
+    this.element.requestSubmit();
+  }
+
+  clear() {
+    this.inputs.forEach((input) => input.remove());
+  }
+
+  get inputs() {
+    return this.element.querySelectorAll("input[data-generated]");
+  }
+}
+
+const Definitions = [
+  {
+    identifier: "tables--turbo--collection",
+    controllerConstructor: TurboCollectionController,
+  },
+  {
+    identifier: "tables--orderable--item",
+    controllerConstructor: OrderableRowController,
+  },
+  {
+    identifier: "tables--orderable--list",
+    controllerConstructor: OrderableListController,
+  },
+  {
+    identifier: "tables--orderable--form",
+    controllerConstructor: OrderableFormController,
+  },
+];
+
+export { Definitions as default };

data/app/assets/builds/katalyst/tables.min.js

@@ -0,0 +1,2 @@
+import{Controller as t}from"@hotwired/stimulus";import{Turbo as e}from"@hotwired/turbo-rails";class s{constructor(t,e,s){this.cursorOffset=e.offsetY,this.initialPosition=e.target.offsetTop-t.offsetTop,this.targetId=s}updateCursor(t,e,s,i){this.listOffset=t.getBoundingClientRect().top;let r=s.clientY-this.listOffset-this.cursorOffset;this.#t(t,e,r,i)}updateScroll(t,e,s){const i=this.listOffset;this.listOffset=t.getBoundingClientRect().top;const r=i-this.listOffset,a=this.position+r;this.#t(t,e,a,s)}#t(t,e,s,i){s=Math.max(s,0),s=Math.min(s,t.offsetHeight-e.offsetHeight),this.position=s;i(s-this.initialPosition)}}const i=[{identifier:"tables--turbo--collection",controllerConstructor:class extends t{static values={query:String,sort:String};queryValueChanged(t){e.navigator.history.replace(this.#e(t))}sortValueChanged(t){document.querySelectorAll(this.#s).forEach((e=>{e&&(e.value=t)}))}get#s(){return"input[name='sort']"}#e(t){const e=this.element.closest("turbo-frame");let s;return s=e?new URL(e.baseURI):new URL(window.location.href),s.search=t,s}}},{identifier:"tables--orderable--item",controllerConstructor:class extends t{static values={params:Object};connect(){var t;this.index=(t=this.row,Array.from(t.parentElement.children).indexOf(t))}paramsValueChanged(t){this.id=t.id_value}dragUpdate(t){this.dragOffset=t,this.row.style.position="relative",this.row.style.top=t+"px",this.row.style.zIndex="1",this.row.toggleAttribute("dragging",!0)}updateVisually(t){this.row.style.position="relative",this.row.style.top=this.row.offsetHeight*(t-this.dragIndex)+"px"}updateIndex(t){this.index=t}reset(){delete this.dragOffset,this.row.removeAttribute("style"),this.row.removeAttribute("dragging")}get hasChanges(){return this.paramsValue.index_value!==this.index}get dragIndex(){return this.dragOffset&&0!==this.dragOffset?this.index+Math.round(this.dragOffset/this.row.offsetHeight):this.index}get comparisonIndex(){return this.dragOffset?this.dragIndex+(this.dragOffset>0?.5:-.5):this.index}get row(){return this.element.parentElement}}},{identifier:"tables--orderable--list",controllerConstructor:class extends t{static outlets=["tables--orderable--item","tables--orderable--form"];startDragging(t){this.dragState=t,document.addEventListener("mousemove",this.mousemove),document.addEventListener("mouseup",this.mouseup),window.addEventListener("scroll",this.scroll,!0),this.element.style.position="relative"}stopDragging(){const t=this.dragState;return delete this.dragState,document.removeEventListener("mousemove",this.mousemove),document.removeEventListener("mouseup",this.mouseup),window.removeEventListener("scroll",this.scroll,!0),this.element.removeAttribute("style"),this.tablesOrderableItemOutlets.forEach((t=>t.reset())),t}drop(){const t=this.dragItem;if(!t)return;const e=t.dragIndex,s=this.tablesOrderableItemOutlets[e];s&&(e<t.index?s.row.insertAdjacentElement("beforebegin",t.row):e>t.index&&s.row.insertAdjacentElement("afterend",t.row),this.tablesOrderableItemOutlets.forEach(((t,e)=>t.updateIndex(e))),this.commitChanges())}commitChanges(){this.tablesOrderableFormOutlet.clear(),this.tablesOrderableItemOutlets.forEach((t=>{t.hasChanges&&this.tablesOrderableFormOutlet.add(t)})),this.tablesOrderableFormOutlet.submit()}mousedown(t){if(this.isDragging)return;const e=this.#i(t.target);e&&(t.preventDefault(),this.startDragging(new s(this.element,t,e.id)),this.dragState.updateCursor(this.element,e.row,t,this.animate))}mousemove=t=>{this.isDragging&&(t.preventDefault(),this.ticking||(this.ticking=!0,window.requestAnimationFrame((()=>{this.ticking=!1,this.dragState.updateCursor(this.element,this.dragItem.row,t,this.animate)}))))};scroll=t=>{this.isDragging&&!this.ticking&&(this.ticking=!0,window.requestAnimationFrame((()=>{this.ticking=!1,this.dragState.updateScroll(this.element,this.dragItem.row,this.animate)})))};mouseup=t=>{this.isDragging&&(this.drop(),this.stopDragging(),this.tablesOrderableFormOutlets.forEach((t=>delete t.dragState)))};tablesOrderableFormOutletConnected(t,e){t.dragState&&this.startDragging(t.dragState)}tablesOrderableFormOutletDisconnected(t,e){this.isDragging&&(t.dragState=this.stopDragging())}animate=t=>{const e=this.dragItem;e.dragUpdate(t),this.#r.forEach(((t,s)=>{t!==e&&t.updateVisually(s)}))};get isDragging(){return!!this.dragState}get dragItem(){return this.isDragging?this.tablesOrderableItemOutlets.find((t=>t.id===this.dragState.targetId)):null}get#r(){return this.tablesOrderableItemOutlets.toSorted(((t,e)=>t.comparisonIndex-e.comparisonIndex))}#i(t){return this.tablesOrderableItemOutlets.find((e=>e.element===t))}}},{identifier:"tables--orderable--form",controllerConstructor:class extends t{add(t){const{id_name:e,id_value:s,index_name:i}=t.paramsValue;this.element.insertAdjacentHTML("beforeend",`<input type="hidden" name="${e}" value="${s}" data-generated>\n              <input type="hidden" name="${i}" value="${t.index}" data-generated>`)}submit(){0!==this.inputs.length&&this.element.requestSubmit()}clear(){this.inputs.forEach((t=>t.remove()))}get inputs(){return this.element.querySelectorAll("input[data-generated]")}}}];export{i as default};
+//# sourceMappingURL=tables.min.js.map

data/app/assets/builds/katalyst/tables.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tables.min.js","sources":["../../../javascript/tables/orderable/list_controller.js","../../../javascript/tables/application.js","../../../javascript/tables/turbo/collection_controller.js","../../../javascript/tables/orderable/item_controller.js","../../../javascript/tables/orderable/form_controller.js"],"sourcesContent":["import { Controller } from \"@hotwired/stimulus\";\n\nexport default class OrderableListController extends Controller {\n  static outlets = [\"tables--orderable--item\", \"tables--orderable--form\"];\n\n  //region State transitions\n\n  startDragging(dragState) {\n    this.dragState = dragState;\n\n    document.addEventListener(\"mousemove\", this.mousemove);\n    document.addEventListener(\"mouseup\", this.mouseup);\n    window.addEventListener(\"scroll\", this.scroll, true);\n\n    this.element.style.position = \"relative\";\n  }\n\n  stopDragging() {\n    const dragState = this.dragState;\n    delete this.dragState;\n\n    document.removeEventListener(\"mousemove\", this.mousemove);\n    document.removeEventListener(\"mouseup\", this.mouseup);\n    window.removeEventListener(\"scroll\", this.scroll, true);\n\n    this.element.removeAttribute(\"style\");\n    this.tablesOrderableItemOutlets.forEach((item) => item.reset());\n\n    return dragState;\n  }\n\n  drop() {\n    // note: early returns guard against turbo updates that prevent us finding\n    // the right item to drop on. In this situation it's better to discard the\n    // drop than to drop in the wrong place.\n\n    const dragItem = this.dragItem;\n\n    if (!dragItem) return;\n\n    const newIndex = dragItem.dragIndex;\n    const targetItem = this.tablesOrderableItemOutlets[newIndex];\n\n    if (!targetItem) return;\n\n    // swap the dragged item into the correct position for its current offset\n    if (newIndex < dragItem.index) {\n      targetItem.row.insertAdjacentElement(\"beforebegin\", dragItem.row);\n    } else if (newIndex > dragItem.index) {\n      targetItem.row.insertAdjacentElement(\"afterend\", dragItem.row);\n    }\n\n    // reindex all items based on their new positions\n    this.tablesOrderableItemOutlets.forEach((item, index) =>\n      item.updateIndex(index)\n    );\n\n    // save the changes\n    this.commitChanges();\n  }\n\n  commitChanges() {\n    // clear any existing inputs to prevent duplicates\n    this.tablesOrderableFormOutlet.clear();\n\n    // insert any items that have changed position\n    this.tablesOrderableItemOutlets.forEach((item) => {\n      if (item.hasChanges) this.tablesOrderableFormOutlet.add(item);\n    });\n\n    this.tablesOrderableFormOutlet.submit();\n  }\n\n  //endregion\n\n  //region Events\n\n  mousedown(event) {\n    if (this.isDragging) return;\n\n    const target = this.#targetItem(event.target);\n\n    if (!target) return;\n\n    event.preventDefault(); // prevent built-in drag\n\n    this.startDragging(new DragState(this.element, event, target.id));\n\n    this.dragState.updateCursor(this.element, target.row, event, this.animate);\n  }\n\n  mousemove = (event) => {\n    if (!this.isDragging) return;\n\n    event.preventDefault(); // prevent build-in drag\n\n    if (this.ticking) return;\n\n    this.ticking = true;\n\n    window.requestAnimationFrame(() => {\n      this.ticking = false;\n      this.dragState.updateCursor(\n        this.element,\n        this.dragItem.row,\n        event,\n        this.animate\n      );\n    });\n  };\n\n  scroll = (event) => {\n    if (!this.isDragging || this.ticking) return;\n\n    this.ticking = true;\n\n    window.requestAnimationFrame(() => {\n      this.ticking = false;\n      this.dragState.updateScroll(\n        this.element,\n        this.dragItem.row,\n        this.animate\n      );\n    });\n  };\n\n  mouseup = (event) => {\n    if (!this.isDragging) return;\n\n    this.drop();\n    this.stopDragging();\n    this.tablesOrderableFormOutlets.forEach((form) => delete form.dragState);\n  };\n\n  tablesOrderableFormOutletConnected(form, element) {\n    if (form.dragState) {\n      // restore the previous controller's state\n      this.startDragging(form.dragState);\n    }\n  }\n\n  tablesOrderableFormOutletDisconnected(form, element) {\n    if (this.isDragging) {\n      // cache drag state in the form\n      form.dragState = this.stopDragging();\n    }\n  }\n\n  //endregion\n\n  //region Helpers\n\n  /**\n   * Updates the position of the drag item with a relative offset. Updates\n   * other items relative to the new position of the drag item, as required.\n   *\n   * @callback {OrderableListController~animate}\n   * @param {number} offset\n   */\n  animate = (offset) => {\n    const dragItem = this.dragItem;\n\n    // Visually update the dragItem so it follows the cursor\n    dragItem.dragUpdate(offset);\n\n    // Visually updates the position of all items in the list relative to the\n    // dragged item. No actual changes to orderings at this stage.\n    this.#currentItems.forEach((item, index) => {\n      if (item === dragItem) return;\n      item.updateVisually(index);\n    });\n  };\n\n  get isDragging() {\n    return !!this.dragState;\n  }\n\n  get dragItem() {\n    if (!this.isDragging) return null;\n\n    return this.tablesOrderableItemOutlets.find(\n      (item) => item.id === this.dragState.targetId\n    );\n  }\n\n  /**\n   * Returns the current items in the list, sorted by their current index.\n   * Current uses the drag index if the item is being dragged, if set.\n   *\n   * @returns {Array[OrderableRowController]}\n   */\n  get #currentItems() {\n    return this.tablesOrderableItemOutlets.toSorted(\n      (a, b) => a.comparisonIndex - b.comparisonIndex\n    );\n  }\n\n  /**\n   * Returns the item outlet that was clicked on, if any.\n   *\n   * @param element {HTMLElement} the clicked ordinal cell\n   * @returns {OrderableRowController}\n   */\n  #targetItem(element) {\n    return this.tablesOrderableItemOutlets.find(\n      (item) => item.element === element\n    );\n  }\n\n  //endregion\n}\n\n/**\n * During drag we want to be able to translate a document-relative coordinate\n * into a coordinate relative to the list element. This state object calculates\n * and stores internal state so that we can translate absolute page coordinates\n * from mouse events into relative offsets for the list items within the list\n * element.\n *\n * We also keep track of the drag target so that if the controller is attached\n * to a new element during the drag we can continue after the turbo update.\n */\nclass DragState {\n  /**\n   * @param list {HTMLElement} the list controller's element (tbody)\n   * @param event {MouseEvent} the initial event\n   * @param id {String} the id of the element being dragged\n   */\n  constructor(list, event, id) {\n    // cursor offset is the offset of the cursor relative to the drag item\n    this.cursorOffset = event.offsetY;\n\n    // initial offset is the offset position of the drag item at drag start\n    this.initialPosition = event.target.offsetTop - list.offsetTop;\n\n    // id of the item being dragged\n    this.targetId = id;\n  }\n\n  /**\n   * Calculates the offset of the drag item relative to its initial position.\n   *\n   * @param list {HTMLElement} the list controller's element (tbody)\n   * @param row {HTMLElement} the row being dragged\n   * @param event {MouseEvent} the current event\n   * @param callback {OrderableListController~animate} updates the drag item with a relative offset\n   */\n  updateCursor(list, row, event, callback) {\n    // Calculate and store the list offset relative to the viewport\n    // This value is cached so we can calculate the outcome of any scroll events\n    this.listOffset = list.getBoundingClientRect().top;\n\n    // Calculate the position of the cursor relative to the list.\n    // Accounts for scroll offsets by using the item's bounding client rect.\n    const cursorPosition = event.clientY - this.listOffset;\n\n    // intended item position relative to the list, from cursor position\n    let itemPosition = cursorPosition - this.cursorOffset;\n\n    this.#updateItemPosition(list, row, itemPosition, callback);\n  }\n\n  /**\n   * Animates the item's position as the list scrolls. Requires a previous call\n   * to set the scroll offset.\n   *\n   * @param list {HTMLElement} the list controller's element (tbody)\n   * @param row {HTMLElement} the row being dragged\n   * @param callback {OrderableListController~animate} updates the drag item with a relative offset\n   */\n  updateScroll(list, row, callback) {\n    const previousScrollOffset = this.listOffset;\n\n    // Calculate and store the list offset relative to the viewport\n    // This value is cached so we can calculate the outcome of any scroll events\n    this.listOffset = list.getBoundingClientRect().top;\n\n    // Calculate the change in scroll offset since the last update\n    const scrollDelta = previousScrollOffset - this.listOffset;\n\n    // intended item position relative to the list, from cursor position\n    const position = this.position + scrollDelta;\n\n    this.#updateItemPosition(list, row, position, callback);\n  }\n\n  #updateItemPosition(list, row, position, callback) {\n    // ensure itemPosition is within the bounds of the list (tbody)\n    position = Math.max(position, 0);\n    position = Math.min(position, list.offsetHeight - row.offsetHeight);\n\n    // cache the item's position relative to the list for use in scroll events\n    this.position = position;\n\n    // Item has position: relative, so we want to calculate the amount to move\n    // the item relative to it's DOM position to represent how much it has been\n    // dragged by.\n    const offset = position - this.initialPosition;\n\n    // Convert itemPosition from offset relative to list to offset relative to\n    // its position within the DOM (if it hadn't moved).\n    callback(offset);\n  }\n}\n","import TurboCollectionController from \"./turbo/collection_controller\";\nimport ItemController from \"./orderable/item_controller\";\nimport ListController from \"./orderable/list_controller\";\nimport FormController from \"./orderable/form_controller\";\n\nconst Definitions = [\n  {\n    identifier: \"tables--turbo--collection\",\n    controllerConstructor: TurboCollectionController,\n  },\n  {\n    identifier: \"tables--orderable--item\",\n    controllerConstructor: ItemController,\n  },\n  {\n    identifier: \"tables--orderable--list\",\n    controllerConstructor: ListController,\n  },\n  {\n    identifier: \"tables--orderable--form\",\n    controllerConstructor: FormController,\n  },\n];\n\nexport { Definitions as default };\n","import { Controller } from \"@hotwired/stimulus\";\nimport { Turbo } from \"@hotwired/turbo-rails\";\n\nexport default class TurboCollectionController extends Controller {\n  static values = {\n    query: String,\n    sort: String,\n  };\n\n  queryValueChanged(query) {\n    Turbo.navigator.history.replace(this.#url(query));\n  }\n\n  sortValueChanged(sort) {\n    document.querySelectorAll(this.#sortSelector).forEach((input) => {\n      if (input) input.value = sort;\n    });\n  }\n\n  get #sortSelector() {\n    return \"input[name='sort']\";\n  }\n\n  #url(query) {\n    const frame = this.element.closest(\"turbo-frame\");\n    let url;\n\n    if (frame) {\n      url = new URL(frame.baseURI);\n    } else {\n      url = new URL(window.location.href);\n    }\n\n    url.search = query;\n\n    return url;\n  }\n}\n","import { Controller } from \"@hotwired/stimulus\";\n\nexport default class OrderableRowController extends Controller {\n  static values = {\n    params: Object,\n  };\n\n  connect() {\n    // index from server may be inconsistent with the visual ordering,\n    // especially if this is a new node. Use positional indexes instead,\n    // as these are the values we will send on save.\n    this.index = domIndex(this.row);\n  }\n\n  paramsValueChanged(params) {\n    this.id = params.id_value;\n  }\n\n  dragUpdate(offset) {\n    this.dragOffset = offset;\n    this.row.style.position = \"relative\";\n    this.row.style.top = offset + \"px\";\n    this.row.style.zIndex = \"1\";\n    this.row.toggleAttribute(\"dragging\", true);\n  }\n\n  /**\n   * Called on items that are not the dragged item during drag. Updates the\n   * visual position of the item relative to the dragged item.\n   *\n   * @param index {number} intended index of the item during drag\n   */\n  updateVisually(index) {\n    this.row.style.position = \"relative\";\n    this.row.style.top = `${\n      this.row.offsetHeight * (index - this.dragIndex)\n    }px`;\n  }\n\n  /**\n   * Set the index value of the item. This is called on all items after a drop\n   * event. If the index is different to the params index then this item has\n   * changed.\n   *\n   * @param index {number} the new index value\n   */\n  updateIndex(index) {\n    this.index = index;\n  }\n\n  /**\n   * Restore any visual changes made during drag and remove the drag state.\n   */\n  reset() {\n    delete this.dragOffset;\n    this.row.removeAttribute(\"style\");\n    this.row.removeAttribute(\"dragging\");\n  }\n\n  /**\n   * @returns {boolean} true when the item has a change to its index value\n   */\n  get hasChanges() {\n    return this.paramsValue.index_value !== this.index;\n  }\n\n  /**\n   * Calculate the relative index of the item during drag. This is used to\n   * sort items during drag as it takes into account any uncommitted changes\n   * to index caused by the drag offset.\n   *\n   * @returns {number} index for the purposes of drag and drop ordering\n   */\n  get dragIndex() {\n    if (this.dragOffset && this.dragOffset !== 0) {\n      return this.index + Math.round(this.dragOffset / this.row.offsetHeight);\n    } else {\n      return this.index;\n    }\n  }\n\n  /**\n   * Index value for use in comparisons during drag. This is used to determine\n   * whether the dragged item is above or below another item. If this item is\n   * being dragged then we offset the index by 0.5 to ensure that it jumps up\n   * or down when it reaches the midpoint of the item above or below it.\n   *\n   * @returns {number}\n   */\n  get comparisonIndex() {\n    if (this.dragOffset) {\n      return this.dragIndex + (this.dragOffset > 0 ? 0.5 : -0.5);\n    } else {\n      return this.index;\n    }\n  }\n\n  /**\n   * The containing row element.\n   *\n   * @returns {HTMLElement}\n   */\n  get row() {\n    return this.element.parentElement;\n  }\n}\n\nfunction domIndex(element) {\n  return Array.from(element.parentElement.children).indexOf(element);\n}\n","import { Controller } from \"@hotwired/stimulus\";\n\nexport default class OrderableFormController extends Controller {\n  add(item) {\n    const { id_name, id_value, index_name } = item.paramsValue;\n    this.element.insertAdjacentHTML(\n      \"beforeend\",\n      `<input type=\"hidden\" name=\"${id_name}\" value=\"${id_value}\" data-generated>\n              <input type=\"hidden\" name=\"${index_name}\" value=\"${item.index}\" data-generated>`\n    );\n  }\n\n  submit() {\n    if (this.inputs.length === 0) return;\n\n    this.element.requestSubmit();\n  }\n\n  clear() {\n    this.inputs.forEach((input) => input.remove());\n  }\n\n  get inputs() {\n    return this.element.querySelectorAll(\"input[data-generated]\");\n  }\n}\n"],"names":["DragState","constructor","list","event","id","this","cursorOffset","offsetY","initialPosition","target","offsetTop","targetId","updateCursor","row","callback","listOffset","getBoundingClientRect","top","itemPosition","clientY","updateItemPosition","updateScroll","previousScrollOffset","scrollDelta","position","Math","max","min","offsetHeight","Definitions","identifier","controllerConstructor","Controller","static","query","String","sort","queryValueChanged","Turbo","navigator","history","replace","url","sortValueChanged","document","querySelectorAll","sortSelector","forEach","input","value","frame","element","closest","URL","baseURI","window","location","href","search","params","Object","connect","index","Array","from","parentElement","children","indexOf","paramsValueChanged","id_value","dragUpdate","offset","dragOffset","style","zIndex","toggleAttribute","updateVisually","dragIndex","updateIndex","reset","removeAttribute","hasChanges","paramsValue","index_value","round","comparisonIndex","startDragging","dragState","addEventListener","mousemove","mouseup","scroll","stopDragging","removeEventListener","tablesOrderableItemOutlets","item","drop","dragItem","newIndex","targetItem","insertAdjacentElement","commitChanges","tablesOrderableFormOutlet","clear","add","submit","mousedown","isDragging","preventDefault","animate","ticking","requestAnimationFrame","tablesOrderableFormOutlets","form","tablesOrderableFormOutletConnected","tablesOrderableFormOutletDisconnected","currentItems","find","toSorted","a","b","id_name","index_name","insertAdjacentHTML","inputs","length","requestSubmit","remove"],"mappings":"8FA8NA,MAAMA,EAMJ,WAAAC,CAAYC,EAAMC,EAAOC,GAEvBC,KAAKC,aAAeH,EAAMI,QAG1BF,KAAKG,gBAAkBL,EAAMM,OAAOC,UAAYR,EAAKQ,UAGrDL,KAAKM,SAAWP,CACjB,CAUD,YAAAQ,CAAaV,EAAMW,EAAKV,EAAOW,GAG7BT,KAAKU,WAAab,EAAKc,wBAAwBC,IAO/C,IAAIC,EAHmBf,EAAMgB,QAAUd,KAAKU,WAGRV,KAAKC,aAEzCD,MAAKe,EAAoBlB,EAAMW,EAAKK,EAAcJ,EACnD,CAUD,YAAAO,CAAanB,EAAMW,EAAKC,GACtB,MAAMQ,EAAuBjB,KAAKU,WAIlCV,KAAKU,WAAab,EAAKc,wBAAwBC,IAG/C,MAAMM,EAAcD,EAAuBjB,KAAKU,WAG1CS,EAAWnB,KAAKmB,SAAWD,EAEjClB,MAAKe,EAAoBlB,EAAMW,EAAKW,EAAUV,EAC/C,CAED,EAAAM,CAAoBlB,EAAMW,EAAKW,EAAUV,GAEvCU,EAAWC,KAAKC,IAAIF,EAAU,GAC9BA,EAAWC,KAAKE,IAAIH,EAAUtB,EAAK0B,aAAef,EAAIe,cAGtDvB,KAAKmB,SAAWA,EAShBV,EAJeU,EAAWnB,KAAKG,gBAKhC,ECzSE,MAACqB,EAAc,CAClB,CACEC,WAAY,4BACZC,sBCLW,cAAwCC,EACrDC,cAAgB,CACdC,MAAOC,OACPC,KAAMD,QAGR,iBAAAE,CAAkBH,GAChBI,EAAMC,UAAUC,QAAQC,QAAQpC,MAAKqC,EAAKR,GAC3C,CAED,gBAAAS,CAAiBP,GACfQ,SAASC,iBAAiBxC,MAAKyC,GAAeC,SAASC,IACjDA,IAAOA,EAAMC,MAAQb,EAAI,GAEhC,CAED,KAAIU,GACF,MAAO,oBACR,CAED,EAAAJ,CAAKR,GACH,MAAMgB,EAAQ7C,KAAK8C,QAAQC,QAAQ,eACnC,IAAIV,EAUJ,OAPEA,EADEQ,EACI,IAAIG,IAAIH,EAAMI,SAEd,IAAID,IAAIE,OAAOC,SAASC,MAGhCf,EAAIgB,OAASxB,EAENQ,CACR,ID1BD,CACEZ,WAAY,0BACZC,sBEVW,cAAqCC,EAClDC,cAAgB,CACd0B,OAAQC,QAGV,OAAAC,GAoGF,IAAkBV,EAhGd9C,KAAKyD,OAgGSX,EAhGQ9C,KAAKQ,IAiGtBkD,MAAMC,KAAKb,EAAQc,cAAcC,UAAUC,QAAQhB,GAhGzD,CAED,kBAAAiB,CAAmBT,GACjBtD,KAAKD,GAAKuD,EAAOU,QAClB,CAED,UAAAC,CAAWC,GACTlE,KAAKmE,WAAaD,EAClBlE,KAAKQ,IAAI4D,MAAMjD,SAAW,WAC1BnB,KAAKQ,IAAI4D,MAAMxD,IAAMsD,EAAS,KAC9BlE,KAAKQ,IAAI4D,MAAMC,OAAS,IACxBrE,KAAKQ,IAAI8D,gBAAgB,YAAY,EACtC,CAQD,cAAAC,CAAed,GACbzD,KAAKQ,IAAI4D,MAAMjD,SAAW,WAC1BnB,KAAKQ,IAAI4D,MAAMxD,IACbZ,KAAKQ,IAAIe,cAAgBkC,EAAQzD,KAAKwE,WADnB,IAGtB,CASD,WAAAC,CAAYhB,GACVzD,KAAKyD,MAAQA,CACd,CAKD,KAAAiB,UACS1E,KAAKmE,WACZnE,KAAKQ,IAAImE,gBAAgB,SACzB3E,KAAKQ,IAAImE,gBAAgB,WAC1B,CAKD,cAAIC,GACF,OAAO5E,KAAK6E,YAAYC,cAAgB9E,KAAKyD,KAC9C,CASD,aAAIe,GACF,OAAIxE,KAAKmE,YAAkC,IAApBnE,KAAKmE,WACnBnE,KAAKyD,MAAQrC,KAAK2D,MAAM/E,KAAKmE,WAAanE,KAAKQ,IAAIe,cAEnDvB,KAAKyD,KAEf,CAUD,mBAAIuB,GACF,OAAIhF,KAAKmE,WACAnE,KAAKwE,WAAaxE,KAAKmE,WAAa,EAAI,IAAO,IAE/CnE,KAAKyD,KAEf,CAOD,OAAIjD,GACF,OAAOR,KAAK8C,QAAQc,aACrB,IF1FD,CACEnC,WAAY,0BACZC,sBDdW,cAAsCC,EACnDC,eAAiB,CAAC,0BAA2B,2BAI7C,aAAAqD,CAAcC,GACZlF,KAAKkF,UAAYA,EAEjB3C,SAAS4C,iBAAiB,YAAanF,KAAKoF,WAC5C7C,SAAS4C,iBAAiB,UAAWnF,KAAKqF,SAC1CnC,OAAOiC,iBAAiB,SAAUnF,KAAKsF,QAAQ,GAE/CtF,KAAK8C,QAAQsB,MAAMjD,SAAW,UAC/B,CAED,YAAAoE,GACE,MAAML,EAAYlF,KAAKkF,UAUvB,cATOlF,KAAKkF,UAEZ3C,SAASiD,oBAAoB,YAAaxF,KAAKoF,WAC/C7C,SAASiD,oBAAoB,UAAWxF,KAAKqF,SAC7CnC,OAAOsC,oBAAoB,SAAUxF,KAAKsF,QAAQ,GAElDtF,KAAK8C,QAAQ6B,gBAAgB,SAC7B3E,KAAKyF,2BAA2B/C,SAASgD,GAASA,EAAKhB,UAEhDQ,CACR,CAED,IAAAS,GAKE,MAAMC,EAAW5F,KAAK4F,SAEtB,IAAKA,EAAU,OAEf,MAAMC,EAAWD,EAASpB,UACpBsB,EAAa9F,KAAKyF,2BAA2BI,GAE9CC,IAGDD,EAAWD,EAASnC,MACtBqC,EAAWtF,IAAIuF,sBAAsB,cAAeH,EAASpF,KACpDqF,EAAWD,EAASnC,OAC7BqC,EAAWtF,IAAIuF,sBAAsB,WAAYH,EAASpF,KAI5DR,KAAKyF,2BAA2B/C,SAAQ,CAACgD,EAAMjC,IAC7CiC,EAAKjB,YAAYhB,KAInBzD,KAAKgG,gBACN,CAED,aAAAA,GAEEhG,KAAKiG,0BAA0BC,QAG/BlG,KAAKyF,2BAA2B/C,SAASgD,IACnCA,EAAKd,YAAY5E,KAAKiG,0BAA0BE,IAAIT,EAAK,IAG/D1F,KAAKiG,0BAA0BG,QAChC,CAMD,SAAAC,CAAUvG,GACR,GAAIE,KAAKsG,WAAY,OAErB,MAAMlG,EAASJ,MAAK8F,EAAYhG,EAAMM,QAEjCA,IAELN,EAAMyG,iBAENvG,KAAKiF,cAAc,IAAItF,EAAUK,KAAK8C,QAAShD,EAAOM,EAAOL,KAE7DC,KAAKkF,UAAU3E,aAAaP,KAAK8C,QAAS1C,EAAOI,IAAKV,EAAOE,KAAKwG,SACnE,CAEDpB,UAAatF,IACNE,KAAKsG,aAEVxG,EAAMyG,iBAEFvG,KAAKyG,UAETzG,KAAKyG,SAAU,EAEfvD,OAAOwD,uBAAsB,KAC3B1G,KAAKyG,SAAU,EACfzG,KAAKkF,UAAU3E,aACbP,KAAK8C,QACL9C,KAAK4F,SAASpF,IACdV,EACAE,KAAKwG,QACN,KACD,EAGJlB,OAAUxF,IACHE,KAAKsG,aAActG,KAAKyG,UAE7BzG,KAAKyG,SAAU,EAEfvD,OAAOwD,uBAAsB,KAC3B1G,KAAKyG,SAAU,EACfzG,KAAKkF,UAAUlE,aACbhB,KAAK8C,QACL9C,KAAK4F,SAASpF,IACdR,KAAKwG,QACN,IACD,EAGJnB,QAAWvF,IACJE,KAAKsG,aAEVtG,KAAK2F,OACL3F,KAAKuF,eACLvF,KAAK2G,2BAA2BjE,SAASkE,UAAgBA,EAAK1B,YAAU,EAG1E,kCAAA2B,CAAmCD,EAAM9D,GACnC8D,EAAK1B,WAEPlF,KAAKiF,cAAc2B,EAAK1B,UAE3B,CAED,qCAAA4B,CAAsCF,EAAM9D,GACtC9C,KAAKsG,aAEPM,EAAK1B,UAAYlF,KAAKuF,eAEzB,CAaDiB,QAAWtC,IACT,MAAM0B,EAAW5F,KAAK4F,SAGtBA,EAAS3B,WAAWC,GAIpBlE,MAAK+G,EAAcrE,SAAQ,CAACgD,EAAMjC,KAC5BiC,IAASE,GACbF,EAAKnB,eAAed,EAAM,GAC1B,EAGJ,cAAI6C,GACF,QAAStG,KAAKkF,SACf,CAED,YAAIU,GACF,OAAK5F,KAAKsG,WAEHtG,KAAKyF,2BAA2BuB,MACpCtB,GAASA,EAAK3F,KAAOC,KAAKkF,UAAU5E,WAHV,IAK9B,CAQD,KAAIyG,GACF,OAAO/G,KAAKyF,2BAA2BwB,UACrC,CAACC,EAAGC,IAAMD,EAAElC,gBAAkBmC,EAAEnC,iBAEnC,CAQD,EAAAc,CAAYhD,GACV,OAAO9C,KAAKyF,2BAA2BuB,MACpCtB,GAASA,EAAK5C,UAAYA,GAE9B,IC7LD,CACErB,WAAY,0BACZC,sBGlBW,cAAsCC,EACnD,GAAAwE,CAAIT,GACF,MAAM0B,QAAEA,EAAOpD,SAAEA,EAAQqD,WAAEA,GAAe3B,EAAKb,YAC/C7E,KAAK8C,QAAQwE,mBACX,YACA,8BAA8BF,aAAmBpD,gEACZqD,aAAsB3B,EAAKjC,yBAEnE,CAED,MAAA2C,GAC6B,IAAvBpG,KAAKuH,OAAOC,QAEhBxH,KAAK8C,QAAQ2E,eACd,CAED,KAAAvB,GACElG,KAAKuH,OAAO7E,SAASC,GAAUA,EAAM+E,UACtC,CAED,UAAIH,GACF,OAAOvH,KAAK8C,QAAQN,iBAAiB,wBACtC"}

data/app/assets/config/katalyst-tables.js

@@ -1 +1 @@
-//= link_tree ../javascripts
+//= link_tree ../builds

data/app/components/katalyst/turbo/table_component.rb

@@ -26,9 +26,9 @@ module Katalyst
       def default_html_attributes
         {
           data: {
-            controller:                           "tables--turbo-collection",
-            tables__turbo_collection_query_value: current_query,
-            tables__turbo_collection_sort_value:  collection.sort,
+            controller:                            "tables--turbo--collection",
+            tables__turbo__collection_query_value: current_query,
+            tables__turbo__collection_sort_value:  collection.sort,
           },
         }
       end

data/app/javascript/tables/application.js

@@ -0,0 +1,25 @@
+import TurboCollectionController from "./turbo/collection_controller";
+import ItemController from "./orderable/item_controller";
+import ListController from "./orderable/list_controller";
+import FormController from "./orderable/form_controller";
+
+const Definitions = [
+  {
+    identifier: "tables--turbo--collection",
+    controllerConstructor: TurboCollectionController,
+  },
+  {
+    identifier: "tables--orderable--item",
+    controllerConstructor: ItemController,
+  },
+  {
+    identifier: "tables--orderable--list",
+    controllerConstructor: ListController,
+  },
+  {
+    identifier: "tables--orderable--form",
+    controllerConstructor: FormController,
+  },
+];
+
+export { Definitions as default };

data/app/{assets/javascripts/controllers → javascript}/tables/orderable/form_controller.js

@@ -6,7 +6,7 @@ export default class OrderableFormController extends Controller {
     this.element.insertAdjacentHTML(
       "beforeend",
       `<input type="hidden" name="${id_name}" value="${id_value}" data-generated>
-              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`,
+              <input type="hidden" name="${index_name}" value="${item.index}" data-generated>`
     );
   }
 

data/app/{assets/javascripts/controllers → javascript}/tables/orderable/list_controller.js

@@ -52,7 +52,7 @@ export default class OrderableListController extends Controller {
 
     // reindex all items based on their new positions
     this.tablesOrderableItemOutlets.forEach((item, index) =>
-      item.updateIndex(index),
+      item.updateIndex(index)
     );
 
     // save the changes
@@ -104,7 +104,7 @@ export default class OrderableListController extends Controller {
         this.element,
         this.dragItem.row,
         event,
-        this.animate,
+        this.animate
       );
     });
   };
@@ -119,7 +119,7 @@ export default class OrderableListController extends Controller {
       this.dragState.updateScroll(
         this.element,
         this.dragItem.row,
-        this.animate,
+        this.animate
       );
     });
   };
@@ -179,7 +179,7 @@ export default class OrderableListController extends Controller {
     if (!this.isDragging) return null;
 
     return this.tablesOrderableItemOutlets.find(
-      (item) => item.id === this.dragState.targetId,
+      (item) => item.id === this.dragState.targetId
     );
   }
 
@@ -191,7 +191,7 @@ export default class OrderableListController extends Controller {
    */
   get #currentItems() {
     return this.tablesOrderableItemOutlets.toSorted(
-      (a, b) => a.comparisonIndex - b.comparisonIndex,
+      (a, b) => a.comparisonIndex - b.comparisonIndex
     );
   }
 
@@ -203,7 +203,7 @@ export default class OrderableListController extends Controller {
    */
   #targetItem(element) {
     return this.tablesOrderableItemOutlets.find(
-      (item) => item.element === element,
+      (item) => item.element === element
     );
   }
 

data/config/importmap.rb

@@ -1,5 +1,2 @@
 # frozen_string_literal: true
-
-pin_all_from Katalyst::Tables::Engine.root.join("app/assets/javascripts"),
-             # preload in tests so that we don't start clicking before controllers load
-             preload: Rails.env.test?
+pin "@katalyst/tables", to: "katalyst/tables.js"

data/lib/katalyst/tables/backend.rb

@@ -19,7 +19,7 @@ module Katalyst
       #
       # @return [[SortForm, ActiveRecord::Relation]]
       def table_sort(collection)
-        column, direction = params[:sort]&.split(" ")
+        column, direction = params[:sort]&.split
         direction         = "asc" unless SortForm::DIRECTIONS.include?(direction)
 
         SortForm.new(column:    column,

data/lib/katalyst/tables/engine.rb

@@ -9,14 +9,16 @@ module Katalyst
 
       initializer "katalyst-tables.asset" do
         config.after_initialize do |app|
-          app.config.assets.precompile += %w[katalyst-tables.js] if app.config.respond_to?(:assets)
+          if app.config.respond_to?(:assets)
+            app.config.assets.precompile += %w[katalyst-tables.js]
+          end
         end
       end
 
       initializer "katalyst-tables.importmap", before: "importmap" do |app|
         if app.config.respond_to?(:importmap)
           app.config.importmap.paths << root.join("config/importmap.rb")
-          app.config.importmap.cache_sweepers << root.join("app/assets/javascripts")
+          app.config.importmap.cache_sweepers << root.join("app/assets/builds")
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 2.2.12
+  version: 2.3.1
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katalyst-html-attributes
@@ -49,11 +49,11 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- app/assets/builds/katalyst/tables.esm.js
+- app/assets/builds/katalyst/tables.js
+- app/assets/builds/katalyst/tables.min.js
+- app/assets/builds/katalyst/tables.min.js.map
 - app/assets/config/katalyst-tables.js
-- app/assets/javascripts/controllers/tables/orderable/form_controller.js
-- app/assets/javascripts/controllers/tables/orderable/item_controller.js
-- app/assets/javascripts/controllers/tables/orderable/list_controller.js
-- app/assets/javascripts/controllers/tables/turbo_collection_controller.js
 - app/components/concerns/katalyst/tables/configurable_component.rb
 - app/components/concerns/katalyst/tables/has_table_content.rb
 - app/components/concerns/katalyst/tables/orderable.rb
@@ -70,6 +70,11 @@ files:
 - app/components/katalyst/tables/pagy_nav_component.rb
 - app/components/katalyst/turbo/pagy_nav_component.rb
 - app/components/katalyst/turbo/table_component.rb
+- app/javascript/tables/application.js
+- app/javascript/tables/orderable/form_controller.js
+- app/javascript/tables/orderable/item_controller.js
+- app/javascript/tables/orderable/list_controller.js
+- app/javascript/tables/turbo/collection_controller.js
 - app/models/concerns/katalyst/tables/collection/core.rb
 - app/models/concerns/katalyst/tables/collection/pagination.rb
 - app/models/concerns/katalyst/tables/collection/reducers.rb
@@ -100,14 +105,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: HTML table generator for Rails views