hotwire_nested_form 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95575593f362dd0db15938a6b130eb2fa7353e12b4c939c84ee4aa1eb00035ec
-  data.tar.gz: 8ace6c3f971faaadc42d2692a6540bd4a907387302963573a904ad7990b1a3b6
+  metadata.gz: de50acd45ca73b2f450facf4306904957892b14438c12e4b64aac7fa02eed9e9
+  data.tar.gz: c3e7e5096d346ba91d27f61ce6c20c28f3a076763769ab1e895b89df943a081d
 SHA512:
-  metadata.gz: 409ccb4b58b6be6caba5a0b8b5634f999337677de6c146ea3bb100bb3bab9496dca69f4ae5c72ed2587419d321552bb4c7bfb09788ac7664069c0fd2e5ae7e0d
-  data.tar.gz: 4b5902764ddc0e1e7b3223cd6f449a325089198a4a0fadee4077638eb7b403bc0179f0105233950c63b73f828339c6b796f577e3d807e67ec66137e286784791
+  metadata.gz: ead6225736617ac2c6367effc43422804167929c0d5fca1962165627e89d589c8c001f0e476f96eee2c8050de0d765863fe7bc8aa3b48a9f027ef7f9eb3ca034
+  data.tar.gz: cde5e3da91c82bd35ea3813f45a576b9ad872fbd1b806dcd35df6830e49597f6c34288d3bc3ec780d9bc2da946be7f68a01fd5021fe6efe59a60d2876f1f59bd

data/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.0] - 2026-02-06
+
+### Added
+- Drag & drop sorting for nested items (requires SortableJS)
+  - `data-nested-form-sortable-value` - enable sorting
+  - `data-nested-form-position-field-value` - custom position field name
+  - `data-nested-form-sort-handle-value` - CSS selector for drag handle
+- New events: `nested-form:before-sort` and `nested-form:after-sort`
+- CSS classes for drag styling: `nested-form-dragging`, `nested-form-drag-ghost`
+
+### Changed
+- Controller now cleans up Sortable instance on disconnect
+
 ## [1.2.0] - 2026-02-05
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hotwire_nested_form (1.2.0)
+    hotwire_nested_form (1.3.0)
       rails (>= 7.0)
 
 GEM

data/README.md

