Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Admin: improve UX of search field on record lists

Damian Legawiec02acc9bd6c47
diff --git a/admin/app/assets/tailwind/spree/admin/components/_forms.css b/admin/app/assets/tailwind/spree/admin/components/_forms.css
index 20270a6a77..70f2555af9 100644
--- a/admin/app/assets/tailwind/spree/admin/components/_forms.css
+++ b/admin/app/assets/tailwind/spree/admin/components/_forms.css
@@ -248,4 +248,11 @@
.custom-range::-webkit-slider-thumb, .form-range::-webkit-slider-thumb {
@apply w-4 h-4 appearance-none bg-blue-500 rounded-full cursor-pointer ring-2 ring-blue-500/25 ring-offset-1 focus:outline-none;
}
+
+ /* Hide native search clear button */
+ input[type="search"]::-webkit-search-cancel-button,
+ input[type="search"]::-webkit-search-decoration {
+ -webkit-appearance: none;
+ appearance: none;
+ }
}
diff --git a/admin/app/javascript/spree/admin/application.js b/admin/app/javascript/spree/admin/application.js
index 4353cc840b..305ebb2ce0 100644
--- a/admin/app/javascript/spree/admin/application.js
+++ b/admin/app/javascript/spree/admin/application.js
@@ -74,6 +74,7 @@ import ReturnItemsController from 'spree/admin/controllers/return_items_controll
import ReplaceController from 'spree/admin/controllers/replace_controller'
import RowLinkController from 'spree/admin/controllers/row_link_controller'
import RuleFormController from 'spree/admin/controllers/rule_form_controller'
+import SearchClearController from 'spree/admin/controllers/search_clear_controller'
import SearchPickerController from 'spree/admin/controllers/search_picker_controller'
import SectionFormController from 'spree/admin/controllers/section_form_controller'
import SelectController from 'spree/admin/controllers/select_controller'
@@ -144,6 +145,7 @@ application.register('return-items', ReturnItemsController)
application.register('reveal', Reveal)
application.register('row-link', RowLinkController)
application.register('rule-form', RuleFormController)
+application.register('search-clear', SearchClearController)
application.register('search-picker', SearchPickerController)
application.register('section-form', SectionFormController)
application.register('select', SelectController)
diff --git a/admin/app/javascript/spree/admin/controllers/search_clear_controller.js b/admin/app/javascript/spree/admin/controllers/search_clear_controller.js
new file mode 100644
index 0000000000..8507709638
--- /dev/null
+++ b/admin/app/javascript/spree/admin/controllers/search_clear_controller.js
@@ -0,0 +1,22 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+ static targets = ["input", "clear"]
+
+ connect() {
+ this.toggleClearButton()
+ }
+
+ toggleClearButton() {
+ const hasValue = this.inputTarget.value.length > 0
+ this.clearTarget.classList.toggle("hidden", !hasValue)
+ }
+
+ clear() {
+ this.inputTarget.value = ""
+ this.toggleClearButton()
+ // Dispatch a 'search' event to trigger auto-submit
+ this.inputTarget.dispatchEvent(new Event("search", { bubbles: true }))
+ this.inputTarget.focus()
+ }
+}
diff --git a/admin/app/views/spree/admin/tables/_table.html.erb b/admin/app/views/spree/admin/tables/_table.html.erb
index fd4cdd21f9..2d07033f40 100644
--- a/admin/app/views/spree/admin/tables/_table.html.erb
+++ b/admin/app/views/spree/admin/tables/_table.html.erb
@@ -10,18 +10,22 @@
<%= render 'spree/admin/shared/export_modal', export_type: export_type %>
<% end %>
-<%= turbo_frame_tag frame_name, autoscroll: true, data: { autoscroll_block: :start, turbo_action: 'advance' } do %>
+<%= turbo_frame_tag frame_name, data: { turbo_action: 'advance' } do %>
<div class="<%= local_assigns[:container_class] || 'card-lg' %>" data-controller="table" data-table-url-value="<%= request.path %>">
<div class="p-3 border-b border-gray-200">
<div class="flex flex-col lg:flex-row gap-3 items-start lg:items-center justify-between">
<div class="flex gap-2 items-center flex-wrap">
- <%= search_form_for @search, url: url_for, html: { data: { turbo_frame: frame_name, turbo_action: 'advance' } } do |f| %>
- <div class="form-input flex items-center py-0 focus-within:outline-2 focus-within:outline-offset-2 focus-within:outline-blue-500 lg:w-[300px] mr-auto h-[2.125rem] transition-all duration-100 ease-in-out">
- <%= icon "search", class: "mr-4 text-gray-600" %>
+ <%= search_form_for @search, url: url_for, html: { data: { turbo_frame: frame_name, turbo_action: 'advance', controller: 'auto-submit search-clear', auto_submit_delay_value: 300 } } do |f| %>
+ <div class="form-input flex items-center py-0 pr-1 focus-within:outline-2 focus-within:outline-offset-2 focus-within:outline-blue-500 lg:w-[300px] mr-auto h-[2.125rem] transition-all duration-100 ease-in-out">
+ <%= icon "search", class: "mr-4 text-gray-600 shrink-0" %>
<%= search_field_tag "q[#{search_param}]",
params.dig(:q, search_param),
class: "outline-none border-0 h-full focus:border-0 focus:ring-0 p-0 text-base w-full",
- placeholder: search_placeholder %>
+ placeholder: search_placeholder,
+ data: { action: 'input->auto-submit#submit input->search-clear#toggleClearButton search->auto-submit#submit', search_clear_target: 'input' } %>
+ <button type="button" class="<%= 'hidden' if params.dig(:q, search_param).blank? %> p-1 text-gray-400 hover:text-gray-600 shrink-0" data-search-clear-target="clear" data-action="search-clear#clear">
+ <%= icon 'x', class: 'w-4 h-4' %>
+ </button>
</div>
<% end %>
</div>