hotwire_combobox 0.1.34 → 0.1.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3bf6f83f984a36fb6e0491f68a71c9386c3f2a00e6b6082cd490b73e58d652d
-  data.tar.gz: db089a58628fa02b4a173f18053a9a81a21402eeafdcfb943d403989597bf314
+  metadata.gz: 446cd3c4beeb66029cab7cd6b92ac04c2a8c7a1f08ffd874728da2a3e605ead7
+  data.tar.gz: 9783eb83824ebeff3fa55536002c24e129fc66ed0b9d82e33c808a8d65c6c3ee
 SHA512:
-  metadata.gz: '0483ae80475b1d52b9b74d21c5749ee0300914954f74e40267de50cfb96dbb77e44a8bdfb5448caf9d743798e2621d678986927c5f201c40052e049c2844a13f'
-  data.tar.gz: 594db1df1c85dd096ca2cebf2ff9a7dc6564e061aee5f4403729eb94eaf55ab587f32ea620b0f359bd5f1c41e2e4c70096fb5ef04230a07ee13d6cda7873cd33
+  metadata.gz: a4d5e3d5fddd0017fc6bb6e838a60550d0e7dc2da3fac8999befa092ad9a8a7d35753cc785271fdfb8fe43e63edc535dc97f441594c8be2a3eece394622b97d6
+  data.tar.gz: 1d60ba35f6f043b9698d7b9bd48aadd702e67c00cb626068e797890ebcc3cfd370af14c33479da153f57096c1015c062f7539676da55aac559d76b38234a4d24

data/app/assets/javascripts/controllers/hw_combobox_controller.js

@@ -1,7 +1,9 @@
 import Combobox from "hw_combobox/models/combobox"
-import { Concerns } from "hw_combobox/helpers"
+import { Concerns, sleep } from "hw_combobox/helpers"
 import { Controller } from "@hotwired/stimulus"
 
+window.HOTWIRE_COMBOBOX_STREAM_DELAY = 0 // ms, for testing purposes
+
 const concerns = [
   Controller,
   Combobox.Actors,
@@ -70,13 +72,15 @@ export default class HwComboboxController extends Concerns(...concerns) {
     }
   }
 