@@ -180,6 +180,98 @@ document.addEventListener("nested-form:minimum-reached", (event) => {
 })
 ```
 
+## Drag & Drop Sorting
+
+Enable drag & drop reordering with position persistence:
+
+### 1. Install SortableJS
+
+```bash
+# Rails with importmap
+bin/importmap pin sortablejs
+
+# OR npm/yarn
+npm install sortablejs
+```
+
+### 2. Add Position to Your Model
+
+```bash
+rails generate migration AddPositionToTasks position:integer
+rails db:migrate
+```
+
+```ruby
+# app/models/task.rb
+class Task < ApplicationRecord
+  belongs_to :project
+  default_scope { order(:position) }
+end
+```
+
+### 3. Update Your Partial
+
+```erb
+<%# app/views/projects/_task_fields.html.erb %>
+<div class="nested-fields">
+  <%= f.hidden_field :position %>
+  <span class="drag-handle">☰</span>
+  <%= f.text_field :name %>
+  <%= link_to_remove_association "Remove", f %>
+</div>
+```
+
+### 4. Enable Sorting
+
+```erb
+<div data-controller="nested-form"
+     data-nested-form-sortable-value="true"
+     data-nested-form-sort-handle-value=".drag-handle">
+  <!-- nested fields -->
+</div>
+```
+
+### 5. Permit Position in Controller
+
+```ruby
+params.require(:project).permit(:name,
+  tasks_attributes: [:id, :name, :position, :_destroy])
+```
+
+### Sorting Options
+
+| Attribute | Default | Description |
+|-----------|---------|-------------|
+| `data-nested-form-sortable-value` | `false` | Enable drag & drop |
+| `data-nested-form-position-field-value` | `"position"` | Position field name |
+| `data-nested-form-sort-handle-value` | (none) | Drag handle selector |
+
+### Sorting Events
+
+| Event | Detail | Description |
+|-------|--------|-------------|
+| `nested-form:before-sort` | `{ item, oldIndex }` | Before drag (cancelable) |
+| `nested-form:after-sort` | `{ item, oldIndex, newIndex }` | After drop |
+
+### Example CSS
+
+```css
+.drag-handle {
+  cursor: grab;
+  user-select: none;
+}
+
+.nested-form-dragging {
+  opacity: 0.8;
+  background: #e3f2fd;
+}
+
+.nested-form-drag-ghost {
+  opacity: 0.4;
+  border: 2px dashed #2196F3;
+}
+```
+
 ## NPM Package (JavaScript-only)
 
 For non-Rails projects using Stimulus, install via npm:
@@ -276,6 +368,8 @@ link_to_remove_association(name, form, options = {}, &block)
 | `nested-form:after-remove` | No | `{ wrapper }` | After fields removed |
 | `nested-form:limit-reached` | No | `{ limit, current }` | When max limit reached |
 | `nested-form:minimum-reached` | No | `{ minimum, current }` | When min limit reached |
+| `nested-form:before-sort` | Yes | `{ item, oldIndex }` | Before drag starts |
+| `nested-form:after-sort` | No | `{ item, oldIndex, newIndex }` | After drop completes |
 
 **Usage Examples:**
 

data/lib/generators/hotwire_nested_form/templates/nested_form_controller.js

@@ -5,11 +5,19 @@ export default class extends Controller {
     wrapperClass: { type: String, default: "nested-fields" },
     min: { type: Number, default: 0 },
     max: { type: Number, default: 999999 },
-    limitBehavior: { type: String, default: "disable" }
+    limitBehavior: { type: String, default: "disable" },
+    sortable: { type: Boolean, default: false },
+    positionField: { type: String, default: "position" },
+    sortHandle: { type: String, default: "" }
   }
 
   connect() {
     this.updateButtonStates()
+    if (this.sortableValue) this.initializeSortable()
+  }
+
+  disconnect() {
+    if (this.sortableInstance) this.sortableInstance.destroy()
   }
 
   get currentCount() {
@@ -45,6 +53,7 @@ export default class extends Controller {
     }
 
     this.updateButtonStates()
+    if (this.sortableValue && !this.sortableInstance) this.initializeSortable()
   }
 
   remove(event) {
@@ -146,4 +155,79 @@ export default class extends Controller {
         button.style.display = ""
     }
   }
+
+  // Drag & Drop Sorting
+
+  initializeSortable() {
+    if (typeof Sortable === 'undefined') {
+      console.warn('hotwire_nested_form: SortableJS not found. Install it for drag & drop sorting: https://sortablejs.github.io/Sortable/')
+      return
+    }
+
+    const container = this.findSortableContainer()
+    if (!container) return
+
+    this.sortableInstance = Sortable.create(container, {
+      animation: 150,
+      handle: this.sortHandleValue || null,
+      draggable: `.${this.wrapperClassValue}`,
+      ghostClass: 'nested-form-drag-ghost',
+      chosenClass: 'nested-form-dragging',
+      onStart: (evt) => this.onSortStart(evt),
+      onEnd: (evt) => this.onSortEnd(evt)
+    })
+  }
+
+  findSortableContainer() {
+    // Look for common container patterns
+    const selectors = ['#tasks', '#items', '[data-nested-form-target="container"]']
+    for (const selector of selectors) {
+      const container = this.element.querySelector(selector)
+      if (container) return container
+    }
+    // Fallback: find first element containing nested-fields
+    const firstField = this.element.querySelector(`.${this.wrapperClassValue}`)
+    return firstField ? firstField.parentElement : this.element
+  }
+
+  onSortStart(evt) {
+    const beforeEvent = this.dispatch("before-sort", {
+      cancelable: true,
+      detail: { item: evt.item, oldIndex: evt.oldIndex }
+    })
+
+    if (beforeEvent.defaultPrevented) {
+      this.sortableInstance.option("disabled", true)
+      setTimeout(() => this.sortableInstance.option("disabled", false), 0)
+    }
+  }
+
+  onSortEnd(evt) {
+    this.updatePositions()
+
+    this.dispatch("after-sort", {
+      detail: {
+        item: evt.item,
+        oldIndex: evt.oldIndex,
+        newIndex: evt.newIndex
+      }
+    })
+
+    this.updateButtonStates()
+  }
+
+  updatePositions() {
+    const items = this.element.querySelectorAll(
+      `.${this.wrapperClassValue}:not([style*="display: none"])`
+    )
+
+    items.forEach((item, index) => {
+      const positionInput = item.querySelector(
+        `input[name*="[${this.positionFieldValue}]"]`
+      )
+      if (positionInput) {
+        positionInput.value = index + 1
+      }
+    })
+  }
 }

data/lib/hotwire_nested_form/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HotwireNestedForm
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/npm/README.md

@@ -64,6 +64,40 @@ application.register("nested-form", NestedFormController)
 | `data-nested-form-max-value` | Maximum items allowed | unlimited |
 | `data-nested-form-limit-behavior-value` | `"disable"`, `"hide"`, or `"error"` | `"disable"` |
 
+### Drag & Drop Sorting
+
+Requires [SortableJS](https://sortablejs.github.io/Sortable/):
+
+```bash
+npm install sortablejs
+```
+
+```javascript
+import Sortable from 'sortablejs'
+window.Sortable = Sortable
+```
+
+```html
+<div data-controller="nested-form"
+     data-nested-form-sortable-value="true"
+     data-nested-form-sort-handle-value=".drag-handle">
+
+  <div id="items">
+    <div class="nested-fields">
+      <input type="hidden" name="items[][position]" value="1">
+      <span class="drag-handle">☰</span>
+      <!-- other fields -->
+    </div>
+  </div>
+</div>
+```
+
+| Attribute | Default | Description |
+|-----------|---------|-------------|
+| `data-nested-form-sortable-value` | `false` | Enable sorting |
+| `data-nested-form-position-field-value` | `"position"` | Position field name |
+| `data-nested-form-sort-handle-value` | (none) | Drag handle selector |
+
 ### Events
 
 | Event | Cancelable | Detail |
@@ -74,6 +108,8 @@ application.register("nested-form", NestedFormController)
 | `nested-form:after-remove` | No | `{ wrapper }` |
 | `nested-form:limit-reached` | No | `{ limit, current }` |
 | `nested-form:minimum-reached` | No | `{ minimum, current }` |
+| `nested-form:before-sort` | Yes | `{ item, oldIndex }` |
+| `nested-form:after-sort` | No | `{ item, oldIndex, newIndex }` |
 
 ### Example: Listen for Events
 

data/npm/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hotwire-nested-form-stimulus",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Stimulus controller for dynamic nested forms - works with Rails, React, Vue, or any Stimulus app",
   "main": "src/index.js",
   "module": "src/index.js",

data/npm/src/nested_form_controller.js

@@ -5,11 +5,19 @@ export default class extends Controller {
     wrapperClass: { type: String, default: "nested-fields" },
     min: { type: Number, default: 0 },
     max: { type: Number, default: 999999 },
-    limitBehavior: { type: String, default: "disable" }
+    limitBehavior: { type: String, default: "disable" },
+    sortable: { type: Boolean, default: false },
+    positionField: { type: String, default: "position" },
+    sortHandle: { type: String, default: "" }
   }
 
   connect() {
     this.updateButtonStates()
+    if (this.sortableValue) this.initializeSortable()
+  }
+
+  disconnect() {
+    if (this.sortableInstance) this.sortableInstance.destroy()
   }
 
   get currentCount() {
@@ -45,6 +53,7 @@ export default class extends Controller {
     }
 
     this.updateButtonStates()
+    if (this.sortableValue && !this.sortableInstance) this.initializeSortable()
   }
 
   remove(event) {
@@ -146,4 +155,79 @@ export default class extends Controller {
         button.style.display = ""
     }
   }
+
+  // Drag & Drop Sorting
+
+  initializeSortable() {
+    if (typeof Sortable === 'undefined') {
+      console.warn('hotwire_nested_form: SortableJS not found. Install it for drag & drop sorting: https://sortablejs.github.io/Sortable/')
+      return
+    }
+
+    const container = this.findSortableContainer()
+    if (!container) return
+
+    this.sortableInstance = Sortable.create(container, {
+      animation: 150,
+      handle: this.sortHandleValue || null,
+      draggable: `.${this.wrapperClassValue}`,
+      ghostClass: 'nested-form-drag-ghost',
+      chosenClass: 'nested-form-dragging',
+      onStart: (evt) => this.onSortStart(evt),
+      onEnd: (evt) => this.onSortEnd(evt)
+    })
+  }
+
+  findSortableContainer() {
+    // Look for common container patterns
+    const selectors = ['#tasks', '#items', '[data-nested-form-target="container"]']
+    for (const selector of selectors) {
+      const container = this.element.querySelector(selector)
+      if (container) return container
+    }
+    // Fallback: find first element containing nested-fields
+    const firstField = this.element.querySelector(`.${this.wrapperClassValue}`)
+    return firstField ? firstField.parentElement : this.element
+  }
+
+  onSortStart(evt) {
+    const beforeEvent = this.dispatch("before-sort", {
+      cancelable: true,
+      detail: { item: evt.item, oldIndex: evt.oldIndex }
+    })
+
+    if (beforeEvent.defaultPrevented) {
+      this.sortableInstance.option("disabled", true)
+      setTimeout(() => this.sortableInstance.option("disabled", false), 0)
+    }
+  }
+
+  onSortEnd(evt) {
+    this.updatePositions()
+
+    this.dispatch("after-sort", {
+      detail: {
+        item: evt.item,
+        oldIndex: evt.oldIndex,
+        newIndex: evt.newIndex
+      }
+    })
+
+    this.updateButtonStates()
+  }
+
+  updatePositions() {
+    const items = this.element.querySelectorAll(
+      `.${this.wrapperClassValue}:not([style*="display: none"])`
+    )
+
+    items.forEach((item, index) => {
+      const positionInput = item.querySelector(
+        `input[name*="[${this.positionFieldValue}]"]`
+      )
+      if (positionInput) {
+        positionInput.value = index + 1
+      }
+    })
+  }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire_nested_form
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - BhumitBhadani
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-05 00:00:00.000000000 Z
+date: 2026-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails