hotwire_combobox 0.1.14 → 0.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1edf53e6f495466fb562c9e5a5fa6f4484fcb3f5729d561dc3e59ab622daad5
-  data.tar.gz: ade7a12ec97430ec9fb824525725706d0f4628f67a12019b5392c2f2b5ce46a2
+  metadata.gz: b5df1f9a0088f1fcc4298f725b24bab30d8f7edf74642939ad66794e3005842a
+  data.tar.gz: 784385d003bbc9648d3e8308342f4c4707a826930ecbba3f3829712c59f61c31
 SHA512:
-  metadata.gz: 4b8a4ed1d34fa641f546fc59838e052feaa9bd1f89a339b31ef218a5f61354cefb5cc4ced5c5b02d29a1416d125054a7a93087bc8a94b54855cba2fe0f4cb4da
-  data.tar.gz: 771ddf2a2f621331bc0199dcb114ef9362fdb090459a80dc1e56589d5c2221dd5eec45516a84acdc279fd349f86494fd800838c5203c6412bfa40f11e36a4724
+  metadata.gz: cacbd4cf2de90218a8b79430bb4d887dc49cc6168b17ee92c7dad04278d4e07866cd9c5e19cafed9b6989780e3c4e7ff8ca7071597ce0c48b458f4aad11f39de
+  data.tar.gz: 422a1376980a941746dbe5cd49caf5d12c8fce12803feac9934de9ead54b85f9d9bf039731ab2c897a813fb57453579ce4c29b9f442db995185d92bc44af9bc1

data/README.md

@@ -1,115 +1,21 @@
-# HotwireCombobox
+<p align="center">
+  <img src="docs/assets/images/logo.png" height=150>
+</p>
 
-A combobox implementation for Ruby on Rails apps running on Hotwire.
+# Easy Autocomplete for Ruby on Rails
 
-> [!WARNING]
-> This gem is pre-release software. It's not ready for production use yet and the API is subject to change.
+[![CI Tests](https://github.com/josefarias/hotwire_combobox/actions/workflows/ci_tests.yml/badge.svg)](https://github.com/josefarias/hotwire_combobox/actions/workflows/ci_tests.yml) [![Gem Version](https://badge.fury.io/rb/hotwire_combobox.svg)](https://badge.fury.io/rb/hotwire_combobox)
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem "hotwire_combobox"
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-## Output
-
-This is the stripped-down output of a combobox generated with HotwireCombobox. Understanding it will be helpful in getting the most out of this library.
-
-```html
-<fieldset class="hw-combobox">
-  <input type="hidden" name="provided_name">
-
-  <input type="text" role="combobox">
-
-  <ul role="listbox">
-    <li role="option">Provided Option 1 Content</li>
-    <li role="option">Provided Option 2 Content</li>
-    <!-- ... -->
-  </ul>
-</fieldset>
-```
-
-The `<ul role="listbox">` element is what gets shown when the combobox is open.
-
-The library uses stimulus to add interactivity to the combobox and sync the input element's value with the hidden input element.
-
-The hidden input's value is what ultimately gets sent to the server when submitting a form containing the combobox.
-
-## Usage
-
-### Options
-
-Options are what you see when you open the combobox.
 
-The `options` argument takes an array of any objects which respond to:
+> [!IMPORTANT]
+> We need your help to finalize this gem's first major release. Please use it in your apps and report any issues.
 
-| Method             | Description                                                                                                                                |
-|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
-| id                 | Used as the option element's `id` attribute. Only required if `value` is not provided.                                                     |
-| value              | Used to populate the input element's `value` attribute. Falls back to calling `id` on the object if not provided.                          |
-| content            | **Supports HTML** <br> Used as the option element's content. Falls back to calling `display` on the object if not provided.                |
-| filterable_as      | Used to filter down the options when the user types into the input element. Falls back to calling `display` on the object if not provided. |
-| autocompletable_as | Used to autocomplete the input element when the user types into it. Falls back to calling `display` on the object if not provided.         |
-| display            | Used as a short-hand for other attributes. See the rest of the list for details.                                                           |
-
-You can use the `combobox_options` helper to create an array of option objects which respond to the above methods:
-
-```ruby
-combobox_options [
-  { value: "AL", display: "Alabama" },
-  { value: "AK", display: "Alaska" },
-  { value: "AZ", display: "Arizona" },
-  # ...
-]
-```
-
-### Styling
-
-The combobox is completely unstyled by default. You can use the following CSS selectors to style the combobox:
-
-* `.hw-combobox` targets the `<fieldset>` element used to wrap the whole component.
-* `.hw-combobox [role="combobox"]` targets the input element.
-* `.hw-combobox [role="listbox"]` targets the listbox which encloses all option elements.
-* `.hw-combobox [role="option"]` targets each option element inside the listbox.
-
-Additionally, you can pass the following [Stimulus class values](https://stimulus.hotwired.dev/reference/css-classes) to `combobox_tag`:
-
-* `data-hw-combobox-selected-class`: The class to apply to the selected option while shown inside an open listbox.
-* `data-hw-combobox-invalid-class`: The class to apply to the input element when the current value is invalid.
-
-### Validity
-
-Unless `name_when_new` is passed, the hidden input can't have a value that's not in the list of options.
-
-If a nonexistent value is typed into the combobox, the value of the hidden input will be set empty.
-
-The only way a value can be marked as invalid is if the field is required and empty after having interacted with the combobox.
-
-The library will mark the element as invalid but this won't be noticeable in the UI unless you specify styles for the invalid state. See the [Styling](#styling) section for details.
-
-> [!CAUTION]
-> Bad actors can still submit invalid values to the server. You should always validate the input on the server side.
-
-### Naming Conflicts
-
-If your application has naming conflicts with this gem, the following config will turn:
+## Installation
 
-* `#combobox_tag` into `#hw_combobox_tag`
-* `#combobox_options` into `#hw_combobox_options`
+Add this line to your application's Gemfile and run `bundle install`:
 
 ```ruby
-# config/initializers/hotwire_combobox.rb
-
-HotwireCombobox.setup do |config|
-  config.bypass_convenience_methods = true
-end
+gem "hotwire_combobox"
 ```
 
 ## Contributing

data/app/helpers/hotwire_combobox/helper.rb

@@ -39,8 +39,8 @@ module HotwireCombobox
     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), format: :turbo_stream)
-      next_page = render("hotwire_combobox/next_page", for_id: for_id, src: src, next_page: next_page, format: :turbo_stream)
+      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)
 
       safe_join [ this_page, next_page ]
     end

data/lib/hotwire_combobox/engine.rb

@@ -21,5 +21,9 @@ module HotwireCombobox
     initializer "hotwire_combobox.importmap", before: "importmap" do |app|
       app.config.importmap.paths << Engine.root.join("config/importmap.rb")
     end
+
+    initializer "hotwire_combobox.assets.precompile" do |app|
+      app.config.assets.precompile += %w( hotwire_combobox.css )
+    end
   end
 end

data/lib/hotwire_combobox/version.rb

@@ -1,3 +1,3 @@
 module HotwireCombobox
-  VERSION = "0.1.14"
+  VERSION = "0.1.16"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire_combobox
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.16
 platform: ruby
 authors:
 - Jose Farias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-02 00:00:00.000000000 Z
+date: 2024-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.11
-description: A combobox implementation for Ruby on Rails apps running on Hotwire.
+description: A combobox implementation for Ruby on Rails apps using Hotwire.
 email:
 - jose@farias.mx
 executables: []
@@ -149,5 +149,5 @@ requirements: []
 rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
-summary: A combobox implementation for Ruby on Rails apps running on Hotwire
+summary: Autocomplete for Rails apps using Hotwire
 test_files: []