Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract the table search field to a component #5428

Merged
merged 1 commit into from
Oct 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ class SolidusAdmin::UI::Forms::Input::Component < SolidusAdmin::BaseComponent
datetime-local
month
week
search
time
]).freeze

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<label
data-controller="<%= stimulus_id %>"
class="items-center gap-1 p-0 inline-flex w-full justify-start relative"
>
<%= render component("ui/icon").new(
name: "search-line",
class: "w-[1.4em] h-[1.4em] fill-gray-500 absolute ml-3",
) %>
<%= render component("ui/forms/input").new(**@attributes) %>
<button
class="absolute right-0 mr-3 peer-placeholder-shown:hidden"
data-action="<%= stimulus_id %>#clear"
aria-label="<%= t('.clear') %>"
>
<%= render component("ui/icon").new(
name: "close-circle-fill",
class: "w-[1.4em] h-[1.4em] fill-gray-500"
) %>
</button>
</label>
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import { Controller } from "@hotwired/stimulus"

export default class extends Controller {
static targets = ["input"]

clear() {
this.inputTarget.value = ""
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# frozen_string_literal: true

class SolidusAdmin::UI::Forms::SearchField::Component < SolidusAdmin::BaseComponent
def initialize(**attributes)
@attributes = attributes
@attributes[:type] ||= :search
@attributes[:class] = "search-cancel:appearance-none peer !px-10 #{@attributes[:class]}"
@attributes[:"data-#{stimulus_id}-target"] = "input"
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
en:
clear: Clear
26 changes: 7 additions & 19 deletions admin/app/components/solidus_admin/ui/table/component.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -31,25 +31,13 @@
"data-action": "input->#{stimulus_id}#search change->#{stimulus_id}#search",
},
) do |form| %>
<label class="items-center gap-1 p-0 inline-flex w-full justify-start relative">
<%= render component("ui/icon").new(name: 'search-line', class: "w-[1.4em] h-[1.4em] fill-gray-500 absolute ml-3") %>
<input
name="<%= "#{@search_param}[#{@search_key}]" %>"
value="<%= params.dig(@search_param, @search_key) %>"
type="search"
placeholder="<%= t('.search_placeholder', resources: resource_plural_name) %>"
class="peer w-full placeholder:text-gray-400 py-1.5 px-10 bg-white rounded border border-gray-300 search-cancel:appearance-none"
data-<%= stimulus_id %>-target="searchField"
aria-label="<%= t('.search_placeholder', resources: resource_plural_name) %>"
>
<button
class="absolute right-0 mr-3 peer-placeholder-shown:hidden"
data-action="<%= stimulus_id %>#clearSearch"
aria-label="<%= t('.clear') %>"
>
<%= render component("ui/icon").new(name: 'close-circle-fill', class: "w-[1.4em] h-[1.4em] fill-gray-500") %>
</button>
</label>
<%= render component('ui/forms/search_field').new(
name: "#{@search_param}[#{@search_key}]",
value: params.dig(@search_param, @search_key),
placeholder: t('.search_placeholder', resources: resource_plural_name),
"data-#{stimulus_id}-target": "searchField",
"aria-label": t('.search_placeholder', resources: resource_plural_name)
) %>
<% end %>

<div class="ml-4">
Expand Down
5 changes: 0 additions & 5 deletions admin/app/components/solidus_admin/ui/table/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,6 @@ export default class extends Controller {
this.searchFormTarget.requestSubmit()
}

clearSearch() {
this.searchFieldTarget.value = ''
this.search()
}

cancelSearch() {
this.clearSearch()

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,4 @@ en:
search_placeholder: 'Search all %{resources}'
refine_search: 'Refine Search'
batch_actions: Batch actions
clear: Clear
cancel: Cancel
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# frozen_string_literal: true

# @component "ui/forms/search_field"
class SolidusAdmin::UI::Forms::SearchField::ComponentPreview < ViewComponent::Preview
include SolidusAdmin::Preview

def overview
render_with_template
end
end
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<div class="mb-8">
<h6 class="text-gray-500 mb-3 mt-0">
Default
</h6>

<%= render current_component.new %>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# frozen_string_literal: true

require "spec_helper"

RSpec.describe SolidusAdmin::UI::Forms::SearchField::Component, type: :component do
it "renders the overview preview" do
render_preview(:overview)
end
end