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.

Added `dialog` and `drawer` methods to fully implement Dialog / Drawe… (#13461)

Damian Legawiec849974e4f2fd
diff --git a/admin/app/helpers/spree/admin/dialog_helper.rb b/admin/app/helpers/spree/admin/dialog_helper.rb
index 80ed794a51..88022823cc 100644
--- a/admin/app/helpers/spree/admin/dialog_helper.rb
+++ b/admin/app/helpers/spree/admin/dialog_helper.rb
@@ -1,6 +1,36 @@
module Spree
module Admin
module DialogHelper
+ # Renders a dialog container element
+ # @param id [String, nil] the id of the dialog element
+ # @param controller_name [String] the Stimulus controller name (default: 'dialog')
+ # @param html_options [Hash] additional HTML attributes
+ # @yield the content to render inside the dialog
+ # @return [String] the dialog HTML
+ #
+ # @example Basic usage
+ # <%= dialog do %>
+ # <%= dialog_header("Confirm Delete") %>
+ # <div class="dialog-body">Are you sure?</div>
+ # <div class="dialog-footer">
+ # <%= dialog_discard_button %>
+ # <%= button_tag "Delete", class: "btn btn-danger" %>
+ # </div>
+ # <% end %>
+ #
+ # @example With custom id and controller
+ # <%= dialog(id: 'my-dialog', controller_name: 'custom-dialog') do %>
+ # ...
+ # <% end %>
+ def dialog(id: nil, controller_name: 'dialog', **html_options, &block)
+ html_options[:class] = "dialog #{html_options[:class]}".strip
+ html_options[:data] ||= {}
+ html_options[:data]["#{controller_name}-target".to_sym] = 'dialog'
+ html_options[:id] = id if id.present?
+
+ content_tag(:dialog, html_options, &block)
+ end
+
def dialog_header(title, controller_name = 'dialog')
content_tag(:div, class: 'dialog-header') do
content_tag(:h5, title, class: 'dialog-title') + dialog_close_button(controller_name)
diff --git a/admin/app/helpers/spree/admin/drawer_helper.rb b/admin/app/helpers/spree/admin/drawer_helper.rb
index c39d181c98..9a95212e4f 100644
--- a/admin/app/helpers/spree/admin/drawer_helper.rb
+++ b/admin/app/helpers/spree/admin/drawer_helper.rb
@@ -1,6 +1,36 @@
module Spree
module Admin
module DrawerHelper
+ # Renders a drawer container element (slide-out panel)
+ # @param id [String, nil] the id of the drawer element
+ # @param controller_name [String] the Stimulus controller name (default: 'drawer')
+ # @param html_options [Hash] additional HTML attributes
+ # @yield the content to render inside the drawer
+ # @return [String] the drawer HTML
+ #
+ # @example Basic usage
+ # <%= drawer do %>
+ # <%= drawer_header("Edit Product") %>
+ # <div class="drawer-body">Form fields here...</div>
+ # <div class="drawer-footer">
+ # <%= drawer_discard_button %>
+ # <%= button_tag "Save", class: "btn btn-primary" %>
+ # </div>
+ # <% end %>
+ #
+ # @example With custom id and controller
+ # <%= drawer(id: 'filters-drawer', controller_name: 'dialog') do %>
+ # ...
+ # <% end %>
+ def drawer(id: nil, controller_name: 'drawer', **html_options, &block)
+ html_options[:class] = "drawer #{html_options[:class]}".strip
+ html_options[:data] ||= {}
+ html_options[:data]["#{controller_name}-target".to_sym] = 'dialog'
+ html_options[:id] = id if id.present?
+
+ content_tag(:dialog, html_options, &block)
+ end
+
def drawer_header(title, controller_name = 'drawer')
content_tag(:div, class: 'drawer-header') do
content_tag(:h5, title, class: 'drawer-title') + drawer_close_button(controller_name)
diff --git a/admin/app/views/spree/admin/gift_cards/_filters.html.erb b/admin/app/views/spree/admin/gift_cards/_filters.html.erb
index f7e51bd628..370f1ace56 100644
--- a/admin/app/views/spree/admin/gift_cards/_filters.html.erb
+++ b/admin/app/views/spree/admin/gift_cards/_filters.html.erb
@@ -19,7 +19,7 @@
<% end %>
</div>
- <dialog class="drawer" data-dialog-target="dialog" id="gift-card-filters-drawer">
+ <%= drawer(id: 'gift-card-filters-drawer', controller_name: 'dialog') do %>
<%= drawer_header(Spree.t(:filter), 'dialog') %>
<div class="drawer-body">
<% if params[:user_id].blank? %>
@@ -45,7 +45,7 @@
<% end %>
</div>
</div>
- </dialog>
+ <% end %>
<%= render "spree/admin/shared/filter_badge_template" %>
diff --git a/admin/app/views/spree/admin/orders/_filters.html.erb b/admin/app/views/spree/admin/orders/_filters.html.erb
index 63fbe2a66d..73e9bd02fa 100644
--- a/admin/app/views/spree/admin/orders/_filters.html.erb
+++ b/admin/app/views/spree/admin/orders/_filters.html.erb
@@ -43,7 +43,7 @@
<% end %>
</div>
- <dialog class="drawer" data-dialog-target="dialog" id="order-filters-drawer">
+ <%= drawer(id: 'order-filters-drawer', controller_name: 'dialog') do %>
<%= drawer_header(Spree.t(:filter), 'dialog') %>
<div class="drawer-body">
<%= f.hidden_field :payment_state_not_eq, value: params.dig(:q, :payment_state_not_eq) %>
@@ -109,7 +109,7 @@
<%= drawer_discard_button('dialog') %>
<%= render 'spree/admin/shared/filter_submit' %>
</div>
- </dialog>
+ <% end %>
<%= render "spree/admin/shared/filter_badge_template" %>
<div data-filters-target="badgesContainer" class="filter-badges-container"></div>
diff --git a/admin/app/views/spree/admin/posts/filters.html.erb b/admin/app/views/spree/admin/posts/filters.html.erb
index 5e0c7d7da3..a5ca5760e9 100644
--- a/admin/app/views/spree/admin/posts/filters.html.erb
+++ b/admin/app/views/spree/admin/posts/filters.html.erb
@@ -8,7 +8,7 @@
<% end %>
</div>
- <dialog class="drawer" data-dialog-target="dialog" id="posts-filters-drawer">
+ <%= drawer(id: 'posts-filters-drawer', controller_name: 'dialog') do %>
<%= drawer_header(Spree.t(:filter), 'dialog') %>
<div class="drawer-body">
<div class="form-group">
@@ -31,7 +31,7 @@
<%= drawer_discard_button('dialog') %>
<%= render 'spree/admin/shared/filter_submit' %>
</div>
- </dialog>
+ <% end %>
<%= render "spree/admin/shared/filter_badge_template" %>
diff --git a/admin/app/views/spree/admin/products/_filters.html.erb b/admin/app/views/spree/admin/products/_filters.html.erb
index e8411ccef6..3f6e2cfedc 100644
--- a/admin/app/views/spree/admin/products/_filters.html.erb
+++ b/admin/app/views/spree/admin/products/_filters.html.erb
@@ -18,7 +18,7 @@
<% end %>
</div>
- <dialog class="drawer" data-dialog-target="dialog" id="product-filters-drawer">
+ <%= drawer(id: 'product-filters-drawer', controller_name: 'dialog') do %>
<%= drawer_header(Spree.t(:filter), 'dialog') %>
<div class="drawer-body">
<%= f.hidden_field :status_eq, value: params.dig(:q, :status_eq) %>
@@ -58,7 +58,7 @@
<%= drawer_discard_button('dialog') %>
<%= render 'spree/admin/shared/filter_submit' %>
</div>
- </dialog>
+ <% end %>
<%= render "spree/admin/shared/filter_badge_template" %>
diff --git a/admin/app/views/spree/admin/promotions/_filters.html.erb b/admin/app/views/spree/admin/promotions/_filters.html.erb
index 162386a689..016a90049b 100644
--- a/admin/app/views/spree/admin/promotions/_filters.html.erb
+++ b/admin/app/views/spree/admin/promotions/_filters.html.erb
@@ -8,7 +8,7 @@
<% end %>
</div>
- <dialog class="drawer" data-dialog-target="dialog" id="promotion-filters-drawer">
+ <%= drawer(id: 'promotion-filters-drawer', controller_name: 'dialog') do %>
<%= drawer_header(Spree.t(:filter), 'dialog') %>
<div class="drawer-body">
<div class="form-group">
@@ -21,7 +21,7 @@
<%= drawer_discard_button('dialog') %>
<%= render 'spree/admin/shared/filter_submit' %>
</div>
- </dialog>
+ <% end %>
<%= render "spree/admin/shared/filter_badge_template" %>
diff --git a/admin/app/views/spree/admin/shared/_bulk_modal.html.erb b/admin/app/views/spree/admin/shared/_bulk_modal.html.erb
index 0bdb60216d..eef5a1eb6e 100644
--- a/admin/app/views/spree/admin/shared/_bulk_modal.html.erb
+++ b/admin/app/views/spree/admin/shared/_bulk_modal.html.erb
@@ -1,4 +1,4 @@
-<dialog class="dialog" data-bulk-dialog-target="dialog" id="bulk-dialog">
+<%= dialog(id: 'bulk-dialog', controller_name: 'bulk-dialog') do %>
<%= turbo_frame_tag :bulk_dialog do %>
<%= dialog_header(Spree.t(:loading), 'bulk-dialog') %>
<div class="dialog-body text-center">
@@ -10,4 +10,4 @@
</div>
</div>
<% end %>
-</dialog>
+<% end %>
diff --git a/admin/app/views/spree/admin/shared/_dialog.html.erb b/admin/app/views/spree/admin/shared/_dialog.html.erb
index 26d0a41f1f..b2f8c46f2c 100644
--- a/admin/app/views/spree/admin/shared/_dialog.html.erb
+++ b/admin/app/views/spree/admin/shared/_dialog.html.erb
@@ -1,4 +1,4 @@
-<dialog class="dialog" data-dialog-target="dialog" id="main-dialog">
+<%= dialog(id: 'main-dialog') do %>
<%= turbo_frame_tag :dialog_alerts %>
<%= turbo_frame_tag :dialog %>
-</dialog>
+<% end %>
diff --git a/admin/app/views/spree/admin/shared/_drawer.html.erb b/admin/app/views/spree/admin/shared/_drawer.html.erb
index 7fd896766d..c6158508ce 100644
--- a/admin/app/views/spree/admin/shared/_drawer.html.erb
+++ b/admin/app/views/spree/admin/shared/_drawer.html.erb
@@ -1,4 +1,4 @@
-<dialog class="drawer" data-drawer-target="dialog" id="drawer-dialog">
+<%= drawer(id: 'drawer-dialog') do %>
<%= turbo_frame_tag :drawer_alerts %>
<%= turbo_frame_tag :drawer %>
-</dialog>
\ No newline at end of file
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shared/_export_modal.html.erb b/admin/app/views/spree/admin/shared/_export_modal.html.erb
index 01f088a08a..c8536f0042 100644
--- a/admin/app/views/spree/admin/shared/_export_modal.html.erb
+++ b/admin/app/views/spree/admin/shared/_export_modal.html.erb
@@ -1,3 +1,3 @@
-<dialog class="dialog" data-export-dialog-target="dialog" id="export-dialog">
+<%= dialog(id: 'export-dialog', controller_name: 'export-dialog') do %>
<%= turbo_frame_tag :export_dialog, src: spree.new_admin_export_path(export: { search_params: params[:q]&.to_json, type: export_type }) %>
-</dialog>
\ No newline at end of file
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shared/_internal_note.html.erb b/admin/app/views/spree/admin/shared/_internal_note.html.erb
index 19e2645118..8ac5790181 100644
--- a/admin/app/views/spree/admin/shared/_internal_note.html.erb
+++ b/admin/app/views/spree/admin/shared/_internal_note.html.erb
@@ -25,7 +25,7 @@
</div>
<% if can?(:update, notable) %>
- <dialog class="dialog" data-dialog-target="dialog">
+ <%= dialog do %>
<%= dialog_header(Spree.t(:internal_note)) %>
<%= form_with url: form_url, scope: param_key, method: :put do |f| %>
<div class="dialog-body">
@@ -36,6 +36,6 @@
<%= turbo_save_button_tag Spree.t('actions.save') %>
</div>
<% end %>
- </dialog>
+ <% end %>
<% end %>
</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/stock_items/_filters.html.erb b/admin/app/views/spree/admin/stock_items/_filters.html.erb
index 96f59c063b..a682b2f803 100644
--- a/admin/app/views/spree/admin/stock_items/_filters.html.erb
+++ b/admin/app/views/spree/admin/stock_items/_filters.html.erb
@@ -8,7 +8,7 @@
<% end %>
</div>
- <dialog class="drawer" data-dialog-target="dialog" id="stock-items-filters-drawer">
+ <%= drawer(id: 'stock-items-filters-drawer', controller_name: 'dialog') do %>
<%= drawer_header(Spree.t(:filter), 'dialog') %>
<div class="drawer-body">
<div class="form-group">
@@ -28,7 +28,7 @@
<%= drawer_discard_button('dialog') %>
<%= render 'spree/admin/shared/filter_submit' %>
</div>
- </dialog>
+ <% end %>
<%= render "spree/admin/shared/filter_badge_template" %>
<div data-filters-target="badgesContainer" class="filter-badges-container"></div>
diff --git a/admin/app/views/spree/admin/stock_transfers/_filters.html.erb b/admin/app/views/spree/admin/stock_transfers/_filters.html.erb
index 1784d741c8..f0bd75786a 100644
--- a/admin/app/views/spree/admin/stock_transfers/_filters.html.erb
+++ b/admin/app/views/spree/admin/stock_transfers/_filters.html.erb
@@ -7,7 +7,7 @@
<% end %>
</div>
- <dialog class="drawer" data-dialog-target="dialog" id="stock-transfers-filters-drawer">
+ <%= drawer(id: 'stock-transfers-filters-drawer', controller_name: 'dialog') do %>
<%= drawer_header(Spree.t(:filter), 'dialog') %>
<div class="drawer-body">
<div class="form-group">
@@ -42,7 +42,7 @@
<%= button Spree.t(:search), "search" %>
</div>
</div>
- </dialog>
+ <% end %>
<%= render "spree/admin/shared/filter_badge_template" %>
<div data-filters-target="badgesContainer" class="filter-badges-container"></div>
diff --git a/admin/app/views/spree/admin/stock_transfers/_new_variant_modal.html.erb b/admin/app/views/spree/admin/stock_transfers/_new_variant_modal.html.erb
index afcb071fe1..6dbe13dc2c 100644
--- a/admin/app/views/spree/admin/stock_transfers/_new_variant_modal.html.erb
+++ b/admin/app/views/spree/admin/stock_transfers/_new_variant_modal.html.erb
@@ -1,4 +1,4 @@
-<dialog class="dialog" data-dialog-target="dialog" id="stock_transfer_dialog" data-controller="search-picker">
+<%= dialog(id: 'stock_transfer_dialog', data: { controller: 'search-picker' }) do %>
<%= dialog_header(Spree.t(:add_variant)) %>
<div class="dialog-body">
<%= form_with url: spree.admin_variants_search_path, method: :post, data: { controller: 'auto-submit', turbo_frame: '_top' } do |form| %>
@@ -21,4 +21,4 @@
<%= dialog_discard_button %>
<%= button_tag Spree.t(:add_selected_variant), class: "btn btn-primary text-center", disabled: true, data: { search_picker_target: :submit, action: 'stock-transfer#add search-picker#closeAndClear dialog#close' } %>
</div>
-</dialog>
+<% end %>
diff --git a/admin/app/views/spree/admin/tables/_query_builder.html.erb b/admin/app/views/spree/admin/tables/_query_builder.html.erb
index 84f741b7bb..434425739c 100644
--- a/admin/app/views/spree/admin/tables/_query_builder.html.erb
+++ b/admin/app/views/spree/admin/tables/_query_builder.html.erb
@@ -15,9 +15,7 @@
<% end %>
</button>
- <dialog class="drawer"
- data-dialog-target="dialog"
- id="query-builder-drawer-<%= table_key %>">
+ <%= drawer(id: "query-builder-drawer-#{table_key}", controller_name: 'dialog') do %>
<%= drawer_header(Spree.t('admin.tables.filter_builder'), 'dialog') %>
<div data-controller="query-builder"
@@ -93,5 +91,5 @@
<%= render 'spree/admin/tables/filter_group' %>
</template>
</div>
- </dialog>
+ <% end %>
</div>
diff --git a/admin/app/views/spree/admin/users/_filters.html.erb b/admin/app/views/spree/admin/users/_filters.html.erb
index 53a5a9ff0c..f7d33fc967 100644
--- a/admin/app/views/spree/admin/users/_filters.html.erb
+++ b/admin/app/views/spree/admin/users/_filters.html.erb
@@ -14,7 +14,7 @@
<% end %>
</div>
- <dialog class="drawer" data-dialog-target="dialog" id="user-filters-drawer">
+ <%= drawer(id: 'user-filters-drawer', controller_name: 'dialog') do %>
<%= drawer_header(Spree.t(:filter), 'dialog') %>
<div class="drawer-body">
<div class="form-group">
@@ -73,7 +73,7 @@
<%= drawer_discard_button('dialog') %>
<%= render 'spree/admin/shared/filter_submit' %>
</div>
- </dialog>
+ <% end %>
<%= render "spree/admin/shared/filter_badge_template" %>
diff --git a/admin/spec/helpers/spree/admin/dialog_helper_spec.rb b/admin/spec/helpers/spree/admin/dialog_helper_spec.rb
new file mode 100644
index 0000000000..412ef01fa8
--- /dev/null
+++ b/admin/spec/helpers/spree/admin/dialog_helper_spec.rb
@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Spree::Admin::DialogHelper do
+ describe '#dialog' do
+ it 'renders a dialog element with default attributes' do
+ result = helper.dialog { 'content' }
+
+ expect(result).to have_css('dialog.dialog[data-dialog-target="dialog"]')
+ expect(result).to include('content')
+ end
+
+ it 'renders with custom id' do
+ result = helper.dialog(id: 'my-dialog') { 'content' }
+
+ expect(result).to have_css('dialog#my-dialog')
+ end
+
+ it 'renders with custom controller name' do
+ result = helper.dialog(controller_name: 'custom-dialog') { 'content' }
+
+ expect(result).to have_css('dialog[data-custom-dialog-target="dialog"]')
+ end
+
+ it 'merges additional data attributes' do
+ result = helper.dialog(data: { controller: 'search-picker' }) { 'content' }
+
+ expect(result).to have_css('dialog[data-controller="search-picker"]')
+ expect(result).to have_css('dialog[data-dialog-target="dialog"]')
+ end
+
+ it 'merges additional CSS classes' do
+ result = helper.dialog(class: 'custom-class') { 'content' }
+
+ expect(result).to have_css('dialog.dialog.custom-class')
+ end
+ end
+
+ describe '#dialog_header' do
+ it 'renders a dialog header with title' do
+ result = helper.dialog_header('Test Title')
+
+ expect(result).to have_css('.dialog-header')
+ expect(result).to have_css('.dialog-title', text: 'Test Title')
+ expect(result).to have_css('.btn-close')
+ end
+
+ it 'uses default controller name for close button' do
+ result = helper.dialog_header('Test Title')
+
+ expect(result).to have_css('[data-action="dialog#close"]')
+ end
+
+ it 'uses custom controller name for close button' do
+ result = helper.dialog_header('Test Title', 'custom-dialog')
+
+ expect(result).to have_css('[data-action="custom-dialog#close"]')
+ end
+ end
+
+ describe '#dialog_close_button' do
+ it 'renders a close button with default controller' do
+ result = helper.dialog_close_button
+
+ expect(result).to have_css('button.btn-close[data-action="dialog#close"]')
+ end
+
+ it 'renders a close button with custom controller' do
+ result = helper.dialog_close_button('my-dialog')
+
+ expect(result).to have_css('button.btn-close[data-action="my-dialog#close"]')
+ end
+ end
+
+ describe '#dialog_discard_button' do
+ it 'renders a discard button with default controller' do
+ result = helper.dialog_discard_button
+
+ expect(result).to have_css('button.btn.btn-light[data-action="dialog#close"]')
+ expect(result).to include(Spree.t('actions.discard'))
+ end
+
+ it 'renders a discard button with custom controller' do
+ result = helper.dialog_discard_button('my-dialog')
+
+ expect(result).to have_css('button[data-action="my-dialog#close"]')
+ end
+ end
+end
diff --git a/admin/spec/helpers/spree/admin/drawer_helper_spec.rb b/admin/spec/helpers/spree/admin/drawer_helper_spec.rb
new file mode 100644
index 0000000000..1bbddc1185
--- /dev/null
+++ b/admin/spec/helpers/spree/admin/drawer_helper_spec.rb
@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Spree::Admin::DrawerHelper do
+ describe '#drawer' do
+ it 'renders a dialog element with drawer class' do
+ result = helper.drawer { 'content' }
+
+ expect(result).to have_css('dialog.drawer[data-drawer-target="dialog"]')
+ expect(result).to include('content')
+ end
+
+ it 'renders with custom id' do
+ result = helper.drawer(id: 'my-drawer') { 'content' }
+
+ expect(result).to have_css('dialog#my-drawer')
+ end
+
+ it 'renders with custom controller name' do
+ result = helper.drawer(controller_name: 'dialog') { 'content' }
+
+ expect(result).to have_css('dialog[data-dialog-target="dialog"]')
+ end
+
+ it 'merges additional data attributes' do
+ result = helper.drawer(data: { controller: 'filters' }) { 'content' }
+
+ expect(result).to have_css('dialog[data-controller="filters"]')
+ expect(result).to have_css('dialog[data-drawer-target="dialog"]')
+ end
+
+ it 'merges additional CSS classes' do
+ result = helper.drawer(class: 'custom-class') { 'content' }
+
+ expect(result).to have_css('dialog.drawer.custom-class')
+ end
+ end
+
+ describe '#drawer_header' do
+ it 'renders a drawer header with title' do
+ result = helper.drawer_header('Test Title')
+
+ expect(result).to have_css('.drawer-header')
+ expect(result).to have_css('.drawer-title', text: 'Test Title')
+ expect(result).to have_css('.btn-close')
+ end
+
+ it 'uses default controller name for close button' do
+ result = helper.drawer_header('Test Title')
+
+ expect(result).to have_css('[data-action="drawer#close"]')
+ end
+
+ it 'uses custom controller name for close button' do
+ result = helper.drawer_header('Test Title', 'dialog')
+
+ expect(result).to have_css('[data-action="dialog#close"]')
+ end
+ end
+
+ describe '#drawer_close_button' do
+ it 'renders a close button with default controller' do
+ result = helper.drawer_close_button
+
+ expect(result).to have_css('button.btn-close[data-action="drawer#close"]')
+ end
+
+ it 'renders a close button with custom controller' do
+ result = helper.drawer_close_button('dialog')
+
+ expect(result).to have_css('button.btn-close[data-action="dialog#close"]')
+ end
+ end
+
+ describe '#drawer_discard_button' do
+ it 'renders a discard button with default controller' do
+ result = helper.drawer_discard_button
+
+ expect(result).to have_css('button.btn.btn-light[data-action="drawer#close"]')
+ expect(result).to include(Spree.t('actions.discard'))
+ end
+
+ it 'renders a discard button with custom controller' do
+ result = helper.drawer_discard_button('dialog')
+
+ expect(result).to have_css('button[data-action="dialog#close"]')
+ end
+ end
+end