hotwire_combobox 0.1.36 → 0.1.38

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

@@ -6,6 +6,10 @@ Combobox.Actors = Base => class extends Base {
     this._actingCombobox = this.comboboxTarget
   }
 
+  _forAllComboboxes(callback) {
+    this._allComboboxes.forEach(callback)
+  }
+
   get _actingListbox() {
     return this.actingListbox
   }
@@ -21,4 +25,8 @@ Combobox.Actors = Base => class extends Base {
   set _actingCombobox(combobox) {
     this.actingCombobox = combobox
   }
+
+  get _allComboboxes() {
+    return [ this.comboboxTarget, this.dialogComboboxTarget ]
+  }
 }

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

@@ -21,7 +21,12 @@ Combobox.Filtering = Base => class extends Base {
   }
 
   async _filterAsync(event) {
-    const query = { q: this._fullQuery, input_type: event.inputType }
+    const query = {
+      q: this._fullQuery,
+      input_type: event.inputType,
+      for_id: this.element.dataset.asyncId
+    }
+
     await get(this.asyncSrcValue, { responseKind: "turbo-stream", query })
   }
 

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

@@ -41,12 +41,14 @@ Combobox.Selection = Base => class extends Base {
     }
 
     option.setAttribute("aria-selected", selected)
+    this._setActiveDescendant(selected ? option.id : "")
   }
 
   _deselect() {
     const option = this._selectedOptionElement
     if (option) this._commitSelection(option, { selected: false })
     this.hiddenFieldTarget.value = null
+    this._setActiveDescendant("")
   }
 
   _selectNew() {
@@ -77,6 +79,10 @@ Combobox.Selection = Base => class extends Base {
     }
   }
 
+  _setActiveDescendant(id) {
+    this._forAllComboboxes(el => el.setAttribute("aria-activedescendant", id))
+  }
+
   get _hasValueButNoSelection() {
     return this.hiddenFieldTarget.value && !this._selectedOptionElement
   }

data/app/assets/stylesheets/hotwire_combobox.css

@@ -121,6 +121,10 @@
   text-overflow: ellipsis;
 }
 
+.hw-combobox__option--blank {
+  border-bottom: var(--hw-border-width--slim) solid var(--hw-border-color);
+}
+
 .hw-combobox__option:hover,
 .hw-combobox__option--selected {
   background-color: var(--hw-active-bg-color);

data/app/presenters/hotwire_combobox/component.rb

@@ -1,5 +1,7 @@
+require "securerandom"
+
 class HotwireCombobox::Component
-  attr_reader :async_src, :options, :dialog_label
+  attr_reader :options, :dialog_label
 
   def initialize \
       view, name,
@@ -53,8 +55,9 @@ class HotwireCombobox::Component
       class: "hw-combobox__input",
       type: input_type,
       data: input_data,
-      aria: input_aria
-    }.merge combobox_attrs.except(*nested_attrs)
+      aria: input_aria,
+      autocomplete: :off
+    }.with_indifferent_access.merge combobox_attrs.except(*nested_attrs)
   end
 
 
@@ -77,11 +80,6 @@ class HotwireCombobox::Component
   end
 
 
