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.

Ability to extend and swap shipping method forms elements (#12755)

Damian Legawiec3db962caf072
diff --git a/admin/app/views/spree/admin/shipping_methods/_form.html.erb b/admin/app/views/spree/admin/shipping_methods/_form.html.erb
index 574223073c..e98fc76d14 100644
--- a/admin/app/views/spree/admin/shipping_methods/_form.html.erb
+++ b/admin/app/views/spree/admin/shipping_methods/_form.html.erb
@@ -1,141 +1,14 @@
<div class="row">
<div class="col-lg-6">
- <div class="card mb-4">
- <div class="card-body">
- <div class="row">
- <div class="col-lg-6">
- <div class="form-group">
- <%= f.label :name, Spree.t(:name) %>
- <%= f.text_field :name, class: 'form-control', required: true, autofocus: f.object.new_record? %>
- <%= f.error_message_on :name %>
- </div>
-
- <p class="form-text text-muted small mt-2">
- This will be displayed to customers.
- </p>
- </div>
-
- <div class="col-lg-6">
- <div class="form-group">
- <%= f.label :display_on %>
- <%= f.select :display_on, display_on_options, {}, { class: 'custom-select custom-select' } %>
- <%= f.error_message_on :display_on %>
- </div>
- </div>
- </div>
- </div>
- </div>
-
- <div class="card mb-4">
- <div class="card-header">
- <h5 class="card-title">
- <%= Spree.t(:tracking_url) %>
- </h5>
- </div>
- <div class="card-body">
- <div class="form-group">
- <%= f.url_field :tracking_url, class: 'form-control', placeholder: Spree.t(:tracking_url_placeholder) %>
- <%= f.error_message_on :tracking_url %>
- </div>
-
- <p class="form-text text-muted small mt-2">
- <code>:tracking</code>
- <span>will be replaced with the tracking number.</span>
- </p>
- </div>
- </div>
-
- <div class="card mb-4">
- <div class="card-header d-flex align-items-center">
- <h5 class="card-title">
- <%= Spree.t(:zones) %>
- </h5>
-
- <%= link_to_with_icon('adjustments', Spree.t('admin.manage_zones'), spree.admin_zones_path, class: 'btn btn-sm btn-light ml-auto h-100') if can?(:manage, Spree::Zone) %>
- </div>
-
- <div class="card-body">
- <div class="form-group">
- <% @available_zones.each do |zone| %>
- <div class="custom-control custom-checkbox mb-2">
- <%= check_box_tag('shipping_method[zone_ids][]', zone.id, @shipping_method.zone_ids.include?(zone.id), id: "shipping_method_zones_#{zone.id}", class: 'custom-control-input') %>
- <%= label_tag "shipping_method_zones_#{zone.id}", class: 'custom-control-label' do %>
- <span ><%= zone.name.gsub('_', ' ') %></span>
- <p class="text-muted small mb-0">
- <%= zone.zone_members.map {|zone_member| zone_member.zoneable.name }.join(', ') %>
- </p>
- <% end %>
- </div>
- <% end %>
- <%= f.error_message_on :zone_id %>
- </div>
- </div>
- </div>
-
- <div class="card mb-4">
- <div class="card-header">
- <h5 class="card-title">
- <%= Spree.t(:shipping_categories) %>
- </h5>
- </div>
-
- <div class="card-body">
- <div class="form-group">
- <% @shipping_categories.each do |category| %>
- <div class="custom-control custom-checkbox mb-2">
- <%= check_box_tag('shipping_method[shipping_category_ids][]', category.id, @shipping_method.shipping_categories.include?(category), id: "shipping_method_categories_#{category.id}", class: 'custom-control-input') %>
- <%= label_tag "shipping_method_categories_#{category.id}", class: 'custom-control-label' do %>
- <%= category.name.gsub('_', ' ') %>
- <% end %>
- </div>
- <% end %>
- <%= f.error_message_on :shipping_category_id %>
- </div>
- </div>
- </div>
-
- <% if can?(:manage, Spree::TaxCategory) %>
- <div class="card mb-4">
- <div class="card-header">
- <h5 class="card-title">
- <%= Spree.t(:tax_category) %>
- </h5>
- </div>
-
- <div class="card-body">
- <div class="form-group">
- <%= f.collection_select(:tax_category_id, @tax_categories, :id, :name, { include_blank: Spree.t('match_choices.none') }, { class: 'custom-select' }) %>
- <%= f.error_message_on :tax_category %>
- </div>
- </div>
- </div>
- <% end %>
+ <%= render 'spree/admin/shipping_methods/form/display', f: f %>
+ <%= render 'spree/admin/shipping_methods/form/tracking_url', f: f %>
+ <%= render 'spree/admin/shipping_methods/form/zones', f: f %>
+ <%= render 'spree/admin/shipping_methods/form/shipping_categories', f: f %>
+ <%= render 'spree/admin/shipping_methods/form/tax_category', f: f %>
</div>
<div class="col-lg-6">
<%= render partial: 'spree/admin/shared/calculator_fields', locals: { f: f, calculators: @calculators } %>
-
- <div class="card mb-4 tax_categories">
- <div class="card-header">
- <h5 class="card-title">
- <%= Spree.t(:estimated_transit_business_days) %>
- </h5>
- </div>
- <div class="card-body">
- <div class="alert alert-info">
- This is the estimated number of business days it will take for the package to arrive at the customer's address.
- It will be displayed on the checkout page.
- </div>
- <div class="row">
- <div class="col">
- <%= f.label :estimated_transit_business_days_min, Spree.t(:min) %>
- <%= f.number_field :estimated_transit_business_days_min, class: 'form-control w-auto', size: 2, placeholder: Spree.t(:min), min: 1 %>
- </div>
- <div class="col">
- <%= f.label :estimated_transit_business_days_max, Spree.t(:max) %>
- <%= f.number_field :estimated_transit_business_days_max, class: 'form-control w-auto', size: 2, placeholder: Spree.t(:max), min: 1 %>
- </div>
- </div>
- </div>
- </div>
+ <%= render 'spree/admin/shipping_methods/form/estimated_transit_business_days', f: f %>
+ <%= render_admin_partials(:shipping_method_form_partials, f: f, shipping_method: @shipping_method) %>
</div>
</div>
diff --git a/admin/app/views/spree/admin/shipping_methods/form/_display.html.erb b/admin/app/views/spree/admin/shipping_methods/form/_display.html.erb
new file mode 100644
index 0000000000..89d4b1d6d4
--- /dev/null
+++ b/admin/app/views/spree/admin/shipping_methods/form/_display.html.erb
@@ -0,0 +1,25 @@
+<div class="card mb-4">
+ <div class="card-body">
+ <div class="row">
+ <div class="col-lg-6">
+ <div class="form-group">
+ <%= f.label :name, Spree.t(:name) %>
+ <%= f.text_field :name, class: 'form-control', required: true, autofocus: f.object.new_record? %>
+ <%= f.error_message_on :name %>
+ </div>
+
+ <p class="form-text text-muted small mt-2">
+ This will be displayed to customers.
+ </p>
+ </div>
+
+ <div class="col-lg-6">
+ <div class="form-group">
+ <%= f.label :display_on %>
+ <%= f.select :display_on, display_on_options, {}, { class: 'custom-select custom-select' } %>
+ <%= f.error_message_on :display_on %>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shipping_methods/form/_estimated_transit_business_days.html.erb b/admin/app/views/spree/admin/shipping_methods/form/_estimated_transit_business_days.html.erb
new file mode 100644
index 0000000000..23849aabc5
--- /dev/null
+++ b/admin/app/views/spree/admin/shipping_methods/form/_estimated_transit_business_days.html.erb
@@ -0,0 +1,23 @@
+<div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title">
+ <%= Spree.t(:estimated_transit_business_days) %>
+ </h5>
+ </div>
+ <div class="card-body">
+ <div class="alert alert-info">
+ This is the estimated number of business days it will take for the package to arrive at the customer's address.
+ It will be displayed on the checkout page.
+ </div>
+ <div class="row">
+ <div class="col">
+ <%= f.label :estimated_transit_business_days_min, Spree.t(:min) %>
+ <%= f.number_field :estimated_transit_business_days_min, class: 'form-control w-auto', size: 2, placeholder: Spree.t(:min), min: 1 %>
+ </div>
+ <div class="col">
+ <%= f.label :estimated_transit_business_days_max, Spree.t(:max) %>
+ <%= f.number_field :estimated_transit_business_days_max, class: 'form-control w-auto', size: 2, placeholder: Spree.t(:max), min: 1 %>
+ </div>
+ </div>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shipping_methods/form/_shipping_categories.html.erb b/admin/app/views/spree/admin/shipping_methods/form/_shipping_categories.html.erb
new file mode 100644
index 0000000000..668692c213
--- /dev/null
+++ b/admin/app/views/spree/admin/shipping_methods/form/_shipping_categories.html.erb
@@ -0,0 +1,21 @@
+<div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title">
+ <%= Spree.t(:shipping_categories) %>
+ </h5>
+ </div>
+
+ <div class="card-body">
+ <div class="form-group">
+ <% @shipping_categories.each do |category| %>
+ <div class="custom-control custom-checkbox mb-2">
+ <%= check_box_tag('shipping_method[shipping_category_ids][]', category.id, @shipping_method.shipping_categories.include?(category), id: "shipping_method_categories_#{category.id}", class: 'custom-control-input') %>
+ <%= label_tag "shipping_method_categories_#{category.id}", class: 'custom-control-label' do %>
+ <%= category.name.gsub('_', ' ') %>
+ <% end %>
+ </div>
+ <% end %>
+ <%= f.error_message_on :shipping_category_id %>
+ </div>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shipping_methods/form/_tax_category.html.erb b/admin/app/views/spree/admin/shipping_methods/form/_tax_category.html.erb
new file mode 100644
index 0000000000..f89804303d
--- /dev/null
+++ b/admin/app/views/spree/admin/shipping_methods/form/_tax_category.html.erb
@@ -0,0 +1,16 @@
+<% if can?(:manage, Spree::TaxCategory) %>
+ <div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title">
+ <%= Spree.t(:tax_category) %>
+ </h5>
+ </div>
+
+ <div class="card-body">
+ <div class="form-group">
+ <%= f.collection_select(:tax_category_id, @tax_categories, :id, :name, { include_blank: Spree.t('match_choices.none') }, { class: 'custom-select' }) %>
+ <%= f.error_message_on :tax_category %>
+ </div>
+ </div>
+ </div>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shipping_methods/form/_tracking_url.html.erb b/admin/app/views/spree/admin/shipping_methods/form/_tracking_url.html.erb
new file mode 100644
index 0000000000..5b6e12d3d2
--- /dev/null
+++ b/admin/app/views/spree/admin/shipping_methods/form/_tracking_url.html.erb
@@ -0,0 +1,18 @@
+<div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title">
+ <%= Spree.t(:tracking_url) %>
+ </h5>
+ </div>
+ <div class="card-body">
+ <div class="form-group">
+ <%= f.url_field :tracking_url, class: 'form-control', placeholder: Spree.t(:tracking_url_placeholder) %>
+ <%= f.error_message_on :tracking_url %>
+ </div>
+
+ <p class="form-text text-muted small mt-2">
+ <code>:tracking</code>
+ <span>will be replaced with the tracking number.</span>
+ </p>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/shipping_methods/form/_zones.html.erb b/admin/app/views/spree/admin/shipping_methods/form/_zones.html.erb
new file mode 100644
index 0000000000..4673889930
--- /dev/null
+++ b/admin/app/views/spree/admin/shipping_methods/form/_zones.html.erb
@@ -0,0 +1,26 @@
+<div class="card mb-4">
+ <div class="card-header d-flex align-items-center">
+ <h5 class="card-title">
+ <%= Spree.t(:zones) %>
+ </h5>
+
+ <%= link_to_with_icon('adjustments', Spree.t('admin.manage_zones'), spree.admin_zones_path, class: 'btn btn-sm btn-light ml-auto h-100') if can?(:manage, Spree::Zone) %>
+ </div>
+
+ <div class="card-body">
+ <div class="form-group">
+ <% @available_zones.each do |zone| %>
+ <div class="custom-control custom-checkbox mb-2">
+ <%= check_box_tag('shipping_method[zone_ids][]', zone.id, @shipping_method.zone_ids.include?(zone.id), id: "shipping_method_zones_#{zone.id}", class: 'custom-control-input') %>
+ <%= label_tag "shipping_method_zones_#{zone.id}", class: 'custom-control-label' do %>
+ <span ><%= zone.name.gsub('_', ' ') %></span>
+ <p class="text-muted small mb-0">
+ <%= zone.zone_members.map {|zone_member| zone_member.zoneable.name }.join(', ') %>
+ </p>
+ <% end %>
+ </div>
+ <% end %>
+ <%= f.error_message_on :zone_ids %>
+ </div>
+ </div>
+</div>
\ No newline at end of file
diff --git a/admin/lib/spree/admin/engine.rb b/admin/lib/spree/admin/engine.rb
index ee8d919c9b..a03ed790da 100644
--- a/admin/lib/spree/admin/engine.rb
+++ b/admin/lib/spree/admin/engine.rb
@@ -22,6 +22,7 @@ module Spree
:store_form_partials,
:store_nav_partials,
:settings_nav_partials,
+ :shipping_method_form_partials,
:store_settings_nav_partials,
:store_orders_nav_partials,
:store_products_nav_partials,
@@ -97,6 +98,7 @@ module Spree
Rails.application.config.spree_admin.store_form_partials = []
Rails.application.config.spree_admin.store_nav_partials = []
Rails.application.config.spree_admin.settings_nav_partials = []
+ Rails.application.config.spree_admin.shipping_method_form_partials = []
Rails.application.config.spree_admin.store_settings_nav_partials = []
Rails.application.config.spree_admin.store_orders_nav_partials = []
Rails.application.config.spree_admin.store_products_nav_partials = []
diff --git a/docs/developer/admin/extending-ui.mdx b/docs/developer/admin/extending-ui.mdx
index e597401161..1d9a28ab4a 100644
--- a/docs/developer/admin/extending-ui.mdx
+++ b/docs/developer/admin/extending-ui.mdx
@@ -456,6 +456,39 @@ Here's a list of all places you can inject your custom code:
</Accordion>
</AccordionGroup>
+### Shipping Methods
+
+<AccordionGroup>
+ <Accordion title="Shipping Methods Form">
+ `shipping_method_form_partials`
+
+ #### Variables
+
+ <ParamField path="f" type="ActionView::Helpers::FormBuilder">
+ The [ActionView::Helpers::FormBuilder](https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html) object.
+ </ParamField>
+
+ <ParamField path="shipping_method" type="Spree::ShippingMethod">
+ The [Spree::ShippingMethod](https://github.com/spree/spree/blob/main/core/app/models/spree/shipping_method.rb) object.
+ </ParamField>
+
+ Injects code into the shipping method form. This partial has access to the `f` variable, which is the form builder for the shipping method form, and the `shipping_method` variable.
+
+ To add a new section to the shipping method form, you can use the following code:
+
+ ```erb
+ <div class="card mb-4">
+ <div class="card-header">
+ <h5 class="card-title">ERP Integration</h5>
+ </div>
+ <div class="card-body">
+ <%= f.text_field :erp_shipping_method_id, class: "form-control" %>
+ </div>
+ </div>
+ ```
+ </Accordion>
+</AccordionGroup>
+
### Store Settings
<AccordionGroup>