-  endOfOptionsStreamTargetConnected(element) {
+  async endOfOptionsStreamTargetConnected(element) {
     const inputType = element.dataset.inputType
+    const delay = window.HOTWIRE_COMBOBOX_STREAM_DELAY
 
-    this._preselectOption()
-
-    if (inputType) {
+    if (inputType && inputType !== "hw:lockInSelection") {
+      if (delay) await sleep(delay)
       this._commitFilter({ inputType })
+    } else {
+      this._preselectOption()
     }
   }
 }

data/app/assets/javascripts/hw_combobox/helpers.js

@@ -1,5 +1,3 @@
-export const nullEvent = new Event("NULL")
-
 export function Concerns(Base, ...mixins) {
   return mixins.reduce((accumulator, current) => current(accumulator), Base)
 }
@@ -52,3 +50,15 @@ export function debounce(fn, delay = 150) {
 export function isDeleteEvent(event) {
   return event.inputType === "deleteContentBackward" || event.inputType === "deleteWordBackward"
 }
+
+export function sleep(ms) {
+  return new Promise(resolve => setTimeout(resolve, ms))
+}
+
+export function unselectedPortion(element) {
+  if (element.selectionStart === element.selectionEnd) {
+    return element.value
+  } else {
+    return element.value.substring(0, element.selectionStart)
+  }
+}

data/app/assets/javascripts/hw_combobox/models/combobox/autocomplete.js

@@ -11,14 +11,14 @@ Combobox.Autocomplete = Base => class extends Base {
   _autocompleteWith(option, { force }) {
     if (!this._autocompletesInline && !force) return
 
-    const typedValue = this._query
+    const typedValue = this._typedQuery
     const autocompletedValue = option.getAttribute(this.autocompletableAttributeValue)
 
     if (force) {
-      this._query = autocompletedValue
+      this._fullQuery = autocompletedValue
       this._actingCombobox.setSelectionRange(autocompletedValue.length, autocompletedValue.length)
     } else if (startsWith(autocompletedValue, typedValue)) {
-      this._query = autocompletedValue
+      this._fullQuery = autocompletedValue
       this._actingCombobox.setSelectionRange(typedValue.length, autocompletedValue.length)
     }
   }
@@ -30,14 +30,14 @@ Combobox.Autocomplete = Base => class extends Base {
   }
 
   get _isExactAutocompleteMatch() {
-    return this._immediatelyAutocompletableValue === this._query
+    return this._immediatelyAutocompletableValue === this._fullQuery
   }
 
   // All `_isExactAutocompleteMatch` matches are `_isPartialAutocompleteMatch` matches
   // but not all `_isPartialAutocompleteMatch` matches are `_isExactAutocompleteMatch` matches.
   get _isPartialAutocompleteMatch() {
     return !!this._immediatelyAutocompletableValue &&
-      startsWith(this._immediatelyAutocompletableValue, this._query)
+      startsWith(this._immediatelyAutocompletableValue, this._fullQuery)
   }
 
   get _autocompletesList() {
@@ -49,6 +49,6 @@ Combobox.Autocomplete = Base => class extends Base {
   }
 
   get _immediatelyAutocompletableValue() {
-    return this._visibleOptionElements[0]?.getAttribute(this.autocompletableAttributeValue)
+    return this._ensurableOption?.getAttribute(this.autocompletableAttributeValue)
   }
 }

data/app/assets/javascripts/hw_combobox/models/combobox/dialog.js

@@ -14,7 +14,7 @@ Combobox.Dialog = Base => class extends Base {
   }
 
   _moveArtifactsToDialog() {
-    this.dialogComboboxTarget.value = this._query
+    this.dialogComboboxTarget.value = this._fullQuery
 
     this._actingCombobox = this.dialogComboboxTarget
     this._actingListbox = this.dialogListboxTarget
@@ -23,7 +23,7 @@ Combobox.Dialog = Base => class extends Base {
   }
 
   _moveArtifactsInline() {
-    this.comboboxTarget.value = this._query
+    this.comboboxTarget.value = this._fullQuery
 
     this._actingCombobox = this.comboboxTarget
     this._actingListbox = this.listboxTarget

data/app/assets/javascripts/hw_combobox/models/combobox/filtering.js

@@ -1,6 +1,6 @@
 
 import Combobox from "hw_combobox/models/combobox/base"
-import { applyFilter, debounce, isDeleteEvent } from "hw_combobox/helpers"
+import { applyFilter, debounce, isDeleteEvent, unselectedPortion } from "hw_combobox/helpers"
 import { get } from "hw_combobox/vendor/requestjs"
 
 Combobox.Filtering = Base => class extends Base {
@@ -21,13 +21,13 @@ Combobox.Filtering = Base => class extends Base {
   }
 
   async _filterAsync(event) {
-    const query = { q: this._query, input_type: event.inputType }
+    const query = { q: this._fullQuery, input_type: event.inputType }
     await get(this.asyncSrcValue, { responseKind: "turbo-stream", query })
   }
 
   _filterSync(event) {
     this.open()
-    this._allOptionElements.forEach(applyFilter(this._query, { matching: this.filterableAttributeValue }))
+    this._allOptionElements.forEach(applyFilter(this._fullQuery, { matching: this.filterableAttributeValue }))
     this._commitFilter(event)
   }
 
@@ -42,16 +42,18 @@ Combobox.Filtering = Base => class extends Base {
   }
 
   get _isQueried() {
-    return this._query.length > 0
+    return this._fullQuery.length > 0
   }
 
-  // Consider +_query+ will contain the full autocompleted value
-  // after a certain point in the call chain.
-  get _query() {
-    return this._actingCombobox.value.trim()
+  get _fullQuery() {
+    return this._actingCombobox.value
   }
 
-  set _query(value) {
+  set _fullQuery(value) {
     this._actingCombobox.value = value
   }
+
+  get _typedQuery() {
+    return unselectedPortion(this._actingCombobox)
+  }
 }

data/app/assets/javascripts/hw_combobox/models/combobox/selection.js

@@ -1,5 +1,5 @@
 import Combobox from "hw_combobox/models/combobox/base"
-import { wrapAroundAccess, nullEvent } from "hw_combobox/helpers"
+import { wrapAroundAccess } from "hw_combobox/helpers"
 
 Combobox.Selection = Base => class extends Base {
   selectOption(event) {
@@ -10,16 +10,16 @@ Combobox.Selection = Base => class extends Base {
 
   _connectSelection() {
     if (this.hasPrefilledDisplayValue) {
-      this._query = this.prefilledDisplayValue
+      this._fullQuery = this.prefilledDisplayValue
     }
   }
 
-  _select(option, { force = false } = {}) {
+  _select(option, { forceAutocomplete = false } = {}) {
     this._resetOptions()
 
     if (option) {
       this._markValid()
-      this._autocompleteWith(option, { force })
+      this._autocompleteWith(option, { force: forceAutocomplete })
       this._commitSelection(option, { selected: true })
     } else {
       this._markInvalid()
@@ -32,8 +32,6 @@ Combobox.Selection = Base => class extends Base {
     if (selected) {
       this.hiddenFieldTarget.value = option.dataset.value
       option.scrollIntoView({ block: "nearest" })
-    } else {
-      this.hiddenFieldTarget.value = null
     }
   }
 
@@ -48,17 +46,18 @@ Combobox.Selection = Base => class extends Base {
   _deselect() {
     const option = this._selectedOptionElement
     if (option) this._commitSelection(option, { selected: false })
+    this.hiddenFieldTarget.value = null
   }
 
   _selectNew() {
     this._resetOptions()
-    this.hiddenFieldTarget.value = this._query
+    this.hiddenFieldTarget.value = this._fullQuery
     this.hiddenFieldTarget.name = this.nameWhenNewValue
   }
 
   _selectIndex(index) {
     const option = wrapAroundAccess(this._visibleOptionElements, index)
-    this._select(option, { force: true })
+    this._select(option, { forceAutocomplete: true })
   }
 
   _preselectOption() {
@@ -71,10 +70,10 @@ Combobox.Selection = Base => class extends Base {
     }
   }
 
-  _selectFuzzyMatch() {
-    if (this._isFuzzyMatch) {
-      this._select(this._visibleOptionElements[0], { force: true })
-      this.filter(nullEvent)
+  _lockInSelection() {
+    if (this._shouldLockInSelection) {
+      this._select(this._ensurableOption, { forceAutocomplete: true })
+      this.filter({ inputType: "hw:lockInSelection" })
     }
   }
 
@@ -82,7 +81,11 @@ Combobox.Selection = Base => class extends Base {
     return this.hiddenFieldTarget.value && !this._selectedOptionElement
   }
 
-  get _isFuzzyMatch() {
-    return this._isQueried && !!this._visibleOptionElements[0] && !this._isNewOptionWithPotentialMatches
+  get _shouldLockInSelection() {
+    return this._isQueried && !!this._ensurableOption && !this._isNewOptionWithPotentialMatches
+  }
+
+  get _ensurableOption() {
+    return this._selectedOptionElement || this._visibleOptionElements[0]
   }
 }

data/app/assets/javascripts/hw_combobox/models/combobox/toggle.js

@@ -8,7 +8,7 @@ Combobox.Toggle = Base => class extends Base {
 
   close() {
     if (this._isOpen) {
-      this._ensureSelection()
+      this._lockInSelection()
       this.expandedValue = false
     }
   }
@@ -34,7 +34,6 @@ Combobox.Toggle = Base => class extends Base {
   closeOnFocusOutside({ target }) {
     if (!this._isOpen) return
     if (this.element.contains(target)) return
-    if (target.matches("main")) return
 
     this.close()
   }
@@ -50,10 +49,6 @@ Combobox.Toggle = Base => class extends Base {
     return clientX >= left && clientX <= right && clientY >= top && clientY <= bottom
   }
 
-  _ensureSelection() {
-    this._selectFuzzyMatch()
-  }
-
   _openByFocusing() {
     this._actingCombobox.focus()
   }

data/lib/hotwire_combobox/version.rb

@@ -1,3 +1,3 @@
 module HotwireCombobox
-  VERSION = "0.1.34"
+  VERSION = "0.1.36"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire_combobox
 version: !ruby/object:Gem::Version
-  version: 0.1.34
+  version: 0.1.36
 platform: ruby
 authors:
 - Jose Farias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-29 00:00:00.000000000 Z
+date: 2024-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,7 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
-description: A combobox implementation for Ruby on Rails apps using Hotwire.
+description: An autocomplete combobox implementation for Ruby on Rails apps using
+  Hotwire.
 email:
 - jose@farias.mx
 executables: []