-  def listbox_options_attrs
-    { id: listbox_options_id }
-  end
-
-
   def dialog_wrapper_attrs
     {
       class: "hw-combobox__dialog__wrapper"
@@ -185,9 +183,13 @@ class HotwireCombobox::Component
       form&.object&.class&.reflect_on_association(association_name).present?
     end
 
+    def async_src
+      view.hw_uri_with_params @async_src, for_id: canonical_id, format: :turbo_stream
+    end
+
 
     def canonical_id
-      id || form&.field_id(name)
+      id || form&.field_id(name) || SecureRandom.uuid
     end
 
 
@@ -239,7 +241,8 @@ class HotwireCombobox::Component
         controls: listbox_id,
         owns: listbox_id,
         haspopup: "listbox",
-        autocomplete: autocomplete
+        autocomplete: autocomplete,
+        activedescendant: ""
     end
 
 
@@ -260,11 +263,6 @@ class HotwireCombobox::Component
     end
 
 
-    def listbox_options_id
-      "#{listbox_id}__options"
-    end
-
-
     def dialog_data
       {
         action: "keydown->hw-combobox#navigate",
@@ -290,7 +288,8 @@ class HotwireCombobox::Component
       {
         controls: dialog_listbox_id,
         owns: dialog_listbox_id,
-        autocomplete: autocomplete
+        autocomplete: autocomplete,
+        activedescendant: ""
       }
     end
 

data/app/presenters/hotwire_combobox/listbox/option.rb

@@ -1,3 +1,5 @@
+require "securerandom"
+
 class HotwireCombobox::Listbox::Option
   def initialize(option)
     @option = option.is_a?(Hash) ? Data.new(**option) : option
@@ -16,7 +18,7 @@ class HotwireCombobox::Listbox::Option
   end
 
   private
-    Data = Struct.new :id, :value, :display, :content, :filterable_as, :autocompletable_as, keyword_init: true
+    Data = Struct.new :id, :value, :display, :content, :blank, :filterable_as, :autocompletable_as, keyword_init: true
 
     attr_reader :option
 
@@ -24,13 +26,13 @@ class HotwireCombobox::Listbox::Option
       {
         id: id,
         role: :option,
-        class: "hw-combobox__option",
+        class: [ "hw-combobox__option", { "hw-combobox__option--blank": blank? } ],
         data: data
       }
     end
 
     def id
-      option.try(:id)
+      option.try(:id) || SecureRandom.uuid
     end
 
     def data
@@ -49,4 +51,8 @@ class HotwireCombobox::Listbox::Option
     def filterable_as
       option.try(:filterable_as) || option.try(:display)
     end
+
+    def blank?
+      option.try(:blank).present?
+    end
 end

data/app/views/hotwire_combobox/_next_page.turbo_stream.erb

@@ -1,5 +1,6 @@
 <%# locals: (for_id:, next_page:, src:) -%>
 
-<%= turbo_stream.replace hw_pagination_frame_id(for_id) do %>
-  <%= render "hotwire_combobox/pagination", for_id: for_id, src: hw_combobox_next_page_uri(src, next_page) %>
+<%= turbo_stream.remove hw_pagination_frame_wrapper_id(for_id) %>
+<%= turbo_stream.append hw_listbox_id(for_id) do %>
+  <%= render "hotwire_combobox/pagination", for_id: for_id, src: hw_combobox_next_page_uri(src, next_page, for_id) %>
 <% end %>

data/app/views/hotwire_combobox/_paginated_options.turbo_stream.erb

@@ -1,6 +1,6 @@
 <%# locals: (for_id:, options:) -%>
 
-<%= turbo_stream.public_send(hw_combobox_page_stream_action, hw_listbox_options_id(for_id)) do %>
+<%= turbo_stream.public_send(hw_combobox_page_stream_action, hw_listbox_id(for_id)) do %>
   <% options.each do |option| %>
     <%= render option %>
   <% end %>

data/app/views/hotwire_combobox/_pagination.html.erb

@@ -1,4 +1,7 @@
 <%# locals: (for_id:, src:) -%>
 
-<%= turbo_frame_tag hw_pagination_frame_id(for_id), src: src, loading: :lazy,
-      data: { hw_combobox_target: "endOfOptionsStream", input_type: params[:input_type] } %>
+<%= tag.li id: hw_pagination_frame_wrapper_id(for_id), data: {
+      hw_combobox_target: "endOfOptionsStream", input_type: params[:input_type] },
+      aria: { hidden: true } do %>
+  <%= turbo_frame_tag hw_pagination_frame_id(for_id), src: src, loading: :lazy %>
+<% end %>

data/app/views/hotwire_combobox/combobox/_paginated_listbox.html.erb

@@ -1,8 +1,6 @@
 <%= tag.ul **component.listbox_attrs do |ul| %>
-  <%= tag.div **component.listbox_options_attrs do %>
-    <% component.options.each do |option| %>
-      <%= render option %>
-    <% end %>
+  <% component.options.each do |option| %>
+    <%= render option %>
   <% end %>
 
   <% if component.paginated? %>

data/lib/hotwire_combobox/engine.rb

@@ -10,7 +10,7 @@ module HotwireCombobox
         unless HotwireCombobox.bypass_convenience_methods?
           module FormBuilderExtensions
             def combobox(*args, **kwargs)
-              @template.hw_combobox_tag *args, **kwargs.merge(form: self)
+              @template.hw_combobox_tag(*args, **kwargs.merge(form: self))
             end
           end
 

data/lib/hotwire_combobox/helper.rb

@@ -15,27 +15,32 @@ module HotwireCombobox
     end
     hw_alias :hw_combobox_style_tag
 
-    def hw_combobox_tag(name, options_or_src = [], render_in: {}, **kwargs)
-      options, src = hw_extract_options_and_src(options_or_src, render_in)
+    def hw_combobox_tag(name, options_or_src = [], render_in: {}, include_blank: nil, **kwargs)
+      options, src = hw_extract_options_and_src(options_or_src, render_in, include_blank)
       component = HotwireCombobox::Component.new self, name, options: options, async_src: src, **kwargs
 
       render "hotwire_combobox/combobox", component: component
     end
     hw_alias :hw_combobox_tag
 
-    def hw_combobox_options(options, render_in: {}, display: :to_combobox_display, **methods)
+    def hw_combobox_options(options, render_in: {}, include_blank: nil, display: :to_combobox_display, **methods)
       if options.first.is_a? HotwireCombobox::Listbox::Option
         options
       else
-        render_in_proc = ->(object) { render(**render_in.merge(object: object)) } if render_in.present?
-        hw_parse_combobox_options options, render_in: render_in_proc, **methods.merge(display: display)
+        render_in_proc = hw_render_in_proc(render_in) if render_in.present?
+
+        hw_parse_combobox_options(options, render_in: render_in_proc, **methods.merge(display: display)).tap do |options|
+          options.unshift(hw_blank_option(include_blank)) if include_blank.present?
+        end
       end
     end
     hw_alias :hw_combobox_options
 
-    def hw_paginated_combobox_options(options, for_id:, src: request.path, next_page: nil, render_in: {}, **methods)
-      this_page = render("hotwire_combobox/paginated_options", for_id: for_id, options: hw_combobox_options(options, render_in: render_in, **methods))
-      next_page = render("hotwire_combobox/next_page", for_id: for_id, src: src, next_page: next_page)
+    def hw_paginated_combobox_options(options, for_id: params[:for_id], src: request.path, next_page: nil, render_in: {}, include_blank: {}, **methods)
+      include_blank = params[:page] ? nil : include_blank
+      options = hw_combobox_options options, render_in: render_in, include_blank: include_blank, **methods
+      this_page = render "hotwire_combobox/paginated_options", for_id: for_id, options: options
+      next_page = render "hotwire_combobox/next_page", for_id: for_id, src: src, next_page: next_page
 
       safe_join [ this_page, next_page ]
     end
@@ -44,18 +49,26 @@ module HotwireCombobox
     alias_method :hw_async_combobox_options, :hw_paginated_combobox_options
     hw_alias :hw_async_combobox_options
 
-    protected # library use only
-      def hw_listbox_options_id(id)
-        "#{id}-hw-listbox__options"
+    # private library use only
+      def hw_listbox_id(id)
+        "#{id}-hw-listbox"
+      end
+
+      def hw_pagination_frame_wrapper_id(id)
+        "#{id}__hw_combobox_pagination__wrapper"
       end
 
       def hw_pagination_frame_id(id)
         "#{id}__hw_combobox_pagination"
       end
 
-      def hw_combobox_next_page_uri(uri, next_page)
+      def hw_combobox_next_page_uri(uri, next_page, for_id)
         if next_page
-          hw_uri_with_params uri, page: next_page, q: params[:q], format: :turbo_stream
+          hw_uri_with_params uri,
+            page: next_page,
+            q: params[:q],
+            for_id: for_id,
+            format: :turbo_stream
         end
       end
 
@@ -63,12 +76,19 @@ module HotwireCombobox
         params[:page] ? :append : :update
       end
 
-    private
-      def hw_extract_options_and_src(options_or_src, render_in)
-        if options_or_src.is_a? String
-          [ [], hw_uri_with_params(options_or_src, format: :turbo_stream) ]
+      def hw_blank_option(include_blank)
+        display, content = hw_extract_blank_display_and_content include_blank
+
+        HotwireCombobox::Listbox::Option.new display: display, content: content, value: "", blank: true
+      end
+
+      def hw_extract_blank_display_and_content(include_blank)
+        if include_blank.is_a? Hash
+          text = include_blank.delete(:text)
+
+          [ text, hw_render_in_proc(include_blank).(text) ]
         else
-          [ hw_combobox_options(options_or_src, render_in: render_in), nil ]
+          [ include_blank, include_blank ]
         end
       end
 
@@ -81,9 +101,23 @@ module HotwireCombobox
         url_or_path
       end
 
+    private
+      def hw_render_in_proc(render_in)
+        ->(object) { render(**render_in.reverse_merge(object: object)) }
+      end
+
+      def hw_extract_options_and_src(options_or_src, render_in, include_blank)
+        if options_or_src.is_a? String
+          [ [], options_or_src ]
+        else
+          [ hw_combobox_options(options_or_src, render_in: render_in, include_blank: include_blank), nil ]
+        end
+      end
+
       def hw_parse_combobox_options(options, render_in: nil, **methods)
         options.map do |option|
-          HotwireCombobox::Listbox::Option.new **hw_option_attrs_for(option, render_in: render_in, **methods)
+          HotwireCombobox::Listbox::Option.new \
+            **hw_option_attrs_for(option, render_in: render_in, **methods)
         end
       end
 
@@ -118,8 +152,43 @@ module HotwireCombobox
         if method_or_proc.is_a? Proc
           method_or_proc.call object
         else
-          object.public_send method_or_proc
+          hw_call_method object, method_or_proc
+        end
+      end
+
+      def hw_call_method(object, method)
+        if object.respond_to? method
+          object.public_send method
+        else
+          hw_raise_no_public_method_error object, method
+        end
+      end
+
+      def hw_raise_no_public_method_error(object, method)
+        if object.respond_to? method, true
+          header = "`#{object.class}` responds to `##{method}` but the method is not public."
+        else
+          header = "`#{object.class}` does not respond to `##{method}`."
+        end
+
+        if method.to_s == "to_combobox_display"
+          header << "\n\nThis method is used to determine how this option should appear in the combobox options list."
         end
+
+        raise NoMethodError, <<~MSG
+          [ACTION NEEDED] – Message from HotwireCombobox:
+
+          #{header}
+
+          Please add this as a public method and return a string.
+
+          Example:
+            class #{object.class} < ApplicationRecord
+              def #{method}
+                name # or `title`, `to_s`, etc.
+              end
+            end
+        MSG
       end
   end
 end

data/lib/hotwire_combobox/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire_combobox
 version: !ruby/object:Gem::Version
-  version: 0.1.36
+  version: 0.1.38
 platform: ruby
 authors:
 - Jose Farias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -65,6 +65,8 @@ files:
 - Rakefile
 - app/assets/config/hw_combobox_manifest.js
 - app/assets/javascripts/controllers/hw_combobox_controller.js
+- app/assets/javascripts/hotwire_combobox.esm.js
+- app/assets/javascripts/hotwire_combobox.umd.js
 - app/assets/javascripts/hw_combobox/helpers.js
 - app/assets/javascripts/hw_combobox/models/combobox.js
 - app/assets/javascripts/hw_combobox/models/combobox/actors.js